KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > management > support > AMXDebugStuff


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 /*
25  * Copyright 2004-2005 Sun Microsystems, Inc. All rights reserved.
26  * Use is subject to license terms.
27  */
28  
29 /*
30  */
31
32 package com.sun.enterprise.management.support;
33
34
35 /**
36     This interface will be exposed in MBeanInfo when AMX-DEBUG.enabled=true.
37     It is private and should be used only for internal development purposes.
38     @see com.sun.appserv.management.base.AMXDebug
39  */
40 public interface AMXDebugStuff
41 {
42     /**
43         Applicable to those MBeans that have a Delegate.
44         Output any anomolies between the interface the MBean
45         provides and the items that are available in the Delegate.
46         <p>
47         If debug is off, or there is no Delegate, then null is returned.
48         If there are no issues, then an empty String is returned.
49         Otherwise, a String describing the problem(s) is returned.
50         
51         @return a String summary
52      */
53     public String JavaDoc checkInterfaceAgainstDelegate();
54     
55     /**
56      */
57     public boolean getAMXDebug();
58     
59     /**
60         Implemented as a method, so it can be used with or without
61         AMX-DEBUG being on (unknown Attributes are rejected normally).
62         @return previous enable status
63      */
64     public boolean enableAMXDebug( final boolean enable );
65     
66     
67     /**
68         Implemented as a method, so it can be used with or without
69         AMX-DEBUG being on (unknown Attributes are rejected normally).
70         @return previous enable status
71      */
72     public boolean enableCoverageInfo( final boolean enable );
73     
74     /**
75         This is only for internal, debug use, so it's OK
76         to return a proprietary type.
77      */
78     public CoverageInfo getCoverageInfo();
79     
80     
81     /**
82         This is only for internal, debug use, so it's OK
83         to return a proprietary type.
84      */
85     public void clearCoverageInfo();
86     
87     /**
88         Produces a useful String describing the AMX MBean.
89      */
90     public String JavaDoc getImplString( boolean verbose );
91 }
92
93
Popular Tags