com.metamatrix.common.config.api
Interface ConfigurationModelContainer

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

ConfigurationModelContainerImpl

public interface ConfigurationModelContainer
extends java.lang.Cloneable

Created on Sep 18, 2002 The ConfigurationModelContainer represents the logical view to obtaining configuration related information. The persistent layer will build this container

Method Summary

java.lang.Object	clone()
ConfigurationModelContainer	copyAs(ConfigurationID configID)
java.util.Collection	getAllComponentTypeDefinitions(ComponentTypeID typeID) Return a collection of the ComponentTypeDefinitions for the request component type
java.util.Collection	getAllObjects() Return all the objects that make up this model.
ComponentType	getComponentType(java.lang.String fullName) Return the ComponentType for the specified name
ComponentTypeDefn	getComponentTypeDefinition(ComponentTypeID typeID, java.lang.String defnName) Return a ComponentTypeDefn for a give typeID and defnName.
java.util.Map	getComponentTypes() Return a map of the component types.
Configuration	getConfiguration()
ConfigurationID	getConfigurationID()
java.util.Collection	getConnectionPools() Return a collection of objects of type ResourceDescriptor.
java.util.Properties	getDefaultPropertyValues(ComponentTypeID componentTypeID) Return a properties object that contains the default properties defined for the specified component type
Host	getHost(java.lang.String fullName) Return a host based on the host name.
java.util.Collection	getHosts() Return a collection of objects of type Host.
ProductType	getProductType(java.lang.String fullname) Return a ProductType based on the specified name.
java.util.Collection	getProductTypes() Return a collection of objects of type ProductType.
SharedResource	getResource(java.lang.String resourceName)
java.util.Collection	getResources()

Method Detail

getConfiguration

Configuration getConfiguration()

getConfigurationID

ConfigurationID getConfigurationID()

getAllObjects

java.util.Collection getAllObjects()

Return all the objects that make up this model. Note, objects that are modeled under the context of a configuration will be contained in the Configuration object. The following are the types that are not modeled under on configuration:

Host

ComponentTypes,ProductTypes

ConnectorBindings

Resources

Returns:

Collection of objects

getHosts

java.util.Collection getHosts()

Return a collection of objects of type Host. These are all the hosts defined in this configuration.

Returns:

Since:

4.2

getHost

Host getHost(java.lang.String fullName)

Return a host based on the host name.

Parameters:

fullName -

Returns:

Since:

4.2

getComponentTypes

java.util.Map getComponentTypes()

Return a map of the component types. type full name ComponentType

Returns:

map of ComponentTypes

Since:

4.1

getAllComponentTypeDefinitions

java.util.Collection getAllComponentTypeDefinitions(ComponentTypeID typeID)

Return a collection of the ComponentTypeDefinitions for the request component type

Parameters:

typeID -

Returns:

Collection of ComponentTypeDefinitions

Since:

4.1

getComponentTypeDefinition

ComponentTypeDefn getComponentTypeDefinition(ComponentTypeID typeID,
                                             java.lang.String defnName)

Return a ComponentTypeDefn for a give typeID and defnName.

Parameters:

typeID - identifies the specific @link ComponentType to look for

defnName - idenfities the @link ComponentTypeDefn to look for in the componentType.

Returns:

ComponentTypeDefn

Since:

4.1

getComponentType

ComponentType getComponentType(java.lang.String fullName)

Return the ComponentType for the specified name

Parameters:

fullName -

Returns:

ComponentType

Since:

4.1

getDefaultPropertyValues

java.util.Properties getDefaultPropertyValues(ComponentTypeID componentTypeID)

Return a properties object that contains the default properties defined for the specified component type

Parameters:

componentTypeID -

Returns:

default Properties for the ComponentType

Since:

4.1

getConnectionPools

java.util.Collection getConnectionPools()

Return a collection of objects of type ResourceDescriptor. These are all the hosts defined in this configuration.

Returns:

Since:

4.2

getProductTypes

java.util.Collection getProductTypes()

Return a collection of objects of type ProductType. These are all the hosts defined in this configuration.

Returns:

Since:

4.2

getProductType

ProductType getProductType(java.lang.String fullname)

Return a ProductType based on the specified name.

Returns:

Since:

4.2

getResource

SharedResource getResource(java.lang.String resourceName)

getResources

java.util.Collection getResources()

copyAs

ConfigurationModelContainer copyAs(ConfigurationID configID)
                                   throws ConfigurationException

Throws:

ConfigurationException

clone

java.lang.Object clone()