org.glassfish.admin.amx.impl.mbean

Class AMXImplBase

java.lang.Object

org.glassfish.admin.amx.impl.mbean.MBeanImplBase

org.glassfish.admin.amx.impl.mbean.AMXImplBase

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, NotificationEmitter, AMX_SPI, NotificationSender

Direct Known Subclasses:

AMXConfigImpl, BulkAccessImpl, DomainRootImpl, ExtImpl, J2EEManagedObjectImplBase, LoggingImpl, MonitoringRootImpl, PathnamesImpl, QueryMgrImpl, RealmsImpl, RuntimeRootImpl, SampleImpl, ServerMonitoringImpl, ServerRuntimeImpl, SystemInfoImpl, ToolsImpl

public class AMXImplBase
extends MBeanImplBase
implements DynamicMBean, NotificationEmitter, AMX_SPI

Base class from which all AMX MBeans should derive (but not "must").

Note that even though this base class implements a number of interfaces, the actual MBean interface supplied by the subclass construction-time determines which of these is actually exposed in the MBeanInfo.

A subclass should generally not implement get/setAttribute(s) as these calls are processed in this base class--

If a subclass implements a getter or setter Method it will be invoked automatically. If there is no getter or setter Method, then the getAttributeManually() or setAttributeManually() methods will be invoked; the subclass should implement these methods instead.

Method invocation is also handled automatically. If a Method cannot be found, the invokeManually() method is called; the subclass should implement this method.

Note that various optimizations are possible, but not implemented. These include caching Methods for each Attribute and for operations as well. Careful testing should be done before complicating the code with such optimizations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ObjectName[]	EMPTY_OBJECT_NAMES
protected static String	GET
protected static String	GET_PREFIX
protected MBeanInfo	mMBeanInfo
protected static String	OBJECT_NAME_SUFFIX
protected static String	SET

Fields inherited from class org.glassfish.admin.amx.impl.mbean.MBeanImplBase

EMPTY_STRING_ARRAY, mSelfObjectName, mServer

Constructor Summary

Constructors

Constructor and Description
AMXImplBase(ObjectName parentObjectName)
AMXImplBase(ObjectName parentObjectName, Class<? extends AMX_SPI> intf)
AMXImplBase(ObjectName parentObjectName, MBeanInfo mbeanInfo)

Method Summary

Modifier and Type	Method and Description
protected String[]	attributeNameToType(String attributeName) Supply possible types to be tried based on attribute name
protected boolean	attributeTypeMatches(String attributeName, Class<?> clazz)
protected static void	cdebug(String s) console debug
protected ObjectName	child(Class<?> intf)
protected ObjectName	child(String type)
protected ObjectName	child(String type, String name)
protected Method	findGetter(String name)
protected Method	findMethod(String methodName, Class[] sig) Find a method.
protected Method	findSetter(Attribute attr) Find a setXXX() method that matches the Attribute.
protected ObjectName	getAncestorByType(String type)
Object	getAttribute(String name) Get an Attribute value, first by looking for a getter method of the correct name and signature, then by looking for a delegate, and finally by calling getAttributeManually(), which a subclass is expected to override.
protected Object	getAttributeByMethod(String attrName, Method m) Set an Attribute by invoking the supplied method.
protected MBeanAttributeInfo	getAttributeInfo(String name)
protected Map<String,MBeanAttributeInfo>	getAttributeInfos()
protected Object	getAttributeInternal(String name)
protected Object	getAttributeManually(String attributeName) Subclasses should override this to handle getAttribute( attrName ).
Set<String>	getAttributeNames()
protected Object	getAttributeNoThrow(String name)
AttributeList	getAttributes(String[] names) Bulk get.
protected String	getAttributeType(String attrName)
ObjectName[]	getChildren() If no children are possible (a leaf node), an AttributeNotFoundException should be thrown.
ObjectName[]	getChildren(Class<?> clazz)
ObjectName[]	getChildren(Set<String> types)
ObjectName[]	getChildren(String type)
Map<String,ObjectName>	getChildrenMap(String type)
ObjectName	getDomainRoot()
DomainRoot	getDomainRootProxy()
Logger	getLogger()
MBeanInfo	getMBeanInfo()
MBeanTrackerMBean	getMBeanTracker()
String	getName() A subclass might need to override this method if its name contains characters that are illegal for the ObjectName.
MBeanNotificationInfo[]	getNotificationInfo()
protected ObjectName	getObjectNameAttribute(String attributeName) get child ObjectName corresponding to the AttributeName
protected ObjectNameBuilder	getObjectNames()
protected ObjectName[]	getObjectNamesForAttribute(String attributeName) get child ObjectNameBuilder corresponding to the AttributeName
ObjectName	getParent() Return the ObjectName of the parent.
AMXProxy	getParentProxy()
protected <T extends AMXProxy> T	getProxy(ObjectName objectName, Class<T> intf)
protected ProxyFactory	getProxyFactory()
protected AMXProxy	getSelf()
protected <T extends AMXProxy> T	getSelf(Class<T> intf)
protected boolean	getterNameMatches(String operationName, String suffix)
protected void	handleException(Exception e)
protected void	handleGetAttributeException(Exception e)
protected void	handleInvokeThrowable(Exception e)
protected void	impossible(Throwable t) The impossible has happened.
Object	invoke(String operationName, Object[] args, String[] types) Generic handling of invoke().
protected Object	invokeManually(String operationName, Object[] args, String[] types) An operation is being invoked manually, meaning that it is missing as a method.
protected boolean	isReadOnlyAttribute(String name)
protected static boolean	isUtilityMBean(Class mbeanInterface)
String	java()
protected boolean	operationNameMatches(String operationName, String prefix, String suffix)
protected void	postRegisterHook(Boolean registrationSucceeded) Important: must be synchronized so that preDeregisterHook cannot be called prior to existing postRegisterHook()
protected MBeanInfo	postRegisterModifyMBeanInfo(MBeanInfo info) Hook for a subclass when registration is complete
protected void	preDeregisterHook() Important: must be synchronized so that it cannot be called prior to exiting postRegisterHook()
ObjectName	preRegister(MBeanServer server, ObjectName nameIn)
protected void	preRegisterDone()
protected ObjectName	preRegisterHook(MBeanServer server, ObjectName selfObjectName) This is an opportunity for a subclass to do initialization and optionally to modify the ObjectName one last time.
protected ObjectName	preRegisterModifyName(MBeanServer server, ObjectName nameIn) O the ObjectName by adding to it: adding AMX.FULL_TYPE_KEY property
protected ObjectName	registerChild(Object mbean, ObjectName childObjectName)
protected void	registerChildren()
protected void	sendAttributeChangeNotification(String msg, String name, String attrType, long when, Object oldValue, Object newValue)
void	setAttribute(Attribute attr)
protected void	setAttributeByMethod(Attribute attr, Method m)
protected void	setAttributeInternal(Attribute attr) Set an Attribute value, first by looking for a setter method of the correct name and signature, then by looking for a delegate, and finally by calling setAttributeManually(), which a subclass is expected to override.
protected void	setAttributeManually(Attribute attr) Subclasses should override this to handle setAttribute( attr ).
AttributeList	setAttributes(AttributeList attrs) Note that the default implementation sets attributes one at a time, but that MBeans with transactional requirements (eg configuration) may wish to set them as a group.
protected boolean	shouldEmitNotifications()
protected String	stringify(Object o)
protected boolean	supportsChildren()
String	toString()
protected Object	unimplementedAttribute(String attrName) An Attribute has not been implemented.
protected void	unimplementedOperation(String operation) An operation has not been implemented.
protected void	unregisterChildren()

Methods inherited from class org.glassfish.admin.amx.impl.mbean.MBeanImplBase

_getMBeanLogLevel, addNotificationListener, addNotificationListener, createNotificationBuilder, debug, debug, debugMethod, debugMethod, enableAMXDebug, getAMXDebug, getDebugID, getDebugOutput, getJMXDomain, getListenerCount, getMBeanLogger, getMBeanLoggerName, getMBeanLogLevel, getMBeanLogLevelInt, getMBeanServer, getNotificationBuilder, getNotificationEmitter, getNotificationTypeListenerCount, getObjectName, logFine, logFiner, logFinest, logInfo, logSevere, logWarning, postDeregister, postDeregisterHook, postRegister, preDeregister, quote, removeNotificationListener, removeNotificationListener, sendNotification, sendNotification, sendNotification, sendNotification, setAMXDebug, setMBeanLogLevel, shouldOmitObjectNameForDebug, sleepMillis, toString, trace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, removeNotificationListener

Field Detail

GET

protected static final String GET

See Also:

Constant Field Values

SET

protected static final String SET

See Also:

Constant Field Values

mMBeanInfo

protected volatile MBeanInfo mMBeanInfo

EMPTY_OBJECT_NAMES

protected static final ObjectName[] EMPTY_OBJECT_NAMES

GET_PREFIX

protected static final String GET_PREFIX

See Also:

Constant Field Values

OBJECT_NAME_SUFFIX

protected static final String OBJECT_NAME_SUFFIX

See Also:

Constant Field Values

Constructor Detail

AMXImplBase

public AMXImplBase(ObjectName parentObjectName,
                   Class<? extends AMX_SPI> intf)

AMXImplBase

public AMXImplBase(ObjectName parentObjectName)

AMXImplBase

public AMXImplBase(ObjectName parentObjectName,
                   MBeanInfo mbeanInfo)

Method Detail

cdebug

protected static void cdebug(String s)

console debug

getMBeanInfo

public MBeanInfo getMBeanInfo()

Specified by:

getMBeanInfo in interface DynamicMBean

shouldEmitNotifications

protected final boolean shouldEmitNotifications()

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Specified by:

getNotificationInfo in interface NotificationBroadcaster

getProxyFactory

protected ProxyFactory getProxyFactory()

getProxy

protected <T extends AMXProxy> T getProxy(ObjectName objectName,
                                          Class<T> intf)

getSelf

protected final <T extends AMXProxy> T getSelf(Class<T> intf)

getSelf

protected AMXProxy getSelf()

getParent

public final ObjectName getParent()

Description copied from interface: AMX_SPI

Return the ObjectName of the parent. Must not be null (except for DomainRoot)

Specified by:

getParent in interface AMX_SPI

getAncestorByType

protected ObjectName getAncestorByType(String type)

getParentProxy

public final AMXProxy getParentProxy()

getMBeanTracker

public MBeanTrackerMBean getMBeanTracker()

getChildren

public ObjectName[] getChildren()

Description copied from interface: AMX_SPI

If no children are possible (a leaf node), an AttributeNotFoundException should be thrown.

Specified by:

getChildren in interface AMX_SPI

getChildren

public ObjectName[] getChildren(Class<?> clazz)

getChildren

public ObjectName[] getChildren(String type)

getChildren

public ObjectName[] getChildren(Set<String> types)

getChildrenMap

public Map<String,ObjectName> getChildrenMap(String type)

supportsChildren

protected boolean supportsChildren()

child

protected ObjectName child(String type,
                           String name)

child

protected ObjectName child(String type)

child

protected ObjectName child(Class<?> intf)

isUtilityMBean

protected static boolean isUtilityMBean(Class mbeanInterface)

getAttributeNames

public final Set<String> getAttributeNames()

unimplementedOperation

protected final void unimplementedOperation(String operation)

An operation has not been implemented. Deal with appropriately.

unimplementedAttribute

protected final Object unimplementedAttribute(String attrName)

An Attribute has not been implemented.

impossible

protected final void impossible(Throwable t)

The impossible has happened.

getAttributeNoThrow

protected Object getAttributeNoThrow(String name)

getAttributeInfos

protected Map<String,MBeanAttributeInfo> getAttributeInfos()

getAttributeInfo

protected MBeanAttributeInfo getAttributeInfo(String name)

isReadOnlyAttribute

protected boolean isReadOnlyAttribute(String name)

getLogger

public Logger getLogger()

getAttribute

public final Object getAttribute(String name)
                          throws AttributeNotFoundException

Get an Attribute value, first by looking for a getter method of the correct name and signature, then by looking for a delegate, and finally by calling getAttributeManually(), which a subclass is expected to override.

Specified by:

getAttribute in interface DynamicMBean

Parameters:

name - name of the Attribute

Returns:

value of the Attribute

Throws:

AttributeNotFoundException

attributeTypeMatches

protected boolean attributeTypeMatches(String attributeName,
                                       Class<?> clazz)

getAttributeInternal

protected Object getAttributeInternal(String name)
                               throws AttributeNotFoundException,
                                      ReflectionException,
                                      MBeanException

Throws:

AttributeNotFoundException

ReflectionException

MBeanException

getAttributes

public AttributeList getAttributes(String[] names)

Bulk get. Note that is is important for this implementation to call getAttribute() for each name so that each may be processed appropriately; some Attributes may be in this MBean itself.

Specified by:

getAttributes in interface DynamicMBean

Parameters:

names - array of Attribute names

Returns:

AttributeList of Attributes successfully fetched

getAttributeByMethod

protected Object getAttributeByMethod(String attrName,
                                      Method m)
                               throws AttributeNotFoundException

Set an Attribute by invoking the supplied method.

Throws:

AttributeNotFoundException

setAttributeByMethod

protected void setAttributeByMethod(Attribute attr,
                                    Method m)
                             throws AttributeNotFoundException,
                                    InvalidAttributeValueException

Throws:

AttributeNotFoundException

InvalidAttributeValueException

attributeNameToType

protected String[] attributeNameToType(String attributeName)

Supply possible types to be tried based on attribute name

getObjectNamesForAttribute

protected ObjectName[] getObjectNamesForAttribute(String attributeName)

get child ObjectNameBuilder corresponding to the AttributeName

getObjectNameAttribute

protected ObjectName getObjectNameAttribute(String attributeName)

get child ObjectName corresponding to the AttributeName

getAttributeManually

protected Object getAttributeManually(String attributeName)
                               throws AttributeNotFoundException,
                                      ReflectionException,
                                      MBeanException

Subclasses should override this to handle getAttribute( attrName ). It will be called if no appropriate getter is found.

Throws:

AttributeNotFoundException

ReflectionException

MBeanException

setAttributeManually

protected void setAttributeManually(Attribute attr)
                             throws AttributeNotFoundException,
                                    InvalidAttributeValueException

Subclasses should override this to handle setAttribute( attr ). It will be called if no appropriate setter is found.

Throws:

AttributeNotFoundException

InvalidAttributeValueException

setAttribute

public void setAttribute(Attribute attr)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException

Specified by:

setAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

InvalidAttributeValueException

setAttributeInternal

protected void setAttributeInternal(Attribute attr)
                             throws AttributeNotFoundException,
                                    InvalidAttributeValueException,
                                    ReflectionException,
                                    MBeanException

Set an Attribute value, first by looking for a setter method of the correct name and signature, then by looking for a delegate, and finally by calling setAttributeManually(), which a subclass is expected to override.

Parameters:

attr - the Attribute

Throws:

AttributeNotFoundException

InvalidAttributeValueException

ReflectionException

MBeanException

getAttributeType

protected final String getAttributeType(String attrName)

sendAttributeChangeNotification

protected void sendAttributeChangeNotification(String msg,
                                               String name,
                                               String attrType,
                                               long when,
                                               Object oldValue,
                                               Object newValue)

setAttributes

public AttributeList setAttributes(AttributeList attrs)

Note that the default implementation sets attributes one at a time, but that MBeans with transactional requirements (eg configuration) may wish to set them as a group.

Specified by:

setAttributes in interface DynamicMBean

findMethod

protected final Method findMethod(String methodName,
                                  Class[] sig)

Find a method.

Parameters:

methodName -

sig -

Returns:

a Method or null if not found

findGetter

protected final Method findGetter(String name)

findSetter

protected final Method findSetter(Attribute attr)

Find a setXXX() method that matches the Attribute.

Parameters:

attr - an Attribute for which a matching setter should be located

Returns:

a Method or null if not found

operationNameMatches

protected boolean operationNameMatches(String operationName,
                                       String prefix,
                                       String suffix)

getterNameMatches

protected boolean getterNameMatches(String operationName,
                                    String suffix)

handleException

protected void handleException(Exception e)
                        throws MBeanException,
                               ReflectionException

Throws:

MBeanException

ReflectionException

handleGetAttributeException

protected void handleGetAttributeException(Exception e)
                                    throws MBeanException,
                                           ReflectionException,
                                           AttributeNotFoundException

Throws:

MBeanException

ReflectionException

AttributeNotFoundException

handleInvokeThrowable

protected void handleInvokeThrowable(Exception e)
                              throws MBeanException,
                                     ReflectionException

Throws:

MBeanException

ReflectionException

invoke

public final Object invoke(String operationName,
                           Object[] args,
                           String[] types)
                    throws MBeanException,
                           ReflectionException

Generic handling of invoke(). Converts the types[] to a Class[], then attempts to locate a suitable Method. If a suitable Method is found, it is invoked. If not found the subclass is expected to handle it in invokeManually();

Specified by:

invoke in interface DynamicMBean

Throws:

MBeanException

ReflectionException

invokeManually

protected Object invokeManually(String operationName,
                                Object[] args,
                                String[] types)
                         throws MBeanException,
                                ReflectionException,
                                NoSuchMethodException,
                                AttributeNotFoundException

An operation is being invoked manually, meaning that it is missing as a method. invokeManually() will be called only if no appropriate Method is found.

Subclasses may override this to handle invoke(), though usually it's just easier to write the appropriate method directly, which will be found and called if present.

Throws:

MBeanException

ReflectionException

NoSuchMethodException

AttributeNotFoundException

getName

public String getName()

A subclass might need to override this method if its name contains characters that are illegal for the ObjectName.

Specified by:

getName in interface AMX_SPI

preRegisterModifyName

protected ObjectName preRegisterModifyName(MBeanServer server,
                                           ObjectName nameIn)

O the ObjectName by adding to it:

• adding AMX.FULL_TYPE_KEY property

preRegister

public final ObjectName preRegister(MBeanServer server,
                                    ObjectName nameIn)
                             throws Exception

Specified by:

preRegister in interface MBeanRegistration

Overrides:

preRegister in class MBeanImplBase

Throws:

Exception

preRegisterHook

protected ObjectName preRegisterHook(MBeanServer server,
                                     ObjectName selfObjectName)
                              throws Exception

This is an opportunity for a subclass to do initialization and optionally to modify the ObjectName one last time.

Throws:

Exception

preRegisterDone

protected void preRegisterDone()
                        throws Exception

Throws:

Exception

postRegisterModifyMBeanInfo

protected MBeanInfo postRegisterModifyMBeanInfo(MBeanInfo info)

Hook for a subclass when registration is complete

postRegisterHook

protected void postRegisterHook(Boolean registrationSucceeded)

Important: must be synchronized so that preDeregisterHook cannot be called prior to existing postRegisterHook()

Overrides:

postRegisterHook in class MBeanImplBase

registerChildren

protected void registerChildren()

preDeregisterHook

protected void preDeregisterHook()
                          throws Exception

Important: must be synchronized so that it cannot be called prior to exiting postRegisterHook()

Overrides:

preDeregisterHook in class MBeanImplBase

Throws:

Exception

unregisterChildren

protected void unregisterChildren()

getDomainRootProxy

public final DomainRoot getDomainRootProxy()

getDomainRoot

public final ObjectName getDomainRoot()

stringify

protected String stringify(Object o)

toString

public String toString()

Overrides:

toString in class Object

java

public String java()

registerChild

protected ObjectName registerChild(Object mbean,
                                   ObjectName childObjectName)

getObjectNames

protected ObjectNameBuilder getObjectNames()