AbstractServiceMBeansImpl (ui-runtime 2.4.3 API)

java.lang.Object
- com.sun.esb.management.base.services.AbstractServiceMBeansImpl

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractListStateServiceMBeansImpl, DeploymentServiceMBeanImpl, InstallationServiceMBeanImpl, PerformanceMeasurementServiceMBeanImpl
```
public abstract class AbstractServiceMBeansImpl
extends Object
implements Serializable
```
Author:

graj

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`COLON`
`protected static String`	`COMMA`
`protected static String`	`COMPONENT_CONFIG_INSTANCE_ERROR_KEY`
`protected ComponentConfigurationHelper`	`componentConfigurationHelper` Component Configuration helper
`protected static String`	`CUSTOM_ADMINISTRATION_NAME_KEY`
`protected static String`	`CUSTOM_CONFIGURATION_NAME_KEY`
`protected static String`	`CUSTOM_LOGGER_NAME_KEY`
`protected static String`	`CUSTOM_MANAGEMENT_ACTIONS_NAME_KEY`
`protected static String`	`CUSTOM_STATISTICS_NAME_KEY`
`protected static String`	`DOMAIN_TARGET_KEY`
`protected static String`	`EBIJMXDOMAIN` Enterprise Business Integration JMX domain
`protected EnvironmentContext`	`environmentContext` Jbi Environment context.
`protected static String`	`EQUAL`
`protected static String`	`IDENTIFICATION_NAME_KEY`
`protected static String`	`JMX_EBI_DOMAIN` JMX Domain name for the Enterprise Business Integration JMX MBeans
`protected static char`	`PASSWORD_MASK_CHARACTER`
`protected static String`	`RUNNING_STATE`
`protected static String`	`SERVER_TARGET_KEY`
`protected static String`	`SERVICE_TYPE_KEY`
`protected static String`	`STARTED_STATE`

Constructor Summary

Constructors
Constructor and Description

AbstractServiceMBeansImpl(EnvironmentContext anEnvContext)

Constructors
Constructor and Description
`AbstractServiceMBeansImpl(EnvironmentContext anEnvContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkForValidTarget(ObjectName objectName, String targetName)` Check if a target is valid or not
`protected void`	`checkForValidTarget(ObjectName objectName, String targetName, boolean useTargetNameFlag)` Check if a target is valid or not
`protected TargetType`	`checkTargetType(String target)` Check the type of the specified target
`protected AttributeList`	`constructMBeanAttributes(MBeanServerConnection mbeanServer, ObjectName objectName, Properties params)` invokes the operation on mbean
`protected AttributeList`	`constructMBeanAttributes(ObjectName objectName, Map<String,Object> params)` invokes the operation on mbean
`protected AttributeList`	`constructMBeanAttributes(ObjectName objectName, Properties params)` invokes the operation on mbean
`protected Exception`	`createManagementException(String bundleKey, String[] args, Exception sourceException)` Creates a management message string and populates the exception
`protected String`	`createManagementMessage(String taskId, boolean successResult, String msgType, String msgCode, Object[] args)` Creates a management message.
`protected void`	`domainTargetCheck(String target)` Check to ensure that the target is a domain target
`protected Map<String,ObjectName[]>`	`findLiveExtensionMBeanObjectNames(String componentName, String extensionName, String targetName)` Find Extension MBeans for targets that are up
`protected ObjectName`	`getAdminServiceMBeanObjectName()` returns the ObjectName for the AdminService Mbean of this component.
`protected ObjectName`	`getAdminServiceMBeanObjectName(String targetName)` returns the ObjectName for the AdminService facade Mbean for a target
`protected Object`	`getAttributeValue(MBeanServerConnection mbeanServer, ObjectName objectName, String attributeName)` Invokes the mbean and retrieves the attribute value
`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
`protected Object`	`getAttributeValue(String targetName, ObjectName objectName, String attributeName)` Invokes the mbean and retrieves the attribute value
`protected Map<String,ObjectName[]>`	`getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName)` Gets the extension MBean object names
`protected ObjectName[]`	`getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName)` Gets the extension MBean object names
`protected ObjectName`	`getDeploymentServiceMBeanObjectName(String targetName)` returns the ObjectName for the DeploymentService Mbean of this component.
`protected static String`	`getEbiJmxDomain()` gets the ebi jmx domain name
`protected ObjectName`	`getEbiStatusMBeanObjectName(String componentName, String targetName)` Get the EBI Status MBean ObjectName
`protected static EnvironmentContext`	`getEnvironmentContext()`
`protected ObjectName`	`getExtensionMBeanObjectName(String componentName, String targetName)` returns the ObjectName for the Extension Mbean of this component.
`protected static I18NBundle`	`getI18NBundle()` gives the I18N bundle
`protected static I18NBundle`	`getI18NBundle(String packageName)` gives the I18N bundle
`protected ObjectName`	`getInstallationServiceMBeanObjectName(String targetName)` returns the ObjectName for the InstallationService Mbean of this component.
`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 Map<String,Object>`	`getMBeanAttributeValuesAsMap(MBeanServerConnection connection, ObjectName objectName)` Get the attributes on the MBean
`protected MBeanServerConnection`	`getMBeanServerConnection(String targetName)` Retrieve MBeanServerConnection for targets other than server
`protected PlatformContext`	`getPlatformContext()`
`protected String`	`getPlatformContextAdminServerName()` Get the instance name of the platform's administration server.
`protected Set<String>`	`getPlatformContextClusteredServerNames()` Get a set of the names of all the clustered servers in the domain.
`protected Set<String>`	`getPlatformContextClusterNames()` Get a set of the names of all the clusters in the domain.
`protected String`	`getPlatformContextInstallRoot()` Get the full path to the platform's instaall root directory.
`protected String`	`getPlatformContextInstanceName()` Get the name of this instance.
`protected String`	`getPlatformContextInstanceRoot()` Get the full path to the platform's instance root directory.
`protected String`	`getPlatformContextJmxRmiPort()` Get a string representation of the DAS JMX RMI connector port.
`protected MBeanServer`	`getPlatformContextMBeanServer()` Provides access to the platform's MBean server.
`protected Set<String>`	`getPlatformContextServersInCluster(String clusterName)` Get a set of the names of all the servers in the specified cluster.
`protected Set<String>`	`getPlatformContextStandaloneServerNames()` Get a set of the names of all the standalone servers in the domain.
`protected String`	`getPlatformContextTargetName()` Get the Target Name.
`protected String`	`getPlatformContextTargetName(String instanceName)` Get the Target Name for a specified instance.
`protected String`	`getStackTrace(JBIRemoteException exception)` Returns the stack-trace of the exception
`protected Object`	`invokeMBeanOperation(MBeanServerConnection connection, ObjectName objectName, String operationName, Object[] params, String[] signature)` invokes the operation on mbean
`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
`protected Object`	`invokeMBeanOperation(String targetName, ObjectName objectName, String operationName, Object[] params, String[] signature)` invokes the operation on mbean on appropriate target
`protected boolean`	`isMBeanRegistered(ObjectName objectName)` Test whether an mbean is registered.
`protected boolean`	`isPlatformContextAdminServer()` Determine whether this instance is the administration server instance.
`protected boolean`	`isPlatformContextCluster(String targetName)` Determine whether a target is a cluster.
`protected boolean`	`isPlatformContextClusteredServer(String targetName)` Determine whether the target is a clustered server.
`protected boolean`	`isPlatformContextInstanceClustered(String instanceName)` Determine whether or not an instance is clustered.
`protected boolean`	`isPlatformContextInstanceUp(String instanceName)` Determine if the specified instance is up.
`protected boolean`	`isPlatformContextStandaloneServer(String targetName)` Determine whether a target is a standalone server.
`protected boolean`	`isPlatformContextValidTarget(String targetName)` Determine whether a target is a valid server or cluster name.
`protected boolean`	`isTargetUp(String targetName)` Checks to see if the Target (server, cluster) is up or down.
`protected boolean`	`isValidTarget(ObjectName objectName)` Test whether it is a valid target.
`protected boolean`	`isValidTarget(ObjectName objectName, String targetName)` Test whether it is a valid target.
`protected Map<String,String[]>`	`listTargetNames()` Returns a map of target names to an array of target instance names.
`protected static void`	`log(String aMsg)` logs the message
`protected static void`	`logDebug(Exception ex)` logs the message
`protected static void`	`logDebug(String aMsg)` logs the message
`protected static void`	`logError(Exception ex)` logs errors
`static void`	`logWarning(Exception ex)` logs warnings
`protected boolean`	`platformContextSupportsMultipleServers()` Determine whether multiple servers are permitted within this AS installation.
`protected void`	`setAttributeValue(MBeanServerConnection connection, ObjectName objectName, String attributeName, Object attributeValue)` Invokes the mbean and retrieves the attribute value
`protected void`	`setAttributeValue(ObjectName objectName, String attributeName, Object attributeValue)` Invokes the mbean and retrieves the attribute value
`protected void`	`setAttributeValue(String targetName, ObjectName objectName, String attributeName, Object attributeValue)` Invokes the mbean and retrieves the attribute value
`protected String`	`setLevel(Level logLevel)` Return the "verb" (the setXXX MBean operation) for the given log level
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - environmentContext
```
protected EnvironmentContext environmentContext
```
    Jbi Environment context.
  - componentConfigurationHelper
```
protected ComponentConfigurationHelper componentConfigurationHelper
```
    Component Configuration helper
  - DOMAIN_TARGET_KEY
```
protected static final String DOMAIN_TARGET_KEY
```
    See Also:
    Constant Field Values
  - SERVER_TARGET_KEY
```
protected static final String SERVER_TARGET_KEY
```
    See Also:
    Constant Field Values
  - CUSTOM_CONFIGURATION_NAME_KEY
```
protected static final String CUSTOM_CONFIGURATION_NAME_KEY
```
    See Also:
    Constant Field Values
  - CUSTOM_STATISTICS_NAME_KEY
```
protected static final String CUSTOM_STATISTICS_NAME_KEY
```
    See Also:
    Constant Field Values
  - CUSTOM_ADMINISTRATION_NAME_KEY
```
protected static final String CUSTOM_ADMINISTRATION_NAME_KEY
```
    See Also:
    Constant Field Values
  - CUSTOM_MANAGEMENT_ACTIONS_NAME_KEY
```
protected static final String CUSTOM_MANAGEMENT_ACTIONS_NAME_KEY
```
    See Also:
    Constant Field Values
  - CUSTOM_LOGGER_NAME_KEY
```
protected static final String CUSTOM_LOGGER_NAME_KEY
```
    See Also:
    Constant Field Values
  - 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
  - EQUAL
```
protected static final String EQUAL
```
    See Also:
    Constant Field Values
  - COLON
```
protected static final String COLON
```
    See Also:
    Constant Field Values
  - COMMA
```
protected static final String COMMA
```
    See Also:
    Constant Field Values
  - PASSWORD_MASK_CHARACTER
```
protected static final char PASSWORD_MASK_CHARACTER
```
    See Also:
    Constant Field Values
  - COMPONENT_CONFIG_INSTANCE_ERROR_KEY
```
protected static final String COMPONENT_CONFIG_INSTANCE_ERROR_KEY
```
    See Also:
    Constant Field Values
  - JMX_EBI_DOMAIN
```
protected static final String JMX_EBI_DOMAIN
```
    JMX Domain name for the Enterprise Business Integration JMX MBeans
    
    See Also:
    Constant Field Values
  - EBIJMXDOMAIN
```
protected static String EBIJMXDOMAIN
```
    Enterprise Business Integration JMX domain
  - SERVICE_TYPE_KEY
```
protected static final String SERVICE_TYPE_KEY
```
    See Also:
    Constant Field Values
  - IDENTIFICATION_NAME_KEY
```
protected static final String IDENTIFICATION_NAME_KEY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - AbstractServiceMBeansImpl
```
public AbstractServiceMBeansImpl(EnvironmentContext anEnvContext)
```
- Method Detail
  - log
```
protected static void log(String aMsg)
```
    logs the message
    
    Parameters:
    aMsg - message string
  - logDebug
```
protected static void logDebug(String aMsg)
```
    logs the message
    
    Parameters:
    aMsg - message string
  - logDebug
```
protected static void logDebug(Exception ex)
```
    logs the message
    
    Parameters:
    ex - exception
  - logError
```
protected 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
  - getI18NBundle
```
protected static I18NBundle getI18NBundle(String packageName)
```
    gives the I18N bundle
    
    Parameters:
    packageName -
    
    Returns:
    I18NBundle object
  - getAttributeValue
```
protected Object getAttributeValue(String targetName,
                       ObjectName objectName,
                       String attributeName)
                            throws ManagementRemoteException
```
    Invokes the mbean and retrieves the attribute value
    
    Parameters:
    targetName -
    objectName - object name
    attributeName - attribute name
    
    Returns:
    the value of the attribute
    
    Throws:
    
    ManagementRemoteException - on error
  - getAttributeValue
```
protected Object getAttributeValue(MBeanServer mbeanServer,
                       ObjectName objectName,
                       String attributeName)
                            throws ManagementRemoteException
```
    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:
    
    ManagementRemoteException - on error
  - getAttributeValue
```
protected Object getAttributeValue(MBeanServerConnection mbeanServer,
                       ObjectName objectName,
                       String attributeName)
                            throws ManagementRemoteException
```
    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:
    
    ManagementRemoteException - on error
  - getAttributeValue
```
protected Object getAttributeValue(ObjectName objectName,
                       String attributeName)
                            throws ManagementRemoteException
```
    Invokes the mbean and retrieves the attribute value
    
    Parameters:
    objectName - object name
    attributeName - attribute name
    
    Returns:
    the value of the attribute
    
    Throws:
    
    ManagementRemoteException - on error
  - setAttributeValue
```
protected void setAttributeValue(String targetName,
                     ObjectName objectName,
                     String attributeName,
                     Object attributeValue)
                          throws ManagementRemoteException
```
    Invokes the mbean and retrieves the attribute value
    
    Parameters:
    targetName -
    objectName - object name
    attributeName - attribute name
    
    Throws:
    
    ManagementRemoteException - on error
  - setAttributeValue
```
protected void setAttributeValue(ObjectName objectName,
                     String attributeName,
                     Object attributeValue)
                          throws ManagementRemoteException
```
    Invokes the mbean and retrieves the attribute value
    
    Parameters:
    objectName - object name
    attributeName - attribute name
    
    Throws:
    
    ManagementRemoteException - on error
  - setAttributeValue
```
protected void setAttributeValue(MBeanServerConnection connection,
                     ObjectName objectName,
                     String attributeName,
                     Object attributeValue)
                          throws ManagementRemoteException
```
    Invokes the mbean and retrieves the attribute value
    
    Parameters:
    connection -
    objectName - object name
    attributeName - attribute name
    
    Throws:
    
    ManagementRemoteException - on error
  - invokeMBeanOperation
```
protected Object invokeMBeanOperation(ObjectName objectName,
                          String operationName,
                          Object[] params,
                          String[] signature)
                               throws ManagementRemoteException
```
    invokes the operation on mbean
    
    Parameters:
    objectName - object name
    operationName - operation name
    params - parameters
    signature - signature of the parameters
    
    Returns:
    result object
    
    Throws:
    
    ManagementRemoteException - on user error
  - invokeMBeanOperation
```
protected Object invokeMBeanOperation(MBeanServerConnection connection,
                          ObjectName objectName,
                          String operationName,
                          Object[] params,
                          String[] signature)
                               throws ManagementRemoteException
```
    invokes the operation on mbean
    
    Parameters:
    connection -
    objectName - object name
    operationName - operation name
    params - parameters
    signature - signature of the parameters
    
    Returns:
    result object
    
    Throws:
    
    ManagementRemoteException - on user error
  - invokeMBeanOperation
```
protected Object invokeMBeanOperation(String targetName,
                          ObjectName objectName,
                          String operationName,
                          Object[] params,
                          String[] signature)
                               throws ManagementRemoteException
```
    invokes the operation on mbean on appropriate target
    
    Parameters:
    targetName -
    objectName - object name
    operationName - operation name
    params - parameters
    signature - signature of the parameters
    
    Returns:
    result object
    
    Throws:
    
    ManagementRemoteException - on user error
  - invokeMBeanOperation
```
protected Object invokeMBeanOperation(ObjectName objectName,
                          String operationName,
                          String param)
                               throws ManagementRemoteException
```
    invokes the operation on mbean
    
    Parameters:
    objectName - object name
    operationName - operation name
    param - operation param of type String
    
    Returns:
    result object
    
    Throws:
    
    ManagementRemoteException - on user error
  - invokeMBeanOperation
```
protected Object invokeMBeanOperation(ObjectName objectName,
                          String operationName)
                               throws ManagementRemoteException
```
    invokes the operation on mbean
    
    Parameters:
    objectName - object name
    operationName - operation name
    
    Returns:
    result object
    
    Throws:
    
    ManagementRemoteException - on user error
  - getMBeanAttribute
```
protected Object getMBeanAttribute(ObjectName objectName,
                       String attributeName)
                            throws ManagementRemoteException
```
    invokes the operation on mbean
    
    Parameters:
    attributeName - attribute name
    objectName - object name
    
    Returns:
    result object
    
    Throws:
    
    ManagementRemoteException - on user error
  - isMBeanRegistered
```
protected boolean isMBeanRegistered(ObjectName objectName)
                             throws ManagementRemoteException
```
    Test whether an mbean is registered.
    
    Parameters:
    objectName -
    
    Returns:
    true when the mbean is registered, false otherwise
    
    Throws:
    
    ManagementRemoteException
  - setLevel
```
protected String setLevel(Level logLevel)
```
    Return the "verb" (the setXXX MBean operation) for the given log level
    
    Parameters:
    logLevel - log level to set logger to
    
    Returns:
    a MBean operation to set the logger to that level
  - isValidTarget
```
protected boolean isValidTarget(ObjectName objectName)
                         throws ManagementRemoteException
```
    Test whether it is a valid target.
    
    Parameters:
    objectName -
    
    Returns:
    true when the mbean is registered, false otherwise
    
    Throws:
    
    ManagementRemoteException
  - isValidTarget
```
protected boolean isValidTarget(ObjectName objectName,
                    String targetName)
                         throws ManagementRemoteException
```
    Test whether it is a valid target.
    
    Parameters:
    objectName -
    targetName -
    
    Returns:
    true when the mbean is registered, false otherwise
    
    Throws:
    
    ManagementRemoteException
  - setMBeanAttribute
```
protected void setMBeanAttribute(ObjectName objectName,
                     String attributeName,
                     Object attributeValue)
                          throws ManagementRemoteException
```
    invokes the operation on mbean
    
    Parameters:
    attributeValue - attrbute name
    attributeName - attribute value
    objectName - object name
    
    Throws:
    
    ManagementRemoteException - on user error
  - setMBeanAttributes
```
protected void setMBeanAttributes(ObjectName objectName,
                      AttributeList attrList)
                           throws ManagementRemoteException
```
    set the specified attribute values on the mbean attributes
    
    Parameters:
    attrList - list of attributes
    objectName - object name
    
    Throws:
    
    ManagementRemoteException - on user error
  - setMBeanAttributes
```
protected AttributeList setMBeanAttributes(MBeanServerConnection mbeanServer,
                               ObjectName objectName,
                               AttributeList attrList)
                                    throws ManagementRemoteException
```
    set the specified attribute values on the mbean attributes
    
    Parameters:
    attrList - list of attributes
    objectName - object name
    
    Throws:
    
    ManagementRemoteException - on user error
  - constructMBeanAttributes
```
protected AttributeList constructMBeanAttributes(ObjectName objectName,
                                     Properties params)
                                          throws ManagementRemoteException
```
    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:
    
    ManagementRemoteException - on user error
  - constructMBeanAttributes
```
protected AttributeList constructMBeanAttributes(ObjectName objectName,
                                     Map<String,Object> params)
                                          throws ManagementRemoteException
```
    invokes the operation on mbean
    
    Parameters:
    objectName - mbean name
    params - a name value pair Map object contains the attribute name and its value.
    
    Returns:
    Attribute List of the mbean to set
    
    Throws:
    
    ManagementRemoteException - on user error
  - constructMBeanAttributes
```
protected AttributeList constructMBeanAttributes(MBeanServerConnection mbeanServer,
                                     ObjectName objectName,
                                     Properties params)
                                          throws ManagementRemoteException
```
    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:
    
    ManagementRemoteException - on user error
  - createManagementException
```
protected Exception createManagementException(String bundleKey,
                                  String[] args,
                                  Exception sourceException)
```
    Creates a management message string and populates the exception
    
    Parameters:
    bundleKey -
    args - of Strings
    sourceException - - the source exception to propagate
    
    Returns:
    Exception object created with a valid XML Management Message
  - createManagementMessage
```
protected String createManagementMessage(String taskId,
                             boolean successResult,
                             String msgType,
                             String msgCode,
                             Object[] args)
```
    Creates a management message.
    
    Parameters:
    taskId -
    successResult -
    msgType -
    msgCode -
    args -
    
    Returns:
  - getDeploymentServiceMBeanObjectName
```
protected 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.
  - getAdminServiceMBeanObjectName
```
protected ObjectName getAdminServiceMBeanObjectName()
                                             throws ManagementRemoteException
```
    returns the ObjectName for the AdminService Mbean of this component.
    
    Returns:
    the ObjectName of the InstallationService MBean or null.
    
    Throws:
    
    JBIRemoteException - on error.
    
    ManagementRemoteException
  - getAdminServiceMBeanObjectName
```
protected ObjectName getAdminServiceMBeanObjectName(String targetName)
```
    returns the ObjectName for the AdminService facade Mbean for a target
    
    Parameters:
    targetName -
    
    Returns:
    the ObjectName of the AdminService MBean or null.
  - getInstallationServiceMBeanObjectName
```
protected 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.
  - checkForValidTarget
```
protected void checkForValidTarget(ObjectName objectName,
                       String targetName)
                            throws ManagementRemoteException
```
    Check if a target is valid or not
    
    Parameters:
    objectName -
    targetName -
    
    Throws:
    
    ManagementRemoteException
  - checkForValidTarget
```
protected void checkForValidTarget(ObjectName objectName,
                       String targetName,
                       boolean useTargetNameFlag)
                            throws ManagementRemoteException
```
    Check if a target is valid or not
    
    Parameters:
    objectName -
    targetName -
    useTargetNameFlag -
    
    Throws:
    
    ManagementRemoteException
  - checkTargetType
```
protected TargetType checkTargetType(String target)
```
    Check the type of the specified target
    
    Parameters:
    targetName -
    
    Returns:
    an enum representing the type of the target.
  - getMBeanServerConnection
```
protected MBeanServerConnection getMBeanServerConnection(String targetName)
                                                  throws ManagementRemoteException
```
    Retrieve MBeanServerConnection for targets other than server
    
    Parameters:
    targetName -
    
    Returns:
    MBeanServerConnection
    
    Throws:
    
    ManagementRemoteException
  - getEbiJmxDomain
```
protected static String getEbiJmxDomain()
```
    gets the ebi jmx domain name
    
    Returns:
    domain name
  - getEbiStatusMBeanObjectName
```
protected ObjectName getEbiStatusMBeanObjectName(String componentName,
                                     String targetName)
                                          throws ManagementRemoteException
```
    Get the EBI Status MBean ObjectName
    
    Parameters:
    componentName -
    targetName -
    
    Returns:
    object name of ebi config MBean
    
    Throws:
    
    ManagementRemoteException
  - getMBeanAttributeValues
```
protected Properties getMBeanAttributeValues(MBeanServerConnection connection,
                                 ObjectName objectName)
                                      throws ManagementRemoteException
```
    Get the attributes on the MBean
    
    Parameters:
    connection -
    objectName -
    
    Returns:
    
    Throws:
    
    ManagementRemoteException
  - getMBeanAttributeValuesAsMap
```
protected Map<String,Object> getMBeanAttributeValuesAsMap(MBeanServerConnection connection,
                                              ObjectName objectName)
                                                   throws ManagementRemoteException
```
    Get the attributes on the MBean
    
    Parameters:
    connection -
    objectName -
    
    Returns:
    
    Throws:
    
    ManagementRemoteException
  - setMBeanConfigAttributes
```
protected String setMBeanConfigAttributes(ObjectName objectName,
                              AttributeList attrList)
                                   throws ManagementRemoteException
```
    set the specified attribute values on the mbean attributes
    
    Parameters:
    attrList - list of attributes
    objectName - object name
    
    Returns:
    management message response from setConfigurationAttributes
    
    Throws:
    
    ManagementRemoteException - on user error
  - setMBeanConfigAttributes
```
protected String setMBeanConfigAttributes(MBeanServerConnection mbeanServer,
                              ObjectName objectName,
                              AttributeList attrList)
                                   throws ManagementRemoteException
```
    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:
    
    ManagementRemoteException - on user error
  - getStackTrace
```
protected String getStackTrace(JBIRemoteException exception)
```
    Returns the stack-trace of the exception
    
    Parameters:
    exception -
    
    Returns:
    stack traces as a string
  - domainTargetCheck
```
protected void domainTargetCheck(String target)
                          throws ManagementRemoteException
```
    Check to ensure that the target is a domain target
    
    Throws:
    
    ManagementRemoteException - if target is domain
  - listTargetNames
```
protected Map<String,String[]> listTargetNames()
                                        throws ManagementRemoteException
```
    Returns a map of target names to an array of target instance names. In the case cluster targets, the key contains the cluster target name, and the the value contains an array of the "target instance" names. If it is not a cluster target, the key contains the targetName, and the value is null.
    
    Returns:
    map of target names to array of target instance names
    
    Throws:
    
    ManagementRemoteException
  - isTargetUp
```
protected boolean isTargetUp(String targetName)
                      throws ManagementRemoteException
```
    Checks to see if the Target (server, cluster) is up or down.
    
    Parameters:
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    true if Target is up, false if not
    
    Throws:
    
    ManagementRemoteException - if error or exception occurs.
  - findLiveExtensionMBeanObjectNames
```
protected Map<String,ObjectName[]> findLiveExtensionMBeanObjectNames(String componentName,
                                                         String extensionName,
                                                         String targetName)
                                                              throws ManagementRemoteException
```
    Find Extension MBeans for targets that are up
    
    Parameters:
    componentName -
    extensionName -
    targetName -
    
    Returns:
    map of instanceName to ObjectNames[] the contain live instances
    
    Throws:
    
    ManagementRemoteException
  - getComponentExtensionMBeanObjectNames
```
protected Map<String,ObjectName[]> getComponentExtensionMBeanObjectNames(String componentName,
                                                             String extensionName,
                                                             String targetName)
                                                                  throws ManagementRemoteException
```
    Gets the extension MBean object names
    
    Parameters:
    componentName - name of the component
    extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    
    Throws:
    
    ManagementRemoteException - on error
  - getComponentExtensionMBeanObjectNames
```
protected ObjectName[] getComponentExtensionMBeanObjectNames(String componentName,
                                                 String extensionName,
                                                 String targetName,
                                                 String targetInstanceName)
                                                      throws ManagementRemoteException
```
    Gets the extension MBean object names
    
    Parameters:
    componentName - name of the component
    extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    an array of ObjectName(s)
    
    Throws:
    
    ManagementRemoteException - on error
  - getExtensionMBeanObjectName
```
protected ObjectName getExtensionMBeanObjectName(String componentName,
                                     String targetName)
                                          throws ManagementRemoteException
```
    returns the ObjectName for the Extension Mbean of this component.
    
    Parameters:
    componentName -
    targetName -
    
    Returns:
    the ObjectName of the Extension MBean or null.
    
    Throws:
    
    ManagementRemoteException
  - getPlatformContextAdminServerName
```
protected String getPlatformContextAdminServerName()
```
    Get the instance name of the platform's administration server. If the platform does not provide a separate administration server, then this method returns the name of the local instance.
    
    Returns:
    instance name of the administration server
  - isPlatformContextAdminServer
```
protected boolean isPlatformContextAdminServer()
```
    Determine whether this instance is the administration server instance.
    
    Returns:
    true if this instance is the administration server, false if not.
  - getPlatformContextInstanceName
```
protected String getPlatformContextInstanceName()
```
    Get the name of this instance.
    
    Returns:
    the name of this server instance.
  - isPlatformContextInstanceUp
```
protected boolean isPlatformContextInstanceUp(String instanceName)
```
    Determine if the specified instance is up.
    
    Returns:
    true if the instance is up and running, false otherwise
  - platformContextSupportsMultipleServers
```
protected boolean platformContextSupportsMultipleServers()
```
    Determine whether multiple servers are permitted within this AS installation.
    
    Returns:
    true if multiple servers are permitted.
  - getPlatformContextTargetName
```
protected String getPlatformContextTargetName()
```
    Get the Target Name. If the instance is not a clustered instance then the target name is the instance name. If the instance is part of a cluster then the target name is the cluster name.
    
    Returns:
    the target name.
  - getPlatformContextTargetName
```
protected String getPlatformContextTargetName(String instanceName)
```
    Get the Target Name for a specified instance. If the instance is not clustered the instance name is returned. This operation is invoked by the JBI instance MBeans only.
    
    Returns:
    the target name.
  - getPlatformContextStandaloneServerNames
```
protected Set<String> getPlatformContextStandaloneServerNames()
```
    Get a set of the names of all the standalone servers in the domain.
    
    Returns:
    a set of names of standalone servers in the domain.
  - getPlatformContextClusteredServerNames
```
protected Set<String> getPlatformContextClusteredServerNames()
```
    Get a set of the names of all the clustered servers in the domain.
    
    Returns:
    a set of names of clustered servers in the domain.
  - getPlatformContextClusterNames
```
protected Set<String> getPlatformContextClusterNames()
```
    Get a set of the names of all the clusters in the domain.
    
    Returns:
    a set of names of clusters in the domain.
  - getPlatformContextServersInCluster
```
protected Set<String> getPlatformContextServersInCluster(String clusterName)
```
    Get a set of the names of all the servers in the specified cluster.
    
    Returns:
    a set of names of servers in the cluster.
  - isPlatformContextValidTarget
```
protected boolean isPlatformContextValidTarget(String targetName)
```
    Determine whether a target is a valid server or cluster name.
    
    Returns:
    true if targetName is a valid standalone server name or cluster name, false if not.
  - isPlatformContextCluster
```
protected boolean isPlatformContextCluster(String targetName)
```
    Determine whether a target is a cluster.
    
    Returns:
    true if targetName is a cluster, false if not.
  - isPlatformContextStandaloneServer
```
protected boolean isPlatformContextStandaloneServer(String targetName)
```
    Determine whether a target is a standalone server.
    
    Returns:
    true if targetName is a standalone server, false if not.
  - isPlatformContextClusteredServer
```
protected boolean isPlatformContextClusteredServer(String targetName)
```
    Determine whether the target is a clustered server.
    
    Returns:
    true if targetName is a clustered server, false if not.
  - isPlatformContextInstanceClustered
```
protected boolean isPlatformContextInstanceClustered(String instanceName)
```
    Determine whether or not an instance is clustered.
    
    Returns:
    true if the instance is clustered, false if not.
  - getPlatformContextJmxRmiPort
```
protected String getPlatformContextJmxRmiPort()
```
    Get a string representation of the DAS JMX RMI connector port.
    
    Returns:
    the JMX RMI connector port as a (CODE>String.
  - getPlatformContextMBeanServer
```
protected MBeanServer getPlatformContextMBeanServer()
```
    Provides access to the platform's MBean server.
    
    Returns:
    platform MBean server.
  - getPlatformContextInstanceRoot
```
protected String getPlatformContextInstanceRoot()
```
    Get the full path to the platform's instance root directory.
    
    Returns:
    platform instance root
  - getPlatformContextInstallRoot
```
protected String getPlatformContextInstallRoot()
```
    Get the full path to the platform's instaall root directory.
    
    Returns:
    platform install root

Class AbstractServiceMBeansImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

environmentContext

componentConfigurationHelper

DOMAIN_TARGET_KEY

SERVER_TARGET_KEY

CUSTOM_CONFIGURATION_NAME_KEY

CUSTOM_STATISTICS_NAME_KEY

CUSTOM_ADMINISTRATION_NAME_KEY

CUSTOM_MANAGEMENT_ACTIONS_NAME_KEY

CUSTOM_LOGGER_NAME_KEY

STARTED_STATE

RUNNING_STATE

EQUAL

COLON

COMMA

PASSWORD_MASK_CHARACTER

COMPONENT_CONFIG_INSTANCE_ERROR_KEY

JMX_EBI_DOMAIN

EBIJMXDOMAIN

SERVICE_TYPE_KEY

IDENTIFICATION_NAME_KEY

Constructor Detail

AbstractServiceMBeansImpl

Method Detail

log

logDebug

logDebug

logError

logWarning

getPlatformContext

getEnvironmentContext

getI18NBundle

getI18NBundle

getAttributeValue

getAttributeValue

getAttributeValue

getAttributeValue

setAttributeValue

setAttributeValue

setAttributeValue

invokeMBeanOperation

invokeMBeanOperation

invokeMBeanOperation

invokeMBeanOperation

invokeMBeanOperation

getMBeanAttribute

isMBeanRegistered

setLevel

isValidTarget

isValidTarget

setMBeanAttribute

setMBeanAttributes

setMBeanAttributes

constructMBeanAttributes

constructMBeanAttributes

constructMBeanAttributes

createManagementException

createManagementMessage

getDeploymentServiceMBeanObjectName

getAdminServiceMBeanObjectName

getAdminServiceMBeanObjectName

getInstallationServiceMBeanObjectName

checkForValidTarget

checkForValidTarget

checkTargetType

getMBeanServerConnection

getEbiJmxDomain

getEbiStatusMBeanObjectName

getMBeanAttributeValues

getMBeanAttributeValuesAsMap

setMBeanConfigAttributes

setMBeanConfigAttributes

getStackTrace

domainTargetCheck

listTargetNames