com.sun.jbi.platform

Interface PlatformContext

public interface PlatformContext

This interface defines a generic way to obtain application server platform- specific information at runtime. Each platform must provide an implementation of this interface to the JBI framework.

Author:

Sun Microsystems Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INSTALL_ROOT_TOKEN Token used in the JBI registry to account for instance-local install root path.
static String	INSTANCE_ROOT_TOKEN Token used in the JBI registry to account for instance-local root path.
static String	JBI_LOGGER_NAME The JBI Parent Logger

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(PlatformEventListener listener) Register a listener for platform events.
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	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.
Level	getJbiLogLevel(String target) Get the "com.sun.jbi" log level for a target
String	getJmxRmiPort() Get a string representation of the DAS JMX RMI connector port.
KeyStoreUtil	getKeyStoreUtil() Returns a platform-specific implementation of KeyStoreUtil.
MBeanServer	getMBeanServer() Provides access to the platform's MBean server.
MBeanServerConnection	getMBeanServerConnection(String instanceName) Get the MBean server connection for a particular instance.
InitialContext	getNamingContext() Retrieves the naming context that should be used to locate platform resources (e.g.
JBIProvider	getProvider() Returns the provider type for this platform.
SecurityProvider	getSecurityProvider() Get the platform-specific security provider.
Set<String>	getServersInCluster(String clusterName) Get a set of the names of all the servers in the specified cluster.
Set<String>	getStandaloneServerNames() Get a set of the names of all the standalone servers in the domain.
ClassLoader	getSystemClassLoader() Get the schemaorg_apache_xmlbeans.system class loader for this implementation.
String	getTargetName() Get the Target Name.
String	getTargetName(String instanceName) Get the Target Name for a specified instance.
TransactionManager	getTransactionManager() Get the TransactionManager for this implementation.
boolean	isAdminServer() Determine whether this instance is the administration server instance.
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	isStandaloneServer(String targetName) Determine whether a target is a standalone server.
boolean	isValidTarget(String targetName) Determine whether a target is a valid server or cluster name.
void	removeListener(PlatformEventListener listener) Remove a listener for platform events.
void	setJbiLogLevel(String target, Level level) Set the "com.sun.jbi" log level for a target.
boolean	supportsMultipleServers() Determine whether multiple servers are permitted within this AS installation.

Field Detail

INSTANCE_ROOT_TOKEN

static final String INSTANCE_ROOT_TOKEN

Token used in the JBI registry to account for instance-local root path.

See Also:

Constant Field Values

INSTALL_ROOT_TOKEN

static final String INSTALL_ROOT_TOKEN

Token used in the JBI registry to account for instance-local install root path.

See Also:

Constant Field Values

JBI_LOGGER_NAME

static final String JBI_LOGGER_NAME

The JBI Parent Logger

See Also:

Constant Field Values

Method Detail

getTransactionManager

TransactionManager getTransactionManager()
                                         throws Exception

Get the TransactionManager for this implementation. The instance returned is an implementation of the standard JTS interface. If none is available, returns null.

Returns:

a TransactionManager instance.

Throws:

Exception - if a TransactionManager cannot be obtained.

getMBeanServerConnection

MBeanServerConnection getMBeanServerConnection(String instanceName)
                                               throws Exception

Get the MBean server connection for a particular instance.

Returns:

the MBeanServerConnection for the specified instance.

Throws:

Exception - if a MBeanServerConnection cannot be obtained.

getSystemClassLoader

ClassLoader getSystemClassLoader()

Get the schemaorg_apache_xmlbeans.system class loader for this implementation.

Returns:

the ClassLoader that is the "schemaorg_apache_xmlbeans.system" class loader from a JBI runtime perspective.

getAdminServerName

String getAdminServerName()

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

isAdminServer

boolean isAdminServer()

Determine whether this instance is the administration server instance.

Returns:

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

getInstanceName

String getInstanceName()

Get the name of this instance.

Returns:

the name of this server instance.

isInstanceUp

boolean isInstanceUp(String instanceName)

Determine if the specified instance is up.

Returns:

true if the instance is up and running, false otherwise

supportsMultipleServers

boolean supportsMultipleServers()

Determine whether multiple servers are permitted within this AS installation.

Returns:

true if multiple servers are permitted.

getTargetName

String getTargetName()

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.

getTargetName

String getTargetName(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.

getStandaloneServerNames

Set<String> getStandaloneServerNames()

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.

getClusteredServerNames

Set<String> getClusteredServerNames()

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.

getClusterNames

Set<String> getClusterNames()

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

Returns:

a set of names of clusters in the domain.

getServersInCluster

Set<String> getServersInCluster(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.

isValidTarget

boolean isValidTarget(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.

isCluster

boolean isCluster(String targetName)

Determine whether a target is a cluster.

Returns:

true if targetName is a cluster, false if not.

isStandaloneServer

boolean isStandaloneServer(String targetName)

Determine whether a target is a standalone server.

Returns:

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

isClusteredServer

boolean isClusteredServer(String targetName)

Determine whether the target is a clustered server.

Returns:

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

isInstanceClustered

boolean isInstanceClustered(String instanceName)

Determine whether or not an instance is clustered.

Returns:

true if the instance is clustered, false if not.

getJmxRmiPort

String getJmxRmiPort()

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

Returns:

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

getMBeanServer

MBeanServer getMBeanServer()

Provides access to the platform's MBean server.

Returns:

platform MBean server.

getInstanceRoot

String getInstanceRoot()

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

Returns:

platform instance root

getInstallRoot

String getInstallRoot()

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

Returns:

platform install root

getProvider

JBIProvider getProvider()

Returns the provider type for this platform.

Returns:

enum value corresponding to this platform implementation.

getNamingContext

InitialContext getNamingContext()

Retrieves the naming context that should be used to locate platform resources (e.g. TransactionManager).

Returns:

naming context

addListener

void addListener(PlatformEventListener listener)

Register a listener for platform events.

Parameters:

listener - listener implementation

removeListener

void removeListener(PlatformEventListener listener)

Remove a listener for platform events.

Parameters:

listener - listener implementation

getKeyStoreUtil

KeyStoreUtil getKeyStoreUtil()

Returns a platform-specific implementation of KeyStoreUtil.

Returns:

an instance of KeyStoreUtil or null if KeyStoreUtil is not supported as part of this platform.

getJbiLogLevel

Level getJbiLogLevel(String target)

Get the "com.sun.jbi" log level for a target

Parameters:

target - - target name

Returns:

the default platform log level

setJbiLogLevel

void setJbiLogLevel(String target,
                  Level level)

Set the "com.sun.jbi" log level for a target.

Parameters:

target - - target name

level - the default platform log level

getSecurityProvider

SecurityProvider getSecurityProvider()

Get the platform-specific security provider.

Returns:

the platform-specific security provider.