com.metamatrix.common.config.api
Interface ConfigurationObjectEditor

All Superinterfaces:

ObjectEditor

All Known Implementing Classes:

BasicConfigurationObjectEditor

public interface ConfigurationObjectEditor
extends ObjectEditor

Field Summary

Fields inherited from interface com.metamatrix.common.actions.ObjectEditor

ADD, REMOVE, SET

Method Summary

void	addAuthenticationProvider(Configuration configuration, AuthenticationProvider provider)
ComponentObject	addProperty(ComponentObject t, java.lang.String name, java.lang.String value) Adds the property value for the specified name on the ComponentObject.
ProductServiceConfig	addServiceComponentDefn(Configuration configuration, ProductServiceConfig psc, ServiceComponentDefnID serviceComponentDefnID) Adds an existing ServiceComponentDefn to indicated PSC; the ServiceComponentDefn is assumed to already belong to the indicated Configuration.
ProductServiceConfig	addServiceComponentDefn(ProductServiceConfig psc, ServiceComponentDefnID serviceComponentDefnID) Adds an existing ServiceComponentDefn to indicated PSC.
ProductType	addServiceComponentType(ProductType productType, ComponentType serviceComponentType) Adds the service type represented by the indicated ComponentType to the list of legal service types of the indicated ProductType.
AuthenticationProvider	createAuthenticationProviderComponent(Configuration configuration, AuthenticationProvider original, java.lang.String newName) This method will create a provider component from the original provider and give a new name.
AuthenticationProvider	createAuthenticationProviderComponent(ConfigurationID configurationID, AuthenticationProvider original, java.lang.String newName) This method will create a provider component from the original provider and give a new name.
AuthenticationProvider	createAuthenticationProviderComponent(ConfigurationID configuID, ComponentTypeID typeID, java.lang.String descriptorName) This method will create a provider component based on the specific component type ID
ComponentType	createComponentType(ComponentType componentType, java.lang.String name) Create a new ComponentType instance from a copy of the specified ComponentType.
ComponentType	createComponentType(int classTypeCode, java.lang.String name, ComponentTypeID parentID, ComponentTypeID superID, boolean deployable, boolean monitored) Create a new ComponentType instance with the specified name.
ComponentTypeDefn	createComponentTypeDefn(ComponentTypeID typeID, PropertyDefinition propertyDefinition) Deprecated. as of v 2.0 beta 1, use createComponentTypeDefn(ComponentTypeID, PropertyDefinition, boolean)
ComponentTypeDefn	createComponentTypeDefn(ComponentTypeID typeID, PropertyDefinition propertyDefinition, boolean isEffectiveImmediately) Create a new ComponentTypeDefn instance with the specified name.
ComponentTypeDefn	createComponentTypeDefn(ComponentType type, PropertyDefinition propertyDefinition) Deprecated. as of v 2.0 beta 1, use createComponentTypeDefn(ComponentType, PropertyDefinition, boolean)
ComponentTypeDefn	createComponentTypeDefn(ComponentType type, PropertyDefinition propertyDefinition, boolean isEffectiveImmediately) Create a new ComponentTypeDefn and update the ComponentType with the new defintion.
void	createConfiguration(ConfigurationID configID, java.util.Collection configObjects) This method is used only for importing a complete configurtion model.
Configuration	createConfiguration(Configuration original, java.lang.String newName) Copy-create method - creates a deep-copy of the original configuration, with the new name.
Configuration	createConfiguration(java.lang.String configurationName) Create a new Configuration instance with the specified name ID.
Configuration	createConfiguration(java.lang.String configurationName, java.util.Date creationDate, java.util.Date lastChangedDate) Create a new Configuration instance with the specified name ID, and the specified Date parameters.
ConnectorBinding	createConnectorComponent(Configuration configuration, ComponentTypeID typeID, java.lang.String componentName, ProductServiceConfigID pscID) Creates a new ConnectorBinding for a given Configuration and ProductServiceConfig; also automatically "deploys" the service anywhere that this PSC is already deployed, by creating the necessary DeployedComponents (this will only work if the PSC parameter belongs to the Configuration parameter).
ConnectorBinding	createConnectorComponent(ConfigurationID configuID, ComponentTypeID typeID, java.lang.String descriptorName, java.lang.String routingUUID) This method will create a connector component based on the specific component type ID
ConnectorBinding	createConnectorComponent(ConfigurationID configurationID, ConnectorBinding original, java.lang.String newName, java.lang.String routingUUID) This method will create a connector component from the original connector and give a new name.
DeployedComponent	createDeployedServiceComponent(java.lang.String instanceName, Configuration configuration, HostID hostId, VMComponentDefnID vmId, ServiceComponentDefn serviceComponentDefn, ProductServiceConfigID pscID) Create a new DeployedComponent instance respresenting a deployed Service.
DeployedComponent	createDeployedServiceComponent(java.lang.String instanceName, ConfigurationID configurationID, HostID hostId, VMComponentDefnID vmId, ServiceComponentDefnID serviceComponentDefnID, ProductServiceConfigID pscID, ComponentTypeID serviceComponentTypeID) Create a new DeployedComponent instance respresenting a deployed Service.
Host	createHost(ConfigurationID configurationID, java.lang.String hostName)
Host	createHost(Configuration configuration, java.lang.String hostName)
Host	createHost(java.lang.String hostName) Create a new Host instance with the specified ID.
ProductServiceConfig	createProductServiceConfig(ConfigurationID configurationID, ProductTypeID productTypeID, java.lang.String componentName) Allows the creation of an empty ProductServiceConfig entirely from ID objects.
ProductServiceConfig	createProductServiceConfig(Configuration configuration, ProductServiceConfig originalPSC, java.lang.String newName) Copy-creation method, creates a new PSC from the given PSC, with the new given name, and inserts it into the given Configuration.
ProductServiceConfig	createProductServiceConfig(Configuration configuration, ProductTypeID productTypeID, java.lang.String componentName) Allows the creation of an empty ProductServiceConfig entirely from ID objects.
ProductType	createProductType(java.lang.String name, boolean deployable, boolean monitored) Create a new ProductType instance with the specified name.
ProductType	createProductType(java.lang.String name, java.util.Collection serviceComponentTypes, boolean deployable, boolean monitored) Create a new ProductType instance with the specified name.
PropDefnAllowedValue	createPropDefnAllowedValue(ComponentTypeDefn typeDefn, PropertyDefinition propDefn, java.lang.String value) Create a new PropDefnAllowedValue that will be added to the modifiable (cloned) PropertyDefinition that was obtained from the ComponentTypeDefn.
ResourceDescriptor	createResourceDescriptor(Configuration configuration, ComponentTypeID typeID, java.lang.String descriptorName) Create a new ResourceDescriptor Component Definition instance with a specified configuration
ResourceDescriptor	createResourceDescriptor(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String descriptorName) Create a new ResourceDescriptor Component Definition instance with a specified configuration
ServiceComponentDefn	createServiceComponentDefn(Configuration configuration, ComponentTypeID typeID, java.lang.String componentName) Create a new Service Component Definition instance with a specified configuration
ServiceComponentDefn	createServiceComponentDefn(Configuration configuration, ComponentTypeID typeID, java.lang.String componentName, ProductServiceConfigID pscID) Creates a new ServiceComponentDefn for a given Configuration and ProductServiceConfig; also automatically "deploys" the service anywhere that this PSC is already deployed, by creating the necessary DeployedComponents (this will only work if the PSC parameter belongs to the Configuration parameter).
ServiceComponentDefn	createServiceComponentDefn(Configuration configuration, ComponentTypeID typeID, java.lang.String componentName, java.lang.String routingUUID) Create a new Service Component Definition instance with a specified configuration
ServiceComponentDefn	createServiceComponentDefn(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String componentName) Create a new Service Component Definition instance with a specified configuration
ServiceComponentDefn	createServiceComponentDefn(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String componentName, java.lang.String routingUUID) Create a new Service Component Definition instance with a specified configuration
SharedResource	createSharedResource(ComponentTypeID typeID, java.lang.String resourceName) Create a new SharedResource instance
VMComponentDefn	createVMComponentDefn(Configuration configuration, HostID hostID, ComponentTypeID typeID, java.lang.String componentName) Create a new VM Component Definition instance with a specified configuration
VMComponentDefn	createVMComponentDefn(ConfigurationID configurationID, HostID hostID, ComponentTypeID typeID, java.lang.String componentName) Create a new VM Component Definition instance with a specified configuration
Configuration	delete(ComponentObject target, Configuration configuration) Removes the component object from the specified configuration if no dependent objects exist and returns an updated configuration.
Configuration	delete(ComponentObject target, Configuration configuration, boolean deleteDependencies) Removes the component object from the specified configuration if no dependent objects exist.
void	delete(ComponentType target) Call to delete a component type and all its definitions.
void	delete(ComponentTypeDefn target, ComponentType type) Call to delete a ComponentTypeDefn and remove it from the ComponentType.
void	delete(Configuration target) Call to delete a configuration, which is assumed to have no dependencies.
void	delete(Configuration target, boolean deleteDependencies) Deletes the configuration if there exist no dependent objects.
void	delete(ConfigurationID targetID) Call to delete a configuration and all its dependencies.
void	delete(Host target) Call to delete a host
SharedResource	delete(SharedResource target) Deletes the shared resource.
java.util.Collection	deployProductServiceConfig(Configuration configuration, ProductServiceConfig psc, HostID hostId, VMComponentDefnID vmId) Deploys the ServiceComponentDefns indicated by the ProductServiceConfig, contained by the Configuration, onto the specified Host and VM.
java.util.Collection	deployServiceDefn(Configuration configuration, ServiceComponentDefn serviceComponentDefn, ProductServiceConfigID pscID) Deploys a ServiceComponentDefn anywhere that it's PSC is already deployed.
java.util.Properties	getEditableProperties(ComponentObject t) Returns a modifiable properties object for the specified ComponentObject.
ComponentTypeDefn	modifyComponentTypeDefn(ComponentTypeDefn original, ComponentTypeDefn updated) Updates the target ComponentTypeDefn with the updated PropertyDefinition.
ComponentObject	modifyProperties(ComponentObject t, java.util.Properties props, int command) call modifyProperties
ComponentObject	removeProperty(ComponentObject t, java.lang.String name) Removes the property value for the specified name on the ComponentObject.
ProductType	removeServiceComponentType(ProductType productType, ComponentType serviceComponentType) Removes the service type represented by the indicated ComponentType from the list of legal service types of the indicated ProductType.
ProductServiceConfig	renamePSC(ProductServiceConfig psc, java.lang.String name) Change the name of a previously defined PSC.
VMComponentDefn	renameVM(VMComponentDefn vm, java.lang.String name) Change the name of a previously defined VM.
void	setBootStrapConfiguration(ConfigurationID configurationID) Deprecated. as of v 2.0 beta 1, use setNextStartupConfiguration(com.metamatrix.common.config.api.ConfigurationID)
ComponentObject	setComponentType(ComponentObject t, ComponentTypeID componentType) Sets the component type on the specifice component object.
ComponentType	setComponentTypeDefinitions(ComponentType t, java.util.Collection defns) Set the list of ComponentTypeDefns for a local ComponentType object.
ComponentObject	setCreationChangedHistory(ComponentObject compObject, java.lang.String createdBy, java.lang.String creationDate)
ComponentType	setCreationChangedHistory(ComponentType type, java.lang.String createdBy, java.lang.String creationDate)
java.util.Collection	setEnabled(Configuration configuration, ServiceComponentDefn serviceComponentDefn, ProductServiceConfig psc, boolean enabled, boolean deleteDeployedComps) Sets whether the indicated ServiceComponentDefn is enabled for deployment (when the PSC which contains it is deployed) or not.
ProductServiceConfig	setEnabled(ServiceComponentDefnID serviceComponentDefnID, ProductServiceConfig psc, boolean enabled) It simply modifies the ProductServiceConfig by setting the specified service enabled value and creates the necessary change object.
ComponentType	setIsDeployable(ComponentType t, boolean newValue)
Configuration	setIsDeployed(Configuration t, boolean newValue)
ComponentType	setIsDeprecated(ComponentType t, boolean newValue)
ComponentType	setIsMonitored(ComponentType t, boolean newValue)
Configuration	setIsReleased(Configuration t, boolean newValue)
ComponentObject	setLastChangedHistory(ComponentObject compObject, java.lang.String lastChangedBy, java.lang.String lastChangedDate)
ComponentType	setLastChangedHistory(ComponentType type, java.lang.String lastChangedBy, java.lang.String lastChangedDate)
Configuration	setLogConfiguration(Configuration t, LogConfiguration logConfiguration) Sets the LogConfiguration in effect for the Configuration
void	setNextStartupConfiguration(ConfigurationID configurationID) Sets the system next startup configuration
ComponentType	setParentComponentTypeID(ComponentType t, ComponentTypeID parentID) Sets the parent component type, null is allowed;
ComponentObject	setProperty(ComponentObject t, java.lang.String name, java.lang.String value) Set the property value for the specified name on the ComponentObject.
ComponentTypeDefn	setPropertyDefinition(ComponentTypeDefn t, PropertyDefinition defn) Set the PropertyDefinition on the ComponentTypeDefn
void	setRoutingUUID(ServiceComponentDefn serviceComponentDefn, java.lang.String newRoutingUUID) Sets this ServiceComponentDefn's String routing UUID.
ComponentType	setSuperComponentTypeID(ComponentType t, ComponentTypeID superID) Sets the super component type, null is allowed;
ProductServiceConfig	updateProductServiceConfig(Configuration config, ProductServiceConfig psc, java.util.Collection newServiceIDList) This method will update a PSC by adding the new service list of ID's and removing the service ID's from the PSC that are not in the service list.

Methods inherited from interface com.metamatrix.common.actions.ObjectEditor

getDestination, setDestination

Method Detail

createHost

Host createHost(java.lang.String hostName)

Create a new Host instance with the specified ID.

Parameters:

hostName - for the new Host (may not be null).

Returns:

the Host instance

Throws:

java.lang.IllegalArgumentException - if the hostName is null

createHost

Host createHost(ConfigurationID configurationID,
                java.lang.String hostName)

createHost

Host createHost(Configuration configuration,
                java.lang.String hostName)

createConfiguration

void createConfiguration(ConfigurationID configID,
                         java.util.Collection configObjects)

This method is used only for importing a complete configurtion model. The objects should include all object types (e.g., Configuration, Host, ComponentDefn, DeployedComponent, ComponentTypes, PSCs, etc.);

createConfiguration

Configuration createConfiguration(java.lang.String configurationName)

Create a new Configuration instance with the specified name ID.

Parameters:

configurationName - for the new configuration (may not be null).

Returns:

the Configuration instance

Throws:

java.lang.IllegalArgumentException - if the configurationName is null

createConfiguration

Configuration createConfiguration(java.lang.String configurationName,
                                  java.util.Date creationDate,
                                  java.util.Date lastChangedDate)

Create a new Configuration instance with the specified name ID, and the specified Date parameters. This method is only useful for re-creating a serialized configuration; typically a client will want to use createConfiguration(String)

Parameters:

configurationName - for the new configuration (may not be null).

creationDate - Date the configuration was created.

creationDate - Date the configuration was last modified.

Returns:

the Configuration instance

Throws:

java.lang.IllegalArgumentException - if the configurationName is null

createConfiguration

Configuration createConfiguration(Configuration original,
                                  java.lang.String newName)

Copy-create method - creates a deep-copy of the original configuration, with the new name. The new name cannot be the same as the original configuration's name.

All service component definitions, all deployed components, and all property values will also be copied. The copies will all retain their original short names; their full names will reflect the new configuration name.

createComponentType

ComponentType createComponentType(int classTypeCode,
                                  java.lang.String name,
                                  ComponentTypeID parentID,
                                  ComponentTypeID superID,
                                  boolean deployable,
                                  boolean monitored)

Create a new ComponentType instance with the specified name.

Parameters:

classTypeCode - identifies the type of class this component type should represent

name - is the name of the ComponentType

parentID - is the component type that is the parent, can be null

superID - is the component type that is a super type of this component type, can be null

deployable - is a boolean indicating if the type can be deployed in a configuration

monitored - is a boolean insdicating if the type is to be monitored

Returns:

ComponentType

See Also:

for type codes

createComponentType

ComponentType createComponentType(ComponentType componentType,
                                  java.lang.String name)

Create a new ComponentType instance from a copy of the specified ComponentType.

Parameters:

componentType - is the original component type to copy from

name - is the name of the ComponentType

Returns:

ComponentType

createProductType

ProductType createProductType(java.lang.String name,
                              boolean deployable,
                              boolean monitored)

Create a new ProductType instance with the specified name. Use createProductType(String, Collection, boolean, boolean) to also assign legal service types to this product type.

Parameters:

name - is the name of the ProductType

deployable - is a boolean indicating if the type can be deployed in a configuration

monitored - is a boolean insdicating if the type is to be monitored

Returns:

ComponentType

createProductType

ProductType createProductType(java.lang.String name,
                              java.util.Collection serviceComponentTypes,
                              boolean deployable,
                              boolean monitored)

Create a new ProductType instance with the specified name.

Parameters:

name - is the name of the ProductType

serviceComponentTypeIDs - Collection of ComponentType objects which indicate the service types that belong to this product type

deployable - is a boolean indicating if the type can be deployed in a configuration

monitored - is a boolean insdicating if the type is to be monitored

Returns:

ComponentType

createComponentTypeDefn

ComponentTypeDefn createComponentTypeDefn(ComponentType type,
                                          PropertyDefinition propertyDefinition,
                                          boolean isEffectiveImmediately)

Create a new ComponentTypeDefn and update the ComponentType with the new defintion.

Parameters:

type - is the ComponentType the definition will be added to

propertyDefinition - are the attributes describing this definition

isEffectiveImmediately - indicates that a change to a property value for this definition can have an immediate effect (as opposed to not taking effect until server reboots)

Returns:

the ComponentTypeDefn instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createComponentTypeDefn

ComponentTypeDefn createComponentTypeDefn(ComponentType type,
                                          PropertyDefinition propertyDefinition)

Deprecated. as of v 2.0 beta 1, use createComponentTypeDefn(ComponentType, PropertyDefinition, boolean)

createComponentTypeDefn

ComponentTypeDefn createComponentTypeDefn(ComponentTypeID typeID,
                                          PropertyDefinition propertyDefinition,
                                          boolean isEffectiveImmediately)

Create a new ComponentTypeDefn instance with the specified name. To create a basic PropertyDefinition, do the following: PropertyDefinition defn = new PropertyDefinition(); defn.setPropertyType(PropertyType.BOOLEAN);

Parameters:

typeID - for the parent component type this definitions is used by

propertyDefinition - are the attributes describing this definition

isEffectiveImmediately - indicates that a change to a property value for this definition can have an immediate effect (as opposed to not taking effect until server reboots)

Returns:

the ComponentTypeDefn instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

See Also:

createComponentTypeDefn(ComponentType, PropertyDefinition)

createComponentTypeDefn

ComponentTypeDefn createComponentTypeDefn(ComponentTypeID typeID,
                                          PropertyDefinition propertyDefinition)

Deprecated. as of v 2.0 beta 1, use createComponentTypeDefn(ComponentTypeID, PropertyDefinition, boolean)

createPropDefnAllowedValue

PropDefnAllowedValue createPropDefnAllowedValue(ComponentTypeDefn typeDefn,
                                                PropertyDefinition propDefn,
                                                java.lang.String value)
                                                throws InvalidComponentException

Create a new PropDefnAllowedValue that will be added to the modifiable (cloned) PropertyDefinition that was obtained from the ComponentTypeDefn.

Parameters:

typeDefn - is the ComponentTypeDefn the allowed value will be added to

propDefn - is the PropertyDefinition that the new create PropDefnAllowedValue will be added to.

value - is the allowed value

Returns:

PropDefnAllowedValue

Throws:

InvalidComponentException - if the existing allowed values in the typeDefn are not of type PropDefnAllowedValue

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createVMComponentDefn

VMComponentDefn createVMComponentDefn(ConfigurationID configurationID,
                                      HostID hostID,
                                      ComponentTypeID typeID,
                                      java.lang.String componentName)

Create a new VM Component Definition instance with a specified configuration

Parameters:

id - the ID for this object (may not be null).

typeID - is the type of component definition to create

componentName - is the name of the component

Returns:

the Component instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

See Also:

createVMComponentDefn(Configuration, ComponentTypeID, String)

createVMComponentDefn

VMComponentDefn createVMComponentDefn(Configuration configuration,
                                      HostID hostID,
                                      ComponentTypeID typeID,
                                      java.lang.String componentName)

Create a new VM Component Definition instance with a specified configuration

Parameters:

configuration - that will contain the new created component definition

typeID - is the type of component definition to create

componentName - is the name of the component

Returns:

the Component instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createServiceComponentDefn

ServiceComponentDefn createServiceComponentDefn(ConfigurationID configurationID,
                                                ComponentTypeID typeID,
                                                java.lang.String componentName)

Create a new Service Component Definition instance with a specified configuration

Parameters:

id - the ID for this object (may not be null).

typeID - is the type of component definition to create

componentName - is the name of the component

Returns:

the Component instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

See Also:

createServiceComponentDefn(Configuration, ComponentTypeID, String)

createServiceComponentDefn

ServiceComponentDefn createServiceComponentDefn(ConfigurationID configurationID,
                                                ComponentTypeID typeID,
                                                java.lang.String componentName,
                                                java.lang.String routingUUID)

Create a new Service Component Definition instance with a specified configuration

Parameters:

id - the ID for this object (may not be null).

typeID - is the type of component definition to create

componentName - is the name of the component

routingUUID - the globally unique routing UUID of the Service Component Defn

Returns:

the Component instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

See Also:

createServiceComponentDefn(Configuration, ComponentTypeID, String)

createServiceComponentDefn

ServiceComponentDefn createServiceComponentDefn(Configuration configuration,
                                                ComponentTypeID typeID,
                                                java.lang.String componentName)

Create a new Service Component Definition instance with a specified configuration

Parameters:

configuration - that will contain the new created component definition

typeID - is the type of component definition to create

componentName - is the name of the component

Returns:

the Component instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createServiceComponentDefn

ServiceComponentDefn createServiceComponentDefn(Configuration configuration,
                                                ComponentTypeID typeID,
                                                java.lang.String componentName,
                                                java.lang.String routingUUID)

Create a new Service Component Definition instance with a specified configuration

Parameters:

configuration - that will contain the new created component definition

typeID - is the type of component definition to create

componentName - is the name of the component

routingUUID - the globally unique routing UUID of the Service Component Defn

Returns:

the Component instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createServiceComponentDefn

ServiceComponentDefn createServiceComponentDefn(Configuration configuration,
                                                ComponentTypeID typeID,
                                                java.lang.String componentName,
                                                ProductServiceConfigID pscID)

Creates a new ServiceComponentDefn for a given Configuration and ProductServiceConfig; also automatically "deploys" the service anywhere that this PSC is already deployed, by creating the necessary DeployedComponents (this will only work if the PSC parameter belongs to the Configuration parameter).

Parameters:

configuration - the Configuration containing the PSC; this will have the new ServiceComponentDefn added to it, plus any DeployedComponents created for the ServiceComponentDefn

typeID - type of the new ServiceComponentDefn

componentName - name for the new ServiceComponentDefn

pscID - ID of the ProductServiceConfig which this ServiceComponentDefn will belong to

Returns:

new ServiceComponentDefn

createResourceDescriptor

ResourceDescriptor createResourceDescriptor(ConfigurationID configurationID,
                                            ComponentTypeID typeID,
                                            java.lang.String descriptorName)

Create a new ResourceDescriptor Component Definition instance with a specified configuration

Parameters:

configurationID - that the new created component definition will be a part of

typeID - is the type of component definition to create

componentName - is the name of the component

Returns:

the ResourceDescriptor instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createResourceDescriptor

ResourceDescriptor createResourceDescriptor(Configuration configuration,
                                            ComponentTypeID typeID,
                                            java.lang.String descriptorName)

Create a new ResourceDescriptor Component Definition instance with a specified configuration

Parameters:

configuration - that will contain the new created component definition

typeID - is the type of component definition to create

componentName - is the name of the component

Returns:

the ResourceDescriptor instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createSharedResource

SharedResource createSharedResource(ComponentTypeID typeID,
                                    java.lang.String resourceName)

Create a new SharedResource instance

Parameters:

typeID - is the type of component definition to create

resourceName - is the name of the shared resource

Returns:

the ResourceDescriptor instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the ID or data source ID is null

createDeployedServiceComponent

DeployedComponent createDeployedServiceComponent(java.lang.String instanceName,
                                                 ConfigurationID configurationID,
                                                 HostID hostId,
                                                 VMComponentDefnID vmId,
                                                 ServiceComponentDefnID serviceComponentDefnID,
                                                 ProductServiceConfigID pscID,
                                                 ComponentTypeID serviceComponentTypeID)

Create a new DeployedComponent instance respresenting a deployed Service. This method has the advantage of allowing the creation of a deployed component entirely with ID objects, without needing any of the full objects themselves. However, it is the responsibility of the client that the ComponentTypeID parameter and the ServiceComponentDefnID parameter both indicate the same service type. Also, the local Configuration object represented by the ConfigurationID will not be updated.

Parameters:

instanceName - is the name assigned to this instance

configurationID - the configuration the vm is deployed within.

hostId - the host the vm is deployed in.

vmId - the VM that the service is deployed in.

serviceComponentDefnID - is the service component definition to be deployed

pscID - the ID of the ProductServiceConfig of the ServiceComponentDefn which is to be deployed.

serviceComponentTypeID - is type of the service to be deployed

Returns:

the DeployedComponent instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the IDs null

See Also:

createDeployedServiceComponent(String, Configuration, HostID, VMComponentDefn)

createDeployedServiceComponent

DeployedComponent createDeployedServiceComponent(java.lang.String instanceName,
                                                 Configuration configuration,
                                                 HostID hostId,
                                                 VMComponentDefnID vmId,
                                                 ServiceComponentDefn serviceComponentDefn,
                                                 ProductServiceConfigID pscID)

Create a new DeployedComponent instance respresenting a deployed Service. The Configuration parameter will be updated with the new deployed component.

Parameters:

instanceName - is the name assigned to this instance

configuration - the vm is deployed within.

hostId - the host the vm is deployed in.

vmId - the VM that the service is deployed in.

serviceComponentDefnID - is the service component definition to be deployed

componentTypeID - is the type of the service to be deployed

Returns:

the DeployedComponent instance with the specified ID.

Throws:

java.lang.IllegalArgumentException - if either of the IDs null

createProductServiceConfig

ProductServiceConfig createProductServiceConfig(Configuration configuration,
                                                ProductServiceConfig originalPSC,
                                                java.lang.String newName)

Copy-creation method, creates a new PSC from the given PSC, with the new given name, and inserts it into the given Configuration. The configuration parameter must match the configuration which the original PSC belongs to. This will also deep-copy the ServiceComponentDefns that are grouped by the originalPSC parameter.

Parameters:

configuration - which the originalPSC is from, and which the new PSC will be put in; this will be modified

originalPSC - the PSC to copy from

newName - new String name for the new PSC

Returns:

newly-created ProductServiceConfig object

createProductServiceConfig

ProductServiceConfig createProductServiceConfig(ConfigurationID configurationID,
                                                ProductTypeID productTypeID,
                                                java.lang.String componentName)

Allows the creation of an empty ProductServiceConfig entirely from ID objects. Use addServiceComponentDefn(com.metamatrix.common.config.api.Configuration, com.metamatrix.common.config.api.ProductServiceConfig, com.metamatrix.common.config.api.ServiceComponentDefnID) or #removeServiceComponentDefn in conjuncture with this method.

createProductServiceConfig

ProductServiceConfig createProductServiceConfig(Configuration configuration,
                                                ProductTypeID productTypeID,
                                                java.lang.String componentName)

Allows the creation of an empty ProductServiceConfig entirely from ID objects. Use addServiceComponentDefn(com.metamatrix.common.config.api.Configuration, com.metamatrix.common.config.api.ProductServiceConfig, com.metamatrix.common.config.api.ServiceComponentDefnID) or #removeServiceComponentDefn in conjuncture with this method.

deployProductServiceConfig

java.util.Collection deployProductServiceConfig(Configuration configuration,
                                                ProductServiceConfig psc,
                                                HostID hostId,
                                                VMComponentDefnID vmId)

Deploys the ServiceComponentDefns indicated by the ProductServiceConfig, contained by the Configuration, onto the specified Host and VM.

Parameters:

configuration - the Configuration which contains the ServiceComponentDefns, the ProductServiceConfig, and the VMComponentDefn

psc - the ProductServiceConfig which groups the ServiceComponentDefns to be deployed

hostId - ID of the host on which the services will be deployed

vmId - ID of the VMComponentDefn on which the services will be deployed

Returns:

Collection of DeployedComponent objects, each representing one of the deployed ServiceComponentDefns

deployServiceDefn

java.util.Collection deployServiceDefn(Configuration configuration,
                                       ServiceComponentDefn serviceComponentDefn,
                                       ProductServiceConfigID pscID)

Deploys a ServiceComponentDefn anywhere that it's PSC is already deployed. This method is harmless to call if the ServiceComponentDefn is already deployed anywhere. It is also harmless to call if the PSC has not been deployed at all (meaning no other services of the PSC have been deployed.) The ServiceComponentDefn must belong to the PSC, but this method does not check for that. A Collection of any newly-created DeployedComponent objects is returned.

Parameters:

configuration - must be the Configuration containing both the ServiceComponentDefn and PSC ID parameters (but this is not checked for in this method)

serviceComponentDefn - to be deployed

pscID - PSC ID that may already be deployed somewhere in the Configuration parameter

Returns:

Collection of newly-created DeployedComponent objects

setRoutingUUID

void setRoutingUUID(ServiceComponentDefn serviceComponentDefn,
                    java.lang.String newRoutingUUID)

Sets this ServiceComponentDefn's String routing UUID. This method will modify the ServiceComponentDefn parameter, and also create the action to set the routing UUID at the remote server.

Parameters:

serviceComponentDefn - ServiceComponentDefn to have it's routing UUID modified - this instance will be locally modified, and an action will also be created for execution as a transaction later on

newRoutingUUID - new String routing UUID for the indicated ServiceComponentDefn

setEnabled

java.util.Collection setEnabled(Configuration configuration,
                                ServiceComponentDefn serviceComponentDefn,
                                ProductServiceConfig psc,
                                boolean enabled,
                                boolean deleteDeployedComps)
                                throws ConfigurationException

Sets whether the indicated ServiceComponentDefn is enabled for deployment (when the PSC which contains it is deployed) or not. This method can also either automatically create the necessary DeployedComponents (if the service is being enabled) or (optionally) delete the related DeployedComponents (if the service defn is being disabled).

If the ServiceComponentDefn is being enabled:

• This method will set its enabled attribute to true.
• This method will check to see if the ProductServiceConfig PSC has been deployed on any vms, and, if so, will automatically create a DeployedComponent object for this newly-enabled ServiceComponentDefn for each different VM the psc is deployed; these objects will be returned in the returned Collection

If the ServiceComponentDefn is being disabled:

• This method will set its enabled attribute to false.
• If the deleteDeployedComps parameter is true, and the ServiceComponentDefn has been deployed anywhere, all of those DeployedComponents will be deleted from the Configuration; these same objects will be returned in the returned Collection.
• If the deleteDeployedComps is false, and the ServiceComponentDefn has been deployed anywhere, a ConfigurationException will be thrown, indicating that the ServiceComponentDefn cannot be deleted while it has dependant DeployedComponents that exist.

Note: This method will do nothing and return an empty Collection if the enabled parameter supplied is already the same as the enabled status of the ServiceComponentDefn parameter. This prevents unnecessary work for nothing.

Parameters:

configuration - Configuration which the ServiceComponentDefn belongs to. This object will be updated with the changed ServiceComponentDefn, and if any DeployedComponent objects are deleted.

deployedComponent - to have its enabled attribute set; it must belong to the indicated Configuration parameter. This object will have it's enabled field updated.

enabled - whether this service definition should be enabled for deployment or not.

deleteDeployedComps - With this parameter the client can control whether any deployed service components of the ServiceComponentDefn parameter are deleted automatically. If false is passed in, and one or more deployed services do exist for the ServiceComponentDefn parameter, a ConfigurationException will be thrown. If true is passed in, any deployed service components in the indicated configuration will be automatically deleted.

Returns:

the Collection of affected DeployedComponents; either the newly-created DeployedComponents, or the newly-deleted DeployedComponents. If none were affected, a non-null empty Collection will be returned.

Throws:

ConfigurationException - if false was passed in for the deleteDeployedComps parameter, and any DeployedComponents exist for the ServiceComponentDefn parameter.

See Also:

deployProductServiceConfig

setEnabled

ProductServiceConfig setEnabled(ServiceComponentDefnID serviceComponentDefnID,
                                ProductServiceConfig psc,
                                boolean enabled)

It simply modifies the ProductServiceConfig by setting the specified service enabled value and creates the necessary change object.

updateProductServiceConfig

ProductServiceConfig updateProductServiceConfig(Configuration config,
                                                ProductServiceConfig psc,
                                                java.util.Collection newServiceIDList)
                                                throws ConfigurationException

This method will update a PSC by adding the new service list of ID's and removing the service ID's from the PSC that are not in the service list.

Parameters:

config -

psc -

newServiceIDList - is the new list of ID's that the psc will contain

Returns:

updated ProductServiceConfig

Throws:

ConfigurationException

addServiceComponentDefn

ProductServiceConfig addServiceComponentDefn(Configuration configuration,
                                             ProductServiceConfig psc,
                                             ServiceComponentDefnID serviceComponentDefnID)

Adds an existing ServiceComponentDefn to indicated PSC; the ServiceComponentDefn is assumed to already belong to the indicated Configuration. The ServiceComponentDefn will be removed from any PSC it previously belonged to.

Parameters:

configuration - the Configuration containing the ServiceComponentDefn

psc - ProductServiceConfig to have service comp defn added to

serviceComponentDefnID - will be added to the indicated ProductServiceConfiguration (and removed from any PSC it previously belonged to).

addServiceComponentDefn

ProductServiceConfig addServiceComponentDefn(ProductServiceConfig psc,
                                             ServiceComponentDefnID serviceComponentDefnID)

Adds an existing ServiceComponentDefn to indicated PSC. The ServiceComponentDefn will be removed from any PSC it previously belonged to.

Parameters:

psc - ProductServiceConfig to have service comp defn added to

serviceComponentDefnID - will be added to the indicated ProductServiceConfiguration (and removed from any PSC it previously belonged to).

addServiceComponentType

ProductType addServiceComponentType(ProductType productType,
                                    ComponentType serviceComponentType)

Adds the service type represented by the indicated ComponentType to the list of legal service types of the indicated ProductType.

Parameters:

productType - ProductType to have a new service type added to

serviceComponentType - ComponentType to be added to the ProductType

removeServiceComponentType

ProductType removeServiceComponentType(ProductType productType,
                                       ComponentType serviceComponentType)

Removes the service type represented by the indicated ComponentType from the list of legal service types of the indicated ProductType.

Parameters:

productType - ProductType to have the service type taken from

serviceComponentType - ComponentType to be taken from the ProductType

getEditableProperties

java.util.Properties getEditableProperties(ComponentObject t)

Returns a modifiable properties object for the specified ComponentObject. If calling directly on the component object to obtain the properties, an unmodifiable properties objects will be returned.

Parameters:

t - is the component object to obtain the properties from

Returns:

modifiable Properties

renamePSC

ProductServiceConfig renamePSC(ProductServiceConfig psc,
                               java.lang.String name)
                               throws ConfigurationException

Change the name of a previously defined PSC.

Parameters:

psc - The psc whose name to change.

name - The new name.

Returns:

The PSC with its name changed.

Throws:

ConfigurationException

renameVM

VMComponentDefn renameVM(VMComponentDefn vm,
                         java.lang.String name)
                         throws ConfigurationException

Change the name of a previously defined VM.

Parameters:

vm - The VM whose name to change.

name - The new name.

Returns:

The VM with its name changed.

Throws:

ConfigurationException

setIsReleased

Configuration setIsReleased(Configuration t,
                            boolean newValue)

setIsDeployed

Configuration setIsDeployed(Configuration t,
                            boolean newValue)

setLogConfiguration

Configuration setLogConfiguration(Configuration t,
                                  LogConfiguration logConfiguration)

Sets the LogConfiguration in effect for the Configuration

setProperty

ComponentObject setProperty(ComponentObject t,
                            java.lang.String name,
                            java.lang.String value)

Set the property value for the specified name on the ComponentObject. This method will replace the current property by the same name.

Parameters:

t - is the ComponentObject to set the value on

name - is the name of the property

value - is the value for the property

Returns:

updated ComponentObject

addProperty

ComponentObject addProperty(ComponentObject t,
                            java.lang.String name,
                            java.lang.String value)

Adds the property value for the specified name on the ComponentObject. This method assumes the named property does not exist.

Parameters:

t - is the ComponentObject to set the value on

name - is the name of the property

value - is the value for the property

Returns:

updated ComponentObject

removeProperty

ComponentObject removeProperty(ComponentObject t,
                               java.lang.String name)

Removes the property value for the specified name on the ComponentObject.

Parameters:

t - is the ComponentObject to set the value on

name - is the name of the property

value - is the value for the property

Returns:

updated ComponentObject

modifyProperties

ComponentObject modifyProperties(ComponentObject t,
                                 java.util.Properties props,
                                 int command)

call modifyProperties

Parameters:

t - is the ComponentObject to set the value on

props - are the properties that will be used based on the command

command - the object editor command (ADD, REMOVE, or SET) that defines the operation to be performed.

Returns:

updated ComponentObject

modifyComponentTypeDefn

ComponentTypeDefn modifyComponentTypeDefn(ComponentTypeDefn original,
                                          ComponentTypeDefn updated)

Updates the target ComponentTypeDefn with the updated PropertyDefinition.

Parameters:

original - is the original ComponentTypeDefn to be updated.

updated - is the updated ComponentTypeDefn to replace the original.

defn - is the PropertyDefinition

Returns:

an updated ComponentTypeDefn

setParentComponentTypeID

ComponentType setParentComponentTypeID(ComponentType t,
                                       ComponentTypeID parentID)

Sets the parent component type, null is allowed;

Parameters:

t - is the ComponentType

parentID - is the parent component type (null allowed)

Returns:

ComponentType updated

setSuperComponentTypeID

ComponentType setSuperComponentTypeID(ComponentType t,
                                      ComponentTypeID superID)

Sets the super component type, null is allowed;

Parameters:

t - is the ComponentType

superID - is the super component type (null allowed)

Returns:

ComponentType updated

setIsDeployable

ComponentType setIsDeployable(ComponentType t,
                              boolean newValue)

setIsDeprecated

ComponentType setIsDeprecated(ComponentType t,
                              boolean newValue)

setIsMonitored

ComponentType setIsMonitored(ComponentType t,
                             boolean newValue)

setLastChangedHistory

ComponentType setLastChangedHistory(ComponentType type,
                                    java.lang.String lastChangedBy,
                                    java.lang.String lastChangedDate)

setCreationChangedHistory

ComponentType setCreationChangedHistory(ComponentType type,
                                        java.lang.String createdBy,
                                        java.lang.String creationDate)

setLastChangedHistory

ComponentObject setLastChangedHistory(ComponentObject compObject,
                                      java.lang.String lastChangedBy,
                                      java.lang.String lastChangedDate)

setCreationChangedHistory

ComponentObject setCreationChangedHistory(ComponentObject compObject,
                                          java.lang.String createdBy,
                                          java.lang.String creationDate)

setComponentType

ComponentObject setComponentType(ComponentObject t,
                                 ComponentTypeID componentType)

Sets the component type on the specifice component object.

Parameters:

t - is the ComponentObject to have its type set

componentType - is the ComponentType to set

Returns:

ComponentObject that had its type set

setComponentTypeDefinitions

ComponentType setComponentTypeDefinitions(ComponentType t,
                                          java.util.Collection defns)

Set the list of ComponentTypeDefns for a local ComponentType object. This method will not generate actions because the definitions should have been created using the createComponentTypeDefn method, which would set the ComponentType properly on the remote system; it is intended only to modify a local copy of a ComponentType object.

Parameters:

t - is the ComponentType to set on

defns - Collection of new definitions

Returns:

ComponentType that is modified

See Also:

createComponentTypeDefn(ComponentTypeID, PropertyDefinition, boolean)

setPropertyDefinition

ComponentTypeDefn setPropertyDefinition(ComponentTypeDefn t,
                                        PropertyDefinition defn)

Set the PropertyDefinition on the ComponentTypeDefn

Parameters:

t - is the component type definition to update with the defintion

defn - is the property defn that will be applied.

Returns:

updated ComponentTypeDefn

setBootStrapConfiguration

void setBootStrapConfiguration(ConfigurationID configurationID)
                               throws ConfigurationException

Deprecated. as of v 2.0 beta 1, use setNextStartupConfiguration(com.metamatrix.common.config.api.ConfigurationID)

Call to set the specified configuration as the next startup configuration, to use after a system reboot.

Parameters:

configurationID - for the Configuration to use on the next system reboot.

Throws:

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

setNextStartupConfiguration

void setNextStartupConfiguration(ConfigurationID configurationID)
                                 throws ConfigurationException

Sets the system next startup configuration

Parameters:

configurationID - for the Configuration to use on the next system reboot.

Throws:

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

delete

void delete(ComponentType target)
            throws ConfigurationException

Call to delete a component type and all its definitions.

Parameters:

target - ComponentType and all its ComponentTypeDefns to delete

Throws:

ConfigurationException - if unable to delete the ComponentType

java.lang.IllegalArgumentException - if target is null

delete

void delete(Host target)
            throws ConfigurationException

Call to delete a host

Parameters:

target - Host to delete

Throws:

ConfigurationException - if unable to delete the host

java.lang.IllegalArgumentException - if target is null

delete

void delete(ComponentTypeDefn target,
            ComponentType type)
            throws ConfigurationException

Call to delete a ComponentTypeDefn and remove it from the ComponentType. The type will changed by having the target ComponentTypeDefn removed.

Parameters:

target - is the ComponentTypeDefn to delete

type - is the ComponentType that it should be removed from.

Throws:

ConfigurationException - if unable to delete the configuration

java.lang.IllegalArgumentException - if target is null

delete

void delete(Configuration target)
            throws ConfigurationException

Call to delete a configuration, which is assumed to have no dependencies.

Parameters:

target - Configuration to delete

Throws:

ConfigurationException - if unable to delete the configuration

java.lang.IllegalArgumentException - if target is null

See Also:

to delete a configuration and all its dependencies.

delete

void delete(ConfigurationID targetID)
            throws ConfigurationException

Call to delete a configuration and all its dependencies.

Parameters:

targetID - ConfigurationID to delete

Throws:

ConfigurationException - if unable to delete the configuration

java.lang.IllegalArgumentException - if target is null

delete

void delete(Configuration target,
            boolean deleteDependencies)
            throws ConfigurationException

Deletes the configuration if there exist no dependent objects. To delete the configuration and all its dependencies, pass the boolean argument of true.

Parameters:

target - configuration to be deleted.

boolean - true will also delete all other objects that depend on the target object

Throws:

ConfigurationException - if unable to delete the configuration

java.lang.IllegalArgumentException - if target is null

delete

SharedResource delete(SharedResource target)
                      throws ConfigurationException

Deletes the shared resource.

Parameters:

target - configuration to be deleted.

Throws:

ConfigurationException - if unable to delete the configuration

java.lang.IllegalArgumentException - if target is null

delete

Configuration delete(ComponentObject target,
                     Configuration configuration)
                     throws ConfigurationException

Removes the component object from the specified configuration if no dependent objects exist and returns an updated configuration.

Parameters:

target - component object to be removed

configuration - that the object is to be removed from

Returns:

Configuration with the target object removed

Throws:

ConfigurationException - if unable to delete the configuration

java.lang.IllegalArgumentException - if target is null

delete

Configuration delete(ComponentObject target,
                     Configuration configuration,
                     boolean deleteDependencies)
                     throws ConfigurationException

Removes the component object from the specified configuration if no dependent objects exist. If deleteDependencies is true, then the component object and all dependencies will be deleted.

Parameters:

target - component object to be removed.

configuration - that the object is to be removed from

boolean - true will delete all dependent objects

Returns:

Configuration with the target object removed

Throws:

ConfigurationException - if unable to delete the configuration

java.lang.IllegalArgumentException - if target is null

createConnectorComponent

ConnectorBinding createConnectorComponent(ConfigurationID configuID,
                                          ComponentTypeID typeID,
                                          java.lang.String descriptorName,
                                          java.lang.String routingUUID)

This method will create a connector component based on the specific component type ID

Parameters:

typeID - is the component type of the definition

componentName - is the name of the definition

Returns:

ServiceComponentDefn

createConnectorComponent

ConnectorBinding createConnectorComponent(ConfigurationID configurationID,
                                          ConnectorBinding original,
                                          java.lang.String newName,
                                          java.lang.String routingUUID)

This method will create a connector component from the original connector and give a new name.

Parameters:

configurationID - Identifies which configuration this belongs to

original - is the connector to copy the new connector from

newName - is the name to be given to the new connector

routingUUID - is the routingUUID to use in the copied connector

Returns:

ConnectorBinding

createConnectorComponent

ConnectorBinding createConnectorComponent(Configuration configuration,
                                          ComponentTypeID typeID,
                                          java.lang.String componentName,
                                          ProductServiceConfigID pscID)

Creates a new ConnectorBinding for a given Configuration and ProductServiceConfig; also automatically "deploys" the service anywhere that this PSC is already deployed, by creating the necessary DeployedComponents (this will only work if the PSC parameter belongs to the Configuration parameter).

Parameters:

configuration - the Configuration containing the PSC; this will have the new ServiceComponentDefn added to it, plus any DeployedComponents created for the ServiceComponentDefn

typeID - type of the new ServiceComponentDefn

componentName - name for the new ServiceComponentDefn

pscID - ID of the ProductServiceConfig which this ServiceComponentDefn will belong to

Returns:

new ConnectorBinding

addAuthenticationProvider

void addAuthenticationProvider(Configuration configuration,
                               AuthenticationProvider provider)

createAuthenticationProviderComponent

AuthenticationProvider createAuthenticationProviderComponent(ConfigurationID configuID,
                                                             ComponentTypeID typeID,
                                                             java.lang.String descriptorName)

This method will create a provider component based on the specific component type ID

Parameters:

typeID - is the component type of the definition

componentName - is the name of the definition

Returns:

ServiceComponentDefn

createAuthenticationProviderComponent

AuthenticationProvider createAuthenticationProviderComponent(ConfigurationID configurationID,
                                                             AuthenticationProvider original,
                                                             java.lang.String newName)

This method will create a provider component from the original provider and give a new name.

Parameters:

configurationID - Identifies which configuration this belongs to

original - is the connector to copy the new provider from

newName - is the name to be given to the new provider

Returns:

AuthenticationProvider

createAuthenticationProviderComponent

AuthenticationProvider createAuthenticationProviderComponent(Configuration configuration,
                                                             AuthenticationProvider original,
                                                             java.lang.String newName)

This method will create a provider component from the original provider and give a new name.

Parameters:

configurationID - Identifies which configuration this belongs to

original - is the connector to copy the new provider from

newName - is the name to be given to the new provider

Returns:

AuthenticationProvider