com.sun.jbi

Interface ComponentInfo

All Known Subinterfaces:

ComponentInfo

public interface ComponentInfo

This interface provides information on components (Binding Components, Service Engines, and Shared Libraries.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Determine if the supplied Object is equal to this one.
String	getBootstrapClassName() Get the class name of the bootstrap implementation for this BC or SE.
List<String>	getBootstrapClassPathElements() Get the class path elements that this BC or SE needs in its bootstrap runtime environment.
List<String>	getClassPathElements() Get the class path elements.
String	getComponentClassName() Get the component class name.
ComponentType	getComponentType() Get the component type.
String	getDescription() Get the description of the component.
String	getInstallationDescriptor() Get the Installation Descriptor ( jbi.xml ) for the Component / Shared Library.
String	getInstallRoot() Get the directory into which this component is installed.
String	getName() Get the name of the component.
Map<String,String>	getProperties() Get the installation specific properties for the component.
List<ServiceUnitInfo>	getServiceUnitList() Get the list of ServiceUnitInfo objects representing all the SUs that are currently deployed to this component; for Shared Libraries this is null.
List<String>	getSharedLibraryNames() Get the list of Shared Libraries required by this component.
ComponentState	getStatus() Get the Status of the Component.
String	getWorkspaceRoot() Get the workspace for the component
int	hashCode() Get a hash code for this ComponentInfo.
boolean	isBootstrapClassLoaderSelfFirst()
boolean	isClassLoaderSelfFirst()

Method Detail

equals

boolean equals(Object object)

Determine if the supplied Object is equal to this one.

Overrides:

equals in class Object

Parameters:

object - - the Object to be compared with this one.

Returns:

true if the supplied Object is equal to this one.

getClassPathElements

List<String> getClassPathElements()

Get the class path elements. For BCs and SEs this is the list of elements that comprise the runtime class path; for Shared Libraries it is the list of elements that comprise the shared class path. Each element in the list is a String representing a single jar file or directory.

Returns:

List of jar files and directories that comprise the class path for the component or shared library.

getComponentClassName

String getComponentClassName()

Get the component class name. For BCs and SEs this is the name of the class that implements the javax.jbi.component.Component interface; for Shared Libraries it is null.

Returns:

the name of the Component class.

getComponentType

ComponentType getComponentType()

Get the component type.

Returns:

the component type: ComponentInfo.BINDING, ComponentInfo.ENGINE, or ComponentInfo.SHARED_LIBRARY.

getDescription

String getDescription()

Get the description of the component.

Returns:

the String describing the component.

getInstallRoot

String getInstallRoot()

Get the directory into which this component is installed.

Returns:

the directory into which this component is installed.

getWorkspaceRoot

String getWorkspaceRoot()

Get the workspace for the component

Returns:

this components workspace directory.

getName

String getName()

Get the name of the component.

Returns:

the name of the component.

getServiceUnitList

List<ServiceUnitInfo> getServiceUnitList()

Get the list of ServiceUnitInfo objects representing all the SUs that are currently deployed to this component; for Shared Libraries this is null.

Returns:

List of ServiceUnitInfo objects.

getSharedLibraryNames

List<String> getSharedLibraryNames()

Get the list of Shared Libraries required by this component. For BCs and SEs, this is the list of Shared Library names in the order that they appear in the class loader chain; for Shared Libraries this is null.

Returns:

List of Strings containing Shared Library names.

getStatus

ComponentState getStatus()

Get the Status of the Component. For Shared Libraries this is always INSTALLED.

Returns:

should be of the values: LOADED, INSTALLED, STOPPED and STARTED

hashCode

int hashCode()

Get a hash code for this ComponentInfo.

Overrides:

hashCode in class Object

Returns:

the hash code for the object.

getProperties

Map<String,String> getProperties()

Get the installation specific properties for the component.

Returns:

a Map of the properties

isBootstrapClassLoaderSelfFirst

boolean isBootstrapClassLoaderSelfFirst()

Returns:

true/false depending on the value of the bootstrapClassLoaderSelfFirst attribute. This method returns false for shared libraries.

isClassLoaderSelfFirst

boolean isClassLoaderSelfFirst()

Returns:

true/false depending on the value of the {Component}ClassLoaderSelfFirst attribute.

getBootstrapClassPathElements

List<String> getBootstrapClassPathElements()

Get the class path elements that this BC or SE needs in its bootstrap runtime environment.

Returns:

A list of the elements of the bootstrap class path as strings.

getBootstrapClassName

String getBootstrapClassName()

Get the class name of the bootstrap implementation for this BC or SE.

Returns:

The bootstrap class name.

getInstallationDescriptor

String getInstallationDescriptor()

Get the Installation Descriptor ( jbi.xml ) for the Component / Shared Library.

Returns:

the jbi.xml as a String