Java Doc for AdministrationService.java in » ESB » open-esb » com » sun » esb » management » api » administration » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » ESB » open esb » com.sun.esb.management.api.administration

Source Cross Reference Class Diagram Java Document (Java Doc)

com.sun.esb.management.api.administration .AdministrationService

All known Subclasses:   com.sun.esb.management.impl.administration .AdministrationServiceMBeanImpl,  com.sun.esb.management.impl.administration .AdministrationServiceImpl,
AdministrationService
public interface AdministrationService (Code)
Defines operations for common administration services.
author:
   graj

Field Summary
final public static String BUILD_NUMBER_KEY

final public static String COPYRIGHT_KEY

final public static String FULL_PRODUCT_NAME_KEY

final public static String MAJOR_VERSION_KEY

final public static String MINOR_VERSION_KEY

final public static String SHORT_PRODUCT_NAME_KEY

final public static String SYSTEM_INFORMATION_KEY


Method Summary
public String getAdminServerName()
     Get the instance name of the platform's administration server.
public Set<String> getClusterNames()
     Get a set of the names of all the clusters in the domain.
public Set<String> getClusteredServerNames()
     Get a set of the names of all the clustered servers in the domain.
public String getComponentInstallationDescriptor(String componentName)
     Returns the jbi.xml Installation Descriptor for a Service Engine/Binding Component.
public String getComponentState(String componentName, String targetName)

public String getComponentType(String componentName, String targetName)

public MBeanServerConnection getConnectionForInstance(String instanceName)
     Get the MBean server connection for a particular instance.
public String[] getConsumingEndpoints(String componentName, String targetName)

public String getInstallRoot()
     Get the full path to the platform's instaall root directory.
public String getInstanceName()
     Get the name of this instance.
public String getInstanceRoot()
     Get the full path to the platform's instance root directory.
public String getJmxRmiPort()
     Get a string representation of the DAS JMX RMI connector port.
public String[] getProvisioningEndpoints(String componentName, String targetName)

public Map<String /*targetName*/, Properties getRuntimeDetails()

public Set<String> getServersInCluster(String clusterName)
     Get a set of the names of all the servers in the specified cluster.
public String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
     Returns the jbi.xml Deployment Descriptor for a Service Assembly.
public String getServiceAssemblyState(String serviceAssemblyName, String targetName)

public String getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName)
     Returns the jbi.xml Deployment Descriptor for a Service Unit.
public String getSharedLibraryInstallationDescriptor(String sharedLibraryName)
     Returns the jbi.xml Installation Descriptor for a Shared Library.
public Set<String> getStandaloneServerNames()
     Get a set of the names of all the standalone servers in the domain.
public String getTargetName()
     Get the Target Name.
public String getTargetName(String instanceName)
     Get the Target Name for a specified instance.
public String getWSDLDefinition(String componentName, String endpoint, String targetName)
     Retrieves the primary WSDL associated with the specified endpoint.
public String getWSDLImportedResource(String componentName, String endpoint, String targetNamespace, String targetName)

public boolean isAdminServer()
     Determine whether this instance is the administration server instance.
public boolean isBindingComponent(String componentName)

public boolean isCluster(String targetName)
     Determine whether a target is a cluster.
public boolean isClusteredServer(String targetName)
     Determine whether the target is a clustered server.
public boolean isInstanceClustered(String instanceName)
     Determine whether or not an instance is clustered.
public boolean isInstanceUp(String instanceName)
     Determine if the specified instance is up.
public boolean isJBIComponentInstalled(String componentName, String targetName)

public boolean isJBIRuntimeEnabled()
     Checks to see if the JBI Runtime is enabled.
public boolean isServiceAssemblyDeployed(String serviceAssemblyName, String targetName)

public boolean isServiceEngine(String componentName)

public boolean isStandaloneServer(String targetName)
     Determine whether a target is a standalone server.
public boolean isTargetUp(String targetName)
     Checks to see if the Target (server, cluster) is up or down.
public boolean isValidTarget(String targetName)
     Determine whether a target is a valid server or cluster name.
public Map<String /*targetName*/, String[] listTargetNames()
     Returns a map of target names to an array of target instance names.
public boolean supportsMultipleServers()
     Determine whether multiple servers are permitted within this AS installation.

Field Detail
BUILD_NUMBER_KEY
final public static String BUILD_NUMBER_KEY(Code)

COPYRIGHT_KEY
final public static String COPYRIGHT_KEY(Code)

FULL_PRODUCT_NAME_KEY
final public static String FULL_PRODUCT_NAME_KEY(Code)

MAJOR_VERSION_KEY
final public static String MAJOR_VERSION_KEY(Code)

MINOR_VERSION_KEY
final public static String MINOR_VERSION_KEY(Code)

SHORT_PRODUCT_NAME_KEY
final public static String SHORT_PRODUCT_NAME_KEY(Code)

SYSTEM_INFORMATION_KEY
final public static String SYSTEM_INFORMATION_KEY(Code)

Method Detail
getAdminServerName
public String getAdminServerName() throws ManagementRemoteException(Code)
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. instance name of the administration server
throws:
  ManagementRemoteException -

getClusterNames
public Set<String> getClusterNames() throws ManagementRemoteException(Code)
Get a set of the names of all the clusters in the domain. a set of names of clusters in the domain.
throws:
  ManagementRemoteException -

getClusteredServerNames
public Set<String> getClusteredServerNames() throws ManagementRemoteException(Code)
Get a set of the names of all the clustered servers in the domain. a set of names of clustered servers in the domain.
throws:
  ManagementRemoteException -

getComponentInstallationDescriptor
public String getComponentInstallationDescriptor(String componentName) throws ManagementRemoteException(Code)
Returns the jbi.xml Installation Descriptor for a Service Engine/Binding Component.
Parameters:
  the - name of the ServiceEngine or Binding Component the jbi.xml deployment descriptor of the archive
throws:
  ManagementRemoteException - if error or exception occurs.

getComponentState
public String getComponentState(String componentName, String targetName) throws ManagementRemoteException(Code)
Gets the component state
Parameters:
  componentName -
Parameters:
  targetName - the state of the component
throws:
  ManagementRemoteException -

getComponentType
public String getComponentType(String componentName, String targetName) throws ManagementRemoteException(Code)
Gets the component type
Parameters:
  componentName -
Parameters:
  targetName - the type of the component (binding-component, service-engine, orshared-library)
throws:
  ManagementRemoteException -

getConnectionForInstance
public MBeanServerConnection getConnectionForInstance(String instanceName) throws ManagementRemoteException(Code)
Get the MBean server connection for a particular instance. the MBeanServerConnection for the specified instance.
throws:
  ManagementRemoteException -

getConsumingEndpoints
public String[] getConsumingEndpoints(String componentName, String targetName) throws ManagementRemoteException(Code)
Get the list of consuming endpoints
Parameters:
  componentName -
Parameters:
  targetName - Returns the consumingEndpoints.
throws:
  ManagementRemoteException -

getInstallRoot
public String getInstallRoot() throws ManagementRemoteException(Code)
Get the full path to the platform's instaall root directory. platform install root
throws:
  ManagementRemoteException -

getInstanceName
public String getInstanceName() throws ManagementRemoteException(Code)
Get the name of this instance. the name of this server instance.
throws:
  ManagementRemoteException -

getInstanceRoot
public String getInstanceRoot() throws ManagementRemoteException(Code)
Get the full path to the platform's instance root directory. platform instance root
throws:
  ManagementRemoteException -

getJmxRmiPort
public String getJmxRmiPort() throws ManagementRemoteException(Code)
Get a string representation of the DAS JMX RMI connector port. the JMX RMI connector port as a (CODE>String.
throws:
  ManagementRemoteException -

getProvisioningEndpoints
public String[] getProvisioningEndpoints(String componentName, String targetName) throws ManagementRemoteException(Code)
Get the list of provisioning endpoints
Parameters:
  componentName -
Parameters:
  targetName - Returns the provisioningEndpoints.
throws:
  ManagementRemoteException -

getRuntimeDetails
public Map<String /*targetName*/, Properties getRuntimeDetails() throws ManagementRemoteException(Code)
Retrieve runtime version information map of targetName to Properties elements detailing version info
throws:
  ManagementRemoteException -

getServersInCluster
public Set<String> getServersInCluster(String clusterName) throws ManagementRemoteException(Code)
Get a set of the names of all the servers in the specified cluster. a set of names of servers in the cluster.
throws:
  ManagementRemoteException -

getServiceAssemblyDeploymentDescriptor
public String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName) throws ManagementRemoteException(Code)
Returns the jbi.xml Deployment Descriptor for a Service Assembly.
Parameters:
  the - name of the Service Assembly the jbi.xml deployment descriptor of the archive
throws:
  ManagementRemoteException - if error or exception occurs.

getServiceAssemblyState
public String getServiceAssemblyState(String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code)
Gets the Service Assembly state
Parameters:
  serviceAssemblyName -
Parameters:
  targetName - the state of the Service Assembly
throws:
  ManagementRemoteException -

getServiceUnitDeploymentDescriptor
public String getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName) throws ManagementRemoteException(Code)
Returns the jbi.xml Deployment Descriptor for a Service Unit.
Parameters:
  the - name of the Service Assembly
Parameters:
  the - name of the Service Unit the jbi.xml deployment descriptor of the archive
throws:
  ManagementRemoteException - if error or exception occurs.

getSharedLibraryInstallationDescriptor
public String getSharedLibraryInstallationDescriptor(String sharedLibraryName) throws ManagementRemoteException(Code)
Returns the jbi.xml Installation Descriptor for a Shared Library.
Parameters:
  the - name of the Shared Library the jbi.xml deployment descriptor of the archive
throws:
  ManagementRemoteException - if error or exception occurs.

getStandaloneServerNames
public Set<String> getStandaloneServerNames() throws ManagementRemoteException(Code)
Get a set of the names of all the standalone servers in the domain. a set of names of standalone servers in the domain.
throws:
  ManagementRemoteException -

getTargetName
public String getTargetName() throws ManagementRemoteException(Code)
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. the target name.
throws:
  ManagementRemoteException -

getTargetName
public String getTargetName(String instanceName) throws ManagementRemoteException(Code)
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. the target name.
throws:
  ManagementRemoteException -

getWSDLDefinition
public String getWSDLDefinition(String componentName, String endpoint, String targetName) throws ManagementRemoteException(Code)
Retrieves the primary WSDL associated with the specified endpoint.
Parameters:
  componentName -
Parameters:
  endpoint -
Parameters:
  targetName - primary WSDL associated with the endpoint
throws:
  ManagementRemoteException -

getWSDLImportedResource
public String getWSDLImportedResource(String componentName, String endpoint, String targetNamespace, String targetName) throws ManagementRemoteException(Code)
Retrieves the WSDL or XSD associated with the specified endpoint and targetNamespace
Parameters:
  componentName -
Parameters:
  endpoint -
Parameters:
  targetNamespace -
Parameters:
  targetName - wsdl or xsd
throws:
  ManagementRemoteException -

isAdminServer
public boolean isAdminServer() throws ManagementRemoteException(Code)
Determine whether this instance is the administration server instance. true if this instance is the administration server,false if not.
throws:
  ManagementRemoteException -

isBindingComponent
public boolean isBindingComponent(String componentName) throws ManagementRemoteException(Code)
check for BindingComponent
Parameters:
  the - name of the ServiceEngine or Binding Component true if it is a Binding Component else false.
throws:
  ManagementRemoteException - if error or exception occurs.

isCluster
public boolean isCluster(String targetName) throws ManagementRemoteException(Code)
Determine whether a target is a cluster. true if targetName is a cluster,false if not.
throws:
  ManagementRemoteException -

isClusteredServer
public boolean isClusteredServer(String targetName) throws ManagementRemoteException(Code)
Determine whether the target is a clustered server. true if targetName is a clusteredserver, false if not.
throws:
  ManagementRemoteException -

isInstanceClustered
public boolean isInstanceClustered(String instanceName) throws ManagementRemoteException(Code)
Determine whether or not an instance is clustered. true if the instance is clustered,false if not.
throws:
  ManagementRemoteException -

isInstanceUp
public boolean isInstanceUp(String instanceName) throws ManagementRemoteException(Code)
Determine if the specified instance is up. true if the instance is up and running, false otherwise
throws:
  ManagementRemoteException -

isJBIComponentInstalled
public boolean isJBIComponentInstalled(String componentName, String targetName) throws ManagementRemoteException(Code)
Checks to see if a component/library is installed on a target
Parameters:
  componentName -
Parameters:
  targetName - true if installed, false if not
throws:
  ManagementRemoteException -

isJBIRuntimeEnabled
public boolean isJBIRuntimeEnabled() throws ManagementRemoteException(Code)
Checks to see if the JBI Runtime is enabled. true if JBI Runtime Framework is available, false if not
throws:
  ManagementRemoteException - if error or exception occurs.

isServiceAssemblyDeployed
public boolean isServiceAssemblyDeployed(String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code)
Checks to see if a Service Assembly is deployed on a target
Parameters:
  serviceAssemblyName -
Parameters:
  targetName - true if deployed, false if not
throws:
  ManagementRemoteException -

isServiceEngine
public boolean isServiceEngine(String componentName) throws ManagementRemoteException(Code)
check for ServiceEngine
Parameters:
  the - name of the ServiceEngine or Binding Component true if it is a Service Engine else false.
throws:
  ManagementRemoteException - if error or exception occurs.

isStandaloneServer
public boolean isStandaloneServer(String targetName) throws ManagementRemoteException(Code)
Determine whether a target is a standalone server. true if targetName is a standaloneserver, false if not.
throws:
  ManagementRemoteException -

isTargetUp
public boolean isTargetUp(String targetName) throws ManagementRemoteException(Code)
Checks to see if the Target (server, cluster) is up or down.
Parameters:
  targetName - name of the target (e.g., cluster1, server, etc.) true if Target is up, false if not
throws:
  ManagementRemoteException - if error or exception occurs.

isValidTarget
public boolean isValidTarget(String targetName) throws ManagementRemoteException(Code)
Determine whether a target is a valid server or cluster name. true if targetName is a validstandalone server name or cluster name, false if not.
throws:
  ManagementRemoteException -

listTargetNames
public Map<String /*targetName*/, String[] listTargetNames() throws ManagementRemoteException(Code)
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. map of target names to array of target instance names
throws:
  ManagementRemoteException -

supportsMultipleServers
public boolean supportsMultipleServers() throws ManagementRemoteException(Code)
Determine whether multiple servers are permitted within this AS installation. true if multiple servers are permitted.
throws:
  ManagementRemoteException -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.