com.sun.jbi.management

Class ComponentInstallationContext

java.lang.Object

com.sun.jbi.management.ComponentInstallationContext

All Implemented Interfaces:

InstallationContext

public class ComponentInstallationContext
extends Object
implements InstallationContext

Contains information necessary for a component (BC or SE) to perform special installation/uninstallation processing. This context is provided to the init method of the javax.jbi.component.Bootstrap implementation for the component.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from interface com.sun.jbi.component.InstallationContext

BINDING, ENGINE, SELF_FIRST

Constructor Summary

Constructors

Constructor and Description
ComponentInstallationContext(String componentName, int componentType, String className, List classPathElements, DocumentFragment extensionData) Public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
List	getAbsoluteClassPathElements() Get a list of elements that comprise the class path for this component.
List	getClassPathElements() Get a list of elements that comprise the class path for this component.
String	getComponentClassName() Get the name of the class that implements javax.jbi.component.Component for this component.
String	getComponentName() Get the unique name assigned to this component.
ComponentContext	getContext() Get the component context.
String	getDescription() Return the description of this component.
DocumentFragment	getInstallationDescriptorExtension() Return a DOM document fragment representing the installation descriptor (jbi.xml) extension data for this component, if any is present.
String	getInstallRoot() Get the installation root directory for this component.
String	getWorkspaceRoot() Return the workspace root directory for the component.
boolean	isBinding() Return an indication as to whether the component being installed is a Binding Component.
boolean	isBootstrapClassLoaderSelfFirst() Return an indication as to whether the bootstrap class loader should use the normal hierarchy (parent-first) or an inverted hierarchy (self-first).
boolean	isComponentClassLoaderSelfFirst() Return an indication as to whether the component class loader should use the normal hierarchy (parent-first) or an inverted hierarchy (self-first).
boolean	isEngine() Return an indication as to whether the component being installed is a Service Engine.
boolean	isInstall() Return an indication as to whether this context is for an install or an uninstall.
void	setBootstrapClassLoaderSelfFirst() Set a flag to force the bootstrap class loader to use an inverted hierarchy (self-first).
void	setClassPathElements(List classPathElements) Set the list of elements that comprise the class path for this component.
void	setComponentClassLoaderSelfFirst() Set a flag to force the component class loader to use an inverted hierarchy (self-first).
void	setComponentClassName(String name) Set the name of the class that implements javax.jbi.component.Component for this component.
void	setComponentName(String name) Set the name of this component.
void	setContext(ComponentContext context) Set the context for this component.
void	setDescription(String description) Set the description of this component.
void	setInstallationDescriptorExtension(DocumentFragment extension) Set the installation descriptor extension.
void	setInstallRoot(String installRoot) Set the installation root directory name for this component.
void	setIsInstall(boolean isInstall) Set the flag to indicate whether this is an install or an uninstall.
void	setWorkspaceRoot(String workspaceRoot) Set the workspace root directory name for this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentInstallationContext

public ComponentInstallationContext(String componentName,
                            int componentType,
                            String className,
                            List classPathElements,
                            DocumentFragment extensionData)

Public constructor.

Parameters:

componentName - the unique component name.

componentType - the type of this component - either BINDING or ENGINE.

className - the name of the class the implements the javax.jbi.component.Component interface for this component.

classPathElements - the list of elements that comprise the runtime class path for this component. NOTE: The elements in this list are relative paths based off the component's install root.

extensionData - the DOM document fragment representing the contents of the installation descriptor extension from the jbi.xml file.

Method Detail

getClassPathElements

public List getClassPathElements()

Get a list of elements that comprise the class path for this component. Each element represents either a directory (containing class files) or a jar file. The elements are relative paths based off of the component's install root, and are returned with the File.separator character as their file separators.

Specified by:

getClassPathElements in interface InstallationContext

Returns:

a list of String objects containing class path elements.

getComponentClassName

public String getComponentClassName()

Get the name of the class that implements javax.jbi.component.Component for this component.

Specified by:

getComponentClassName in interface InstallationContext

Returns:

the class name.

getComponentName

public String getComponentName()

Get the unique name assigned to this component.

Specified by:

getComponentName in interface InstallationContext

Returns:

the unique component name.

getContext

public ComponentContext getContext()

Get the component context.

Specified by:

getContext in interface InstallationContext

Returns:

the component context.

getInstallationDescriptorExtension

public DocumentFragment getInstallationDescriptorExtension()

Return a DOM document fragment representing the installation descriptor (jbi.xml) extension data for this component, if any is present.

Specified by:

getInstallationDescriptorExtension in interface InstallationContext

Returns:

the DOM document fragment for the extension data.

getInstallRoot

public String getInstallRoot()

Get the installation root directory for this component.

Specified by:

getInstallRoot in interface InstallationContext

Returns:

the name of the installation root directory, with the levels separated by the local File.separator character.

isInstall

public boolean isInstall()

Return an indication as to whether this context is for an install or an uninstall.

Specified by:

isInstall in interface InstallationContext

Returns:

true for an install, false for an uninstall.

setClassPathElements

public void setClassPathElements(List classPathElements)

Set the list of elements that comprise the class path for this component. Each element represents either a directory (containing class files) or a jar file. This method is provided to allow the component's installer to modify the list of class path elements. Each element must be formatted using the File.separator character, and must be a relative path based on the component's install root.

Specified by:

setClassPathElements in interface InstallationContext

Parameters:

classPathElements - a list of String objects containing class path elements.

getAbsoluteClassPathElements

public List getAbsoluteClassPathElements()

Get a list of elements that comprise the class path for this component. Each element represents either a directory (containing class files) or a jar file. The elements are absolute paths and are returned with a forward slash as their file separators.

Returns:

a list of String objects containing class path elements.

getDescription

public String getDescription()

Return the description of this component.

Returns:

the description of this component.

getWorkspaceRoot

public String getWorkspaceRoot()

Return the workspace root directory for the component.

Returns:

the workspace root directory path.

isBinding

public boolean isBinding()

Return an indication as to whether the component being installed is a Binding Component.

Returns:

true if the component is a BC, false if not.

isBootstrapClassLoaderSelfFirst

public boolean isBootstrapClassLoaderSelfFirst()

Return an indication as to whether the bootstrap class loader should use the normal hierarchy (parent-first) or an inverted hierarchy (self-first).

Returns:

true if the bootstrap class loader should use the self-first hierarchy, false if it should use parent-first.

isComponentClassLoaderSelfFirst

public boolean isComponentClassLoaderSelfFirst()

Return an indication as to whether the component class loader should use the normal hierarchy (parent-first) or an inverted hierarchy (self-first).

Returns:

true if the component class loader should use the self-first hierarchy, false if it should use parent-first.

isEngine

public boolean isEngine()

Return an indication as to whether the component being installed is a Service Engine.

Returns:

true if the component is a SE, false if not.

setContext

public void setContext(ComponentContext context)

Set the context for this component. This method is used by the Component Framework to set the context during installation processing.

Parameters:

context - the component context.

setBootstrapClassLoaderSelfFirst

public void setBootstrapClassLoaderSelfFirst()

Set a flag to force the bootstrap class loader to use an inverted hierarchy (self-first).

setComponentClassLoaderSelfFirst

public void setComponentClassLoaderSelfFirst()

Set a flag to force the component class loader to use an inverted hierarchy (self-first).

setComponentClassName

public void setComponentClassName(String name)

Set the name of the class that implements javax.jbi.component.Component for this component.

Parameters:

name - the component class name of this component.

setComponentName

public void setComponentName(String name)

Set the name of this component.

Parameters:

name - the name of this component.

setDescription

public void setDescription(String description)

Set the description of this component.

Parameters:

description - the description of this component.

setInstallationDescriptorExtension

public void setInstallationDescriptorExtension(DocumentFragment extension)

Set the installation descriptor extension.

Parameters:

extension - the extension portion of the component's installation descriptor.

setInstallRoot

public void setInstallRoot(String installRoot)

Set the installation root directory name for this component.

Parameters:

installRoot - the installation root directory name.

setIsInstall

public void setIsInstall(boolean isInstall)

Set the flag to indicate whether this is an install or an uninstall.

Parameters:

isInstall - is true for an install, false for an uninstall.

setWorkspaceRoot

public void setWorkspaceRoot(String workspaceRoot)

Set the workspace root directory name for this component.

Parameters:

workspaceRoot - the workspace root directory name.