com.sun.esb.management.impl.administration

Class AdministrationServiceImpl

java.lang.Object

com.sun.esb.management.base.services.AbstractServiceImpl

com.sun.esb.management.impl.administration.AdministrationServiceImpl

All Implemented Interfaces:

AdministrationService, Serializable

public class AdministrationServiceImpl
extends AbstractServiceImpl
implements Serializable, AdministrationService

Defines client operations for common administration services for the client.

Author:

graj

See Also:

Serialized Form

Field Summary

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

CANNED_RESPONSE, I18NBUNDLE, isRemoteConnection, remoteConnection

Fields inherited from interface com.sun.esb.management.api.administration.AdministrationService

BUILD_NUMBER_KEY, COPYRIGHT_KEY, FULL_PRODUCT_NAME_KEY, MAJOR_VERSION_KEY, MINOR_VERSION_KEY, SHORT_PRODUCT_NAME_KEY, SYSTEM_INFORMATION_KEY

Constructor Summary

Constructors

Constructor and Description
AdministrationServiceImpl() Constructor - Constructs a new instance of AdministrationServiceImpl
AdministrationServiceImpl(MBeanServerConnection serverConnection) Constructor - Constructs a new instance of AdministrationServiceImpl
AdministrationServiceImpl(MBeanServerConnection serverConnection, boolean isRemoteConnection) Constructor - Constructs a new instance of AdministrationServiceImpl

Method Summary

Methods

Modifier and Type	Method and Description
String	getAdminServerName() Get the instance name of the platform's administration server.
Set<String>	getClusteredServerNames() Get a set of the names of all the clustered servers in the domain.
Set<String>	getClusterNames() Get a set of the names of all the clusters in the domain.
String	getComponentInstallationDescriptor(String componentName) Retrieve the Component Installation descriptor for the server target.
String	getComponentState(String componentName, String targetName) Gets the component state
String	getComponentType(String componentName, String targetName) Gets the component type
MBeanServerConnection	getConnectionForInstance(String instanceName) Get the MBean server connection for a particular instance.
String[]	getConsumingEndpoints(String componentName, String targetName) Get the list of consuming endpoints
String	getInstallRoot() Get the full path to the platform's instaall root directory.
String	getInstanceName() Get the name of this instance.
String	getInstanceRoot() Get the full path to the platform's instance root directory.
String	getJmxRmiPort() Get a string representation of the DAS JMX RMI connector port.
String[]	getProvisioningEndpoints(String componentName, String targetName) Get the list of provisioning endpoints
Map<String,Properties>	getRuntimeDetails() Retrieve runtime version information
Set<String>	getServersInCluster(String clusterName) Get a set of the names of all the servers in the specified cluster.
String	getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName) Returns the jbi.xml Deployment Descriptor for a Service Assembly.
String	getServiceAssemblyState(String serviceAssemblyName, String targetName) Gets the Service Assembly state
String	getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName) Returns the jbi.xml Deployment Descriptor for a Service Unit.
String	getSharedLibraryInstallationDescriptor(String sharedLibraryName) Returns the jbi.xml Installation Descriptor for a Shared Library.
Set<String>	getStandaloneServerNames() Get a set of the names of all the standalone servers in the domain.
String	getTargetName() Get the Target Name.
String	getTargetName(String instanceName) Get the Target Name for a specified instance.
String	getWSDLDefinition(String componentName, String endpoint, String targetName) Retrieves the primary WSDL associated with the specified endpoint.
String	getWSDLImportedResource(String componentName, String endpoint, String targetNamespace, String targetName) Retrieves the WSDL or XSD associated with the specified endpoint and targetNamespace
boolean	isAdminServer() Determine whether this instance is the administration server instance.
boolean	isBindingComponent(String componentName) check for BindingComponent
boolean	isCluster(String targetName) Determine whether a target is a cluster.
boolean	isClusteredServer(String targetName) Determine whether the target is a clustered server.
boolean	isInstanceClustered(String instanceName) Determine whether or not an instance is clustered.
boolean	isInstanceUp(String instanceName) Determine if the specified instance is up.
boolean	isJBIComponentInstalled(String componentName, String targetName) Checks to see if a component/library is installed on a target
boolean	isJBIRuntimeEnabled() Checks to see if the JBI Runtime is enabled.
boolean	isServiceAssemblyDeployed(String serviceAssemblyName, String targetName) Checks to see if a Service Assembly is deployed on a target
boolean	isServiceEngine(String componentName) check for ServiceEngine
boolean	isStandaloneServer(String targetName) Determine whether a target is a standalone server.
boolean	isTargetUp(String targetName) Checks to see if the Target (server, cluster) is up or down.
boolean	isValidTarget(String targetName) Determine whether a target is a valid server or cluster name.
Map<String,String[]>	listTargetNames() Returns a map of target names to an array of target instance names.
boolean	supportsMultipleServers() Determine whether multiple servers are permitted within this AS installation.

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

getAdministrationServiceMBeanObjectName, getConfigurationServiceMBeanObjectName, getDeploymentServiceMBeanObjectName, getI18NBundle, getInstallationServiceMBeanObjectName, getMBeanServerConnection, getNotificationServiceMBeanObjectName, getPerformanceMeasurementServiceMBeanObjectName, getRuntimeManagementServiceMBeanObjectName, invokeMBeanOperation, invokeMBeanOperation, isRegistered, isRemoteConnection, queryNames

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministrationServiceImpl

public AdministrationServiceImpl()

Constructor - Constructs a new instance of AdministrationServiceImpl

AdministrationServiceImpl

public AdministrationServiceImpl(MBeanServerConnection serverConnection)

Constructor - Constructs a new instance of AdministrationServiceImpl

Parameters:

serverConnection -

AdministrationServiceImpl

public AdministrationServiceImpl(MBeanServerConnection serverConnection,
                         boolean isRemoteConnection)

Constructor - Constructs a new instance of AdministrationServiceImpl

Parameters:

serverConnection -

isRemoteConnection -

Method Detail

listTargetNames

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

Specified by:

listTargetNames in interface AdministrationService

Overrides:

listTargetNames in class AbstractServiceImpl

Returns:

map of target names to array of target instance names

Throws:

ManagementRemoteException

getRuntimeDetails

public Map<String,Properties> getRuntimeDetails()
                                         throws ManagementRemoteException

Retrieve runtime version information

Specified by:

getRuntimeDetails in interface AdministrationService

Returns:

map of targetName to Properties elements detailing version info

Throws:

ManagementRemoteException

isTargetUp

public boolean isTargetUp(String targetName)
                   throws ManagementRemoteException

Checks to see if the Target (server, cluster) is up or down.

Specified by:

isTargetUp in interface AdministrationService

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.

See Also:

com.sun.esb.management.api.runtime.RuntimeManagementService#isTargetUp(java.lang.String)

getComponentInstallationDescriptor

public String getComponentInstallationDescriptor(String componentName)
                                          throws ManagementRemoteException

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.

Specified by:

getComponentInstallationDescriptor in interface AdministrationService

Parameters:

Component - name as a string

Returns:

the Component Installation descriptor as a string

Throws:

ManagementRemoteException - on error

See Also:

AdministrationService.getComponentInstallationDescriptor(java.lang.String)

getServiceAssemblyDeploymentDescriptor

public String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
                                              throws ManagementRemoteException

Returns the jbi.xml Deployment Descriptor for a Service Assembly.

Specified by:

getServiceAssemblyDeploymentDescriptor in interface AdministrationService

Parameters:

the - name of the Service Assembly

Returns:

the jbi.xml deployment descriptor of the archive

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

AdministrationService.getServiceAssemblyDeploymentDescriptor(java.lang.String)

getServiceUnitDeploymentDescriptor

public String getServiceUnitDeploymentDescriptor(String serviceAssemblyName,
                                        String serviceUnitName)
                                          throws ManagementRemoteException

Returns the jbi.xml Deployment Descriptor for a Service Unit.

Specified by:

getServiceUnitDeploymentDescriptor in interface AdministrationService

Parameters:

the - name of the Service Assembly

the - name of the Service Unit

Returns:

the jbi.xml deployment descriptor of the archive

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

AdministrationService.getServiceUnitDeploymentDescriptor(java.lang.String, java.lang.String)

getSharedLibraryInstallationDescriptor

public String getSharedLibraryInstallationDescriptor(String sharedLibraryName)
                                              throws ManagementRemoteException

Returns the jbi.xml Installation Descriptor for a Shared Library.

Specified by:

getSharedLibraryInstallationDescriptor in interface AdministrationService

Parameters:

the - name of the Shared Library

Returns:

the jbi.xml deployment descriptor of the archive

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

AdministrationService.getSharedLibraryInstallationDescriptor(java.lang.String)

isJBIRuntimeEnabled

public boolean isJBIRuntimeEnabled()
                            throws ManagementRemoteException

Checks to see if the JBI Runtime is enabled.

Specified by:

isJBIRuntimeEnabled in interface AdministrationService

Returns:

true if JBI Runtime Framework is available, false if not

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

AdministrationService.isJBIRuntimeEnabled()

isServiceEngine

public boolean isServiceEngine(String componentName)
                        throws ManagementRemoteException

check for ServiceEngine

Specified by:

isServiceEngine in interface AdministrationService

Parameters:

the - name of the ServiceEngine or Binding Component

Returns:

true if it is a Service Engine else false.

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

AdministrationService.isServiceEngine(java.lang.String)

isBindingComponent

public boolean isBindingComponent(String componentName)
                           throws ManagementRemoteException

check for BindingComponent

Specified by:

isBindingComponent in interface AdministrationService

Parameters:

the - name of the ServiceEngine or Binding Component

Returns:

true if it is a Binding Component else false.

Throws:

ManagementRemoteException - if error or exception occurs.

See Also:

AdministrationService.isBindingComponent(java.lang.String)

getConsumingEndpoints

public String[] getConsumingEndpoints(String componentName,
                             String targetName)
                               throws ManagementRemoteException

Get the list of consuming endpoints

Specified by:

getConsumingEndpoints in interface AdministrationService

Parameters:

componentName -

targetName -

Returns:

Returns the consumingEndpoints.

Throws:

ManagementRemoteException

See Also:

AdministrationService.getConsumingEndpoints(java.lang.String, String)

getProvisioningEndpoints

public String[] getProvisioningEndpoints(String componentName,
                                String targetName)
                                  throws ManagementRemoteException

Get the list of provisioning endpoints

Specified by:

getProvisioningEndpoints in interface AdministrationService

Parameters:

componentName -

targetName -

Returns:

Returns the provisioningEndpoints.

Throws:

ManagementRemoteException

See Also:

AdministrationService.getProvisioningEndpoints(java.lang.String, String)

getWSDLDefinition

public String getWSDLDefinition(String componentName,
                       String endpoint,
                       String targetName)
                         throws ManagementRemoteException

Retrieves the primary WSDL associated with the specified endpoint.

Specified by:

getWSDLDefinition in interface AdministrationService

Parameters:

componentName -

endpoint -

targetName -

Returns:

primary WSDL associated with the endpoint

Throws:

ManagementRemoteException

See Also:

AdministrationService.getWSDLDefinition(String,String,String)

getWSDLImportedResource

public String getWSDLImportedResource(String componentName,
                             String endpoint,
                             String targetNamespace,
                             String targetName)
                               throws ManagementRemoteException

Retrieves the WSDL or XSD associated with the specified endpoint and targetNamespace

Specified by:

getWSDLImportedResource in interface AdministrationService

Parameters:

componentName -

endpoint -

targetNamespace -

targetName -

Returns:

wsdl or xsd

Throws:

ManagementRemoteException

See Also:

AdministrationService.getWSDLImportedResource(String, String, String, String)

getComponentState

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

Gets the component state

Specified by:

getComponentState in interface AdministrationService

Parameters:

componentName -

targetName -

Returns:

the state of the component

Throws:

ManagementRemoteException

See Also:

AdministrationService.getComponentState(java.lang.String, java.lang.String)

getComponentType

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

Gets the component type

Specified by:

getComponentType in interface AdministrationService

Parameters:

componentName -

targetName -

Returns:

the type of the component (binding-component, service-engine, or shared-library)

Throws:

ManagementRemoteException

See Also:

AdministrationService.getComponentType(java.lang.String, java.lang.String)

getServiceAssemblyState

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

Gets the Service Assembly state

Specified by:

getServiceAssemblyState in interface AdministrationService

Parameters:

serviceAssemblyName -

targetName -

Returns:

the state of the Service Assembly

Throws:

ManagementRemoteException

See Also:

AdministrationService.getServiceAssemblyState(java.lang.String, java.lang.String)

isJBIComponentInstalled

public boolean isJBIComponentInstalled(String componentName,
                              String targetName)
                                throws ManagementRemoteException

Checks to see if a component/library is installed on a target

Specified by:

isJBIComponentInstalled in interface AdministrationService

Parameters:

componentName -

targetName -

Returns:

true if installed, false if not

Throws:

ManagementRemoteException

See Also:

AdministrationService.isJBIComponentInstalled(java.lang.String, java.lang.String)

isServiceAssemblyDeployed

public boolean isServiceAssemblyDeployed(String serviceAssemblyName,
                                String targetName)
                                  throws ManagementRemoteException

Checks to see if a Service Assembly is deployed on a target

Specified by:

isServiceAssemblyDeployed in interface AdministrationService

Parameters:

serviceAssemblyName -

targetName -

Returns:

true if deployed, false if not

Throws:

ManagementRemoteException

See Also:

AdministrationService.isServiceAssemblyDeployed(java.lang.String, java.lang.String)

getAdminServerName

public String getAdminServerName()
                          throws ManagementRemoteException

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.

Specified by:

getAdminServerName in interface AdministrationService

Returns:

instance name of the administration server

Throws:

ManagementRemoteException

isAdminServer

public boolean isAdminServer()
                      throws ManagementRemoteException

Determine whether this instance is the administration server instance.

Specified by:

isAdminServer in interface AdministrationService

Returns:

true if this instance is the administration server, false if not.

Throws:

ManagementRemoteException

getInstanceName

public String getInstanceName()
                       throws ManagementRemoteException

Get the name of this instance.

Specified by:

getInstanceName in interface AdministrationService

Returns:

the name of this server instance.

Throws:

ManagementRemoteException

isInstanceUp

public boolean isInstanceUp(String instanceName)
                     throws ManagementRemoteException

Determine if the specified instance is up.

Specified by:

isInstanceUp in interface AdministrationService

Returns:

true if the instance is up and running, false otherwise

Throws:

ManagementRemoteException

supportsMultipleServers

public boolean supportsMultipleServers()
                                throws ManagementRemoteException

Determine whether multiple servers are permitted within this AS installation.

Specified by:

supportsMultipleServers in interface AdministrationService

Returns:

true if multiple servers are permitted.

Throws:

ManagementRemoteException

getTargetName

public String getTargetName()
                     throws ManagementRemoteException

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.

Specified by:

getTargetName in interface AdministrationService

Returns:

the target name.

Throws:

ManagementRemoteException

getTargetName

public String getTargetName(String instanceName)
                     throws ManagementRemoteException

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.

Specified by:

getTargetName in interface AdministrationService

Returns:

the target name.

Throws:

ManagementRemoteException

getStandaloneServerNames

public Set<String> getStandaloneServerNames()
                                     throws ManagementRemoteException

Get a set of the names of all the standalone servers in the domain.

Specified by:

getStandaloneServerNames in interface AdministrationService

Returns:

a set of names of standalone servers in the domain.

Throws:

ManagementRemoteException

getClusteredServerNames

public Set<String> getClusteredServerNames()
                                    throws ManagementRemoteException

Get a set of the names of all the clustered servers in the domain.

Specified by:

getClusteredServerNames in interface AdministrationService

Returns:

a set of names of clustered servers in the domain.

Throws:

ManagementRemoteException

getClusterNames

public Set<String> getClusterNames()
                            throws ManagementRemoteException

Get a set of the names of all the clusters in the domain.

Specified by:

getClusterNames in interface AdministrationService

Returns:

a set of names of clusters in the domain.

Throws:

ManagementRemoteException

getServersInCluster

public Set<String> getServersInCluster(String clusterName)
                                throws ManagementRemoteException

Get a set of the names of all the servers in the specified cluster.

Specified by:

getServersInCluster in interface AdministrationService

Returns:

a set of names of servers in the cluster.

Throws:

ManagementRemoteException

isValidTarget

public boolean isValidTarget(String targetName)
                      throws ManagementRemoteException

Determine whether a target is a valid server or cluster name.

Specified by:

isValidTarget in interface AdministrationService

Returns:

true if targetName is a valid standalone server name or cluster name, false if not.

Throws:

ManagementRemoteException

isCluster

public boolean isCluster(String targetName)
                  throws ManagementRemoteException

Determine whether a target is a cluster.

Specified by:

isCluster in interface AdministrationService

Returns:

true if targetName is a cluster, false if not.

Throws:

ManagementRemoteException

isStandaloneServer

public boolean isStandaloneServer(String targetName)
                           throws ManagementRemoteException

Determine whether a target is a standalone server.

Specified by:

isStandaloneServer in interface AdministrationService

Returns:

true if targetName is a standalone server, false if not.

Throws:

ManagementRemoteException

isClusteredServer

public boolean isClusteredServer(String targetName)
                          throws ManagementRemoteException

Determine whether the target is a clustered server.

Specified by:

isClusteredServer in interface AdministrationService

Returns:

true if targetName is a clustered server, false if not.

Throws:

ManagementRemoteException

isInstanceClustered

public boolean isInstanceClustered(String instanceName)
                            throws ManagementRemoteException

Determine whether or not an instance is clustered.

Specified by:

isInstanceClustered in interface AdministrationService

Returns:

true if the instance is clustered, false if not.

Throws:

ManagementRemoteException

getJmxRmiPort

public String getJmxRmiPort()
                     throws ManagementRemoteException

Get a string representation of the DAS JMX RMI connector port.

Specified by:

getJmxRmiPort in interface AdministrationService

Returns:

the JMX RMI connector port as a (CODE>String.

Throws:

ManagementRemoteException

getInstanceRoot

public String getInstanceRoot()
                       throws ManagementRemoteException

Get the full path to the platform's instance root directory.

Specified by:

getInstanceRoot in interface AdministrationService

Returns:

platform instance root

Throws:

ManagementRemoteException

getInstallRoot

public String getInstallRoot()
                      throws ManagementRemoteException

Get the full path to the platform's instaall root directory.

Specified by:

getInstallRoot in interface AdministrationService

Returns:

platform install root

Throws:

ManagementRemoteException

getConnectionForInstance

public MBeanServerConnection getConnectionForInstance(String instanceName)
                                               throws ManagementRemoteException

Get the MBean server connection for a particular instance.

Specified by:

getConnectionForInstance in interface AdministrationService

Returns:

the MBeanServerConnection for the specified instance.

Throws:

ManagementRemoteException