com.sun.esb.management.base.services

Class AbstractListStateServiceMBeansImpl

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AdministrationServiceMBeanImpl, ConfigurationServiceMBeanImpl, RuntimeManagementServiceMBeanImpl

public class AbstractListStateServiceMBeansImpl
extends AbstractServiceMBeansImpl
implements Serializable

Author:

graj

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ANY_FRAMEWORK_COMPONENT_STATE any framework state
protected static String	COMPONENT_VERSION_NS namespace for Componennt version info node
protected static String	COMPONENT_VERSION_NS_NEW namespace for Componennt version info node
protected static String	COMPONENT_VERSION_XPATH_QUERY XPath query for new component version
protected static String	FRAMEWORK_SA_ANY_STATE any state
protected static String	FRAMEWORK_SA_SHUTDOWN_STATE sa shutdown state
protected static String	FRAMEWORK_SA_STARTED_STATE sa started state
protected static String	FRAMEWORK_SA_STOPPED_STATE sa stopped state
protected static String	FRAMEWORK_SU_SHUTDOWN_STATE state
protected static String	FRAMEWORK_SU_STARTED_STATE state
protected static String	FRAMEWORK_SU_STOPPED_STATE state
protected static String	FRAMEWORK_SU_UNKNOWN_STATE state
protected static String	SHARED_LIBRARY_VERSION_XPATH_QUERY XPath query for new component version

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
AbstractListStateServiceMBeansImpl(EnvironmentContext anEnvContext)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	componentInstalledOnTargetCheck(String componentName, String target) Check if the component is installed on the target.
protected void	componentStartedOnTargetCheck(String componentName, String target) Check if the component is in the "Started" state on the target.
protected ObjectName	getComponentLifeCycleMBeanObjectName(String componentName, String targetName) returns the ObjectName for the lifecycle Mbean of this component.
protected Collection	getComponentNamesDependentOnServiceAssembly(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String saName, String targetName) list of component names
protected Collection	getComponentNamesDependentOnServiceAssembly(String saId, String targetName) list of component names
protected Collection	getComponentNamesDependentOnSharedLibrary(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String slibName, String targetName) list of component names
protected Collection	getComponentNamesDependentOnSharedLibrary(String slibName, String targetName) list of component names
protected Collection	getComponentNamesDependentOnSharedLibraryAndServiceAssembly(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String slibName, String saName, String targetName) list of component names. this method requires non null inputs
protected Set	getComponentNamesWithStatus(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String targetName) list of component names
protected String	getComponentState(String componentName, String targetName) Gets the component state
protected Map<String,Descriptor>	getConfigurationDescriptors(ObjectName objectName) Get the attributes on the MBean
protected List	getFrameworkComponentInfoList(Collection compNameList, String targetName) framework component info list
protected List	getFrameworkComponentInfoListForEnginesAndBindings(ComponentType frameworkCompType, ComponentState frameworkCompState, String sharedLibraryName, String serviceAssemblyName, String targetName) list of componentinfo objects. this methods check for valid inputs and take only a valid inputs. for example slib, saName both can be null
protected List	getFrameworkComponentInfoListForSharedLibraries(String componentName, String targetName) this methods check for valid inputs and take only a valid inputs. for example slib, saName both can be null
protected List	getFrameworkComponentInfoListForSharedLibraryNames(Collection slibNameList, String targetName) list of component infos
protected ComponentQuery	getFrameworkComponentQuery(String targetName) return framework query
protected List	getServiceAssemblyInfoList(String frameworkState, String componentName, String targetName) list of service assembly infos
protected ObjectName[]	getSystemLoggerMBeans(String instanceName) Looks up the cascaded LoggerMBeans for all JBI Framework System Services for a specific instance
protected List	getUiComponentInfoList(ComponentType frameworkCompType, String targetName) list of ui component infos
protected boolean	isExistingComponent(String componentName, String targetName) checks the component name in the registry
protected boolean	isExistingSharedLibrary(String sharedLibraryName, String targetName) check for shared namespace
protected String	listComponents(ComponentType type, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) return component info xml text that has service engines or binding components infos or both which satisfies the options passed to the method.
protected void	targetUpCheck(String target) Check if a target is up.
protected static ComponentState	toFrameworkComponentInfoState(String uiCompState) framework states
protected static ComponentType	toFrameworkComponentInfoType(String uiCompType) converts type
protected static String	toFrameworkServiceAssemblyState(String uiState) converts to deployment service service assembly state.
protected JBIComponentInfo	toUiComponentInfo(ComponentInfo frameworkCompInfo, String targetName) return component info object
protected List	toUiComponentInfoList(List frameworkCompList, String targetName) convert to ui component info list
protected static String	toUiComponentInfoState(ComponentState frameworkCompState) converts state
protected static String	toUiComponentInfoType(ComponentType frameworkCompType) converts type
protected static String	toUiServiceAssemblyState(String frameworkState) converts to ui service assembly state
protected static String	toUiServiceUnitState(String frameworkState) converts to ui service unit state
protected void	updateEachServiceUnitInfoStateInServiceAssemblyInfo(ServiceAssemblyInfo saInfo, String targetName) update the state in each service unit info in service assembly info
protected void	updateServiceAssemblyInfoState(ServiceAssemblyInfo saInfo, String targetName) update state in service assembly info
protected void	updateServiceUnitInfoState(ServiceUnitInfo suInfo, ObjectName deploymentServiceMBean) updates the state in the service unit info
protected void	validateUiJBIComponentInfoState(String state) validates the state value component info
protected void	validateUiServiceAssemblyInfoState(String state) validates the state value for service assembly

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

Field Detail

ANY_FRAMEWORK_COMPONENT_STATE

protected static final int ANY_FRAMEWORK_COMPONENT_STATE

any framework state

See Also:

Constant Field Values

FRAMEWORK_SA_STARTED_STATE

protected static final String FRAMEWORK_SA_STARTED_STATE

sa started state

See Also:

Constant Field Values

FRAMEWORK_SA_STOPPED_STATE

protected static final String FRAMEWORK_SA_STOPPED_STATE

sa stopped state

See Also:

Constant Field Values

FRAMEWORK_SA_SHUTDOWN_STATE

protected static final String FRAMEWORK_SA_SHUTDOWN_STATE

sa shutdown state

See Also:

Constant Field Values

FRAMEWORK_SA_ANY_STATE

protected static final String FRAMEWORK_SA_ANY_STATE

any state

See Also:

Constant Field Values

FRAMEWORK_SU_STARTED_STATE

protected static final String FRAMEWORK_SU_STARTED_STATE

state

See Also:

Constant Field Values

FRAMEWORK_SU_STOPPED_STATE

protected static final String FRAMEWORK_SU_STOPPED_STATE

state

See Also:

Constant Field Values

FRAMEWORK_SU_SHUTDOWN_STATE

protected static final String FRAMEWORK_SU_SHUTDOWN_STATE

state

See Also:

Constant Field Values

FRAMEWORK_SU_UNKNOWN_STATE

protected static final String FRAMEWORK_SU_UNKNOWN_STATE

state

See Also:

Constant Field Values

COMPONENT_VERSION_NS

protected static final String COMPONENT_VERSION_NS

namespace for Componennt version info node

See Also:

Constant Field Values

COMPONENT_VERSION_NS_NEW

protected static final String COMPONENT_VERSION_NS_NEW

namespace for Componennt version info node

See Also:

Constant Field Values

COMPONENT_VERSION_XPATH_QUERY

protected static final String COMPONENT_VERSION_XPATH_QUERY

XPath query for new component version

See Also:

Constant Field Values

SHARED_LIBRARY_VERSION_XPATH_QUERY

protected static final String SHARED_LIBRARY_VERSION_XPATH_QUERY

XPath query for new component version

See Also:

Constant Field Values

Constructor Detail

AbstractListStateServiceMBeansImpl

public AbstractListStateServiceMBeansImpl(EnvironmentContext anEnvContext)

Parameters:

anEnvContext -

Method Detail

getComponentLifeCycleMBeanObjectName

protected ObjectName getComponentLifeCycleMBeanObjectName(String componentName,
                                              String targetName)
                                                   throws ManagementRemoteException

returns the ObjectName for the lifecycle Mbean of this component.

Parameters:

componentName - of a binding or engine component.

targetName -

Returns:

the ObjectName for the lifecycle Mbean.

Throws:

ManagementRemoteException - on error

listComponents

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

return component info xml text that has service engines or binding components infos or both which satisfies the options passed to the method.

Parameters:

type - ComponentInfo.BINDING, ENGINE, BINDING_ENGINE .

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

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

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

targetName -

Returns:

xml text contain the list of component infos

Throws:

ManagementRemoteException - if error or exception occurs.

validateUiJBIComponentInfoState

protected void validateUiJBIComponentInfoState(String state)
                                        throws ManagementRemoteException

validates the state value component info

Throws:

ManagementRemoteException - on validation failure

validateUiServiceAssemblyInfoState

protected void validateUiServiceAssemblyInfoState(String state)
                                           throws ManagementRemoteException

validates the state value for service assembly

Throws:

ManagementRemoteException - on validation failure

toFrameworkComponentInfoState

protected static ComponentState toFrameworkComponentInfoState(String uiCompState)

framework states

Parameters:

uiCompState - state

Returns:

state

getFrameworkComponentInfoListForEnginesAndBindings

protected List getFrameworkComponentInfoListForEnginesAndBindings(ComponentType frameworkCompType,
                                                      ComponentState frameworkCompState,
                                                      String sharedLibraryName,
                                                      String serviceAssemblyName,
                                                      String targetName)
                                                           throws ManagementRemoteException

list of componentinfo objects. this methods check for valid inputs and take only a valid inputs. for example slib, saName both can be null

Parameters:

frameworkCompType - component type.

frameworkCompState - component state

sharedLibraryName - shared library name

serviceAssemblyName - service assembly name

targetName -

Returns:

list of component info

Throws:

com.sun.jbi.ui.common.ManagementRemoteException - on error

ManagementRemoteException

getFrameworkComponentInfoList

protected List getFrameworkComponentInfoList(Collection compNameList,
                                 String targetName)

framework component info list

Parameters:

compNameList - list of component names

targetName -

Returns:

framework component info list

getFrameworkComponentInfoListForSharedLibraries

protected List getFrameworkComponentInfoListForSharedLibraries(String componentName,
                                                   String targetName)
                                                        throws ManagementRemoteException

this methods check for valid inputs and take only a valid inputs. for example slib, saName both can be null

Parameters:

componentName - name

targetName -

Returns:

list of componentInfo objects

Throws:

com.sun.jbi.ui.common.ManagementRemoteException - on error

ManagementRemoteException

getFrameworkComponentInfoListForSharedLibraryNames

protected List getFrameworkComponentInfoListForSharedLibraryNames(Collection slibNameList,
                                                      String targetName)

list of component infos

Parameters:

targetName -

slibNameList - shared library names

Returns:

list of component infos

getUiComponentInfoList

protected List getUiComponentInfoList(ComponentType frameworkCompType,
                          String targetName)
                               throws ManagementRemoteException

list of ui component infos

Parameters:

frameworkCompType - type of the component

targetName -

Returns:

list of ui component infos

Throws:

ManagementRemoteException

toUiComponentInfoList

protected List toUiComponentInfoList(List frameworkCompList,
                         String targetName)
                              throws ManagementRemoteException

convert to ui component info list

Parameters:

frameworkCompList - framework component info list

Returns:

ui component info list

Throws:

ManagementRemoteException

toUiComponentInfo

protected JBIComponentInfo toUiComponentInfo(ComponentInfo frameworkCompInfo,
                                 String targetName)
                                      throws ManagementRemoteException

return component info object

Parameters:

frameworkCompInfo - framework component info

targetName -

Returns:

object

Throws:

ManagementRemoteException

toFrameworkServiceAssemblyState

protected static String toFrameworkServiceAssemblyState(String uiState)

converts to deployment service service assembly state.

Parameters:

uiState - state

Returns:

state

toUiServiceAssemblyState

protected static String toUiServiceAssemblyState(String frameworkState)

converts to ui service assembly state

Parameters:

frameworkState - state

Returns:

state

toUiServiceUnitState

protected static String toUiServiceUnitState(String frameworkState)

converts to ui service unit state

Parameters:

frameworkState - state

Returns:

state

toUiComponentInfoState

protected static String toUiComponentInfoState(ComponentState frameworkCompState)

converts state

Parameters:

frameworkCompState - state

Returns:

state

toFrameworkComponentInfoType

protected static ComponentType toFrameworkComponentInfoType(String uiCompType)

converts type

Parameters:

uiCompType - type

Returns:

int type

toUiComponentInfoType

protected static String toUiComponentInfoType(ComponentType frameworkCompType)

converts type

Parameters:

frameworkCompType - type

Returns:

type

getComponentNamesWithStatus

protected Set getComponentNamesWithStatus(ComponentType frameworkCompType,
                              ComponentState frameworkCompStatus,
                              String targetName)

list of component names

Parameters:

frameworkCompType - component type

frameworkCompStatus - component state

targetName -

Returns:

list of component names

getComponentNamesDependentOnServiceAssembly

protected Collection getComponentNamesDependentOnServiceAssembly(ComponentType frameworkCompType,
                                                     ComponentState frameworkCompStatus,
                                                     String saName,
                                                     String targetName)

list of component names

Parameters:

frameworkCompType - component type

frameworkCompStatus - component state

saName - service assembly name

targetName -

Returns:

list of component names

getComponentNamesDependentOnSharedLibrary

protected Collection getComponentNamesDependentOnSharedLibrary(ComponentType frameworkCompType,
                                                   ComponentState frameworkCompStatus,
                                                   String slibName,
                                                   String targetName)

list of component names

Parameters:

frameworkCompType - component type

frameworkCompStatus - component state

slibName - shared library name

targetName -

Returns:

list of component names

getComponentNamesDependentOnSharedLibraryAndServiceAssembly

protected Collection getComponentNamesDependentOnSharedLibraryAndServiceAssembly(ComponentType frameworkCompType,
                                                                     ComponentState frameworkCompStatus,
                                                                     String slibName,
                                                                     String saName,
                                                                     String targetName)

list of component names. this method requires non null inputs

Parameters:

frameworkCompType - component type

frameworkCompStatus - component state

slibName - shared library name

saName - service assembly name

targetName -

Returns:

list of component names.

getComponentNamesDependentOnSharedLibrary

protected Collection getComponentNamesDependentOnSharedLibrary(String slibName,
                                                   String targetName)

list of component names

Parameters:

slibName - shared library name.

targetName -

Returns:

list of component names

getComponentNamesDependentOnServiceAssembly

protected Collection getComponentNamesDependentOnServiceAssembly(String saId,
                                                     String targetName)

list of component names

Parameters:

saId - service assembly name.

targetName -

Returns:

list of component names

getFrameworkComponentQuery

protected ComponentQuery getFrameworkComponentQuery(String targetName)

return framework query

Parameters:

targetName -

Returns:

framework query interface

isExistingComponent

protected boolean isExistingComponent(String componentName,
                          String targetName)

checks the component name in the registry

Parameters:

componentName - name of the component

targetName -

Returns:

true if component exists else false.

isExistingSharedLibrary

protected boolean isExistingSharedLibrary(String sharedLibraryName,
                              String targetName)

check for shared namespace

Parameters:

sharedLibraryName - id String

targetName -

Returns:

true if it is namespace id else false.

getServiceAssemblyInfoList

protected List getServiceAssemblyInfoList(String frameworkState,
                              String componentName,
                              String targetName)
                                   throws ManagementRemoteException

list of service assembly infos

Parameters:

frameworkState - state

componentName - name

targetName -

Returns:

list of service assembly infos

Throws:

com.sun.jbi.ui.common.ManagementRemoteException - on error

ManagementRemoteException

updateServiceAssemblyInfoState

protected void updateServiceAssemblyInfoState(ServiceAssemblyInfo saInfo,
                                  String targetName)
                                       throws ManagementRemoteException

update state in service assembly info

Parameters:

saInfo - service assembly info

targetName -

Throws:

com.sun.jbi.ui.common.ManagementRemoteException - on error

ManagementRemoteException

updateEachServiceUnitInfoStateInServiceAssemblyInfo

protected void updateEachServiceUnitInfoStateInServiceAssemblyInfo(ServiceAssemblyInfo saInfo,
                                                       String targetName)
                                                            throws ManagementRemoteException

update the state in each service unit info in service assembly info

Parameters:

saInfo - service assembly info object

targetName -

Throws:

com.sun.jbi.ui.common.ManagementRemoteException - on error

ManagementRemoteException

updateServiceUnitInfoState

protected void updateServiceUnitInfoState(ServiceUnitInfo suInfo,
                              ObjectName deploymentServiceMBean)

updates the state in the service unit info

Parameters:

suInfo - service unit info object

ObjectName - deploymentServiceMBean

getSystemLoggerMBeans

protected ObjectName[] getSystemLoggerMBeans(String instanceName)

Looks up the cascaded LoggerMBeans for all JBI Framework System Services for a specific instance

Returns:

array of object names for all schemaorg_apache_xmlbeans.system service LoggerMBeans.

getConfigurationDescriptors

protected Map<String,Descriptor> getConfigurationDescriptors(ObjectName objectName)
                                                      throws ManagementRemoteException

Get the attributes on the MBean

Parameters:

mbeanServer -

objectName -

Returns:

Throws:

JBIRemoteException

ManagementRemoteException

getComponentState

protected String getComponentState(String componentName,
                       String targetName)
                            throws ManagementRemoteException

Gets the component state

Parameters:

componentName -

targetName -

Returns:

the state of the component

Throws:

ManagementRemoteException - on error

targetUpCheck

protected void targetUpCheck(String target)
                      throws ManagementRemoteException

Check if a target is up. A JBI Management exception is thrown if the target is down.

Parameters:

target - - target name, can be standalone or clustered instance, cluster or "server".

Throws:

ManagementRemoteException - if component is not started on target.

componentStartedOnTargetCheck

protected void componentStartedOnTargetCheck(String componentName,
                                 String target)
                                      throws ManagementRemoteException

Check if the component is in the "Started" state on the target. A JBI Management exception is thrown if the component is not in the started state.

Parameters:

componentName - - component name

target - - target name, can be standalone or clustered instance, cluster or "server".

Throws:

ManagementRemoteException - if component is not started on target.

componentInstalledOnTargetCheck

protected void componentInstalledOnTargetCheck(String componentName,
                                   String target)
                                        throws ManagementRemoteException

Check if the component is installed on the target. A JBI Management exception is thrown if the component is not installed.

Parameters:

componentName - - component name

target - - target name, can be standalone or clustered instance, cluster or "server".

Throws:

ManagementRemoteException - if component is not started on target.