|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.common.namedobject.BasicObject com.metamatrix.common.config.model.BasicComponentObject com.metamatrix.common.config.model.BasicConfiguration
public class BasicConfiguration
Configuration represents a single named set of deployable components (e.g., service and system components), a deployed set of components, 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 |
---|
Fields inherited from interface com.metamatrix.common.config.api.Configuration |
---|
COMPONENT_TYPE_NAME, CONFIG_COMPONENT_TYPE_ID, NEXT_STARTUP, NEXT_STARTUP_ID |
Constructor Summary | |
---|---|
BasicConfiguration(ConfigurationInfo configInfo,
ComponentTypeID typeID)
Construct a new Configuration using the name and component type; |
Method Summary | |
---|---|
void |
addComponentDefn(ComponentDefn component)
Add a component to list of available components that can be deployed for this configuration. |
void |
addDeployedComponent(DeployedComponent component)
Add a Component to the list of deployed components. |
void |
addHost(Host component)
|
java.lang.Object |
clone()
Return a deep cloned instance of this object. |
boolean |
doesExist(ComponentDefnID componentID)
|
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 based on 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()
return a clone of the Map of ComponentDefns so that no one can add directly to this objects Map of component definitions |
java.util.Collection |
getComponentObjectDependencies(BaseID componentObjectID)
Returns a Collection of ProductServiceConfig objects which have ServiceComponentDefns which are deployed to the indicated VM. |
ResourceDescriptor |
getConnectionPool(ComponentDefnID componentID)
|
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 componentID)
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(ComponentDefnID hostID)
|
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. |
BaseID |
getID()
Get the ID for this metadata object. |
ConfigurationInfo |
getInfo()
Returns the ConfigurationInfo that provides basic information
about this configuration. |
java.lang.String |
getName()
Override this method to obtain the name from the ConfigurationInfo. |
ResourceDescriptor |
getResourcePool(java.lang.String poolName)
Returns a ResourceDescriptor for the specified descriptorName |
java.util.Collection |
getResourcePools()
Returns a Collection of type ComponentType that represent
all the ComponentTypes defined. |
ServiceComponentDefn |
getServiceComponentDefn(ComponentDefnID componentID)
Returns a ServiceComponentDefn |
ServiceComponentDefn |
getServiceComponentDefn(java.lang.String name)
Returns a ConnectorBinding based on the specified 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 |
getVMDefn(ComponentDefnID componentID)
|
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 |
isNextStartUp()
Does this config represent the Next Startup config? |
boolean |
isReleased()
Returns a boolean true if the configuration is released and ready for deployment. |
void |
removeComponentObject(ComponentObjectID componentID)
Remove the component from this list of available components that can be deployed. |
void |
setComponentDefns(java.util.Map components)
|
void |
setConnectors(java.util.Map components)
|
void |
setDeployedComponents(java.util.Map components)
|
void |
setHosts(java.util.Map newHosts)
|
Methods inherited from class com.metamatrix.common.config.model.BasicComponentObject |
---|
accept, addProperties, addProperty, getComponentTypeID, getCreatedBy, getCreatedDate, getCreatedDateString, getDescription, getEditableProperties, getLastChangedBy, getLastChangedDate, getLastChangedDateString, getProperties, getProperty, isDependentUpon, removeProperties, removeProperty, setCreatedBy, setCreatedDate, setDescription, setLastChangedBy, setLastChangedDate, setProperties, toString |
Methods inherited from class com.metamatrix.common.namedobject.BasicObject |
---|
compareTo, equals, getFullName, hashCode, setID |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.metamatrix.common.config.api.Configuration |
---|
getProperties, getProperty |
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 |
---|
getFullName |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Constructor Detail |
---|
public BasicConfiguration(ConfigurationInfo configInfo, ComponentTypeID typeID)
Method Detail |
---|
public BaseID getID()
BasicObject
getID
in interface BaseObject
getID
in class BasicObject
public java.lang.String getName()
getName
in interface ComponentObject
getName
in interface Configuration
getName
in interface BaseObject
getName
in class BasicObject
getFullName
public boolean isNextStartUp()
public ConfigurationInfo getInfo()
Configuration
ConfigurationInfo
that provides basic information
about this configuration.
getInfo
in interface Configuration
public java.util.Map getComponentDefns()
getComponentDefns
in interface Configuration
public boolean doesExist(ComponentDefnID componentID)
public ComponentDefn getComponentDefn(ComponentDefnID componentID)
Configuration
getComponentDefn
in interface Configuration
componentID
- ID of the ComponentDefn to retrieve from
this configuration object
public VMComponentDefn getVMComponentDefn(ComponentDefnID componentID)
Configuration
VMComponentDefn
getVMComponentDefn
in interface Configuration
public VMComponentDefn getVMDefn(ComponentDefnID componentID)
public AuthenticationProvider getAuthenticationProvider(java.lang.String name)
AuthenticationProvider
based on the specified name.
getAuthenticationProvider
in interface Configuration
public AuthenticationProvider getAuthenticationProvider(ComponentDefnID componentID)
Configuration
AuthenticationProvider
for the specified componentID.
getAuthenticationProvider
in interface Configuration
public ResourceDescriptor getConnectionPool(ComponentDefnID componentID)
public ConnectorBinding getConnectorBinding(ComponentDefnID componentID)
Configuration
ConnectorBinding
based on the specified compoentID
getConnectorBinding
in interface Configuration
public ConnectorBinding getConnectorBinding(java.lang.String name)
ConnectorBinding
based on the specified name.
getConnectorBinding
in interface Configuration
public ConnectorBinding getConnectorBindingByRoutingID(java.lang.String routingID)
ConnectorBinding
based on the specified routing ID..
getConnectorBindingByRoutingID
in interface Configuration
public ServiceComponentDefn getServiceComponentDefn(ComponentDefnID componentID)
Configuration
ServiceComponentDefn
getServiceComponentDefn
in interface Configuration
public ServiceComponentDefn getServiceComponentDefn(java.lang.String name)
ConnectorBinding
based on the specified name.
getServiceComponentDefn
in interface Configuration
public java.util.Collection getComponentDefnIDs(ComponentTypeID componentTypeID)
getComponentDefnIDs
in interface Configuration
componentTypeID
- ComponentTypeID of desired ComponentDefns
contained in this Configuration
getComponentDefn(com.metamatrix.common.config.api.ComponentDefnID)
method to retrieve the full
ComponentDefn objectpublic java.util.Properties getDependentPropsForComponent(BaseID componentObjectID)
Configuration
getDependentPropsForComponent
in interface Configuration
componentObjectID
- is the component object for which all properties it inherits will be returned
Configuration.getAllPropertiesForComponent(com.metamatrix.common.namedobject.BaseID)
public java.util.Properties getAllPropertiesForComponent(BaseID componentObjectID)
Configuration
getAllPropertiesForComponent
in interface Configuration
componentObjectID
- is the id for the component object which all properties will be returned.
getDependentPropsForComponent
public java.util.Collection getDeployedComponents()
Configuration
Collection
of deployed components, keyed by the component id.
getDeployedComponents
in interface Configuration
public DeployedComponent getDeployedComponent(DeployedComponentID deployedComponentID)
Configuration
getDeployedComponent
in interface Configuration
deployedComponentID
- for the deployed component
public java.util.Collection getDeployedComponents(ComponentDefnID componentID)
Configuration
Collection
of deployed components that have been deployed for
that specified component definition.
getDeployedComponents
in interface Configuration
componentID
- is the definition that has been deployed
public VMComponentDefn getVMForHost(VMComponentDefnID vmID, HostID hostID)
Configuration
getVMForHost
in interface Configuration
vmID
- identifies the VM definition that was deployedhostID
- is the host the VM was deployed to.
public DeployedComponent getDeployedServiceForVM(ServiceComponentDefnID serviceID, VMComponentDefn vmComponent)
Configuration
getDeployedServiceForVM
in interface Configuration
serviceID
- identifies the service definition that was deployed
public DeployedComponent getDeployedServiceForVM(ServiceComponentDefnID serviceID, VMComponentDefnID vmID, HostID hostID)
Configuration
getDeployedServiceForVM
in interface Configuration
serviceID
- identifies the service definition that was deployedvmID
- is the VM the service was deployed to.hostID
- is the Host the service was deployed to.
public java.util.Collection getVMsForHost(java.lang.String name)
Configuration
Collection
of deployed components that are VM's deployed
on the specified host name
getVMsForHost
in interface Configuration
name
- of the Host the vm's were deployed on
public VMComponentDefn getVMForHost(java.lang.String hostname, java.lang.String processName)
Configuration
getVMForHost
in interface Configuration
public java.util.Collection getVMsForHost(HostID id)
Collection
of type DeployeComponent
that
represent VMs.
getVMsForHost
in interface Configuration
id
- of the Host the vm's were deployed on
public java.util.Collection getHostIDs()
Collection
of type HostID
that were deployed for this configuration.
getHostIDs
in interface Configuration
public java.util.Collection getConnectorBindings()
Configuration
Collection
of type ConnectorBinding
that exist for this configuration.
getConnectorBindings
in interface Configuration
public java.util.Collection getAuthenticationProviders()
Configuration
Collection
of type AuthenticationProvider
that exist for this configuration.
getAuthenticationProviders
in interface Configuration
public java.util.Collection getHosts()
Configuration
Collection
of type Host
that exist for this configuration.
getHosts
in interface Configuration
public Host getHost(ComponentDefnID hostID)
public Host getHost(java.lang.String hostName)
Host
for the specified host name
getHost
in interface Configuration
public java.util.Collection getDeployedServicesForVM(VMComponentDefnID vmComponentID)
getDeployedServicesForVM
in interface Configuration
public java.util.Collection getDeployedServicesForVM(VMComponentDefn vm)
Configuration
Collection
of DeployedComponents that
represent services deployed on the indicated deployed VM
getDeployedServicesForVM
in interface Configuration
vm
- component represents the deployed vm for which the services
have been deployed.
public java.util.Collection getComponentObjectDependencies(BaseID componentObjectID)
getComponentObjectDependencies
in interface Configuration
deployedVM
- DeployedComponent representing a deployed
VMComponentDefn
InvalidArgumentException
- if the parameter is nullpublic java.util.Collection getResourcePools()
Collection
of type ComponentType
that represent
all the ComponentTypes defined.
ComponentType
ConfigurationException
- if an error occurred within or during communication with the Configuration Service.#ComponentType
public java.util.Collection getServiceComponentDefns()
Collection
of type ServiceComponentDefn
that represent
all the ServiceComponentDefn defined.
getServiceComponentDefns
in interface Configuration
ServiceComponentDefn
ConfigurationException
- if an error occurred within or during communication with the Configuration Service.#ProductServiceConfig
public java.util.Collection getVMComponentDefns()
Collection
of type VMComponentDefn
that represent
all the VMComponentDefn defined.
getVMComponentDefns
in interface Configuration
VMComponentDefn
ConfigurationException
- if an error occurred within or during communication with the Configuration Service.#ProductServiceConfig
public ResourceDescriptor getResourcePool(java.lang.String poolName)
ResourceDescriptor
for the specified descriptorName
descriptorName
- is the name of the resource descriptor to return
ConfigurationException
- if an error occurred within or during communication with the Configuration Service.public boolean isDeployed()
Configuration
isDeployed
in interface Configuration
public boolean isLocked()
Configuration
isLocked
in interface Configuration
public boolean isReleased()
Configuration
isReleased
in interface Configuration
public void addComponentDefn(ComponentDefn component)
public void addDeployedComponent(DeployedComponent component)
Component
to the list of deployed components.
public void addHost(Host component)
public void removeComponentObject(ComponentObjectID componentID)
public void setDeployedComponents(java.util.Map components)
public void setConnectors(java.util.Map components)
public void setComponentDefns(java.util.Map components)
public void setHosts(java.util.Map newHosts)
public java.lang.Object clone()
BaseObject
clone
in interface BaseObject
clone
in class BasicObject
Defaults
cannot be cloned).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |