com.metamatrix.common.config.api
Interface Configuration

All Superinterfaces:

BaseObject, java.lang.Cloneable, java.lang.Comparable, ComponentObject

All Known Implementing Classes:

BasicConfiguration

public interface Configuration
extends ComponentObject

Configuration represents deployable components (e.g., service and vm components), components definitions, global properties, and additional information. Once the configuration is flagged as "Released", it is then available to be deployed. Once it is flagged as "Deployed", it cannot be changed. The configuration must be versioned, and then changes can be made to the new versioned copy.

Field Summary

static java.lang.String	COMPONENT_TYPE_NAME
static ComponentTypeID	CONFIG_COMPONENT_TYPE_ID
static java.lang.String	NEXT_STARTUP
static ConfigurationID	NEXT_STARTUP_ID These configuration ID's can be used to determine which Configuration a ConfigurationID represents using equals.

Method Summary

java.util.Properties	getAllPropertiesForComponent(BaseID componentObjectID) Returns the all properites for the specified component object.
AuthenticationProvider	getAuthenticationProvider(ComponentDefnID componentID) Returns a AuthenticationProvider for the specified componentID.
AuthenticationProvider	getAuthenticationProvider(java.lang.String name) Returns a AuthenticationProvider for the specified name.
java.util.Collection	getAuthenticationProviders() Returns a Collection of type AuthenticationProvider that exist for this configuration.
ComponentDefn	getComponentDefn(ComponentDefnID componentID) This method returns a ComponentDefn implementation, given a ComponentDefnID.
java.util.Collection	getComponentDefnIDs(ComponentTypeID componentTypeID) Returns a Collection of ComponentDefnID objects that are of the indicated type.
java.util.Map	getComponentDefns() Returns a Map of the component definitions that have been created for this configuration.
java.util.Collection	getComponentObjectDependencies(BaseID componentObjectID) Returns a Collection of component objects that are dependent on the specified component object.
ConnectorBinding	getConnectorBinding(ComponentDefnID componentID) Returns a ConnectorBinding based on the specified compoentID
ConnectorBinding	getConnectorBinding(java.lang.String name) Returns a ConnectorBinding based on the specified name.
ConnectorBinding	getConnectorBindingByRoutingID(java.lang.String routingID) Returns a ConnectorBinding based on the specified routing ID..
java.util.Collection	getConnectorBindings() Returns a Collection of type ConnectorBinding that exist for this configuration.
java.util.Properties	getDependentPropsForComponent(BaseID componentObjectID) Returns only the dependent properites for the specified component object.
DeployedComponent	getDeployedComponent(DeployedComponentID deployedComponentID) Returns the deployed component for the specified id
java.util.Collection	getDeployedComponents() Returns a Collection of deployed components, keyed by the component id.
java.util.Collection	getDeployedComponents(ComponentDefnID componentDefnID) Returns a Collection of deployed components that have been deployed for that specified component definition.
DeployedComponent	getDeployedServiceForVM(ServiceComponentDefnID serviceID, VMComponentDefn vmComponent) Returns a deployed Service component that was deployed on the specified VM.
DeployedComponent	getDeployedServiceForVM(ServiceComponentDefnID serviceID, VMComponentDefnID vmID, HostID hostID) Returns a deployed Service component that was deployed on the specified VM and Host.
java.util.Collection	getDeployedServicesForVM(VMComponentDefn vm) Returns a Collection of DeployedComponents that represent services deployed on the indicated deployed VM
java.util.Collection	getDeployedServicesForVM(VMComponentDefnID vmComponentID) This method is technically incorrect, because deployed services should be returned for the deployed vm that they are deployed to, not the vm component definition which may itself be deployed many times.
Host	getHost(java.lang.String hostName) Returns a Host for the specified host name
java.util.Collection	getHostIDs() Returns a Collection of type HostID that were deployed for this configuration.
java.util.Collection	getHosts() Returns a Collection of type Host that exist for this configuration.
ConfigurationInfo	getInfo() Returns the ConfigurationInfo that provides basic information about this configuration.
LogConfiguration	getLogConfiguration() Returns the LogConfiguration
java.lang.String	getName() Returns the name
java.util.Properties	getProperties() Returns a UnmodifiableProperties object containing the current configuration properties.
java.lang.String	getProperty(java.lang.String name) Returns the property value for the specified property name.
ServiceComponentDefn	getServiceComponentDefn(ComponentDefnID defnID) Returns a ServiceComponentDefn
ServiceComponentDefn	getServiceComponentDefn(java.lang.String name) Returns a ServiceComponentDefn based on the service name.
java.util.Collection	getServiceComponentDefns() Returns a Collection of type ServiceComponentDefn that represent all the ServiceComponentDefn defined.
VMComponentDefn	getVMComponentDefn(ComponentDefnID componentID) Returns a VMComponentDefn
java.util.Collection	getVMComponentDefns() Returns a Collection of type VMComponentDefn that represent all the VMComponentDefn defined.
VMComponentDefn	getVMForHost(java.lang.String hostname, java.lang.String processName) Returns a deployed VM component that was deployed on the specified host.
VMComponentDefn	getVMForHost(VMComponentDefnID vmID, HostID hostID) Returns a deployed VM component that was deployed on the specified host.
java.util.Collection	getVMsForHost(HostID id) Returns a Collection of type DeployeComponent that represent VMs.
java.util.Collection	getVMsForHost(java.lang.String name) Returns a Collection of deployed components that are VM's deployed on the specified host name
boolean	isDeployed() Returns a boolean true if the configuration is deployed for current use.
boolean	isLocked() Returns a boolean true if the configuration is locked for current modifications.
boolean	isReleased() Returns a boolean true if the configuration is released and ready for deployment.

Methods inherited from interface com.metamatrix.common.config.api.ComponentObject

accept, getComponentTypeID, getCreatedBy, getCreatedDate, getDescription, getLastChangedBy, getLastChangedDate, isDependentUpon

Methods inherited from interface com.metamatrix.common.namedobject.BaseObject

clone, getFullName, getID

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

NEXT_STARTUP

static final java.lang.String NEXT_STARTUP

See Also:

Constant Field Values

NEXT_STARTUP_ID

static final ConfigurationID NEXT_STARTUP_ID

These configuration ID's can be used to determine which Configuration a ConfigurationID represents using equals.

COMPONENT_TYPE_NAME

static final java.lang.String COMPONENT_TYPE_NAME

See Also:

Constant Field Values

CONFIG_COMPONENT_TYPE_ID

static final ComponentTypeID CONFIG_COMPONENT_TYPE_ID

Method Detail

getName

java.lang.String getName()

Description copied from interface: ComponentObject

Returns the name

Specified by:

getName in interface BaseObject

Specified by:

getName in interface ComponentObject

Returns:

String name of component

See Also:

getFullName

getInfo

ConfigurationInfo getInfo()

Returns the ConfigurationInfo that provides basic information about this configuration.

Returns:

ConfigurationInfo

getProperties

java.util.Properties getProperties()

Returns a UnmodifiableProperties object containing the current configuration properties.

Specified by:

getProperties in interface ComponentObject

Returns:

Properties

getProperty

java.lang.String getProperty(java.lang.String name)

Returns the property value for the specified property name.

Specified by:

getProperty in interface ComponentObject

Parameters:

name - of the property value to obtain

Returns:

String value

getComponentDefns

java.util.Map getComponentDefns()

Returns a Map of the component definitions that have been created for this configuration.

Returns:

Map of component definitions

getComponentDefn

ComponentDefn getComponentDefn(ComponentDefnID componentID)

This method returns a ComponentDefn implementation, given a ComponentDefnID. The returned object can be cast to the subclass which corresponds to the subclass of the componentID parameter. For example, if a ServiceComponentDefnID is passed in, then the returned object will be a ServiceComponentDefn.

Parameters:

componentID - ID of the ComponentDefn to retrieve from this configuration object

Returns:

ComponentDefn impl corresponding to the ID

getComponentDefnIDs

java.util.Collection getComponentDefnIDs(ComponentTypeID componentTypeID)

Returns a Collection of ComponentDefnID objects that are of the indicated type. Note that the type must be an exact match, no component defns of a sub-type of the indicated type will be returned.

Parameters:

componentTypeID - ComponentTypeID of desired ComponentDefns contained in this Configuration

Returns:

Collection of ComponentDefnID objects - use getComponentDefn(com.metamatrix.common.config.api.ComponentDefnID) method to retrieve the full ComponentDefn object

getDependentPropsForComponent

java.util.Properties getDependentPropsForComponent(BaseID componentObjectID)

Returns only the dependent properites for the specified component object. This excludes the properties that are defined at components level. To get the properties defined at this components level, call #getProperties() on the component. The following is the top-down hierarchy as to the order properties are assembled for inheritance: A. VM ComponentDefn - Configuration - VM definition B. Service ComponentDefn - Configuration - Service definition C. VM Deployed Component - Configuration - VM Definition - VM Deployed Component D. Service Deployed Component - VM Deployed Component (and all dependencies) - Service Definition - Service Deployed Component

Parameters:

componentObjectID - is the component object for which all properties it inherits will be returned

Returns:

Properties that are inherited

See Also:

getAllPropertiesForComponent(com.metamatrix.common.namedobject.BaseID)

getAllPropertiesForComponent

java.util.Properties getAllPropertiesForComponent(BaseID componentObjectID)

Returns the all properites for the specified component object. This includes the dependent propertie, as well as, the properties defined at its level.

Parameters:

componentObjectID - is the id for the component object which all properties will be returned.

Returns:

Properties that are inherited

See Also:

getDependentPropsForComponent

getDeployedComponents

java.util.Collection getDeployedComponents()

Returns a Collection of deployed components, keyed by the component id.

Returns:

Collection of deployed components

getDeployedComponents

java.util.Collection getDeployedComponents(ComponentDefnID componentDefnID)

Returns a Collection of deployed components that have been deployed for that specified component definition.

Parameters:

componentDefnID - is the definition that has been deployed

Returns:

Collection of deployed components

getDeployedComponent

DeployedComponent getDeployedComponent(DeployedComponentID deployedComponentID)

Returns the deployed component for the specified id

Parameters:

deployedComponentID - for the deployed component

Returns:

DeployedComponent

getVMForHost

VMComponentDefn getVMForHost(VMComponentDefnID vmID,
                             HostID hostID)

Returns a deployed VM component that was deployed on the specified host.

Parameters:

vmID - identifies the VM definition that was deployed

hostID - is the host the VM was deployed to.

Returns:

DeployedComponent

getVMForHost

VMComponentDefn getVMForHost(java.lang.String hostname,
                             java.lang.String processName)

Returns a deployed VM component that was deployed on the specified host.

Parameters:

vmID - identifies the VM definition that was deployed

hostID - is the host the VM was deployed to.

Returns:

DeployedComponent

getDeployedServiceForVM

DeployedComponent getDeployedServiceForVM(ServiceComponentDefnID serviceID,
                                          VMComponentDefn vmComponent)

Returns a deployed Service component that was deployed on the specified VM.

Parameters:

serviceID - identifies the service definition that was deployed

vmDeployedComponent - is the deployed VM the service was deployed to.

Returns:

DeployedComponent

getDeployedServiceForVM

DeployedComponent getDeployedServiceForVM(ServiceComponentDefnID serviceID,
                                          VMComponentDefnID vmID,
                                          HostID hostID)

Returns a deployed Service component that was deployed on the specified VM and Host.

Parameters:

serviceID - identifies the service definition that was deployed

vmID - is the VM the service was deployed to.

hostID - is the Host the service was deployed to.

Returns:

DeployedComponent

getVMsForHost

java.util.Collection getVMsForHost(java.lang.String name)

Returns a Collection of deployed components that are VM's deployed on the specified host name

Parameters:

name - of the Host the vm's were deployed on

Returns:

Collection of deployed components

getVMsForHost

java.util.Collection getVMsForHost(HostID id)

Returns a Collection of type DeployeComponent that represent VMs.

Parameters:

id - of the Host the vm's were deployed on

Returns:

Collection of deployed components

getHostIDs

java.util.Collection getHostIDs()

Returns a Collection of type HostID that were deployed for this configuration.

Returns:

Collection of deployed hosts

getDeployedServicesForVM

java.util.Collection getDeployedServicesForVM(VMComponentDefnID vmComponentID)

This method is technically incorrect, because deployed services should be returned for the deployed vm that they are deployed to, not the vm component definition which may itself be deployed many times.

getDeployedServicesForVM

java.util.Collection getDeployedServicesForVM(VMComponentDefn vm)

Returns a Collection of DeployedComponents that represent services deployed on the indicated deployed VM

Parameters:

vm - component represents the deployed vm for which the services have been deployed.

Returns:

Collection of DeployedComponent objects representing deployed services

getComponentObjectDependencies

java.util.Collection getComponentObjectDependencies(BaseID componentObjectID)

Returns a Collection of component objects that are dependent on the specified component object.

Parameters:

componentObjectID - to check for dependencies

Returns:

Collection of dependent components

getHosts

java.util.Collection getHosts()

Returns a Collection of type Host that exist for this configuration.

Returns:

Collection of deployed hosts

getConnectorBindings

java.util.Collection getConnectorBindings()

Returns a Collection of type ConnectorBinding that exist for this configuration.

Returns:

Collection of deployed hosts

getAuthenticationProviders

java.util.Collection getAuthenticationProviders()

Returns a Collection of type AuthenticationProvider that exist for this configuration.

Returns:

Collection of authentication providers

getAuthenticationProvider

AuthenticationProvider getAuthenticationProvider(java.lang.String name)

Returns a AuthenticationProvider for the specified name.

Parameters:

name -

Returns:

getAuthenticationProvider

AuthenticationProvider getAuthenticationProvider(ComponentDefnID componentID)

Returns a AuthenticationProvider for the specified componentID.

Parameters:

componentID -

Returns:

getConnectorBinding

ConnectorBinding getConnectorBinding(java.lang.String name)

Returns a ConnectorBinding based on the specified name.

Returns:

ConnectorBinding for that name

getConnectorBindingByRoutingID

ConnectorBinding getConnectorBindingByRoutingID(java.lang.String routingID)

Returns a ConnectorBinding based on the specified routing ID..

Returns:

ConnectorBinding for that name

getConnectorBinding

ConnectorBinding getConnectorBinding(ComponentDefnID componentID)

Returns a ConnectorBinding based on the specified compoentID

Returns:

ConnectorBinding for that give component ID

getHost

Host getHost(java.lang.String hostName)

Returns a Host for the specified host name

Returns:

Host

getServiceComponentDefn

ServiceComponentDefn getServiceComponentDefn(ComponentDefnID defnID)

Returns a ServiceComponentDefn

Returns:

ServiceComponentDefn

getServiceComponentDefn

ServiceComponentDefn getServiceComponentDefn(java.lang.String name)

Returns a ServiceComponentDefn based on the service name.

Returns:

ServiceComponentDefn

getServiceComponentDefns

java.util.Collection getServiceComponentDefns()

Returns a Collection of type ServiceComponentDefn that represent all the ServiceComponentDefn defined.

Returns:

Collection of type ServiceComponentDefn

getVMComponentDefn

VMComponentDefn getVMComponentDefn(ComponentDefnID componentID)

Returns a VMComponentDefn

Returns:

VMComponentDefn

getVMComponentDefns

java.util.Collection getVMComponentDefns()

Returns a Collection of type VMComponentDefn that represent all the VMComponentDefn defined.

Returns:

Collection of type VMComponentDefn

getLogConfiguration

LogConfiguration getLogConfiguration()

Returns the LogConfiguration

Returns:

LogConfiguration

isDeployed

boolean isDeployed()

Returns a boolean true if the configuration is deployed for current use.

Returns:

boolean true if the configuration is deployed

isLocked

boolean isLocked()

Returns a boolean true if the configuration is locked for current modifications.

Returns:

boolean true if the configuration is currently locked.

isReleased

boolean isReleased()

Returns a boolean true if the configuration is released and ready for deployment.

Returns:

boolean true if the configuration is released.