KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > base > Extra


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 package com.sun.appserv.management.base;
24
25 import java.util.Map JavaDoc;
26 import java.io.IOException JavaDoc;
27
28 import javax.management.ObjectName JavaDoc;
29 import javax.management.MBeanInfo JavaDoc;
30 import javax.management.IntrospectionException JavaDoc;
31 import javax.management.ReflectionException JavaDoc;
32 import javax.management.InstanceNotFoundException JavaDoc;
33 import javax.management.MBeanException JavaDoc;
34
35 import com.sun.appserv.management.DomainRoot;
36 import com.sun.appserv.management.client.ProxyFactory;
37 import com.sun.appserv.management.client.ConnectionSource;
38
39
40 /**
41     Extra information available about each {@link AMX}. Most
42     of these fields are for advanced use and/or direct use of JMX.
43     
44     @see com.sun.appserv.management.base.Util#getExtra
45     @see AMX
46  */
47 public interface Extra extends StdAttributesAccess
48 {
49     /*
50         *******************************************************
51         CAUTION: if any Attribute is added that is not a "real"
52         Attribute, be sure to update AMXImplBase.EXTRA_REMOVALS
53         *******************************************************
54      */
55     
56     /**
57         Get the names of all available Attributes as found in MBeanInfo.
58         
59         @return String[] of names
60      */
61     public String JavaDoc[] getAttributeNames( );
62      
63     /**
64         @return the ObjectName of the MBean targeted by the AMX
65      */
66     public ObjectName JavaDoc getObjectName();
67     
68     /**
69         @return the MBeanInfo for the MBean targeted by the AMX
70      */
71     public MBeanInfo JavaDoc getMBeanInfo();
72     
73     
74     /**
75         @return true if the MBean targeted by the AMX has invariant MBeanInfo
76      */
77     public boolean getMBeanInfoIsInvariant();
78     
79     /**
80         Return the Java classname of the interface that this
81         implements. This classname may then subsequently be used
82         to create a standard JMX proxy if desired. If no such
83         classname is appropriate, then null will be returned.
84         
85         @return the classnames of all implemented interfaces (usually 1) or null
86      */
87     public String JavaDoc getInterfaceName();
88     
89     /**
90         @return the {@link ProxyFactory} that created the {@link AMX}
91      */
92     public ProxyFactory getProxyFactory();
93     
94     /**
95         @return the ConnectionSource used by the {@link AMX}
96      */
97     public ConnectionSource getConnectionSource();
98     
99      
100     /**
101         Get all available Attribute values, keyed by name. Available from client only;
102         not a "real" Attribute.
103         
104         @return Map keyed by Attribute name.
105      */
106     public Map JavaDoc<String JavaDoc,Object JavaDoc> getAllAttributes();
107     
108     /**
109         A proxy can become invalid if its corresponding MBean is unregistered. For
110         example, if monitoring is disabled, most monitoring MBeans are unregistered
111         from the MBeanServer and no longer exist.
112         
113         @return true if this proxy is valid
114      */
115     public boolean checkValid();
116
117 }
118
Popular Tags