|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This context contains information necessary for a JBI component to
perform its installation/uninstallation processing. This is provided to
the init() method of the component Bootstrap
interface.
Method Summary | |
java.util.List |
getClassPathElements()
Get a list of elements that comprise the class path for this component. |
java.lang.String |
getComponentClassName()
Get the name of the class that implements the Component
interface for this component. |
java.lang.String |
getComponentName()
Get the unique name assigned to this component. |
ComponentContext |
getContext()
Get the JBI context for this component. |
org.w3c.dom.DocumentFragment |
getInstallationDescriptorExtension()
Return a DOM document fragment representing the installation descriptor (jbi.xml) extension data for the component, if any. |
java.lang.String |
getInstallRoot()
Get the installation root directory full path name for this component. |
boolean |
isInstall()
Returns true if this context was created in order to install
a component into the JBI environment. |
void |
setClassPathElements(java.util.List classPathElements)
Set the list of elements that comprise the class path for this component. |
Method Detail |
public java.lang.String getComponentClassName()
Component
interface for this component. This must be the component
class name given in the component's installation descriptor.
Component
implementation class name, which must be
non-null and non-empty.public java.util.List getClassPathElements()
File.separator
).
public java.lang.String getComponentName()
public ComponentContext getContext()
ComponentContext.getMBeanNames()
ComponentContext.getMBeanServer()
ComponentContext.getNamingContext()
ComponentContext.getTransactionManager()
IllegalStateException
exception if invoked.
public java.lang.String getInstallRoot()
public org.w3c.dom.DocumentFragment getInstallationDescriptorExtension()
The Installation Descriptor Extension data are located at the end of the <component> element of the installation descriptor.
null
if none is present in the
descriptor.public boolean isInstall()
true
if this context was created in order to install
a component into the JBI environment. Returns false
if this
context was created to uninstall a previously installed component.
This method is provided to allow Bootstrap
implementations to
tailor their behaviour according to use case. For example, the
Bootstrap.init(InstallationContext)
method implementation may
create different types of extension MBeans, depending on the use case
specified by this method.
true
if this context was created in order to install
a component into the JBI environment; otherwise the context
was created to uninstall an existing component.public void setClassPathElements(java.util.List classPathElements)
This method allows the component's bootstrap to alter the execution-time
class path specified by the component's installation descriptor. The
component configuration determined during installation can affect the
class path needed by the component at execution-time. All path elements
must use the file separator character appropriate to the system (i.e.,
File.separator
.
classPathElements
- a list of String objects, each of which contains
a class path elements; the list must be non-null and contain at
least one class path element.
java.lang.IllegalArgumentException
- if the class path elements is null,
empty, or if an individual element is ill-formed.
|
Built 06/07/2005 11:16 AM on acer (SunOS 5.9) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |