com.sun.jbi

Interface EnvironmentContext

public interface EnvironmentContext

This context contains data needed by all components and services running in the JBI environment. This interface defines only methods that are not part of the JBI specification.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAppServerInstallRoot() Get the AppServer installation root directory.
String	getAppServerInstanceRoot() Get the AppServer instance root directory.
ComponentManager	getComponentManager() Get the ComponentManager handle.
ComponentQuery	getComponentQuery() Get the ComponentQuery handle.
ComponentQuery	getComponentQuery(String targetName) Get the ComponentQuery for a specified target.
ConnectionManager	getConnectionManager() Get the ConnectionManager handle.
Properties	getInitialProperties() Gets the initial properties specified in the domain.xml file.
long	getJbiInitTime() Get the JBI Framework initialization timestamp in milliseconds.
String	getJbiInstallRoot() Get the JBI install root directory path.
String	getJbiInstanceRoot() Get the JBI instance root directory path.
Object	getManagementClass(String aServiceName) Get a handle to the class implementing management for the named JBI schemaorg_apache_xmlbeans.system service.
ManagementMessageFactory	getManagementMessageFactory() Get the management message factory which enables JBI components to construct status and exception messages.
MBeanHelper	getMBeanHelper() Get a handle to the MBeanHelper implementation.
MBeanNames	getMBeanNames() Get a handle to the MBeanNames service for use in creating MBean names.
MBeanServer	getMBeanServer() Get the JMX MBean server used to register all MBeans in the JBI framework.
InitialContext	getNamingContext() Get the JNDI naming context for this implementation.
EventNotifierCommon	getNotifier() Get the Event Notifier for emitting event notifications.
PlatformContext	getPlatformContext() Get the platform-specific context for this implementation.
JBIProvider	getProvider() Gets the provider typeof JBI.
Document	getReadOnlyRegistry() Get a read-only reference to the persisted JBI Registry.
Registry	getRegistry() Get a reference to the persisted JBI registry.
ServiceUnitRegistration	getServiceUnitRegistration() Get the ServiceUnitRegistration handle.
StringTranslator	getStringTranslator(String packageName) Get a StringTranslator for a specific package name.
StringTranslator	getStringTranslatorFor(Object object) Get a StringTranslator for a specific object.
TransactionManager	getTransactionManager() Get the TransactionManager for this implementation.
VersionInfo	getVersionInfo() Get a handle to the VersionInfo implementation.
WsdlFactory	getWsdlFactory() Get a copy of the WSDL factory.
boolean	isFrameworkReady(boolean start) Indicates whether or not the JBI framework has been fully started.
boolean	isStartOnDeployEnabled() This method is used to find out if start-on-deploy is enabled.
boolean	isStartOnVerifyEnabled() This method is used to find out if start-on-verify is enabled.

Method Detail

getAppServerInstallRoot

String getAppServerInstallRoot()

Get the AppServer installation root directory.

Returns:

The AppServer install root.

getAppServerInstanceRoot

String getAppServerInstanceRoot()

Get the AppServer instance root directory.

Returns:

The AppServer instance root.

getComponentManager

ComponentManager getComponentManager()

Get the ComponentManager handle.

Returns:

The ComponentManager instance.

getComponentQuery

ComponentQuery getComponentQuery()

Get the ComponentQuery handle.

Returns:

The ComponentQuery instance.

getComponentQuery

ComponentQuery getComponentQuery(String targetName)

Get the ComponentQuery for a specified target.

Parameters:

targetName - - either "domain" or a valid server / cluster name

Returns:

The ComponentQuery instance.

getNotifier

EventNotifierCommon getNotifier()

Get the Event Notifier for emitting event notifications.

Returns:

The EventNotifier instance.

getRegistry

Registry getRegistry()

Get a reference to the persisted JBI registry.

Returns:

Registry instance

getReadOnlyRegistry

Document getReadOnlyRegistry()

Get a read-only reference to the persisted JBI Registry. A DOM registry document object is returned.

Returns:

the registry document

isFrameworkReady

boolean isFrameworkReady(boolean start)

Indicates whether or not the JBI framework has been fully started. This method provides clients with a way of determining if the JBI framework started up in passive mode as a result of on-demand initialization. The 'start' parameter instructs the framework to start completely if it has not already done so. If the framework has already been started, the request to start again is ignored.

Parameters:

start - requests that the framework start completely before returning.

Returns:

true if the framework is completely started, false otherwise.

getConnectionManager

ConnectionManager getConnectionManager()

Get the ConnectionManager handle.

Returns:

The ConnectionManager instance.

getInitialProperties

Properties getInitialProperties()

Gets the initial properties specified in the domain.xml file.

Returns:

The initial properties from the AppServer.

getJbiInstallRoot

String getJbiInstallRoot()

Get the JBI install root directory path.

Returns:

The JBI install root directory path.

getJbiInstanceRoot

String getJbiInstanceRoot()

Get the JBI instance root directory path.

Returns:

The JBI instance root directory path.

getManagementClass

Object getManagementClass(String aServiceName)

Get a handle to the class implementing management for the named JBI schemaorg_apache_xmlbeans.system service.

Parameters:

aServiceName - - the name of the JBI schemaorg_apache_xmlbeans.system service.

Returns:

The instance implementing management for the service.

getManagementMessageFactory

ManagementMessageFactory getManagementMessageFactory()

Get the management message factory which enables JBI components to construct status and exception messages.

Returns:

An instance of ManagementMessageFactory.

getMBeanHelper

MBeanHelper getMBeanHelper()

Get a handle to the MBeanHelper implementation.

Returns:

The MBeanHelper instance.

getMBeanNames

MBeanNames getMBeanNames()

Get a handle to the MBeanNames service for use in creating MBean names.

Returns:

Handle to the MBeanNames service.

getMBeanServer

MBeanServer getMBeanServer()

Get the JMX MBean server used to register all MBeans in the JBI framework.

Returns:

The MBean server handle.

getNamingContext

InitialContext getNamingContext()

Get the JNDI naming context for this implementation. This context is a standard JNDI InitialContext but its content will vary based on the environment in which the JBI implementation is running.

Returns:

The JNDI naming context.

getPlatformContext

PlatformContext getPlatformContext()

Get the platform-specific context for this implementation.

Returns:

The PlatformContext.

getServiceUnitRegistration

ServiceUnitRegistration getServiceUnitRegistration()

Get the ServiceUnitRegistration handle.

Returns:

The ServiceUnitRegistration instance.

getStringTranslator

StringTranslator getStringTranslator(String packageName)

Get a StringTranslator for a specific package name.

Parameters:

packageName - - the name of the package for which a StringTranslator is being requested.

Returns:

The StringTranslator for the named package.

getStringTranslatorFor

StringTranslator getStringTranslatorFor(Object object)

Get a StringTranslator for a specific object.

Parameters:

object - - the object for which a StringTranslator is being requested, using the name of the package containing the object.

Returns:

The StringTranslator for the object's package.

getTransactionManager

TransactionManager getTransactionManager()

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.

getVersionInfo

VersionInfo getVersionInfo()

Get a handle to the VersionInfo implementation.

Returns:

The VersionInfo instance.

getProvider

JBIProvider getProvider()

Gets the provider typeof JBI.

Returns:

The JBI provider.

getJbiInitTime

long getJbiInitTime()

Get the JBI Framework initialization timestamp in milliseconds.

Returns:

the time, in milliseconds, when the JBI Framework was initialized.

getWsdlFactory

WsdlFactory getWsdlFactory()
                           throws WsdlException

Get a copy of the WSDL factory. This needs to be done before any reading, writing, or manipulation of WSDL documents can be performed using the WSDL API.

Returns:

An instance of the WSDL factory.

Throws:

WsdlException - If the factory cannot be instantiated.

isStartOnDeployEnabled

boolean isStartOnDeployEnabled()

This method is used to find out if start-on-deploy is enabled. When this is enabled components are started automatically when there is deployment for them. This is controlled by the property com.sun.jbi.startOnDeploy. By default start-on-deploy is enabled. It is disabled only if com.sun.jbi.startOnDeploy=false.

isStartOnVerifyEnabled

boolean isStartOnVerifyEnabled()

This method is used to find out if start-on-verify is enabled. When this is enabled components are started automatically when an application has to be verified for that component. This is controlled by the property com.sun.jbi.startOnVerify. By default start-on-verify is enabled. It is disabled only if com.sun.jbi.startOnVerify=false.