getInitialProperties() Get the initial properties provided by the AppServer from the
properties specified in the lifecycle module definition in the
domain.xml file.
long
getInstallationTimeout() Get the timeout value for component install/uninstall operations.
getMBeanHelper() Get the MBean helper service which enables JBI components to request
that the Management Service create and register MBeans on their behalf.
getManagementClass(String aServiceName) Get a handle to the class implementing management for the named
JBI system service.
Parameters: aServiceName - - the name of the JBI system service.
getStringTranslator(String packageName) Get the StringTranslator for a specified package name.
Parameters: packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator.
getStringTranslator(String packageName, String componentId) Get the StringTranslator for a specified package name using the class
loader for a specified component ID.
Parameters: packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator. Parameters: componentId - - the component ID for which the classloader is tobe used.
getStringTranslatorFor(Object object) Get the StringTranslator for a specified object.
Parameters: object - - an object in the package that contains the resourcebundle to be used for this StringTranslator.
isFrameworkReady(boolean start) Indicates whether or not the JBI framework has been fully started.
public 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.
public boolean
isStartOnVerifyEnabled() This method is used to find out if startOnVerify is enabled.
When this is enabled components are started automatically when
an application has to be verified for them.
Constructor.
Parameters: platform - the platform context for the AppServer. Parameters: framework - the representing the JBI Framework instance. Parameters: initialProperties - is the Properties object provided bythe AppServer, containing all properties specified in thedefinition of the JBI lifecycle module. throws: javax.jbi.JBIException - if any error occurs.
Get the Component Query handle. This returns the ComponentQuery with this
instances target.
the ComponentQuery for the current server instance. This ComponentQueryprovides information on components and shared libraries installed to theserver instance.
Get the timeout value for Service Unit deploy/undeploy operations.
The timeout value in milliseconds for calls to the component'sServiceUnitManager deploy and undeploy methods.
Get the initial properties provided by the AppServer from the
properties specified in the lifecycle module definition in the
domain.xml file.
The initial properties from the AppServer.
Get the timeout value for component install/uninstall operations.
The timeout value in milliseconds for calls to the component'sBootstrap onInstall and onUninstall methods.
Get the MBean helper service which enables JBI components to request
that the Management Service create and register MBeans on their behalf.
The MBeanHelper instance.
Get a handle to the class implementing management for the named
JBI system service.
Parameters: aServiceName - - the name of the JBI system service. The class implementing management for the system service.
Get a read-only reference to the persisted JBI Registry. A DOM registry document
object is returned. If the registry file is missing or cannot be read then a null
value is returned.
the registry document
Get a reference to the persisted JBI registry.
The registry is created if not already available and the result is cached for
later callers.
The framework will transition from lazy to normal if the registry is requested
(or if the Framework is explicitly enabled.) After creating the registry we will
make sure the Framework is ready before continuing.
Note: JBIFramework.frameReady() will indirectly call getRegistry() and getRegistry()
will directly call JBIFramework.frameworkRead(). The recursion is broken by carefully
setting the internal framework ready flag.
See: JBIFramework.readyFramework() and JBIFramework.prepare()
Registry instance
Get the timeout value for Service Unit life cycle operations.
The timeout value in milliseconds for calls to the component'sServiceUnitManager life cycle methods.
Get the StringTranslator for a specified package name.
Parameters: packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator. The StringTranslator instance.
Get the StringTranslator for a specified package name using the class
loader for a specified component ID.
Parameters: packageName - - the name of the package containing the resourcebundle to be used by this StringTranslator. Parameters: componentId - - the component ID for which the classloader is tobe used. The StringTranslator instance.
Get the StringTranslator for a specified object.
Parameters: object - - an object in the package that contains the resourcebundle to be used for this StringTranslator. The StringTranslator instance.
getTransactionManager
public javax.transaction.TransactionManager getTransactionManager()(Code)
Get a TransactionManager from the AppServer.
A TransactionManager instance.
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.
An instance of the WSDL factory. exception: WsdlException - If the factory cannot be instantiated.
isFrameworkReady
public boolean isFrameworkReady(boolean start)(Code)
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 beforereturning. true if the framework is completely started, false otherwise.
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.
By default start-on-deploy is enabled.
true if startOnDeploy is enabled.
This method is used to find out if startOnVerify is enabled.
When this is enabled components are started automatically when
an application has to be verified for them.
By default startOnVerify is enabled.
true if startOnVerify is enabled.
Set the installation root directory of the JBI framework.
Parameters: installRoot - String containing the installation root directoryof the JBI framework