com.sun.jbi.management.registry.data

Class ComponentInfoImpl

java.lang.Object

com.sun.jbi.management.registry.data.ComponentInfoImpl

All Implemented Interfaces:

ComponentInfo

public class ComponentInfoImpl
extends Object
implements ComponentInfo

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

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jbi.management.ComponentInfo

ComponentInfo.Variable

Constructor Summary

Constructors

Constructor and Description
ComponentInfoImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClassPathElement(String element)
void	addServiceUnitInfo(ServiceUnitInfo suInfo)
void	addSharedLibrary(String sharedLibraryName)
boolean	equals(Object object) Determine if the supplied Object is equal to this one.
Properties	getApplicationConfiguration(String name) Get a specific application configuration.
String[]	getApplicationConfigurationNames() Get the names of all application configurations set on the component.
String	getBootstrapClassName() Get the class name of the bootstrap implementation for this BC or SE.
List	getBootstrapClassPathElements() Get the class path elements that this BC or SE needs in its bootstrap runtime environment.
List	getClassPathElements() Get the class path elements.
String	getComponentClassName() Get the component class name.
ComponentType	getComponentType() Get the component type.
Properties	getConfiguration() Get the static component configuration.
String	getDescription() Get the description of the component.
String	getInstallationDescriptor()
String	getInstallRoot() Get the directory into which this component is installed.
String	getName() Get the name of the component.
Map	getProperties() Get the installation specific properties for the component.
List	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	getSharedLibraryNames() Get the list of Shared Libraries required by this component.
ComponentState	getStatus() Get the Status of the Component.
long	getTimestamp() Get the timestamp associated with archive.
long	getUpgradeNumber() Get the grade associated with a component.
ComponentInfo.Variable[]	getVariables() Get the Environment Variables
String	getWorkspaceRoot() Get the workspace for the component
int	hashCode() Get a hash code for this ComponentInfo.
boolean	isBootstrapClassLoaderSelfFirst()
boolean	isClassLoaderSelfFirst()
void	setApplicationConfiguration(String name, Properties applicationConfig) Get a specific application configuration.
void	setBootstrapClassLoaderSelfFirst(boolean flag)
void	setBootstrapClassName(String name)
void	setBootstrapClassPathElements(List elements)
void	setClassLoaderSelfFirst(boolean flag)
void	setClassPathElements(List<String> elements)
void	setComponentClassName(String className)
void	setComponentType(ComponentType type)
void	setConfiguration(Properties configs) Set the static component configuration.
void	setDescription(String descr)
void	setInstallationDescriptor(String jbiXml)
void	setInstallRoot(String installRoot)
void	setName(String name)
void	setProperty(String key, String value)
void	setServiceUnitList(List<ServiceUnitInfo> list)
void	setSharedLibraryNames(List<String> list)
void	setStatus(ComponentState state)
void	setTimestamp(long timestamp)
void	setUpgradeNumber(int upgradeNumber)
void	setVariables(ComponentInfo.Variable[] envVars) Set the Environment Variables
void	setWorkspaceRoot(String workspaceRoot)
String	toXmlString() Return an XML string representing this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentInfoImpl

public ComponentInfoImpl()

Method Detail

equals

public boolean equals(Object object)

Determine if the supplied Object is equal to this one.

Specified by:

equals in interface ComponentInfo

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

public List 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.

Specified by:

getClassPathElements in interface ComponentInfo

Returns:

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

setClassPathElements

public void setClassPathElements(List<String> elements)

addClassPathElement

public void addClassPathElement(String element)

getComponentClassName

public 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.

Specified by:

getComponentClassName in interface ComponentInfo

Returns:

the name of the Component class.

setComponentClassName

public void setComponentClassName(String className)

getComponentType

public ComponentType getComponentType()

Get the component type.

Specified by:

getComponentType in interface ComponentInfo

Returns:

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

setComponentType

public void setComponentType(ComponentType type)

getDescription

public String getDescription()

Get the description of the component.

Specified by:

getDescription in interface ComponentInfo

Returns:

the String describing the component.

setDescription

public void setDescription(String descr)

getInstallRoot

public String getInstallRoot()

Get the directory into which this component is installed.

Specified by:

getInstallRoot in interface ComponentInfo

Returns:

the directory into which this component is installed.

setInstallRoot

public void setInstallRoot(String installRoot)

getWorkspaceRoot

public String getWorkspaceRoot()

Get the workspace for the component

Specified by:

getWorkspaceRoot in interface ComponentInfo

Returns:

this components workspace directory.

setWorkspaceRoot

public void setWorkspaceRoot(String workspaceRoot)

getName

public String getName()

Get the name of the component.

Specified by:

getName in interface ComponentInfo

Returns:

the name of the component.

setName

public void setName(String name)

getTimestamp

public long getTimestamp()

Get the timestamp associated with archive.

Returns:

the timestamp of the archive.

setTimestamp

public void setTimestamp(long timestamp)

getUpgradeNumber

public long getUpgradeNumber()

Get the grade associated with a component.

Returns:

the upgrade number of the component.

setUpgradeNumber

public void setUpgradeNumber(int upgradeNumber)

getServiceUnitList

public List getServiceUnitList()

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

Specified by:

getServiceUnitList in interface ComponentInfo

Returns:

List of ServiceUnitInfo objects.

setServiceUnitList

public void setServiceUnitList(List<ServiceUnitInfo> list)

addServiceUnitInfo

public void addServiceUnitInfo(ServiceUnitInfo suInfo)

getSharedLibraryNames

public List 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.

Specified by:

getSharedLibraryNames in interface ComponentInfo

Returns:

List of Strings containing Shared Library names.

setSharedLibraryNames

public void setSharedLibraryNames(List<String> list)

addSharedLibrary

public void addSharedLibrary(String sharedLibraryName)

getStatus

public ComponentState getStatus()

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

Specified by:

getStatus in interface ComponentInfo

Returns:

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

setStatus

public void setStatus(ComponentState state)

hashCode

public int hashCode()

Get a hash code for this ComponentInfo.

Specified by:

hashCode in interface ComponentInfo

Overrides:

hashCode in class Object

Returns:

the hash code for the object.

getProperties

public Map getProperties()

Get the installation specific properties for the component.

Specified by:

getProperties in interface ComponentInfo

Returns:

a Map of the properties

setProperty

public void setProperty(String key,
               String value)

isBootstrapClassLoaderSelfFirst

public boolean isBootstrapClassLoaderSelfFirst()

Specified by:

isBootstrapClassLoaderSelfFirst in interface ComponentInfo

Returns:

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

setBootstrapClassLoaderSelfFirst

public void setBootstrapClassLoaderSelfFirst(boolean flag)

isClassLoaderSelfFirst

public boolean isClassLoaderSelfFirst()

Specified by:

isClassLoaderSelfFirst in interface ComponentInfo

Returns:

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

setClassLoaderSelfFirst

public void setClassLoaderSelfFirst(boolean flag)

getBootstrapClassPathElements

public List getBootstrapClassPathElements()

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

Specified by:

getBootstrapClassPathElements in interface ComponentInfo

Returns:

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

setBootstrapClassPathElements

public void setBootstrapClassPathElements(List elements)

getBootstrapClassName

public String getBootstrapClassName()

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

Specified by:

getBootstrapClassName in interface ComponentInfo

Returns:

The bootstrap class name.

setBootstrapClassName

public void setBootstrapClassName(String name)

getInstallationDescriptor

public String getInstallationDescriptor()

Specified by:

getInstallationDescriptor in interface ComponentInfo

Returns:

the Installation Descriptor [jbi.xml] for the Component / Shared Library.

setInstallationDescriptor

public void setInstallationDescriptor(String jbiXml)

Parameters:

jbiXml - - the string representation of the installation descriptor for this Component / Shared Library

toXmlString

public String toXmlString()

Return an XML string representing this component.

Returns:

The XML that represents this component's attributes.

getVariables

public ComponentInfo.Variable[] getVariables()

Get the Environment Variables

Returns:

an array of Variables set on the component. If there are zero environment variables et on the component an empty array is returned.

getConfiguration

public Properties getConfiguration()

Get the static component configuration.

Returns:

the components constant configuration.

getApplicationConfiguration

public Properties getApplicationConfiguration(String name)

Get a specific application configuration.

Returns:

the application configuration whose name = configName. If one does not exist an empty properties object is returned.

getApplicationConfigurationNames

public String[] getApplicationConfigurationNames()

Get the names of all application configurations set on the component.

Returns:

a list of names of all application configurations. If there are zero application configurations set on the component an empty array is returned.

setVariables

public void setVariables(ComponentInfo.Variable[] envVars)

Set the Environment Variables

Parameters:

envVars - - an array of Variables set on the component.

setConfiguration

public void setConfiguration(Properties configs)

Set the static component configuration.

Parameters:

configs - the components constant configuration.

setApplicationConfiguration

public void setApplicationConfiguration(String name,
                               Properties applicationConfig)

Get a specific application configuration.