com.sun.esb.management.api.administration

Interface AdministrationService

All Known Implementing Classes:

AdministrationServiceImpl

public interface AdministrationService

Defines operations for common administration services.

Author:

graj

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_NUMBER_KEY
static String	COPYRIGHT_KEY
static String	FULL_PRODUCT_NAME_KEY
static String	MAJOR_VERSION_KEY
static String	MINOR_VERSION_KEY
static String	SHORT_PRODUCT_NAME_KEY
static String	SYSTEM_INFORMATION_KEY

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) Returns the jbi.xml Installation Descriptor for a Service Engine/Binding Component.
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.

Field Detail

SYSTEM_INFORMATION_KEY

static final String SYSTEM_INFORMATION_KEY

See Also:

Constant Field Values

BUILD_NUMBER_KEY

static final String BUILD_NUMBER_KEY

See Also:

Constant Field Values

COPYRIGHT_KEY

static final String COPYRIGHT_KEY

See Also:

Constant Field Values

FULL_PRODUCT_NAME_KEY

static final String FULL_PRODUCT_NAME_KEY

See Also:

Constant Field Values

MAJOR_VERSION_KEY

static final String MAJOR_VERSION_KEY

See Also:

Constant Field Values

MINOR_VERSION_KEY

static final String MINOR_VERSION_KEY

See Also:

Constant Field Values

SHORT_PRODUCT_NAME_KEY

static final String SHORT_PRODUCT_NAME_KEY

See Also:

Constant Field Values

Method Detail

listTargetNames

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

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.

getComponentInstallationDescriptor

String getComponentInstallationDescriptor(String componentName)
                                          throws ManagementRemoteException

Returns the jbi.xml Installation Descriptor for a Service Engine/Binding Component.

Parameters:

the - name of the ServiceEngine or Binding Component

Returns:

the jbi.xml deployment descriptor of the archive

Throws:

ManagementRemoteException - if error or exception occurs.

getComponentState

String getComponentState(String componentName,
                       String targetName)
                         throws ManagementRemoteException

Gets the component state

Parameters:

componentName -

targetName -

Returns:

the state of the component

Throws:

ManagementRemoteException

getComponentType

String getComponentType(String componentName,
                      String targetName)
                        throws ManagementRemoteException

Gets the component type

Parameters:

componentName -

targetName -

Returns:

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

Throws:

ManagementRemoteException

getConsumingEndpoints

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

Get the list of consuming endpoints

Parameters:

componentName -

targetName -

Returns:

Returns the consumingEndpoints.

Throws:

ManagementRemoteException

getProvisioningEndpoints

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

Get the list of provisioning endpoints

Parameters:

componentName -

targetName -

Returns:

Returns the provisioningEndpoints.

Throws:

ManagementRemoteException

getServiceAssemblyDeploymentDescriptor

String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
                                              throws ManagementRemoteException

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

Parameters:

the - name of the Service Assembly

Returns:

the jbi.xml deployment descriptor of the archive

Throws:

ManagementRemoteException - if error or exception occurs.

getServiceAssemblyState

String getServiceAssemblyState(String serviceAssemblyName,
                             String targetName)
                               throws ManagementRemoteException

Gets the Service Assembly state

Parameters:

serviceAssemblyName -

targetName -

Returns:

the state of the Service Assembly

Throws:

ManagementRemoteException

getServiceUnitDeploymentDescriptor

String getServiceUnitDeploymentDescriptor(String serviceAssemblyName,
                                        String serviceUnitName)
                                          throws ManagementRemoteException

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

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.

getSharedLibraryInstallationDescriptor

String getSharedLibraryInstallationDescriptor(String sharedLibraryName)
                                              throws ManagementRemoteException

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

Parameters:

the - name of the Shared Library

Returns:

the jbi.xml deployment descriptor of the archive

Throws:

ManagementRemoteException - if error or exception occurs.

getWSDLDefinition

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

Retrieves the primary WSDL associated with the specified endpoint.

Parameters:

componentName -

endpoint -

targetName -

Returns:

primary WSDL associated with the endpoint

Throws:

ManagementRemoteException

getWSDLImportedResource

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

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

Parameters:

componentName -

endpoint -

targetNamespace -

targetName -

Returns:

wsdl or xsd

Throws:

ManagementRemoteException

isBindingComponent

boolean isBindingComponent(String componentName)
                           throws ManagementRemoteException

check for BindingComponent

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.

isJBIComponentInstalled

boolean isJBIComponentInstalled(String componentName,
                              String targetName)
                                throws ManagementRemoteException

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

Parameters:

componentName -

targetName -

Returns:

true if installed, false if not

Throws:

ManagementRemoteException

isJBIRuntimeEnabled

boolean isJBIRuntimeEnabled()
                            throws ManagementRemoteException

Checks to see if the JBI Runtime is enabled.

Returns:

true if JBI Runtime Framework is available, false if not

Throws:

ManagementRemoteException - if error or exception occurs.

isServiceAssemblyDeployed

boolean isServiceAssemblyDeployed(String serviceAssemblyName,
                                String targetName)
                                  throws ManagementRemoteException

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

Parameters:

serviceAssemblyName -

targetName -

Returns:

true if deployed, false if not

Throws:

ManagementRemoteException

isServiceEngine

boolean isServiceEngine(String componentName)
                        throws ManagementRemoteException

check for ServiceEngine

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.

getRuntimeDetails

Map<String,Properties> getRuntimeDetails()
                                         throws ManagementRemoteException

Retrieve runtime version information

Returns:

map of targetName to Properties elements detailing version info

Throws:

ManagementRemoteException

getAdminServerName

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.

Returns:

instance name of the administration server

Throws:

ManagementRemoteException

isAdminServer

boolean isAdminServer()
                      throws ManagementRemoteException

Determine whether this instance is the administration server instance.

Returns:

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

Throws:

ManagementRemoteException

getInstanceName

String getInstanceName()
                       throws ManagementRemoteException

Get the name of this instance.

Returns:

the name of this server instance.

Throws:

ManagementRemoteException

isInstanceUp

boolean isInstanceUp(String instanceName)
                     throws ManagementRemoteException

Determine if the specified instance is up.

Returns:

true if the instance is up and running, false otherwise

Throws:

ManagementRemoteException

supportsMultipleServers

boolean supportsMultipleServers()
                                throws ManagementRemoteException

Determine whether multiple servers are permitted within this AS installation.

Returns:

true if multiple servers are permitted.

Throws:

ManagementRemoteException

getTargetName

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.

Returns:

the target name.

Throws:

ManagementRemoteException

getTargetName

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.

Returns:

the target name.

Throws:

ManagementRemoteException

getStandaloneServerNames

Set<String> getStandaloneServerNames()
                                     throws ManagementRemoteException

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.

Throws:

ManagementRemoteException

getClusteredServerNames

Set<String> getClusteredServerNames()
                                    throws ManagementRemoteException

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.

Throws:

ManagementRemoteException

getClusterNames

Set<String> getClusterNames()
                            throws ManagementRemoteException

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

Returns:

a set of names of clusters in the domain.

Throws:

ManagementRemoteException

getServersInCluster

Set<String> getServersInCluster(String clusterName)
                                throws ManagementRemoteException

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

Returns:

a set of names of servers in the cluster.

Throws:

ManagementRemoteException

isValidTarget

boolean isValidTarget(String targetName)
                      throws ManagementRemoteException

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.

Throws:

ManagementRemoteException

isCluster

boolean isCluster(String targetName)
                  throws ManagementRemoteException

Determine whether a target is a cluster.

Returns:

true if targetName is a cluster, false if not.

Throws:

ManagementRemoteException

isStandaloneServer

boolean isStandaloneServer(String targetName)
                           throws ManagementRemoteException

Determine whether a target is a standalone server.

Returns:

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

Throws:

ManagementRemoteException

isClusteredServer

boolean isClusteredServer(String targetName)
                          throws ManagementRemoteException

Determine whether the target is a clustered server.

Returns:

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

Throws:

ManagementRemoteException

isInstanceClustered

boolean isInstanceClustered(String instanceName)
                            throws ManagementRemoteException

Determine whether or not an instance is clustered.

Returns:

true if the instance is clustered, false if not.

Throws:

ManagementRemoteException

getJmxRmiPort

String getJmxRmiPort()
                     throws ManagementRemoteException

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

Returns:

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

Throws:

ManagementRemoteException

getInstanceRoot

String getInstanceRoot()
                       throws ManagementRemoteException

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

Returns:

platform instance root

Throws:

ManagementRemoteException

getInstallRoot

String getInstallRoot()
                      throws ManagementRemoteException

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

Returns:

platform install root

Throws:

ManagementRemoteException

getConnectionForInstance

MBeanServerConnection getConnectionForInstance(String instanceName)
                                               throws ManagementRemoteException

Get the MBean server connection for a particular instance.

Returns:

the MBeanServerConnection for the specified instance.

Throws:

ManagementRemoteException