com.metamatrix.platform.config.spi.xml
Class XMLConfigurationReader

java.lang.Object
  com.metamatrix.platform.config.spi.xml.XMLConfigurationReader

public class XMLConfigurationReader
extends java.lang.Object

Constructor Summary

XMLConfigurationReader(ManagedConnection mgdConnection)

Method Summary

boolean	doesResourceExist(java.lang.String resourceName)
ComponentDefn	getComponentDefinition(ComponentDefnID targetID)
ComponentDefn	getComponentDefinition(ComponentDefnID targetID, ConfigurationID configurationID)
java.util.Map	getComponentDefinitions(ConfigurationID configID)
java.lang.String	getComponentPropertyValue(ComponentObjectID componentObjectID, ComponentTypeID typeID, java.lang.String propertyName)
ComponentType	getComponentType(ComponentTypeID typeID)
java.util.Collection	getComponentTypes(boolean includeDeprecated)
java.util.Collection	getComponenTypeDefinitions(ComponentTypeID componentTypeID) Takes a ProductType, and puts into it the ComponentTypeID objects representing legal service types for that product type.
ConfigurationModelContainer	getConfigurationModel(ConfigurationID configID)
java.util.Collection	getConnectionPools(ConfigurationID configurationID)
java.util.List	getDeployedComponents(ConfigurationID configurationID) Returns a UIDCollection of all the deployed components for the configuration.
Configuration	getDesignatedConfiguration(ConfigurationID configurationID) Returns one of the well-known system configurations, either the operational configuration, the next startup configuration, or the startup configuration.
Configuration	getDesignatedConfiguration(java.lang.String name) Returns the Configuration for the given name, or null if the ID is invalid.
ConfigurationID	getDesignatedConfigurationID(java.lang.String designation) Returns ID of one of the well-known system configurations, either the operational configuration, the next startup configuration, or the startup configuration.
java.util.Properties	getDesignatedConfigurationProperties(java.lang.String designation) used specifically by the CurrentConfiguration via JDBCCurrentConfigurationReader
Host	getHost(HostID hostID)
java.util.Collection	getHosts()
java.util.Collection	getMonitoredComponentTypes(boolean includeDeprecated)
java.util.Collection	getProductTypes(boolean includeDeprecated)
SharedResource	getResource(java.lang.String resourceName)
java.util.Collection	getResources()
int	getServerStartupState() Returns the int startup state, use constants in StartupStateController to interpret the meaning
java.util.Date	getServerStartupTime() Obtain the Date that represents the time the server was started
ConfigUserTransaction	getTransaction(java.lang.String principal)
boolean	isDefinitionDeployable(ComponentDefnID defnID)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLConfigurationReader

public XMLConfigurationReader(ManagedConnection mgdConnection)

Method Detail

getHost

public Host getHost(HostID hostID)
             throws ConfigurationException

Throws:

ConfigurationException

getHosts

public java.util.Collection getHosts()
                              throws ConfigurationException

Throws:

ConfigurationException

getServerStartupTime

public java.util.Date getServerStartupTime()
                                    throws ConfigurationException

Obtain the Date that represents the time the server was started

Returns:

Date

Throws:

ConfigurationException - if an business error occurred within or during communication with the Configuration Service.

getComponentType

public ComponentType getComponentType(ComponentTypeID typeID)
                               throws ConfigurationException

Throws:

ConfigurationException

getComponentTypes

public java.util.Collection getComponentTypes(boolean includeDeprecated)
                                       throws ConfigurationException

Throws:

ConfigurationException

getProductTypes

public java.util.Collection getProductTypes(boolean includeDeprecated)
                                     throws ConfigurationException

Throws:

ConfigurationException

getComponentPropertyValue

public java.lang.String getComponentPropertyValue(ComponentObjectID componentObjectID,
                                                  ComponentTypeID typeID,
                                                  java.lang.String propertyName)
                                           throws ConfigurationException

Throws:

ConfigurationException

getComponentDefinition

public ComponentDefn getComponentDefinition(ComponentDefnID targetID)
                                     throws ConfigurationException

Throws:

ConfigurationException

getComponentDefinition

public ComponentDefn getComponentDefinition(ComponentDefnID targetID,
                                            ConfigurationID configurationID)
                                     throws ConfigurationException

Throws:

ConfigurationException

getComponentDefinitions

public java.util.Map getComponentDefinitions(ConfigurationID configID)
                                      throws ConfigurationException

Throws:

ConfigurationException

getConnectionPools

public java.util.Collection getConnectionPools(ConfigurationID configurationID)
                                        throws ConfigurationException

Throws:

ConfigurationException

getComponenTypeDefinitions

public java.util.Collection getComponenTypeDefinitions(ComponentTypeID componentTypeID)
                                                throws ConfigurationException

Takes a ProductType, and puts into it the ComponentTypeID objects representing legal service types for that product type.

Throws:

ConfigurationException

getDeployedComponents

public java.util.List getDeployedComponents(ConfigurationID configurationID)
                                     throws ConfigurationException

Returns a UIDCollection of all the deployed components for the configuration. These components will be complete with properties

Throws:

ConfigurationException

getResources

public java.util.Collection getResources()
                                  throws ConfigurationException

Throws:

ConfigurationException

getResource

public SharedResource getResource(java.lang.String resourceName)
                           throws ConfigurationException

Throws:

ConfigurationException

getServerStartupState

public int getServerStartupState()
                          throws ConfigurationException

Returns the int startup state, use constants in StartupStateController to interpret the meaning

Throws:

ConfigurationException

doesResourceExist

public boolean doesResourceExist(java.lang.String resourceName)
                          throws ConfigurationException

Throws:

ConfigurationException

isDefinitionDeployable

public boolean isDefinitionDeployable(ComponentDefnID defnID)
                               throws ConfigurationException

Throws:

ConfigurationException

getDesignatedConfigurationID

public ConfigurationID getDesignatedConfigurationID(java.lang.String designation)
                                             throws ConfigurationException

Returns ID of one of the well-known system configurations, either the operational configuration, the next startup configuration, or the startup configuration. Use SystemConfigurationNames to supply the String parameter. Will return null if the designation parameter is invalid.

Parameters:

designation - String indicating which of the system configurations is desired; use one of the SystemConfigurationNames constants

jdbcConnection - connection to the proper config database

Returns:

the desired ConfigurationID

Throws:

ConfigurationException - if an error occurred within or during communication with the Configuration Service.

getDesignatedConfigurationProperties

public java.util.Properties getDesignatedConfigurationProperties(java.lang.String designation)
                                                          throws ConfigurationException

used specifically by the CurrentConfiguration via JDBCCurrentConfigurationReader

Throws:

ConfigurationException

getDesignatedConfiguration

public Configuration getDesignatedConfiguration(java.lang.String name)
                                         throws ConfigurationException

Returns the Configuration for the given name, or null if the ID is invalid.

Parameters:

name - of a valid Configuration

configurationID - ID of a valid Configuration

Returns:

jdbcConnection Connection to the configuration data source

Throws:

ConfigurationException - if a problem occurs communicating with the data source

getConfigurationModel

public ConfigurationModelContainer getConfigurationModel(ConfigurationID configID)
                                                  throws ConfigurationException

Throws:

ConfigurationException

getDesignatedConfiguration

public Configuration getDesignatedConfiguration(ConfigurationID configurationID)
                                         throws ConfigurationException

Returns one of the well-known system configurations, either the operational configuration, the next startup configuration, or the startup configuration. Use SystemConfigurationNames to supply the String parameter. Will return null if the designation parameter is invalid.

Parameters:

designation - String indicating which of the system configurations is desired; use one of the SystemConfigurationNames constants

Returns:

the desired Configuration

Throws:

ConfigurationException - if an error occurred within or during communication with the Configuration Service.

getMonitoredComponentTypes

public java.util.Collection getMonitoredComponentTypes(boolean includeDeprecated)
                                                throws ConfigurationException

Throws:

ConfigurationException

getTransaction

public ConfigUserTransaction getTransaction(java.lang.String principal)
                                     throws ConfigTransactionException

Throws:

ConfigTransactionException