com.sun.esb.management.impl.runtime

Class RuntimeManagementServiceMBeanImpl

java.lang.Object

com.sun.esb.management.base.services.AbstractServiceMBeansImpl

com.sun.esb.management.base.services.AbstractListStateServiceMBeansImpl

com.sun.esb.management.impl.runtime.RuntimeManagementServiceMBeanImpl

All Implemented Interfaces:

RuntimeManagementService, Serializable

public class RuntimeManagementServiceMBeanImpl
extends AbstractListStateServiceMBeansImpl
implements RuntimeManagementService, Serializable

Defines operations for common runtime management services. Common runtime management operations include listing component containers available in the runtime, composite applications deployed, controlling lifecycle across the runtime and composite applications, getting state of each container and composite application, etc.

Author:

graj

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sun.esb.management.base.services.AbstractListStateServiceMBeansImpl

ANY_FRAMEWORK_COMPONENT_STATE, COMPONENT_VERSION_NS, COMPONENT_VERSION_NS_NEW, COMPONENT_VERSION_XPATH_QUERY, FRAMEWORK_SA_ANY_STATE, FRAMEWORK_SA_SHUTDOWN_STATE, FRAMEWORK_SA_STARTED_STATE, FRAMEWORK_SA_STOPPED_STATE, FRAMEWORK_SU_SHUTDOWN_STATE, FRAMEWORK_SU_STARTED_STATE, FRAMEWORK_SU_STOPPED_STATE, FRAMEWORK_SU_UNKNOWN_STATE, SHARED_LIBRARY_VERSION_XPATH_QUERY

Fields inherited from class com.sun.esb.management.base.services.AbstractServiceMBeansImpl

COLON, COMMA, COMPONENT_CONFIG_INSTANCE_ERROR_KEY, componentConfigurationHelper, CUSTOM_ADMINISTRATION_NAME_KEY, CUSTOM_CONFIGURATION_NAME_KEY, CUSTOM_LOGGER_NAME_KEY, CUSTOM_MANAGEMENT_ACTIONS_NAME_KEY, CUSTOM_STATISTICS_NAME_KEY, DOMAIN_TARGET_KEY, EBIJMXDOMAIN, environmentContext, EQUAL, IDENTIFICATION_NAME_KEY, JMX_EBI_DOMAIN, PASSWORD_MASK_CHARACTER, RUNNING_STATE, SERVER_TARGET_KEY, SERVICE_TYPE_KEY, STARTED_STATE

Constructor Summary

Constructors

Constructor and Description
RuntimeManagementServiceMBeanImpl(EnvironmentContext anEnvContext) Constructor - Constructs a new instance of RuntimeManagementServiceMBeanImpl

Method Summary

Methods

Modifier and Type	Method and Description
String	listBindingComponents(String targetName) return component info xml text that has only binding component infos.
Map<String,String>	listBindingComponents(String[] targetNames) return component info xml text that has only binding component infos.
String	listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String targetName) return component info xml text that has only binding component infos which satisfies the options passed to the method.
Map<String,String>	listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) return component info xml text that has only binding component infos which satisfies the options passed to the method.
String	listServiceAssemblies(String targetName) returns a list of Service Assembly Infos in a xml format.
Map<String,String>	listServiceAssemblies(String[] targetNames) returns a list of Service Assembly Infos in a xml format.
String	listServiceAssemblies(String componentName, String targetName) returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.
Map<String,String>	listServiceAssemblies(String componentName, String[] targetNames) returns the list of service assembly infos in a xml format that have the service unit deployed on the specified component.
String	listServiceAssemblies(String state, String componentName, String targetName) returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.
Map<String,String>	listServiceAssemblies(String state, String componentName, String[] targetNames) returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.
String	listServiceEngines(String targetName) return component info xml text that has only service engine infos.
Map<String,String>	listServiceEngines(String[] targetNames) return component info xml text that has only service engine infos.
String	listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String targetName) return component info xml text that has only service engine infos which satisfies the options passed to the method.
Map<String,String>	listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) return component info xml text that has only service engine infos which satisfies the options passed to the method.
String	listSharedLibraries(String targetName) return component info xml text that has only shared library infos.
Map<String,String>	listSharedLibraries(String[] targetNames) return component info xml text that has only shared library infos.
String	listSharedLibraries(String componentName, String targetName) returns the list of Shared Library infos in the in a xml format
Map<String,String>	listSharedLibraries(String componentName, String[] targetNames) returns the list of Shared Library infos in the in a xml format
String	listSharedLibraryDependents(String sharedLibraryName, String targetName) returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library
Map<String,String>	listSharedLibraryDependents(String sharedLibraryName, String[] targetNames) returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library
String	showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) return component info xml text for the specified binding component if exists.
Map<String,String>	showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) return component info xml text for the specified binding component if exists.
protected String	showComponent(String name, ComponentType type, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) return component info xml text for the specified service engine if exists.
String	showServiceAssembly(String name, String state, String componentName, String targetName) return service assembly info xml text for the specified service assembly if exists.
Map<String,String>	showServiceAssembly(String name, String state, String componentName, String[] targetNames) return service assembly info xml text for the specified service assembly if exists.
String	showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) return component info xml text for the specified service engine if exists.
Map<String,String>	showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) return component info xml text for the specified service engine if exists.
String	showSharedLibrary(String name, String componentName, String targetName) return component info xml text for the specified shared library if exists.
Map<String,String>	showSharedLibrary(String name, String componentName, String[] targetNames) return component info xml text for the specified shared library if exists.
String	shutdownComponent(String componentName, boolean force, String targetName) shuts down component ( service engine, binding component)
Map<String,String>	shutdownComponent(String componentName, boolean force, String[] targetNames) shuts down component (service engine, binding component)
String	shutdownComponent(String componentName, String targetName) shuts down component ( service engine, binding component)
Map<String,String>	shutdownComponent(String componentName, String[] targetNames) shuts down component (service engine, binding component)
String	shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String targetName) shuts down service assembly
Map<String,String>	shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String[] targetNames) shuts down service assembly
String	shutdownServiceAssembly(String serviceAssemblyName, String targetName) shuts down service assembly
Map<String,String>	shutdownServiceAssembly(String serviceAssemblyName, String[] targetNames) shuts down service assembly
protected String	shutdownServiceAssemblyInternal(String serviceAssemblyName, boolean force, String targetName) shuts down service assembly
String	startComponent(String componentName, String targetName) starts component ( service engine, binding component)
Map<String,String>	startComponent(String componentName, String[] targetNames) starts component ( service engine, binding component)
String	startServiceAssembly(String serviceAssemblyName, String targetName) starts service assembly
Map<String,String>	startServiceAssembly(String serviceAssemblyName, String[] targetNames) starts service assembly
String	stopComponent(String componentName, String targetName) stops component ( service engine, binding component)
Map<String,String>	stopComponent(String componentName, String[] targetNames) stops component ( service engine, binding component)
String	stopServiceAssembly(String serviceAssemblyName, String targetName) stops service assembly
Map<String,String>	stopServiceAssembly(String serviceAssemblyName, String[] targetNames) stops service assembly

Methods inherited from class com.sun.esb.management.base.services.AbstractListStateServiceMBeansImpl

componentInstalledOnTargetCheck, componentStartedOnTargetCheck, getComponentLifeCycleMBeanObjectName, getComponentNamesDependentOnServiceAssembly, getComponentNamesDependentOnServiceAssembly, getComponentNamesDependentOnSharedLibrary, getComponentNamesDependentOnSharedLibrary, getComponentNamesDependentOnSharedLibraryAndServiceAssembly, getComponentNamesWithStatus, getComponentState, getConfigurationDescriptors, getFrameworkComponentInfoList, getFrameworkComponentInfoListForEnginesAndBindings, getFrameworkComponentInfoListForSharedLibraries, getFrameworkComponentInfoListForSharedLibraryNames, getFrameworkComponentQuery, getServiceAssemblyInfoList, getSystemLoggerMBeans, getUiComponentInfoList, isExistingComponent, isExistingSharedLibrary, listComponents, targetUpCheck, toFrameworkComponentInfoState, toFrameworkComponentInfoType, toFrameworkServiceAssemblyState, toUiComponentInfo, toUiComponentInfoList, toUiComponentInfoState, toUiComponentInfoType, toUiServiceAssemblyState, toUiServiceUnitState, updateEachServiceUnitInfoStateInServiceAssemblyInfo, updateServiceAssemblyInfoState, updateServiceUnitInfoState, validateUiJBIComponentInfoState, validateUiServiceAssemblyInfoState

Methods inherited from class com.sun.esb.management.base.services.AbstractServiceMBeansImpl

checkForValidTarget, checkForValidTarget, checkTargetType, constructMBeanAttributes, constructMBeanAttributes, constructMBeanAttributes, createManagementException, createManagementMessage, domainTargetCheck, findLiveExtensionMBeanObjectNames, getAdminServiceMBeanObjectName, getAdminServiceMBeanObjectName, getAttributeValue, getAttributeValue, getAttributeValue, getAttributeValue, getComponentExtensionMBeanObjectNames, getComponentExtensionMBeanObjectNames, getDeploymentServiceMBeanObjectName, getEbiJmxDomain, getEbiStatusMBeanObjectName, getEnvironmentContext, getExtensionMBeanObjectName, getI18NBundle, getI18NBundle, getInstallationServiceMBeanObjectName, getMBeanAttribute, getMBeanAttributeValues, getMBeanAttributeValuesAsMap, getMBeanServerConnection, getPlatformContext, getPlatformContextAdminServerName, getPlatformContextClusteredServerNames, getPlatformContextClusterNames, getPlatformContextInstallRoot, getPlatformContextInstanceName, getPlatformContextInstanceRoot, getPlatformContextJmxRmiPort, getPlatformContextMBeanServer, getPlatformContextServersInCluster, getPlatformContextStandaloneServerNames, getPlatformContextTargetName, getPlatformContextTargetName, getStackTrace, invokeMBeanOperation, invokeMBeanOperation, invokeMBeanOperation, invokeMBeanOperation, invokeMBeanOperation, isMBeanRegistered, isPlatformContextAdminServer, isPlatformContextCluster, isPlatformContextClusteredServer, isPlatformContextInstanceClustered, isPlatformContextInstanceUp, isPlatformContextStandaloneServer, isPlatformContextValidTarget, isTargetUp, isValidTarget, isValidTarget, listTargetNames, log, logDebug, logDebug, logError, logWarning, platformContextSupportsMultipleServers, setAttributeValue, setAttributeValue, setAttributeValue, setLevel, setMBeanAttribute, setMBeanAttributes, setMBeanAttributes, setMBeanConfigAttributes, setMBeanConfigAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeManagementServiceMBeanImpl

public RuntimeManagementServiceMBeanImpl(EnvironmentContext anEnvContext)

Constructor - Constructs a new instance of RuntimeManagementServiceMBeanImpl

Parameters:

anEnvContext -

Method Detail

listBindingComponents

public String listBindingComponents(String targetName)
                             throws ManagementRemoteException

return component info xml text that has only binding component infos.

Specified by:

listBindingComponents in interface RuntimeManagementService

Parameters:

targetName -

Returns:

the component info xml text.

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.listBindingComponents(java.lang.String)

listBindingComponents

public String listBindingComponents(String state,
                           String sharedLibraryName,
                           String serviceAssemblyName,
                           String targetName)
                             throws ManagementRemoteException

return component info xml text that has only binding component infos which satisfies the options passed to the method.

Specified by:

listBindingComponents in interface RuntimeManagementService

Parameters:

state - return all the binding components that are in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return all the binding components that have a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return all the binding components that have the specified service assembly deployed on them. null value to ignore this option.

targetName -

Returns:

xml text contain the list of binding component infos

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.listBindingComponents(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

listServiceAssemblies

public String listServiceAssemblies(String targetName)
                             throws ManagementRemoteException

returns a list of Service Assembly Infos in a xml format.

Specified by:

listServiceAssemblies in interface RuntimeManagementService

Parameters:

targetName -

Returns:

xml text containing the Service Assembly infos

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.listServiceAssemblies(java.lang.String)

listServiceAssemblies

public String listServiceAssemblies(String componentName,
                           String targetName)
                             throws ManagementRemoteException

returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.

Specified by:

listServiceAssemblies in interface RuntimeManagementService

Parameters:

componentName - to list all the service assemblies that have some deployments on this component.

targetName -

Returns:

xml string contain the list of service assembly infos

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.listServiceAssemblies(java.lang.String, java.lang.String)

listServiceAssemblies

public String listServiceAssemblies(String state,
                           String componentName,
                           String targetName)
                             throws ManagementRemoteException

returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.

Specified by:

listServiceAssemblies in interface RuntimeManagementService

Parameters:

state - to return all the service assemblies that are in the specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state

componentName - to list all the service assemblies that have some deployments on this component.

targetName -

Returns:

xml string contain the list of service assembly infos

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.listServiceAssemblies(java.lang.String, java.lang.String, java.lang.String)

listServiceEngines

public String listServiceEngines(String targetName)
                          throws ManagementRemoteException

return component info xml text that has only service engine infos.

Specified by:

listServiceEngines in interface RuntimeManagementService

Parameters:

targetName -

Returns:

the component info xml text.

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.listServiceEngines(java.lang.String)

listServiceEngines

public String listServiceEngines(String state,
                        String sharedLibraryName,
                        String serviceAssemblyName,
                        String targetName)
                          throws ManagementRemoteException

return component info xml text that has only service engine infos which satisfies the options passed to the method.

Specified by:

listServiceEngines in interface RuntimeManagementService

Parameters:

state - return all the service engines that are in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return all the service engines that have a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return all the service engines that have the specified service assembly deployed on them. null value to ignore this option.

targetName -

Returns:

xml text contain the list of service engine component infos

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.listServiceEngines(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

listSharedLibraries

public String listSharedLibraries(String targetName)
                           throws ManagementRemoteException

return component info xml text that has only shared library infos.

Specified by:

listSharedLibraries in interface RuntimeManagementService

Parameters:

targetName -

Returns:

the component info xml text.

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.listSharedLibraries(java.lang.String)

listSharedLibraries

public String listSharedLibraries(String componentName,
                         String targetName)
                           throws ManagementRemoteException

returns the list of Shared Library infos in the in a xml format

Specified by:

listSharedLibraries in interface RuntimeManagementService

Parameters:

componentName - to return only the shared libraries that are this component dependents. null for listing all the shared libraries in the schemaorg_apache_xmlbeans.system.

targetName -

Returns:

xml string contain the list of componentinfos for shared libraries.

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.listSharedLibraries(java.lang.String, java.lang.String)

listSharedLibraryDependents

public String listSharedLibraryDependents(String sharedLibraryName,
                                 String targetName)
                                   throws ManagementRemoteException

returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library

Specified by:

listSharedLibraryDependents in interface RuntimeManagementService

Parameters:

sharedLibraryName - the shared library name

targetName -

Returns:

xml string containing the list of componentInfos

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.listSharedLibraryDependents(java.lang.String, java.lang.String)

showBindingComponent

public String showBindingComponent(String name,
                          String state,
                          String sharedLibraryName,
                          String serviceAssemblyName,
                          String targetName)
                            throws ManagementRemoteException

return component info xml text for the specified binding component if exists. If no binding component with that name exists, it returns the xml with empty list.

Specified by:

showBindingComponent in interface RuntimeManagementService

Parameters:

name - name of the binding component to lookup

state - return the binding component that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return the binding component that has a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return the binding component that has the specified service assembly deployed on it. null value to ignore this option.

targetName -

Returns:

xml text contain the binding component info that confirms to the component info list xml grammer.

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.showBindingComponent(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

showServiceAssembly

public String showServiceAssembly(String name,
                         String state,
                         String componentName,
                         String targetName)
                           throws ManagementRemoteException

return service assembly info xml text for the specified service assembly if exists. If no service assembly with that name exists, it returns the xml with empty list.

Specified by:

showServiceAssembly in interface RuntimeManagementService

Parameters:

name - name of the service assembly to lookup

state - return the service assembly that is in the specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state

componentName - return the service assembly that has service units on this component.

targetName -

Returns:

xml string contain service assembly info that confirms to the service assembly list xml grammer.

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.showServiceAssembly(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

showServiceEngine

public String showServiceEngine(String name,
                       String state,
                       String sharedLibraryName,
                       String serviceAssemblyName,
                       String targetName)
                         throws ManagementRemoteException

return component info xml text for the specified service engine if exists. If no service engine with that name exists, it returns the xml with empty list.

Specified by:

showServiceEngine in interface RuntimeManagementService

Parameters:

name - name of the service engine to lookup

state - return service engine that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return service engine that has a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return the service engine that has the specified service assembly deployed on it. null value to ignore this option.

targetName -

Returns:

xml text contain the service engine component info that confirms to the component info list xml grammer.

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.showServiceEngine(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

showSharedLibrary

public String showSharedLibrary(String name,
                       String componentName,
                       String targetName)
                         throws ManagementRemoteException

return component info xml text for the specified shared library if exists. If no shared library with that name exists, it returns the xml with empty list.

Specified by:

showSharedLibrary in interface RuntimeManagementService

Parameters:

name - name of the shared library to lookup

componentName - return the shared library that is this component dependents. null to ignore this option.

targetName -

Returns:

xml string contain shared library component info that confirms to the component info list xml grammer.

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

RuntimeManagementService.showSharedLibrary(java.lang.String, java.lang.String, java.lang.String)

shutdownComponent

public String shutdownComponent(String componentName,
                       boolean force,
                       String targetName)
                         throws ManagementRemoteException

shuts down component ( service engine, binding component)

Specified by:

shutdownComponent in interface RuntimeManagementService

Parameters:

force - true to force shutdown

componentName - name of the component

targetName -

Returns:

name of the component

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.shutdownComponent(java.lang.String, boolean, java.lang.String)

shutdownComponent

public String shutdownComponent(String componentName,
                       String targetName)
                         throws ManagementRemoteException

shuts down component ( service engine, binding component)

Specified by:

shutdownComponent in interface RuntimeManagementService

Parameters:

componentName - name of the component

targetName -

Returns:

name of the component

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.shutdownComponent(java.lang.String, java.lang.String)

shutdownServiceAssembly

public String shutdownServiceAssembly(String serviceAssemblyName,
                             boolean forceShutdown,
                             String targetName)
                               throws ManagementRemoteException

shuts down service assembly

Specified by:

shutdownServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

forceShutdown -

targetName - name of the target for this operation

Returns:

Map of targetName and result as a management message xml text strings.

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.shutdownServiceAssembly(java.lang.String, boolean, java.lang.String)

shutdownServiceAssembly

public String shutdownServiceAssembly(String serviceAssemblyName,
                             String targetName)
                               throws ManagementRemoteException

shuts down service assembly

Specified by:

shutdownServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

targetName -

Returns:

result as a management message xml text

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.shutdownServiceAssembly(java.lang.String, java.lang.String)

startComponent

public String startComponent(String componentName,
                    String targetName)
                      throws ManagementRemoteException

starts component ( service engine, binding component)

Specified by:

startComponent in interface RuntimeManagementService

Parameters:

componentName - name of the component

targetName -

Returns:

name of the component

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.startComponent(java.lang.String, java.lang.String)

startServiceAssembly

public String startServiceAssembly(String serviceAssemblyName,
                          String targetName)
                            throws ManagementRemoteException

starts service assembly

Specified by:

startServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

targetName -

Returns:

result as a management message xml text

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.startServiceAssembly(java.lang.String, java.lang.String)

stopComponent

public String stopComponent(String componentName,
                   String targetName)
                     throws ManagementRemoteException

stops component ( service engine, binding component)

Specified by:

stopComponent in interface RuntimeManagementService

Parameters:

componentName - name of the component

targetName -

Returns:

name of the component

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.stopComponent(java.lang.String, java.lang.String)

stopServiceAssembly

public String stopServiceAssembly(String serviceAssemblyName,
                         String targetName)
                           throws ManagementRemoteException

stops service assembly

Specified by:

stopServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

targetName -

Returns:

result as a management message xml text

Throws:

ManagementRemoteException - on error

See Also:

RuntimeManagementService.stopServiceAssembly(java.lang.String, java.lang.String)

listBindingComponents

public Map<String,String> listBindingComponents(String[] targetNames)
                                         throws ManagementRemoteException

return component info xml text that has only binding component infos.

Specified by:

listBindingComponents in interface RuntimeManagementService

Parameters:

targetNames -

Returns:

the component info xml text as a Map of [targetName, xmlString].

Throws:

ManagementRemoteException - on error

listBindingComponents

public Map<String,String> listBindingComponents(String state,
                                       String sharedLibraryName,
                                       String serviceAssemblyName,
                                       String[] targetNames)
                                         throws ManagementRemoteException

return component info xml text that has only binding component infos which satisfies the options passed to the method.

Specified by:

listBindingComponents in interface RuntimeManagementService

Parameters:

state - return all the binding components that are in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return all the binding components that have a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return all the binding components that have the specified service assembly deployed on them. null value to ignore this option.

targetName -

Returns:

xml text contain the list of binding component infos as map of [targetName, xmlString]

Throws:

ManagementRemoteException - if error or exception occurs.

listServiceAssemblies

public Map<String,String> listServiceAssemblies(String[] targetNames)
                                         throws ManagementRemoteException

returns a list of Service Assembly Infos in a xml format.

Specified by:

listServiceAssemblies in interface RuntimeManagementService

Parameters:

targetNames -

Returns:

xml text containing the Service Assembly infos as map of [targetName, xmlString]

Throws:

ManagementRemoteException - on error

listServiceAssemblies

public Map<String,String> listServiceAssemblies(String componentName,
                                       String[] targetNames)
                                         throws ManagementRemoteException

returns the list of service assembly infos in a xml format that have the service unit deployed on the specified component.

Specified by:

listServiceAssemblies in interface RuntimeManagementService

Parameters:

componentName - to list all the service assemblies that have some deployments on this component.

targetNames -

Returns:

xml string contain the list of service assembly infos as map of [targetName, xmlString]

Throws:

ManagementRemoteException - if error or exception occurs.

listServiceAssemblies

public Map<String,String> listServiceAssemblies(String state,
                                       String componentName,
                                       String[] targetNames)
                                         throws ManagementRemoteException

returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.

Specified by:

listServiceAssemblies in interface RuntimeManagementService

Parameters:

state - to return all the service assemblies that are in the specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state

componentName - to list all the service assemblies that have some deployments on this component.

targetNames -

Returns:

xml string contain the list of service assembly infos as map of [targetName, xmlString]

Throws:

ManagementRemoteException - if error or exception occurs.

listServiceEngines

public Map<String,String> listServiceEngines(String[] targetNames)
                                      throws ManagementRemoteException

return component info xml text that has only service engine infos.

Specified by:

listServiceEngines in interface RuntimeManagementService

Parameters:

targetName -

Returns:

the component info xml text as map of [targetName,xmlString].

Throws:

ManagementRemoteException - on error

listServiceEngines

public Map<String,String> listServiceEngines(String state,
                                    String sharedLibraryName,
                                    String serviceAssemblyName,
                                    String[] targetNames)
                                      throws ManagementRemoteException

return component info xml text that has only service engine infos which satisfies the options passed to the method.

Specified by:

listServiceEngines in interface RuntimeManagementService

Parameters:

state - return all the service engines that are in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return all the service engines that have a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return all the service engines that have the specified service assembly deployed on them. null value to ignore this option.

targetName -

Returns:

xml text contain the map of service engine component infos as [targetName, xmlString]

Throws:

ManagementRemoteException - if error or exception occurs.

listSharedLibraries

public Map<String,String> listSharedLibraries(String[] targetNames)
                                       throws ManagementRemoteException

return component info xml text that has only shared library infos.

Specified by:

listSharedLibraries in interface RuntimeManagementService

Parameters:

targetName -

Returns:

the component info xml text as a map of [targetName, xmlString].

Throws:

ManagementRemoteException - on error

listSharedLibraries

public Map<String,String> listSharedLibraries(String componentName,
                                     String[] targetNames)
                                       throws ManagementRemoteException

returns the list of Shared Library infos in the in a xml format

Specified by:

listSharedLibraries in interface RuntimeManagementService

Parameters:

componentName - to return only the shared libraries that are this component dependents. null for listing all the shared libraries in the schemaorg_apache_xmlbeans.system.

targetName -

Returns:

xml string contains the map of componentinfos for shared libraries as [targetName, xmlString].

Throws:

ManagementRemoteException - if error or exception occurs.

listSharedLibraryDependents

public Map<String,String> listSharedLibraryDependents(String sharedLibraryName,
                                             String[] targetNames)
                                               throws ManagementRemoteException

returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library

Specified by:

listSharedLibraryDependents in interface RuntimeManagementService

Parameters:

sharedLibraryName - the shared library name

targetName -

Returns:

xml string containing the map of componentInfos as [targetName, xmlString]

Throws:

ManagementRemoteException - on error

showBindingComponent

public Map<String,String> showBindingComponent(String name,
                                      String state,
                                      String sharedLibraryName,
                                      String serviceAssemblyName,
                                      String[] targetNames)
                                        throws ManagementRemoteException

return component info xml text for the specified binding component if exists. If no binding component with that name exists, it returns the xml with empty list.

Specified by:

showBindingComponent in interface RuntimeManagementService

Parameters:

name - name of the binding component to lookup

state - return the binding component that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return the binding component that has a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return the binding component that has the specified service assembly deployed on it. null value to ignore this option.

targetName -

Returns:

xml text contain the binding component info that confirms to the component info list xml grammer as a map of [targetName, xmlString].

Throws:

ManagementRemoteException - if error or exception occurs.

showServiceAssembly

public Map<String,String> showServiceAssembly(String name,
                                     String state,
                                     String componentName,
                                     String[] targetNames)
                                       throws ManagementRemoteException

return service assembly info xml text for the specified service assembly if exists. If no service assembly with that name exists, it returns the xml with empty list.

Specified by:

showServiceAssembly in interface RuntimeManagementService

Parameters:

name - name of the service assembly to lookup

state - return the service assembly that is in the specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state

componentName - return the service assembly that has service units on this component.

targetNames -

Returns:

xml string contain service assembly info that confirms to the service assembly list xml grammer as [targetName, xmlString] map.

Throws:

ManagementRemoteException - if error or exception occurs.

showServiceEngine

public Map<String,String> showServiceEngine(String name,
                                   String state,
                                   String sharedLibraryName,
                                   String serviceAssemblyName,
                                   String[] targetNames)
                                     throws ManagementRemoteException

return component info xml text for the specified service engine if exists. If no service engine with that name exists, it returns the xml with empty list.

Specified by:

showServiceEngine in interface RuntimeManagementService

Parameters:

name - name of the service engine to lookup

state - return service engine that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - return service engine that has a dependency on the specified shared library. null value to ignore this option.

serviceAssemblyName - return the service engine that has the specified service assembly deployed on it. null value to ignore this option.

targetName -

Returns:

xml text contain the service engine component info that confirms to the component info list xml grammer as a map of [targetName, xmlString].

Throws:

ManagementRemoteException - if error or exception occurs.

showSharedLibrary

public Map<String,String> showSharedLibrary(String name,
                                   String componentName,
                                   String[] targetNames)
                                     throws ManagementRemoteException

return component info xml text for the specified shared library if exists. If no shared library with that name exists, it returns the xml with empty list.

Specified by:

showSharedLibrary in interface RuntimeManagementService

Parameters:

name - name of the shared library to lookup

componentName - return the shared library that is this component dependents. null to ignore this option.

targetName -

Returns:

xml string contain shared library component info that confirms to the component info list xml grammer as a map of [targetName, xmlString].

Throws:

ManagementRemoteException - if error or exception occurs.

shutdownComponent

public Map<String,String> shutdownComponent(String componentName,
                                   String[] targetNames)
                                     throws ManagementRemoteException

shuts down component (service engine, binding component)

Specified by:

shutdownComponent in interface RuntimeManagementService

Parameters:

componentName - name of the component

targetNames -

Returns:

name of the component as [targetName, string] map

Throws:

ManagementRemoteException - on error

shutdownComponent

public Map<String,String> shutdownComponent(String componentName,
                                   boolean force,
                                   String[] targetNames)
                                     throws ManagementRemoteException

shuts down component (service engine, binding component)

Specified by:

shutdownComponent in interface RuntimeManagementService

Parameters:

componentName - name of the component

force - true to force shutdown

targetNames -

Returns:

name of the component as [targetName, string] map

Throws:

ManagementRemoteException - on error

shutdownServiceAssembly

public Map<String,String> shutdownServiceAssembly(String serviceAssemblyName,
                                         String[] targetNames)
                                           throws ManagementRemoteException

shuts down service assembly

Specified by:

shutdownServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

targetNames -

Returns:

result as a management message xml text as [targetName, string] map

Throws:

ManagementRemoteException - on error

shutdownServiceAssembly

public Map<String,String> shutdownServiceAssembly(String serviceAssemblyName,
                                         boolean forceShutdown,
                                         String[] targetNames)
                                           throws ManagementRemoteException

shuts down service assembly

Specified by:

shutdownServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

forceShutdown -

targetName - name of the target for this operation

Returns:

Map of targetName and result as a management message xml text strings.

Throws:

ManagementRemoteException - on error

startComponent

public Map<String,String> startComponent(String componentName,
                                String[] targetNames)
                                  throws ManagementRemoteException

starts component ( service engine, binding component)

Specified by:

startComponent in interface RuntimeManagementService

Parameters:

componentName - name of the component

targetNames -

Returns:

name of the component as [targetName, string] map

Throws:

ManagementRemoteException - on error

startServiceAssembly

public Map<String,String> startServiceAssembly(String serviceAssemblyName,
                                      String[] targetNames)
                                        throws ManagementRemoteException

starts service assembly

Specified by:

startServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

targetNames -

Returns:

result as a management message xml text as [targetName, string] map

Throws:

ManagementRemoteException - on error

stopComponent

public Map<String,String> stopComponent(String componentName,
                               String[] targetNames)
                                 throws ManagementRemoteException

stops component ( service engine, binding component)

Specified by:

stopComponent in interface RuntimeManagementService

Parameters:

componentName - name of the component

targetNames -

Returns:

name of the component as [targetName, string] map

Throws:

ManagementRemoteException - on error

stopServiceAssembly

public Map<String,String> stopServiceAssembly(String serviceAssemblyName,
                                     String[] targetNames)
                                       throws ManagementRemoteException

stops service assembly

Specified by:

stopServiceAssembly in interface RuntimeManagementService

Parameters:

serviceAssemblyName - name of the service assembly

targetNames -

Returns:

result as a management message xml text as [targetName, string] map

Throws:

ManagementRemoteException - on error

showComponent

protected String showComponent(String name,
                   ComponentType type,
                   String state,
                   String sharedLibraryName,
                   String serviceAssemblyName,
                   String targetName)
                        throws ManagementRemoteException

return component info xml text for the specified service engine if exists. If no service engine with that name exists, it returns the xml with empty list.

Parameters:

name - name of the service engine to lookup

type - ENGINE or BINDING

state - to return all the service engines that are in the specified state. JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state

sharedLibraryName - to return all the service engines that have a dependency on the specified shared library. Could be null for not filtering the service engines for this dependency.

serviceAssemblyName - to return all the service engines that have the specified service assembly deployed on them. Could be null for not filtering the service engines for this dependency.

targetName -

Returns:

xml string contain service engine component info

Throws:

ManagementRemoteException - if error or exception occurs.

shutdownServiceAssemblyInternal

protected String shutdownServiceAssemblyInternal(String serviceAssemblyName,
                                     boolean force,
                                     String targetName)
                                          throws ManagementRemoteException

shuts down service assembly

Parameters:

serviceAssemblyName - name of the service assembly

force -

targetName -

Returns:

result as a management message xml text

Throws:

ManagementRemoteException - on error