com.sun.jbi.management.facade

Class InstallerConfiguration

java.lang.Object

com.sun.jbi.management.facade.InstallerConfiguration

All Implemented Interfaces:

DynamicMBean

public class InstallerConfiguration
extends Object
implements DynamicMBean

InstallerConfiguration represents a domain facade for a component's installer configuration MBean. The facade MBean is responsible for storing attributes set on the configuration MBean, which are later used by the Installer object to (a) configure the component installer in a stand-alone or clustered instance and (b) serialize configuration properties for use by offline administration/synchronization code.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
InstallerConfiguration(MBeanInfo mbeanInfo, ObjectName mbeanName) Creates a new InstallerConfiguration MBean.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String attribute) Obtain the value of a specific attribute of the Dynamic MBean.
int	getAttributeCount() Returns the total number of attributes that have been set on the configuration MBean.
AttributeList	getAttributeList() Return a list of all attributes that have been set on the config MBean.
AttributeList	getAttributes(String[] attributes) Get the values of several attributes of the Dynamic MBean.
MBeanInfo	getMBeanInfo() Provides the exposed attributes and actions of the Dynamic MBean using an MBeanInfo object.
ObjectName	getObjectName() Returns the ObjectName of the facade InstallerConfiguration MBean registered in the DAS.
Object	invoke(String actionName, Object[] params, String[] signature) Allows an action to be invoked on the Dynamic MBean.
boolean	isReadOnly() Indicates whether the configuration MBean is in read-only mode.
void	setAttribute(Attribute attribute) Set the value of a specific attribute of the Dynamic MBean.
AttributeList	setAttributes(AttributeList attributes) Sets the values of several attributes of the Dynamic MBean.
void	setReadOnly() Marks the configuration MBean as read only.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstallerConfiguration

public InstallerConfiguration(MBeanInfo mbeanInfo,
                      ObjectName mbeanName)

Creates a new InstallerConfiguration MBean.

Parameters:

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

mbeanName - name of this MBean registered in the DAS.

Method Detail

getObjectName

public ObjectName getObjectName()

Returns the ObjectName of the facade InstallerConfiguration MBean registered in the DAS.

Returns:

ObjectName of this MBean on the DAS

getAttributeList

public AttributeList getAttributeList()

Return a list of all attributes that have been set on the config MBean.

Returns:

complete list of attributes

getAttributeCount

public int getAttributeCount()

Returns the total number of attributes that have been set on the configuration MBean.

isReadOnly

public boolean isReadOnly()

Indicates whether the configuration MBean is in read-only mode.

setReadOnly

public void setReadOnly()

Marks the configuration MBean as read only.

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

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:

setAttribute(javax.management.Attribute)

setAttribute

public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException

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

Specified by:

setAttribute in interface DynamicMBean

Parameters:

attribute - The identification of the attribute to be set and the value it is to be set to.

Throws:

AttributeNotFoundException

InvalidAttributeValueException

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

ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the MBean's setter.

See Also:

getAttribute(java.lang.String)

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

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

setAttributes

public AttributeList setAttributes(AttributeList attributes)

Sets the values of several attributes of the Dynamic MBean.

Specified by:

setAttributes in interface DynamicMBean

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[])

getMBeanInfo

public MBeanInfo getMBeanInfo()

Provides the exposed attributes and actions of the Dynamic MBean using an MBeanInfo object.

Specified by:

getMBeanInfo in interface DynamicMBean

Returns:

An instance of MBeanInfo allowing all attributes and actions exposed by this Dynamic MBean to be retrieved.

getAttributes

public AttributeList getAttributes(String[] attributes)

Get the values of several attributes of the Dynamic MBean.

Specified by:

getAttributes in interface DynamicMBean

Parameters:

attributes - A list of the attributes to be retrieved.

Returns:

The list of attributes retrieved.

See Also:

setAttributes(javax.management.AttributeList)