net.openesb.standalone.framework

Class PlatformContext

java.lang.Object

net.openesb.standalone.framework.PlatformContext

All Implemented Interfaces:

com.sun.jbi.platform.PlatformContext

public class PlatformContext
extends Object
implements com.sun.jbi.platform.PlatformContext

Implementation of PlatformContext for OpenESB Standalone.

Author:

David BRASSELY (brasseld at gmail.com), OpenESB Community

Field Summary

Fields inherited from interface com.sun.jbi.platform.PlatformContext

INSTALL_ROOT_TOKEN, INSTANCE_ROOT_TOKEN, JBI_LOGGER_NAME

Constructor Summary

Constructors

Constructor and Description
PlatformContext()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(com.sun.jbi.platform.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.
com.sun.jbi.security.KeyStoreUtil	getKeyStoreUtil() Returns the KeyStoreUtil for Java SE.
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.
com.sun.jbi.JBIProvider	getProvider() Returns the provider type for this platform.
net.openesb.security.SecurityProvider	getSecurityProvider()
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 JBI 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(com.sun.jbi.platform.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformContext

public PlatformContext()

Method Detail

getTransactionManager

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

Specified by:

getTransactionManager in interface com.sun.jbi.platform.PlatformContext

Returns:

a TransactionManager instance.

Throws:

Exception - if a TransactionManager cannot be obtained.

getMBeanServerConnection

public MBeanServerConnection getMBeanServerConnection(String instanceName)
                                               throws Exception

Get the MBean server connection for a particular instance.

Specified by:

getMBeanServerConnection in interface com.sun.jbi.platform.PlatformContext

Returns:

the MBeanServerConnection for the specified instance.

Throws:

Exception

getAdminServerName

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

Specified by:

getAdminServerName in interface com.sun.jbi.platform.PlatformContext

Returns:

instance name of the administration server

isAdminServer

public boolean isAdminServer()

Determine whether this instance is the administration server instance.

Specified by:

isAdminServer in interface com.sun.jbi.platform.PlatformContext

Returns:

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

getInstanceName

public String getInstanceName()

Get the name of this instance.

Specified by:

getInstanceName in interface com.sun.jbi.platform.PlatformContext

Returns:

the name of this server instance.

isInstanceUp

public boolean isInstanceUp(String instanceName)

Determine if the specified instance is up.

Specified by:

isInstanceUp in interface com.sun.jbi.platform.PlatformContext

Returns:

true if the instance is up and running, false otherwise

supportsMultipleServers

public boolean supportsMultipleServers()

Determine whether multiple servers are permitted within this AS installation.

Specified by:

supportsMultipleServers in interface com.sun.jbi.platform.PlatformContext

Returns:

true if multiple servers are permitted.

getTargetName

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

Specified by:

getTargetName in interface com.sun.jbi.platform.PlatformContext

Returns:

the target name.

getTargetName

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

Specified by:

getTargetName in interface com.sun.jbi.platform.PlatformContext

Returns:

the target name.

getStandaloneServerNames

public Set<String> getStandaloneServerNames()

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

Specified by:

getStandaloneServerNames in interface com.sun.jbi.platform.PlatformContext

Returns:

a set of names of standalone servers in the domain.

getClusteredServerNames

public Set<String> getClusteredServerNames()

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

Specified by:

getClusteredServerNames in interface com.sun.jbi.platform.PlatformContext

Returns:

a set of names of clustered servers in the domain.

getClusterNames

public Set<String> getClusterNames()

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

Specified by:

getClusterNames in interface com.sun.jbi.platform.PlatformContext

Returns:

a set of names of clusters in the domain.

getServersInCluster

public Set<String> getServersInCluster(String clusterName)

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

Specified by:

getServersInCluster in interface com.sun.jbi.platform.PlatformContext

Returns:

a set of names of servers in the cluster.

isValidTarget

public boolean isValidTarget(String targetName)

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

Specified by:

isValidTarget in interface com.sun.jbi.platform.PlatformContext

Returns:

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

isCluster

public boolean isCluster(String targetName)

Determine whether a target is a cluster.

Specified by:

isCluster in interface com.sun.jbi.platform.PlatformContext

Returns:

true if targetName is a cluster, false if not.

isStandaloneServer

public boolean isStandaloneServer(String targetName)

Determine whether a target is a standalone server.

Specified by:

isStandaloneServer in interface com.sun.jbi.platform.PlatformContext

Returns:

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

isClusteredServer

public boolean isClusteredServer(String targetName)

Determine whether the target is a clustered server.

Specified by:

isClusteredServer in interface com.sun.jbi.platform.PlatformContext

Returns:

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

isInstanceClustered

public boolean isInstanceClustered(String instanceName)

Determine whether or not an instance is clustered.

Specified by:

isInstanceClustered in interface com.sun.jbi.platform.PlatformContext

Returns:

true if the instance is clustered, false if not.

getJmxRmiPort

public String getJmxRmiPort()

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

Specified by:

getJmxRmiPort in interface com.sun.jbi.platform.PlatformContext

Returns:

the JMX RMI connector port as a String.

getMBeanServer

public MBeanServer getMBeanServer()

Provides access to the platform's MBean server.

Specified by:

getMBeanServer in interface com.sun.jbi.platform.PlatformContext

Returns:

platform MBean server.

getInstanceRoot

public String getInstanceRoot()

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

Specified by:

getInstanceRoot in interface com.sun.jbi.platform.PlatformContext

Returns:

platform instance root

getInstallRoot

public String getInstallRoot()

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

Specified by:

getInstallRoot in interface com.sun.jbi.platform.PlatformContext

Returns:

platform install root

getProvider

public com.sun.jbi.JBIProvider getProvider()

Returns the provider type for this platform.

Specified by:

getProvider in interface com.sun.jbi.platform.PlatformContext

Returns:

enum value corresponding to this platform implementation.

getKeyStoreUtil

public com.sun.jbi.security.KeyStoreUtil getKeyStoreUtil()

Returns the KeyStoreUtil for Java SE. Currently unsupported

Specified by:

getKeyStoreUtil in interface com.sun.jbi.platform.PlatformContext

Returns:

a KeyStoreUtil

Throws:

UnsupportedOperationException

getNamingContext

public InitialContext getNamingContext()

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

Specified by:

getNamingContext in interface com.sun.jbi.platform.PlatformContext

Returns:

naming context

getSystemClassLoader

public ClassLoader getSystemClassLoader()
                                 throws SecurityException

Get the JBI system class loader for this implementation. This is the JBI common classloader and is the parent of the JBI runtime classloader that loaded this class.

Specified by:

getSystemClassLoader in interface com.sun.jbi.platform.PlatformContext

Returns:

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

Throws:

SecurityException - if access to the class loader is denied.

addListener

public void addListener(com.sun.jbi.platform.PlatformEventListener listener)

Register a listener for platform events.

Specified by:

addListener in interface com.sun.jbi.platform.PlatformContext

Parameters:

listener - listener implementation

removeListener

public void removeListener(com.sun.jbi.platform.PlatformEventListener listener)

Remove a listener for platform events.

Specified by:

removeListener in interface com.sun.jbi.platform.PlatformContext

Parameters:

listener - listener implementation

getJbiLogLevel

public Level getJbiLogLevel(String target)

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

Specified by:

getJbiLogLevel in interface com.sun.jbi.platform.PlatformContext

Parameters:

target - - target name

Returns:

the default platform log level

setJbiLogLevel

public void setJbiLogLevel(String target,
                  Level level)

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

Specified by:

setJbiLogLevel in interface com.sun.jbi.platform.PlatformContext

Parameters:

target - = target name

level - the default platform log level

getSecurityProvider

public net.openesb.security.SecurityProvider getSecurityProvider()

Specified by:

getSecurityProvider in interface com.sun.jbi.platform.PlatformContext