com.sun.jbi.management.facade

Class AdminService

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.AdminService

All Implemented Interfaces:

AdminServiceMBean

public class AdminService
extends Facade
implements AdminServiceMBean

This interface defines a set of administrative methods allowing a JMX-based administrative tool to perform a variety of administrative tasks.

• Find component lifecycle MBean names for:
  • Individual components, by name
  • All binding components
  • All service engines
• Find lifecyle MBeans names for implementation-defined services:
  • Individual implementation services, by name
  • All implementation services
• Query whether an individual component is a binding or engine
• Query implementation information (version etc.)

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from class com.sun.jbi.management.facade.Facade

CONFIG_SCHEMA_PATH, DOMAIN, MASKED_FIELD_VALUE, mComponentConfigSchema, mEnvCtx, mLog, mMBeanNames, mMBeanSvr, mMgtCtx, mMsgBuilder, mPlatform, mTarget, mTranslator, PASSWORD, SERVER, sTypeMap, WORKSPACE_ROOT

Constructor Summary

Constructors

Constructor and Description
AdminService(EnvironmentContext ctx, String target)

Method Summary

Methods

Modifier and Type	Method and Description
ObjectName[]	getBindingComponents() Get a list of Facade ComponentLifeCycleMBean's for all binding components currently installed on the target
ObjectName	getComponentByName(String componentName) Find the ComponentLifeCycleMBean of a JBI Installable Component by its unique name.
ObjectName	getComponentExtensionFacadeMBean(String componentName) Query the component extension facade MBeanName.
ObjectName[]	getEngineComponents() Get a list of ComponentLifeCycleMBeans for all service engines currently installed in the JBI schemaorg_apache_xmlbeans.system.
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.
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.

Methods inherited from class com.sun.jbi.management.facade.Facade

archiveEqualityCheck, areAllInstancesUp, componentInstallationCheck, convertToString, fromFileURL, getAllTargets, getComponentConfigurationData, getComponentConfigurationNS, getComponentConfigurationSchema, getComponentLifeCycleMBeanName, getComponentQuery, getComponentQuery, getComponentState, getComponentStateOnInstance, getComponentType, getFacadeInstallerMBeanName, getFacadeInstallerMBeanName, getGenericQuery, getMBeanServerConnection, getRegistry, getRemoteAdminServiceObjectName, getRemoteAttribute, getRemoteAttributes, getServiceAssemblyQuery, getUpdater, handleClusteredInstanceFailures, initPrimitiveTypeMap, instanceRunningCheck, invokeLocalOperation, invokeRemoteOperation, invokeRemoteVoidOperation, isComponentInstalled, isInstanceRunning, isMBeanRegisteredOnInstance, isSharedLibraryInstalled, isTargetUp, mbeanRegistrationCheck, setRemoteAttribute, setRemoteAttributes, sharedLibraryInstallationCheck, throwNotSupportedManagementException, toFileURL, unregisterComponentConfigurationMBean, unregisterComponentConfigurationMBean, unregisterComponentExtensionMBean, unregisterComponentExtensionMBean, unregisterComponentLifeCycleMBean, unregisterComponentLifeCycleMBean, uploadFile, validateArchive

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminService

public AdminService(EnvironmentContext ctx,
            String target)
             throws ManagementException

Parameters:

ctx - - EnvironmentContext

asInfo - - AppServer Information

target - - administration target

Throws:

ManagementException

Method Detail

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 componentName)

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

Specified by:

getComponentByName in interface AdminServiceMBean

Parameters:

componentName - 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 Facade ComponentLifeCycleMBean's for all binding components currently installed on the target

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

getComponentExtensionFacadeMBean

public ObjectName getComponentExtensionFacadeMBean(String componentName)

Query the component extension facade MBeanName.

Parameters:

componentName - - component identification

Returns:

JMX object name of the components Extension facade MBean, or null if there is no such MBean registered.