com.sun.jbi.management.system

Class ModelSystemService

java.lang.Object

com.sun.jbi.management.system.ModelSystemService

All Implemented Interfaces:

LifeCycleMBean, NotificationBroadcaster, NotificationEmitter

Direct Known Subclasses:

AdminService, ConfigurationService, DeploymentService, InstallationService, LoggingService

public abstract class ModelSystemService
extends Object
implements LifeCycleMBean, NotificationEmitter

The ModelSystemService implements the management controls for a standard JBI Framework schemaorg_apache_xmlbeans.system service.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectName	mAdminServiceMBeanName JMX object names for all JBI schemaorg_apache_xmlbeans.system "service" mbeans:
protected ObjectName	mConfigServiceMBeanName
protected ObjectName	mDeployServiceMBeanName
protected String	mDisplayName User-friendly display name to be used by ModelSystemService methods:
protected EnvironmentContext	mEnv
protected MBeanSet	mInitialMBeans
protected ObjectName	mInstallServiceMBeanName
protected JbiNameInfo	mJbiNameInfo handle to jbi schemaorg_apache_xmlbeans.system or installed component identification:
protected ObjectName	mLifeCycleMBeanName JMX object names for standard mbeans:
protected Logger	mLogger Logger to be used by ModelSystemService methods:
protected LoggerMBean	mLoggerImpl The default logger implementation, all logger tasks are delegated to this MBean
protected ObjectName	mLoggerMBeanName
protected ObjectName	mLoggingServiceMBeanName
protected MBeanNames	mMBeanNames handle to our MBean Namer:
protected MBeanServer	mMBeanServer handle to our MBean Server:
protected ObjectName	mMessageServiceMBeanName
protected String	mModelName
protected MBeanSet	mStartMBeans
protected ObjectName	mStatisticsMBeanName
protected StringTranslator	mTranslator Handle to StringTranslator for message translation:

Fields inherited from interface javax.jbi.management.LifeCycleMBean

SHUTDOWN, STARTED, STOPPED, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ModelSystemService()

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	bootstrap() perform one-time startup tasks for this model
protected ComponentQuery	getComponentQuery() Get a reference to ComponentQuery.
String	getCurrentState() Get the current state of this managed compononent.
NotificationBroadcasterSupport	getNotificationBroadcaster() Getter for local NotificationBroadcaster.
MBeanNotificationInfo[]	getNotificationInfo() Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
protected Registry	getRegistry() Get a reference to the JBI registry.
protected void	initModelSystemService(EnvironmentContext anEnv, JbiNameInfo aJbiName) allocate a logger, and then initialize the ModelSystemService.
protected void	initModelSystemService(EnvironmentContext anEnv, Logger aLogger, JbiNameInfo aJbiName) Initialize the ModelSystemService.
void	removeNotificationListener(NotificationListener listener) Removes a listener from this MBean.
void	removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) Removes a listener from this MBean.
void	shutDown() Shut down the item.
void	start() Start the item.
void	stop() Stop the item.

Methods inherited from class java.lang.Object

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

Field Detail

mAdminServiceMBeanName

protected ObjectName mAdminServiceMBeanName

JMX object names for all JBI schemaorg_apache_xmlbeans.system "service" mbeans:

mConfigServiceMBeanName

protected ObjectName mConfigServiceMBeanName

mInstallServiceMBeanName

protected ObjectName mInstallServiceMBeanName

mLoggingServiceMBeanName

protected ObjectName mLoggingServiceMBeanName

mDeployServiceMBeanName

protected ObjectName mDeployServiceMBeanName

mMessageServiceMBeanName

protected ObjectName mMessageServiceMBeanName

mEnv

protected EnvironmentContext mEnv

mInitialMBeans

protected MBeanSet mInitialMBeans

mStartMBeans

protected MBeanSet mStartMBeans

mLogger

protected Logger mLogger

Logger to be used by ModelSystemService methods:

mMBeanServer

protected MBeanServer mMBeanServer

handle to our MBean Server:

mMBeanNames

protected MBeanNames mMBeanNames

handle to our MBean Namer:

mJbiNameInfo

protected JbiNameInfo mJbiNameInfo

handle to jbi schemaorg_apache_xmlbeans.system or installed component identification:

mDisplayName

protected String mDisplayName

User-friendly display name to be used by ModelSystemService methods:

mLoggerImpl

protected LoggerMBean mLoggerImpl

The default logger implementation, all logger tasks are delegated to this MBean

mLifeCycleMBeanName

protected ObjectName mLifeCycleMBeanName

JMX object names for standard mbeans:

mLoggerMBeanName

protected ObjectName mLoggerMBeanName

mStatisticsMBeanName

protected ObjectName mStatisticsMBeanName

mModelName

protected final String mModelName

See Also:

Constant Field Values

mTranslator

protected StringTranslator mTranslator

Handle to StringTranslator for message translation:

Constructor Detail

ModelSystemService

public ModelSystemService()

Method Detail

initModelSystemService

protected void initModelSystemService(EnvironmentContext anEnv,
                          JbiNameInfo aJbiName)

allocate a logger, and then initialize the ModelSystemService.

initModelSystemService

protected void initModelSystemService(EnvironmentContext anEnv,
                          Logger aLogger,
                          JbiNameInfo aJbiName)

Initialize the ModelSystemService. This does not register any mbeans.

bootstrap

protected void bootstrap()

perform one-time startup tasks for this model

start

public void start()
           throws JBIException

Start the item.

Specified by:

start in interface LifeCycleMBean

Throws:

JBIException - if the item fails to start.

stop

public void stop()
          throws JBIException

Stop the item. This suspends current messaging activities.

Specified by:

stop in interface LifeCycleMBean

Throws:

JBIException - if the item fails to stop.

shutDown

public void shutDown()
              throws JBIException

Shut down the item. This releases resources and returns the item to an uninitialized state.

Specified by:

shutDown in interface LifeCycleMBean

Throws:

JBIException - if the item fails to shut down.

getCurrentState

public String getCurrentState()

Get the current state of this managed compononent.

Specified by:

getCurrentState in interface LifeCycleMBean

Returns:

the current state of this managed component (must be one of the string constants defined by this interface)

getRegistry

protected Registry getRegistry()

Get a reference to the JBI registry.

getComponentQuery

protected ComponentQuery getComponentQuery()

Get a reference to ComponentQuery.

addNotificationListener

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

Adds a listener to this MBean.

Specified by:

addNotificationListener in interface NotificationBroadcaster

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.

See Also:

removeNotificationListener(javax.management.NotificationListener)

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException

Removes a listener from this MBean. If the listener has been registered with different handback objects or notification filters, all entries corresponding to the listener will be removed.

Specified by:

removeNotificationListener in interface NotificationBroadcaster

Parameters:

listener - A listener that was previously added to this MBean.

Throws:

ListenerNotFoundException - The listener is not registered with the MBean.

See Also:

addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.

It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning.

Specified by:

getNotificationInfo in interface NotificationBroadcaster

Returns:

the array of possible notifications.

removeNotificationListener

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

Removes a listener from this MBean. The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.

The filter and handback parameters may be null if and only if they are null in a listener to be removed.

Specified by:

removeNotificationListener in interface NotificationEmitter

Parameters:

listener - A listener that was previously added to this MBean.

filter - The filter that was specified when the listener was added.

handback - The handback that was specified when the listener was added.

Throws:

ListenerNotFoundException - The listener is not registered with the MBean, or it is not registered with the given filter and handback.

getNotificationBroadcaster

public NotificationBroadcasterSupport getNotificationBroadcaster()

Getter for local NotificationBroadcaster.

Returns:

NotificationBroadcaster