com.sun.jbi.management.registry.xml

Class RegistryDocument

java.lang.Object

com.sun.jbi.management.registry.xml.RegistryDocument

public class RegistryDocument
extends Object

RegistryDocument encapsulates a read only registry DOM. This class has user friendly operations to get information from the registry w/o getting into the nitty-gritty details of parsing the registry XML doc. This class uses XPath expressions for faster processing.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
RegistryDocument(Document regDoc)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttribute(String target, ConfigurationCategory category, String attribName) Get the value of a specific configuration attribute for a target belonging to a particular category.
Map<String,Properties>	getComponentApplicationConfiguration(String target, boolean isServer, String componentName) Get all the named application configurations.
ComponentInfo.Variable[]	getComponentApplicationVariables(String target, boolean isServer, String componentName) Get the application variables set on a specific component.
Properties	getComponentConfigurationAttributes(String target, boolean isServer, String componentName) Get the static component configuration attributes for a component.
String	getConfigurationAttribute(String target, ConfigurationCategory category, String attrName) Get the value of a specific configuration attribute for a target belonging to a particular category.
Map<String,String>	getConfigurationAttributes(String target, ConfigurationCategory category) Get a map of all the configuration attributes for a particular category.
Element	getTarget(String target, boolean isServer)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryDocument

public RegistryDocument(Document regDoc)

Method Detail

getConfigurationAttribute

public String getConfigurationAttribute(String target,
                               ConfigurationCategory category,
                               String attrName)

Get the value of a specific configuration attribute for a target belonging to a particular category. If the attribute is overriden then the override is returned. If the attribute is missing or the registry configuration is empty a null value is returned.

Parameters:

target - - identification for the target

category - - configuration category

name - - attribute name

Returns:

the string value of the configuration attribute from the persisted registry or null if the attribute is missing or configuration is empty

getConfigurationAttributes

public Map<String,String> getConfigurationAttributes(String target,
                                            ConfigurationCategory category)

Get a map of all the configuration attributes for a particular category. If an attribute is overriden then the specific value replaces the domain configuration

Parameters:

target - - identification for the target

category - - configuration category

Returns:

the configuration attributes from the persisted registry or an empty list

getComponentConfigurationAttributes

public Properties getComponentConfigurationAttributes(String target,
                                             boolean isServer,
                                             String componentName)

Get the static component configuration attributes for a component.

getComponentApplicationVariables

public ComponentInfo.Variable[] getComponentApplicationVariables(String target,
                                                        boolean isServer,
                                                        String componentName)

Get the application variables set on a specific component.

Parameters:

isServer - - flag indicating whether the target is a server or cluster.

target - - target name

componentName - - identification for the component.

getComponentApplicationConfiguration

public Map<String,Properties> getComponentApplicationConfiguration(String target,
                                                          boolean isServer,
                                                          String componentName)

Get all the named application configurations.

Parameters:

isServer - flag indicating whether the target is a server or cluster.

target - target name

componentName - identification for the component.

Returns:

a Map of configuration names and the named config properties.

getAttribute

public String getAttribute(String target,
                  ConfigurationCategory category,
                  String attribName)

Get the value of a specific configuration attribute for a target belonging to a particular category.

Parameters:

target - - identification for the target

category - - configuration category

name - - attribute name

Returns:

the string value of the configuration attribute from the persisted registry or null if the attribute is missing or configuration is empty

getTarget

public Element getTarget(String target,
                boolean isServer)

Returns:

the target reference element