001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.mx.server.registry;
023:
024: import java.util.List;
025: import java.util.Map;
026:
027: import javax.management.InstanceAlreadyExistsException;
028: import javax.management.InstanceNotFoundException;
029: import javax.management.MBeanRegistrationException;
030: import javax.management.NotCompliantMBeanException;
031: import javax.management.ObjectInstance;
032: import javax.management.ObjectName;
033:
034: import org.jboss.mx.server.ServerConstants;
035:
036: /**
037: * Implementations of this interface can be plugged into the MBeanServer,
038: * to control the registration and deregistration of MBeans. <p>
039: *
040: * The registry can expose itself for management under the object name
041: * defined the name defined in {@link ServerConstants}
042: * When this is the case, the MBeanServer will perform the
043: * register/unregister operations dynamically.
044: *
045: * @author <a href="mailto:juha@jboss.org">Juha Lindfors</a>.
046: * @author <a href="mailto:trevor@protocool.com">Trevor Squires</a>.
047: * @author <a href="mailto:Adrian.Brock@HappeningTimes.com">Adrian Brock</a>.
048: * @version $Revision: 57200 $
049: *
050: * @see MBeanEntry
051: *
052: * <p><b>Revisions:</b>
053: *
054: * <p><b>20030806 Juha Lindfors:</b>
055: * <ul>
056: * <li>
057: * Added releaseRegistry() method to the interface as per the patch
058: * submitted by Rod Burgett (Bug Tracker: #763378)
059: * </ul>
060: *
061: */
062: public interface MBeanRegistry extends ServerConstants {
063: /**
064: * Register an mbean.<p>
065: *
066: * This method is invoked by the MBeanServer for
067: * createMBean() and registerMBean().<p>
068: *
069: * The object name passed maybe unqualified.<p>
070: *
071: * The map is a user definable string to value object map for holding
072: * information against a registered object. This map may contain metadata
073: * related to the registration, such as registration date/time, classloader
074: * references, etc. <p>
075: *
076: * Pass {@link org.jboss.mx.server.ServerConstants#JMI_DOMAIN JMI_DOMAIN} in
077: * both the key and values of the values map to get access to the reserved
078: * domain. It is removed from the map during registration to save memory.<p>
079: *
080: * Pass {@link ServerConstants#CLASSLOADER CLASSLOADER} in the values map to
081: * set the context classloader<p>
082: *
083: * Other values are user definable and can be retrieved using the
084: * getValue(ObjectName,String) method.
085: *
086: * @param object the mbean to register.
087: * @param name the object name to assign to the mbean.
088: * @param valueMap a map of other information to include in the
089: * registry
090: *
091: * @return an object instance for the registered mbean
092: *
093: * @exception InstanceAlreadyExistsException when the object name
094: * is already registered.
095: * @exception MBeanRegistrationException when an exception is raised
096: * during preRegister for the mbean.
097: * @exception NotCompliantMBeanException when the passed object is
098: * a valid mbean.
099: */
100: ObjectInstance registerMBean(Object object, ObjectName name,
101: Map valueMap) throws InstanceAlreadyExistsException,
102: MBeanRegistrationException, NotCompliantMBeanException;
103:
104: /**
105: * Unregister an mbean. <p>
106: *
107: * This method is invoked by the MBeanServer for
108: * unregisterMBean().<p>
109: *
110: * The object name passed maybe unqualified.<p>
111: *
112: * MBeans in JMImplementation cannot be unregistered
113: *
114: * @param name the mbean to unregister.
115: *
116: * @exception InstanceNotFoundException when the object name is
117: * not registered.
118: * @exception MBeanRegistrationException when an exception is raised
119: * during preDeregister for the mbean.
120: */
121: void unregisterMBean(ObjectName name)
122: throws InstanceNotFoundException,
123: MBeanRegistrationException;
124:
125: /**
126: * Retrieve the registration for an object name.<p>
127: *
128: * This method is invoked by the MBeanServer for
129: * methods passing an ObjectName that are not covered in other methods.<p>
130: *
131: * The object name passed maybe unqualified.
132: *
133: * @param name the object name to retrieve
134: *
135: * @return the mbean's registration
136: *
137: * @exception InstanceNotFoundException when the object name is not
138: * registered.
139: */
140: public MBeanEntry get(ObjectName name)
141: throws InstanceNotFoundException;
142:
143: /**
144: * Retrieve the default domain for this registry.<p>
145: *
146: * @return the default domain
147: */
148: String getDefaultDomain();
149:
150: /**
151: * Retrieve the domains for this registry.<p>
152: *
153: * @return the domains
154: */
155: String[] getDomains();
156:
157: /**
158: * Retrieve the object instance for an object name.
159: *
160: * @param name the object name of the mbean
161: * @return the object instance
162: * @exception InstanceNotFoundException when the object name is not
163: * registered
164: */
165: public ObjectInstance getObjectInstance(ObjectName name)
166: throws InstanceNotFoundException;
167:
168: /**
169: * Retrieve a value from the registration.
170: *
171: * @param name the object name of the mbean
172: * @param key the key to the value
173: * @return the value or null if there is no such value
174: * @exception InstanceNotFoundException when the object name is not
175: * registered
176: */
177: public Object getValue(ObjectName name, String key)
178: throws InstanceNotFoundException;
179:
180: /**
181: * Test whether an object name is registered. <p>
182: *
183: * This method is invoked by the MBeanServer for
184: * isRegistered().<p>
185: *
186: * The object name passed maybe unqualified.
187: *
188: * @param name the object name
189: * @return true when the object name is registered, false otherwise
190: */
191: boolean contains(ObjectName name);
192:
193: /**
194: * Return a List of MBeanEntry objects with ObjectNames that match the
195: * specified pattern. <p>
196: *
197: * This method is invoked by the MBeanServer for
198: * queryMBeans() and queryNames().
199: *
200: * @param pattern the pattern to match
201: * @return a List of entries matching the pattern
202: */
203: public List findEntries(ObjectName pattern);
204:
205: /**
206: * Retrieve the number of mbeans registered.<p>
207: *
208: * This method is invoked by the MBeanServer for
209: * getMBeanCount().
210: *
211: * @return the number of mbeans registered.
212: */
213: int getSize();
214:
215: /**
216: * Invoked before the MBean server instance is released. Implementing
217: * this method lets the registry to process any clean up before the
218: * MBean server is shut down.
219: */
220: void releaseRegistry();
221:
222: }
|