com.sun.jbi.management.config

Class RuntimeConfiguration

java.lang.Object

javax.management.modelmbean.RequiredModelMBean

com.sun.jbi.management.config.RuntimeConfiguration

All Implemented Interfaces:

Constants, DynamicMBean, MBeanRegistration, ModelMBean, ModelMBeanNotificationBroadcaster, NotificationBroadcaster, NotificationEmitter, PersistentMBean

Direct Known Subclasses:

GlobalConfiguration, InstanceConfiguration

public class RuntimeConfiguration
extends RequiredModelMBean
implements NotificationEmitter, Constants

This is the basic RuntimeConfiguration MBean. It is a dynamic model MBean.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationCategory	mCategory
protected List<NotificationListenerInfo>	mListeners
protected PlatformContext	mPlatformCtx Context information
protected String	mTarget
protected static MessageBuilder	sMsgBuilder Message Builder
protected static MBeanNotificationInfo[]	sNotificationInfo
protected static HashMap<String,String>	sTypeMap Primitive types to their class object mapping

Fields inherited from interface com.sun.jbi.util.Constants

ADMIN_RUNNING_FILE, ADMIN_STOPPED_FILE, CONFIG_NAME_KEY, LOG_LEVEL_DEFAULT, TMP_FOLDER

Constructor Summary

Constructors

Constructor and Description
RuntimeConfiguration(ModelMBeanInfo mbeanInfo, ConfigurationCategory category, String target) Creates a new RuntimeConfiguration MBean.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) Adds a listener to this MBean.
protected void	checkIsValidAttribute(Attribute attribute) This operations checks : (a) If an attribute with the same identification exists in the current configuration (b) If the type of the value passed matches the expected value.
static ModelMBeanInfo	createMBeanInfo(ModelMBeanAttributeInfo[] attributeInfos)
protected void	deleteOverride(String attrName) This operation is called when a configuration attribute is to use the global configuration, the overriden attribute needs to be deleted from the target configiration
Object	getAttribute(String attribute) Obtain the value of a specific attribute of the Dynamic MBean.
protected ModelMBeanAttributeInfo	getAttributeInfo(String attribute)
AttributeList	getAttributes(String[] attributeNames) Get the values of several attributes of the Dynamic MBean.
protected static EnvironmentContext	getEnvironmentContext()
protected List<NotificationListenerInfo>	getListeners()
protected static Logger	getLogger()
protected ManagementContext	getManagementContext()
protected String	getMatchingAttribute(String name)
MBeanNotificationInfo[]	getNotificationInfo()
protected PlatformContext	getPlatformContext()
protected Registry	getRegistry() Get a handle to the registry
protected static StringTranslator	getTranslator()
Object	invoke(String actionName, Object[] params, String[] signature) Allows an action to be invoked on the Dynamic MBean.
protected boolean	isPassword(String attrName)
protected void	notifyListenersOfAttributeChange(Attribute attribute) Send the notification to all interested listeners
protected void	persist() Persist the factory defaults to the registry for the global configuration.
protected void	persistDomainConfig() Persist the domain configuration if required.
void	removeNotificationListener(NotificationListener listener)
void	removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) Remove a specific listener from the set.
AttributeList	setAttributes(AttributeList attributes) Sets the values of several attributes of the Dynamic MBean.

Methods inherited from class javax.management.modelmbean.RequiredModelMBean

addAttributeChangeNotificationListener, getClassLoaderRepository, getMBeanInfo, load, postDeregister, postRegister, preDeregister, preRegister, removeAttributeChangeNotificationListener, sendAttributeChangeNotification, sendAttributeChangeNotification, sendNotification, sendNotification, setAttribute, setManagedResource, setModelMBeanInfo, store

Methods inherited from class java.lang.Object

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

Field Detail

sMsgBuilder

protected static MessageBuilder sMsgBuilder

Message Builder

mPlatformCtx

protected PlatformContext mPlatformCtx

Context information

mCategory

protected ConfigurationCategory mCategory

mTarget

protected String mTarget

mListeners

protected List<NotificationListenerInfo> mListeners

sNotificationInfo

protected static MBeanNotificationInfo[] sNotificationInfo

sTypeMap

protected static HashMap<String,String> sTypeMap

Primitive types to their class object mapping

Constructor Detail

RuntimeConfiguration

public RuntimeConfiguration(ModelMBeanInfo mbeanInfo,
                    ConfigurationCategory category,
                    String target)
                     throws Exception

Creates a new RuntimeConfiguration MBean.

Parameters:

mbeanInfo - metadata returned by the 'real' MBean in the target instance.

mbeanName - name of this MBean registered in the DAS.

Throws:

Exception

Method Detail

getAttribute

public Object getAttribute(String attribute)
                    throws AttributeNotFoundException,
                           MBeanException,
                           ReflectionException

Obtain the value of a specific attribute of the Dynamic MBean.

Specified by:

getAttribute in interface DynamicMBean

Overrides:

getAttribute in class RequiredModelMBean

Parameters:

attribute - The name of the attribute to be retrieved

Returns:

The value of the attribute retrieved.

Throws:

AttributeNotFoundException

MBeanException - Wraps a java.lang.Exception thrown by the MBean's getter.

ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the getter.

See Also:

RequiredModelMBean.setAttribute(javax.management.Attribute)

setAttributes

public AttributeList setAttributes(AttributeList attributes)

Sets the values of several attributes of the Dynamic MBean.

Specified by:

setAttributes in interface DynamicMBean

Overrides:

setAttributes in class RequiredModelMBean

Parameters:

attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.

Returns:

The list of attributes that were set, with their new values.

See Also:

getAttributes(java.lang.String[])

getAttributes

public AttributeList getAttributes(String[] attributeNames)

Get the values of several attributes of the Dynamic MBean.

Specified by:

getAttributes in interface DynamicMBean

Overrides:

getAttributes in class RequiredModelMBean

Parameters:

attributeNames - A list of the attributes to be retrieved.

Returns:

The list of attributes retrieved.

See Also:

setAttributes(javax.management.AttributeList)

invoke

public Object invoke(String actionName,
            Object[] params,
            String[] signature)
              throws MBeanException,
                     ReflectionException

Allows an action to be invoked on the Dynamic MBean.

Specified by:

invoke in interface DynamicMBean

Overrides:

invoke in class RequiredModelMBean

Parameters:

actionName - The name of the action to be invoked.

params - An array containing the parameters to be set when the action is invoked.

signature - An array containing the signature of the action. The class objects will be loaded through the same class loader as the one used for loading the MBean on which the action is invoked.

Returns:

The object returned by the action, which represents the result of invoking the action on the MBean specified.

Throws:

MBeanException - Wraps a java.lang.Exception thrown by the MBean's invoked method.

ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the method

createMBeanInfo

public static ModelMBeanInfo createMBeanInfo(ModelMBeanAttributeInfo[] attributeInfos)
                                      throws Exception

Throws:

Exception

checkIsValidAttribute

protected void checkIsValidAttribute(Attribute attribute)
                              throws AttributeNotFoundException,
                                     InvalidAttributeValueException,
                                     MBeanException

This operations checks : (a) If an attribute with the same identification exists in the current configuration (b) If the type of the value passed matches the expected value.

Parameters:

attribute - - the attribute to be validated

Throws:

AttributeNotFoundException - if attribute with the same identification is not present in the configuration set.

InvalidAttributeValueException - if the type of the attribute is different from what is expected.

MBeanException

getMatchingAttribute

protected String getMatchingAttribute(String name)

Returns:

the type of the attribute from the MBeanAttributeInfo's for this MBean if one with the same name exists. If a match is not found a null value is returned.

getTranslator

protected static StringTranslator getTranslator()

Returns:

the management string translator

getLogger

protected static Logger getLogger()

Returns:

the management logger.

getManagementContext

protected ManagementContext getManagementContext()

Returns:

the management context

getPlatformContext

protected PlatformContext getPlatformContext()

Returns:

the platform context

getEnvironmentContext

protected static EnvironmentContext getEnvironmentContext()

Returns:

the EnvironmentContext

persist

protected void persist()
                throws Exception

Persist the factory defaults to the registry for the global configuration. This operation is invoked before any updates to the global/domain configuration, so global configuration is equivalent to the factory defaults. This operation is invoked only on the domain facade MBean and the Global Configuration MBean

Throws:

Exception

deleteOverride

protected void deleteOverride(String attrName)
                       throws Exception

This operation is called when a configuration attribute is to use the global configuration, the overriden attribute needs to be deleted from the target configiration

Parameters:

attrName - - attribute to be deleted

Throws:

Exception

getAttributeInfo

protected ModelMBeanAttributeInfo getAttributeInfo(String attribute)
                                            throws MBeanException

Parameters:

attribName - - identification of the attribute

Returns:

the ModelMBeanAttributeInfo for the specified attribute

Throws:

MBeanException

getRegistry

protected Registry getRegistry()

Get a handle to the registry

Returns:

the persisted registry instance

persistDomainConfig

protected void persistDomainConfig()
                            throws MBeanException

Persist the domain configuration if required.

Throws:

MBeanException

isPassword

protected boolean isPassword(String attrName)

Returns:

true if the attribute is a password field, false otherwise

getListeners

protected List<NotificationListenerInfo> getListeners()

Returns:

the listeners list

notifyListenersOfAttributeChange

protected void notifyListenersOfAttributeChange(Attribute attribute)
                                         throws Exception

Send the notification to all interested listeners

Parameters:

attribute - the attribute being updated.

Throws:

Exception

addNotificationListener

public void addNotificationListener(NotificationListener listener,
                           NotificationFilter filter,
                           Object handback)
                             throws IllegalArgumentException

Adds a listener to this MBean.

Specified by:

addNotificationListener in interface NotificationBroadcaster

Overrides:

addNotificationListener in class RequiredModelMBean

Parameters:

listener - The listener object which will handle the notifications emitted by the broadcaster.

filter - The filter object. If filter is null, no filtering will be performed before handling notifications.

handback - An opaque object to be sent back to the listener when a notification is emitted. This object cannot be used by the Notification broadcaster object. It should be resent unchanged with the notification to the listener.

Throws:

IllegalArgumentException - - Listener parameter is null.

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException

Specified by:

removeNotificationListener in interface NotificationBroadcaster

Overrides:

removeNotificationListener in class RequiredModelMBean

Throws:

ListenerNotFoundException

removeNotificationListener

public void removeNotificationListener(NotificationListener listener,
                              NotificationFilter filter,
                              Object handback)
                                throws ListenerNotFoundException

Remove a specific listener from the set. One that matches the filter and handback

Specified by:

removeNotificationListener in interface NotificationEmitter

Overrides:

removeNotificationListener in class RequiredModelMBean

Throws:

ListenerNotFoundException

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Specified by:

getNotificationInfo in interface NotificationBroadcaster

Overrides:

getNotificationInfo in class RequiredModelMBean