com.sun.jbi.management.system

Class AdminService

java.lang.Object

com.sun.jbi.management.system.ModelSystemService

com.sun.jbi.management.system.AdminService

All Implemented Interfaces:

EventListener, AdminServiceMBean, LifeCycleMBean, NotificationBroadcaster, NotificationEmitter, NotificationListener

public class AdminService
extends ModelSystemService
implements AdminServiceMBean, NotificationListener

AdminServiceMBean defines the Sun Extentions to AdminServiceMBean. The AdminService is responsible for bootstrapping the JBI Framework management layer for all other schemaorg_apache_xmlbeans.system services, starting and stoping the schemaorg_apache_xmlbeans.system, and providing information that remote clients can use to access other JBI Framework schemaorg_apache_xmlbeans.system services and installed components.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from class com.sun.jbi.management.system.ModelSystemService

mAdminServiceMBeanName, mConfigServiceMBeanName, mDeployServiceMBeanName, mDisplayName, mEnv, mInitialMBeans, mInstallServiceMBeanName, mLifeCycleMBeanName, mLogger, mLoggerImpl, mLoggerMBeanName, mLoggingServiceMBeanName, mMBeanNames, mMBeanServer, mMessageServiceMBeanName, mModelName, mStartMBeans, mStatisticsMBeanName, mTranslator

Fields inherited from interface javax.jbi.management.LifeCycleMBean

SHUTDOWN, STARTED, STOPPED, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
AdminService(ManagementContext anEnv) Constructs a AdminService.

Method Summary

Methods

Modifier and Type	Method and Description
ObjectName[]	getBindingComponents() Get a list of ComponentLifeCycleMBeans for all binding components currently installed in the JBI schemaorg_apache_xmlbeans.system.
String	getBuildNumber()
ObjectName	getComponentByName(String name) Find the ComponentLifeCycleMBean of a JBI Installable Component by its unique name.
ObjectName[]	getComponentMBeans(String componentName) Lookup all active MBeans associated with componentName.
String	getCopyright()
ObjectName[]	getDeployerMBeanNames(String componentName) Get the DeployerMBean for the componentName associated with artifactUrl.
ObjectName[]	getEngineComponents() Get a list of ComponentLifeCycleMBeans for all service engines currently installed in the JBI schemaorg_apache_xmlbeans.system.
String	getFullProductName()
String	getJbiInstanceName() Return the name of this JBI Framework runtime
String	getMajorVersion()
String	getMinorVersion()
String	getRemoteFileUploadURL() Return URL that can be used to upload and deploy a remote Service Assembly.
String	getShortProductName()
String	getSystemInfo() Return current version and other info about this JBI implementation.
ObjectName	getSystemService(String serviceName) Lookup a schemaorg_apache_xmlbeans.system service LifeCycleMBean by name.
ObjectName[]	getSystemServices() Looks up all JBI schemaorg_apache_xmlbeans.system services LifeCycleMBean's currently installed.
void	handleNotification(Notification aNotification, Object anObject) Handle timer notifications.
protected void	initModelSystemService(EnvironmentContext anEnv) local model init - called by constructor - create custom mbeans.
boolean	isBinding(String componentName) Check if a given JBI component is a Binding Component.
boolean	isEngine(String componentName) Check if a given JBI component is a Service Engine.
ObjectName[]	queryHelper(String qStr) Execute a query and return array of mbean object names with result.
ObjectName[]	queryHelper(String qStr, MBeanServerConnection rmbs) Execute a query and return array of mbean object names with result.
boolean	shutdownManagementServices() Shutdown all Management service agents and deregister all MBeans..
void	start() override model start() method.
boolean	startManagementServices() Start all Management service agents
void	stop() override model stop() method.
boolean	stopManagementServices() Stop all Management service agents and deregister Service Mbeans.

Methods inherited from class com.sun.jbi.management.system.ModelSystemService

addNotificationListener, bootstrap, getComponentQuery, getCurrentState, getNotificationBroadcaster, getNotificationInfo, getRegistry, initModelSystemService, initModelSystemService, removeNotificationListener, removeNotificationListener, shutDown

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminService

public AdminService(ManagementContext anEnv)

Constructs a AdminService.

Parameters:

anEnv - is the ManagementContext.

Method Detail

initModelSystemService

protected void initModelSystemService(EnvironmentContext anEnv)

local model init - called by constructor - create custom mbeans.

start

public void start()
           throws JBIException

override model start() method.

Specified by:

start in interface LifeCycleMBean

Overrides:

start in class ModelSystemService

Throws:

JBIException - never

stop

public void stop()
          throws JBIException

override model stop() method.

Specified by:

stop in interface LifeCycleMBean

Overrides:

stop in class ModelSystemService

Throws:

JBIException - never

handleNotification

public void handleNotification(Notification aNotification,
                      Object anObject)

Handle timer notifications.

Specified by:

handleNotification in interface NotificationListener

Parameters:

aNotification - is the received (timer) notification

anObject - is the notification object (ignored)

getSystemService

public ObjectName getSystemService(String serviceName)

Lookup a schemaorg_apache_xmlbeans.system service LifeCycleMBean by name. System services are implementation-defined services which can administered through JMX, and have a life cycle.

System services are not related to service engines.

Specified by:

getSystemService in interface AdminServiceMBean

Parameters:

serviceName - name of the schemaorg_apache_xmlbeans.system service; must be non-null and non- empty; values are implementation-dependent

Returns:

JMX object name of the schemaorg_apache_xmlbeans.system service's LifeCycleMBean, or null if there is no schemaorg_apache_xmlbeans.system service with the given name.

getSystemServices

public ObjectName[] getSystemServices()

Looks up all JBI schemaorg_apache_xmlbeans.system services LifeCycleMBean's currently installed. System services are implementation-defined services which can administered through JMX. System services are not related to service engines.

Specified by:

getSystemServices in interface AdminServiceMBean

Returns:

array of LifecycleMBean JMX object names of schemaorg_apache_xmlbeans.system services currently installed in the JBI implementation; must be non-null; may be empty

getComponentByName

public ObjectName getComponentByName(String name)

Find the ComponentLifeCycleMBean of a JBI Installable Component by its unique name.

Specified by:

getComponentByName in interface AdminServiceMBean

Parameters:

name - the name of the engine or binding component; must be non- null and non-empty

Returns:

the JMX object name of the component's life cycle MBean, or null if there is no such component with the given name

getBindingComponents

public ObjectName[] getBindingComponents()

Get a list of ComponentLifeCycleMBeans for all binding components currently installed in the JBI schemaorg_apache_xmlbeans.system.

Specified by:

getBindingComponents in interface AdminServiceMBean

Returns:

array of JMX object names of component life cycle MBeans for all installed binding components; must be non-null; may be empty

getEngineComponents

public ObjectName[] getEngineComponents()

Get a list of ComponentLifeCycleMBeans for all service engines currently installed in the JBI schemaorg_apache_xmlbeans.system.

Specified by:

getEngineComponents in interface AdminServiceMBean

Returns:

array of JMX object names of component life cycle MBeans for all installed service engines; must be non-null; may be empty

isBinding

public boolean isBinding(String componentName)

Check if a given JBI component is a Binding Component.

Specified by:

isBinding in interface AdminServiceMBean

Parameters:

componentName - the unique name of the component; must be non-null and non-empty

Returns:

true if the component is a binding component; false if the component is a service engine or if there is no component with the given componentName installed in the JBI schemaorg_apache_xmlbeans.system

isEngine

public boolean isEngine(String componentName)

Check if a given JBI component is a Service Engine.

Specified by:

isEngine in interface AdminServiceMBean

Parameters:

componentName - the unique name of the component; must be non-null and non-empty

Returns:

true if the component is a service engine; false if the component is a binding component, or if there is no component with the given componentName installed in the JBI schemaorg_apache_xmlbeans.system

getSystemInfo

public String getSystemInfo()

Return current version and other info about this JBI implementation. The contents of the returned string are implementation dependent.

Specified by:

getSystemInfo in interface AdminServiceMBean

Returns:

information string about the JBI implementation, including version information; must be non-null and non-empty

getDeployerMBeanNames

public ObjectName[] getDeployerMBeanNames(String componentName)

Get the DeployerMBean for the componentName associated with artifactUrl.

Returns:

JMX object name of Component's DeployerMBean or null

getJbiInstanceName

public String getJbiInstanceName()

Return the name of this JBI Framework runtime

Returns:

the instance name of this runtime.

getComponentMBeans

public ObjectName[] getComponentMBeans(String componentName)

Lookup all active MBeans associated with componentName.

Parameters:

componentName - - is the name of the BC or SE.

Returns:

the array of JMX object names for the component.

getRemoteFileUploadURL

public String getRemoteFileUploadURL()
                              throws Exception

Return URL that can be used to upload and deploy a remote Service Assembly.

Returns:

URL String

Throws:

Exception

getFullProductName

public String getFullProductName()

Returns:

the full product name.

getShortProductName

public String getShortProductName()

Returns:

the short product name.

getMajorVersion

public String getMajorVersion()

Returns:

the major version number.

getMinorVersion

public String getMinorVersion()

Returns:

the minor version number.

getBuildNumber

public String getBuildNumber()

Returns:

the build number for this version.

getCopyright

public String getCopyright()

Returns:

the Copyright for this version.

startManagementServices

public boolean startManagementServices()

Start all Management service agents

Returns:

true if successful.

stopManagementServices

public boolean stopManagementServices()

Stop all Management service agents and deregister Service Mbeans.

Returns:

true if successful.

shutdownManagementServices

public boolean shutdownManagementServices()

Shutdown all Management service agents and deregister all MBeans..

Returns:

true if successful.

queryHelper

public ObjectName[] queryHelper(String qStr)

Execute a query and return array of mbean object names with result. This form of queryHelper always executes in the local mbean server.

Parameters:

qStr - is a JMX formatted query string

Returns:

array of JMX object names, possibly of zero length.

queryHelper

public ObjectName[] queryHelper(String qStr,
                       MBeanServerConnection rmbs)

Execute a query and return array of mbean object names with result.

Parameters:

qStr - is a JMX formatted query string

Returns:

array of JMX object names, possibly of zero length.