com.sun.jbi.ui.runtime.mbeans

Class AbstractUIMBeanImpl

java.lang.Object

com.sun.jbi.ui.runtime.mbeans.AbstractUIMBeanImpl

Direct Known Subclasses:

JBIAdminCommandsUIMBeanImpl, JBIStatisticsMBeanImpl

public class AbstractUIMBeanImpl
extends Object

Base class for Implementation of the UI MBean interface.

Author:

graj

Field Summary

Fields

Modifier and Type	Field and Description
protected AdministrationService	administrationService
protected static int	ANY_FRAMEWORK_COMPONENT_STATE any framework state
protected static String	COMPONENT_CONFIG_INSTANCE_ERROR_KEY
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 ConfigurationService	configurationService
protected DeploymentService	deploymentService
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 InstallationService	installationService
protected ComponentConfigurationHelper	mCfgHlpr Component Configuration helper
protected EnvironmentContext	mEnvContext Jbi Environment context.
protected PerformanceMeasurementService	performanceMeasurementService
protected static String	RUNNING_STATE
protected RuntimeManagementService	runtimeManagementService
protected static String	SHARED_LIBRARY_VERSION_XPATH_QUERY XPath query for new component version
protected static String	STARTED_STATE

Constructor Summary

Constructors

Constructor and Description
AbstractUIMBeanImpl(EnvironmentContext anEnvContext) constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected AttributeList	constructMBeanAttributes(MBeanServerConnection mbeanServer, ObjectName objectName, Properties params) invokes the operation on mbean
protected AttributeList	constructMBeanAttributes(ObjectName objectName, Properties params) invokes the operation on mbean
ObjectName	findDeployerMBean(String componentName) returns the ObjectName for the DeployerMBean for the component.
protected AdministrationService	getAdministrationService() Get the Administration Service
ObjectName	getAdminServiceMBeanObjectName() returns the ObjectName for the AdminService Mbean of this component.
protected Object	getAttributeValue(MBeanServer mbeanServer, ObjectName objectName, String attributeName) Invokes the mbean and retrieves the attribute value
protected Object	getAttributeValue(ObjectName objectName, String attributeName) Invokes the mbean and retrieves the attribute value
ObjectName	getComponentLifeCycleMBeanObjectName(String componentName, String targetName) returns the ObjectName for the lifecycle Mbean of this component.
protected String	getComponentNameFromJmxObjectName(ObjectName jmxObjectName) finds the component id property in the object name
Collection	getComponentNamesDependentOnServiceAssembly(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String saName, String targetName) list of component names
Collection	getComponentNamesDependentOnServiceAssembly(String saId, String targetName) list of component names
Collection	getComponentNamesDependentOnSharedLibrary(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String slibName, String targetName) list of component names
Collection	getComponentNamesDependentOnSharedLibrary(String slibName, String targetName) list of component names
Collection	getComponentNamesDependentOnSharedLibraryAndServiceAssembly(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String slibName, String saName, String targetName) list of component names. this method requires non null inputs
Set	getComponentNamesWithStatus(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String targetName) list of component names
protected Properties	getConfigurationAttributeValues(ObjectName objectName) Get the config extension MBean attribute values
protected Map<String,Descriptor>	getConfigurationDescriptors(ObjectName objectName) Get the attributes on the MBean
ObjectName	getConfigurationMBeanObjectName(String targetName, String configurationType)
protected ConfigurationService	getConfigurationService() Get the Configuration Service
protected DeploymentService	getDeploymentService() Get the Deployment Service
ObjectName	getDeploymentServiceMBeanObjectName(String targetName) returns the ObjectName for the DeploymentService Mbean of this component.
protected static EnvironmentContext	getEnvironmentContext()
ObjectName	getExtensionMBeanObjectName(String componentName, String targetName) returns the ObjectName for the Extension Mbean of this component.
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
List	getFrameworkComponentInfoListForSharedLibraryNames(Collection slibNameList, String targetName) list of component infos
protected ComponentQuery	getFrameworkComponentQuery(String targetName) return framework query
protected static I18NBundle	getI18NBundle() gives the I18N bundle
String	getInstallationDescriptor(String componentName, String targetName) Retrieve the Component Installation descriptor for the server target.
protected InstallationService	getInstallationService() Get the Installation Service
ObjectName	getInstallationServiceMBeanObjectName() returns the ObjectName for the InstallationService Mbean of this component.
ObjectName	getInstallationServiceMBeanObjectName(String targetName) returns the ObjectName for the InstallationService Mbean of this component.
ObjectName	getLoggingServiceMBeanObjectName(String targetName) returns the ObjectName for the LoggingService Mbean of this target.
protected Object	getMBeanAttribute(ObjectName objectName, String attributeName) invokes the operation on mbean
protected Properties	getMBeanAttributeValues(MBeanServerConnection connection, ObjectName objectName) Get the attributes on the MBean
protected Properties	getMBeanAttributeValues(MBeanServer mbeanServer, ObjectName objectName) Get the attributes on the MBean
protected MBeanInfo	getMBeanInfo(ObjectName mbeanName) This method is used to get MBeanInfo for the given mbean object
protected PerformanceMeasurementService	getPerformanceMeasurementService() Get the Performance Measurement Service
protected PlatformContext	getPlatformContext()
protected RuntimeManagementService	getRuntimeManagementService() Get the Runtime management Service
protected List	getServiceAssemblyInfoList(String frameworkState, String componentName, String targetName) list of service assembly infos
String	getSharedLibraryDescriptor(String libraryName, String targetName) Retrieve the Shared Library Installation descriptor for the server target.
ObjectName[]	getSystemLoggerMBeans(String instanceName) Looks up the cascaded LoggerMBeans for all JBI Framework System Services for a specific instance
List	getUiComponentInfoList(ComponentType frameworkCompType, String targetName) list of ui component infos
protected Object	invokeMBeanOperation(ObjectName objectName, String operationName) invokes the operation on mbean
protected Object	invokeMBeanOperation(ObjectName objectName, String operationName, Object[] params, String[] signature) invokes the operation on mbean
protected Object	invokeMBeanOperation(ObjectName objectName, String operationName, String param) invokes the operation on mbean
boolean	isExistingComponent(String componentName, String targetName) checks the component name in the registry
boolean	isExistingSharedLibrary(String sharedLibraryName, String targetName) check for shared namespace
boolean	isSharedLibraryArchive(String zipPath) check for shared library
static void	log(String aMsg) logs the message
static void	logDebug(Exception ex) logs the message
static void	logDebug(String aMsg) logs the message
static void	logError(Exception ex) logs errors
static void	logWarning(Exception ex) logs warnings
protected void	setAttributeValue(ObjectName objectName, String attributeName, Object attributeValue) Invokes the mbean and retrieves the attribute value
protected void	setMBeanAttribute(ObjectName objectName, String attributeName, Object attributeValue) invokes the operation on mbean
protected AttributeList	setMBeanAttributes(MBeanServerConnection mbeanServer, ObjectName objectName, AttributeList attrList) set the specified attribute values on the mbean attributes
protected void	setMBeanAttributes(ObjectName objectName, AttributeList attrList) set the specified attribute values on the mbean attributes
protected String	setMBeanConfigAttributes(MBeanServerConnection mbeanServer, ObjectName objectName, AttributeList attrList) set the specified attribute values on the mbean attributes
protected String	setMBeanConfigAttributes(ObjectName objectName, AttributeList attrList) set the specified attribute values on the mbean attributes
static ComponentState	toFrameworkComponentInfoState(String uiCompState) framework states
static ComponentType	toFrameworkComponentInfoType(String uiCompType) converts type
static String	toFrameworkServiceAssemblyState(String uiState) converts to deployment service service assembly state.
JBIComponentInfo	toUiComponentInfo(ComponentInfo frameworkCompInfo, String targetName) return component info object
List	toUiComponentInfoList(List frameworkCompList, String targetName) convert to ui component info list
static String	toUiComponentInfoState(ComponentState frameworkCompState) converts state
static String	toUiComponentInfoType(ComponentType frameworkCompType) converts type
static String	toUiServiceAssemblyState(String frameworkState) converts to ui service assembly state
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
void	validateUiJBIComponentInfoState(String state) validates the state value component info
void	validateUiServiceAssemblyInfoState(String state) validates the state value for service assembly

Methods inherited from class java.lang.Object

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

Field Detail

STARTED_STATE

protected static final String STARTED_STATE

See Also:

Constant Field Values

RUNNING_STATE

protected static final String RUNNING_STATE

See Also:

Constant Field Values

COMPONENT_CONFIG_INSTANCE_ERROR_KEY

protected static final String COMPONENT_CONFIG_INSTANCE_ERROR_KEY

See Also:

Constant Field Values

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

mEnvContext

protected EnvironmentContext mEnvContext

Jbi Environment context.

mCfgHlpr

protected ComponentConfigurationHelper mCfgHlpr

Component Configuration helper

administrationService

protected transient AdministrationService administrationService

configurationService

protected transient ConfigurationService configurationService

deploymentService

protected transient DeploymentService deploymentService

installationService

protected transient InstallationService installationService

runtimeManagementService

protected transient RuntimeManagementService runtimeManagementService

performanceMeasurementService

protected transient PerformanceMeasurementService performanceMeasurementService

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

AbstractUIMBeanImpl

public AbstractUIMBeanImpl(EnvironmentContext anEnvContext)

constructor

Parameters:

anEnvContext - context

Method Detail

getAdministrationService

protected AdministrationService getAdministrationService()

Get the Administration Service

Returns:

administration Service

getConfigurationService

protected ConfigurationService getConfigurationService()

Get the Configuration Service

Returns:

configuration Service

getDeploymentService

protected DeploymentService getDeploymentService()

Get the Deployment Service

Returns:

deployment Service

getInstallationService

protected InstallationService getInstallationService()

Get the Installation Service

Returns:

installation Service

getRuntimeManagementService

protected RuntimeManagementService getRuntimeManagementService()

Get the Runtime management Service

Returns:

Runtime management Service

getPerformanceMeasurementService

protected PerformanceMeasurementService getPerformanceMeasurementService()

Get the Performance Measurement Service

Returns:

Performance Measurement Service

log

public static void log(String aMsg)

logs the message

Parameters:

aMsg - message string

logDebug

public static void logDebug(String aMsg)

logs the message

Parameters:

aMsg - message string

logDebug

public static void logDebug(Exception ex)

logs the message

Parameters:

ex - exception

logError

public static void logError(Exception ex)

logs errors

Parameters:

ex - exception

logWarning

public static void logWarning(Exception ex)

logs warnings

Parameters:

ex - exception

getPlatformContext

protected PlatformContext getPlatformContext()

Returns:

the platform context

getEnvironmentContext

protected static EnvironmentContext getEnvironmentContext()

Returns:

the EnvironmentContext

getI18NBundle

protected static I18NBundle getI18NBundle()

gives the I18N bundle

Returns:

I18NBundle object

getAttributeValue

protected Object getAttributeValue(MBeanServer mbeanServer,
                       ObjectName objectName,
                       String attributeName)
                            throws JBIRemoteException

Invokes the mbean and retrieves the attribute value

Parameters:

mbeanServer - connection to MBean Server

objectName - object name

attributeName - attribute name

Returns:

the value of the attribute

Throws:

JBIRemoteException - on error

getAttributeValue

protected Object getAttributeValue(ObjectName objectName,
                       String attributeName)
                            throws JBIRemoteException

Invokes the mbean and retrieves the attribute value

Parameters:

objectName - object name

attributeName - attribute name

Returns:

the value of the attribute

Throws:

JBIRemoteException - on error

setAttributeValue

protected void setAttributeValue(ObjectName objectName,
                     String attributeName,
                     Object attributeValue)
                          throws JBIRemoteException

Invokes the mbean and retrieves the attribute value

Parameters:

objectName - object name

attributeName - attribute name

Throws:

JBIRemoteException - on error

invokeMBeanOperation

protected Object invokeMBeanOperation(ObjectName objectName,
                          String operationName,
                          Object[] params,
                          String[] signature)
                               throws JBIRemoteException

invokes the operation on mbean

Parameters:

objectName - object name

operationName - operation name

params - parameters

signature - signature of the parameters

Returns:

result object

Throws:

JBIRemoteException - on user error

invokeMBeanOperation

protected Object invokeMBeanOperation(ObjectName objectName,
                          String operationName,
                          String param)
                               throws JBIRemoteException

invokes the operation on mbean

Parameters:

objectName - object name

operationName - operation name

param - operation param of type String

Returns:

result object

Throws:

JBIRemoteException - on user error

invokeMBeanOperation

protected Object invokeMBeanOperation(ObjectName objectName,
                          String operationName)
                               throws JBIRemoteException

invokes the operation on mbean

Parameters:

objectName - object name

operationName - operation name

Returns:

result object

Throws:

JBIRemoteException - on user error

getMBeanAttribute

protected Object getMBeanAttribute(ObjectName objectName,
                       String attributeName)
                            throws JBIRemoteException

invokes the operation on mbean

Parameters:

attributeName - attribute name

objectName - object name

Returns:

result object

Throws:

JBIRemoteException - on user error

getMBeanInfo

protected MBeanInfo getMBeanInfo(ObjectName mbeanName)
                          throws JBIRemoteException

This method is used to get MBeanInfo for the given mbean object

Parameters:

mbeanName - the objectname for the mbean

Returns:

MBeanInfo object

Throws:

JBIRemoteException

setMBeanAttribute

protected void setMBeanAttribute(ObjectName objectName,
                     String attributeName,
                     Object attributeValue)
                          throws JBIRemoteException

invokes the operation on mbean

Parameters:

attributeValue - attrbute name

attributeName - attribute value

objectName - object name

Throws:

JBIRemoteException - on user error

setMBeanAttributes

protected void setMBeanAttributes(ObjectName objectName,
                      AttributeList attrList)
                           throws JBIRemoteException

set the specified attribute values on the mbean attributes

Parameters:

attrList - list of attributes

objectName - object name

Throws:

JBIRemoteException - on user error

setMBeanConfigAttributes

protected String setMBeanConfigAttributes(ObjectName objectName,
                              AttributeList attrList)
                                   throws JBIRemoteException

set the specified attribute values on the mbean attributes

Parameters:

attrList - list of attributes

objectName - object name

Returns:

management message response from setConfigurationAttributes

Throws:

JBIRemoteException - on user error

setMBeanConfigAttributes

protected String setMBeanConfigAttributes(MBeanServerConnection mbeanServer,
                              ObjectName objectName,
                              AttributeList attrList)
                                   throws JBIRemoteException

set the specified attribute values on the mbean attributes

Parameters:

MBeanServer - the MBean server to use

attrList - list of attributes

objectName - object name

Returns:

management message response from setConfigurationAttributes

Throws:

JBIRemoteException - on user error

setMBeanAttributes

protected AttributeList setMBeanAttributes(MBeanServerConnection mbeanServer,
                               ObjectName objectName,
                               AttributeList attrList)
                                    throws JBIRemoteException

set the specified attribute values on the mbean attributes

Parameters:

attrList - list of attributes

objectName - object name

Throws:

JBIRemoteException - on user error

getConfigurationAttributeValues

protected Properties getConfigurationAttributeValues(ObjectName objectName)
                                              throws JBIRemoteException

Get the config extension MBean attribute values

Parameters:

objectName -

Returns:

Throws:

JBIRemoteException

getMBeanAttributeValues

protected Properties getMBeanAttributeValues(MBeanServer mbeanServer,
                                 ObjectName objectName)
                                      throws JBIRemoteException

Get the attributes on the MBean

Parameters:

mbeanServer -

objectName -

Returns:

Throws:

JBIRemoteException

getConfigurationDescriptors

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

Get the attributes on the MBean

Parameters:

mbeanServer -

objectName -

Returns:

Throws:

JBIRemoteException

constructMBeanAttributes

protected AttributeList constructMBeanAttributes(ObjectName objectName,
                                     Properties params)
                                          throws JBIRemoteException

invokes the operation on mbean

Parameters:

objectName - mbean name

params - a name value pair properties object contains the attribute name and its value as string.

Returns:

Attribute List of the mbean to set

Throws:

JBIRemoteException - on user error

constructMBeanAttributes

protected AttributeList constructMBeanAttributes(MBeanServerConnection mbeanServer,
                                     ObjectName objectName,
                                     Properties params)
                                          throws JBIRemoteException

invokes the operation on mbean

Parameters:

objectName - mbean name

params - a name value pair properties object contains the attribute name and its value as string.

Returns:

Attribute List of the mbean to set

Throws:

JBIRemoteException - on user error

isSharedLibraryArchive

public boolean isSharedLibraryArchive(String zipPath)

check for shared library

Parameters:

zipPath - file path

Returns:

true if it is shared library else false.

getComponentNameFromJmxObjectName

protected String getComponentNameFromJmxObjectName(ObjectName jmxObjectName)

finds the component id property in the object name

Parameters:

jmxObjectName - jmx obj name

Returns:

componentId of the component if embbeded in object name else null.

getAdminServiceMBeanObjectName

public ObjectName getAdminServiceMBeanObjectName()
                                          throws JBIRemoteException

returns the ObjectName for the AdminService Mbean of this component.

Returns:

the ObjectName of the InstallationService MBean or null.

Throws:

JBIRemoteException - on error.

getInstallationServiceMBeanObjectName

public ObjectName getInstallationServiceMBeanObjectName()

returns the ObjectName for the InstallationService Mbean of this component.

Returns:

the ObjectName of the InstallationService MBean or null.

getInstallationServiceMBeanObjectName

public ObjectName getInstallationServiceMBeanObjectName(String targetName)

returns the ObjectName for the InstallationService Mbean of this component.

Parameters:

targetName -

Returns:

the ObjectName of the InstallationService MBean or null.

getDeploymentServiceMBeanObjectName

public ObjectName getDeploymentServiceMBeanObjectName(String targetName)

returns the ObjectName for the DeploymentService Mbean of this component.

Parameters:

targetName -

Returns:

the ObjectName of the DeploymentService MBean or null.

getLoggingServiceMBeanObjectName

public ObjectName getLoggingServiceMBeanObjectName(String targetName)

returns the ObjectName for the LoggingService Mbean of this target.

Parameters:

targetName -

Returns:

the ObjectName of the LoggingService MBean or null.

getSystemLoggerMBeans

public 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.

getConfigurationMBeanObjectName

public ObjectName getConfigurationMBeanObjectName(String targetName,
                                         String configurationType)
                                           throws JBIRemoteException

Parameters:

targetName -

configurationType -

Returns:

Throws:

JBIRemoteException

getMBeanAttributeValues

protected Properties getMBeanAttributeValues(MBeanServerConnection connection,
                                 ObjectName objectName)
                                      throws JBIRemoteException

Get the attributes on the MBean

Parameters:

connection -

objectName -

Returns:

Throws:

JBIRemoteException

getExtensionMBeanObjectName

public ObjectName getExtensionMBeanObjectName(String componentName,
                                     String targetName)
                                       throws JBIRemoteException

returns the ObjectName for the Extension Mbean of this component.

Parameters:

componentName -

targetName -

Returns:

the ObjectName of the Extension MBean or null.

Throws:

JBIRemoteException

findDeployerMBean

public ObjectName findDeployerMBean(String componentName)
                             throws JBIRemoteException

returns the ObjectName for the DeployerMBean for the component.

Parameters:

componentName - of a binding or engine component.

Returns:

the ObjectName for the lifecycle Mbean.

Throws:

JBIRemoteException - on error

getComponentLifeCycleMBeanObjectName

public ObjectName getComponentLifeCycleMBeanObjectName(String componentName,
                                              String targetName)
                                                throws JBIRemoteException

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:

JBIRemoteException - on error

getFrameworkComponentQuery

protected ComponentQuery getFrameworkComponentQuery(String targetName)

return framework query

Parameters:

targetName -

Returns:

framework query interface

isExistingComponent

public 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

public boolean isExistingSharedLibrary(String sharedLibraryName,
                              String targetName)

check for shared namespace

Parameters:

sharedLibraryName - id String

targetName -

Returns:

true if it is namespace id else false.

getComponentNamesDependentOnSharedLibrary

public Collection getComponentNamesDependentOnSharedLibrary(String slibName,
                                                   String targetName)

list of component names

Parameters:

slibName - shared library name.

targetName -

Returns:

list of component names

getComponentNamesDependentOnServiceAssembly

public Collection getComponentNamesDependentOnServiceAssembly(String saId,
                                                     String targetName)

list of component names

Parameters:

saId - service assembly name.

targetName -

Returns:

list of component names

getComponentNamesWithStatus

public 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

public 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

public 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

public 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.

updateServiceUnitInfoState

protected void updateServiceUnitInfoState(ServiceUnitInfo suInfo,
                              ObjectName deploymentServiceMBean)

updates the state in the service unit info

Parameters:

suInfo - service unit info object

ObjectName - deploymentServiceMBean

updateEachServiceUnitInfoStateInServiceAssemblyInfo

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

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

Parameters:

saInfo - service assembly info object

targetName -

Throws:

JBIRemoteException - on error

updateServiceAssemblyInfoState

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

update state in service assembly info

Parameters:

saInfo - service assembly info

targetName -

Throws:

JBIRemoteException - on error

getServiceAssemblyInfoList

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

list of service assembly infos

Parameters:

frameworkState - state

componentName - name

targetName -

Returns:

list of service assembly infos

Throws:

JBIRemoteException - on error

getUiComponentInfoList

public List getUiComponentInfoList(ComponentType frameworkCompType,
                          String targetName)
                            throws JBIRemoteException

list of ui component infos

Parameters:

frameworkCompType - type of the component

targetName -

Returns:

list of ui component infos

Throws:

JBIRemoteException

toUiComponentInfoList

public List toUiComponentInfoList(List frameworkCompList,
                         String targetName)
                           throws JBIRemoteException

convert to ui component info list

Parameters:

frameworkCompList - framework component info list

Returns:

ui component info list

Throws:

JBIRemoteException

toUiComponentInfo

public JBIComponentInfo toUiComponentInfo(ComponentInfo frameworkCompInfo,
                                 String targetName)
                                   throws JBIRemoteException

return component info object

Parameters:

frameworkCompInfo - framework component info

targetName -

Returns:

object

Throws:

JBIRemoteException

toFrameworkServiceAssemblyState

public static String toFrameworkServiceAssemblyState(String uiState)

converts to deployment service service assembly state.

Parameters:

uiState - state

Returns:

state

toUiServiceAssemblyState

public static String toUiServiceAssemblyState(String frameworkState)

converts to ui service assembly state

Parameters:

frameworkState - state

Returns:

state

toUiServiceUnitState

public static String toUiServiceUnitState(String frameworkState)

converts to ui service unit state

Parameters:

frameworkState - state

Returns:

state

toUiComponentInfoState

public static String toUiComponentInfoState(ComponentState frameworkCompState)

converts state

Parameters:

frameworkCompState - state

Returns:

state

toFrameworkComponentInfoType

public static ComponentType toFrameworkComponentInfoType(String uiCompType)

converts type

Parameters:

uiCompType - type

Returns:

int type

toUiComponentInfoType

public static String toUiComponentInfoType(ComponentType frameworkCompType)

converts type

Parameters:

frameworkCompType - type

Returns:

type

validateUiJBIComponentInfoState

public void validateUiJBIComponentInfoState(String state)
                                     throws JBIRemoteException

validates the state value component info

Throws:

JBIRemoteException - on validation failure

validateUiServiceAssemblyInfoState

public void validateUiServiceAssemblyInfoState(String state)
                                        throws JBIRemoteException

validates the state value for service assembly

Throws:

JBIRemoteException - on validation failure

toFrameworkComponentInfoState

public 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 JBIRemoteException

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:

JBIRemoteException - on error

getFrameworkComponentInfoList

public 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 JBIRemoteException

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:

JBIRemoteException - on error

getFrameworkComponentInfoListForSharedLibraryNames

public List getFrameworkComponentInfoListForSharedLibraryNames(Collection slibNameList,
                                                      String targetName)

list of component infos

Parameters:

targetName -

slibNameList - shared library names

Returns:

list of component infos

getInstallationDescriptor

public String getInstallationDescriptor(String componentName,
                               String targetName)

Retrieve the Component Installation descriptor for the server target. The Installation descriptor will never be different for a component name in a JBI schemaorg_apache_xmlbeans.system because there's only one component allowed with that same name. Therefore, this implies a registry lookup for the server target.

Parameters:

Component - name as a string

targetName -

Returns:

the Component Installation descriptor as a string

Throws:

JBIRemoteException - on error

getSharedLibraryDescriptor

public String getSharedLibraryDescriptor(String libraryName,
                                String targetName)

Retrieve the Shared Library Installation descriptor for the server target. The Installation descriptor will never be different for a library name in a JBI schemaorg_apache_xmlbeans.system because there's only one library allowed with that same name. Therefore, this implies a registry lookup for the domain target.

Parameters:

libraryName - name as a string

targetName -

Returns:

the Library Installation descriptor as a string

Throws:

JBIRemoteException - on error