|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.common.actions.AbstractObjectEditor com.metamatrix.common.config.model.BasicConfigurationObjectEditor
public class BasicConfigurationObjectEditor
BasicConfigurationObjectEditor provides the update capabiltiy to the implemented versions of the config.api package. NOTE: - in all the methods that take a non-mutable object and returns it, a clone of the object is returned instead of the passed object. This is done so that any future change to the object is not made to the same instance that has a prior change (action) waiting to be executed.
Field Summary |
---|
Fields inherited from class com.metamatrix.common.actions.AbstractObjectEditor |
---|
ADD_LBL, FIRST_COMMAND, LAST_COMMAND, REMOVE_LBL, SET_LBL |
Fields inherited from interface com.metamatrix.common.actions.ObjectEditor |
---|
ADD, REMOVE, SET |
Constructor Summary | |
---|---|
BasicConfigurationObjectEditor()
Create an instance of this editor that does not create any actions. |
|
BasicConfigurationObjectEditor(boolean createActions)
Create an instance of this editor, and specify whether actions are to be created during modifications. |
Method Summary | |
---|---|
void |
addAuthenticationProvider(Configuration configuration,
AuthenticationProvider provider)
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). |
ComponentObject |
addProperty(ComponentObject t,
java.lang.String name,
java.lang.String value)
Adds the property value for the specified name on the ComponentObject . |
java.lang.Object |
assignConfigurationID(java.lang.Object t,
ConfigurationID configurationID)
This method is used by the ConfigurationServiceImpl to enable the console to import actions and assign them to the current configuration. |
AuthenticationProvider |
createAuthenticationProviderComponent(Configuration configuration,
AuthenticationProvider originalProvider,
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 configurationID,
ComponentTypeID typeID,
java.lang.String descriptorName)
This method will create a provider component based on the specific component type ID |
BasicComponentDefn |
createComponentDefn(int defnTypeCode,
ConfigurationID configID,
ComponentTypeID typeID,
java.lang.String defnName)
This method is not provided in the interface, it is only used by the spi implementation for ease of creating the correct type of component defn. |
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)
Copy-create method - creates a deep-copy of the original configuration, with the new 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(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,
ConnectorBinding originalConnector,
java.lang.String newName)
|
ConnectorBinding |
createConnectorComponent(ConfigurationID configurationID,
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 name,
Configuration configuration,
HostID hostId,
VMComponentDefnID vmId,
ServiceComponentDefn serviceComponentDefn)
|
DeployedComponent |
createDeployedServiceComponent(java.lang.String name,
ConfigurationID configurationID,
HostID hostId,
VMComponentDefnID vmId,
ServiceComponentDefnID serviceComponentDefnID,
ComponentTypeID serviceComponentTypeID)
Create a new DeployedComponent instance respresenting a deployed Service. |
DeployedComponent |
createDeployedVMComponentx(java.lang.String instanceName,
ConfigurationID configurationID,
HostID hostId,
VMComponentDefnID vmComponentDefnID,
ComponentTypeID componentTypeID)
|
DeployedComponent |
createDeployedVMComponentx(java.lang.String name,
Configuration configuration,
VMComponentDefn vmComponentDefn)
|
Host |
createHost(Configuration configuration,
Host original,
java.lang.String newName)
|
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. |
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 |
ResourceDescriptor |
createResourceDescriptor(Configuration configuration,
ResourceDescriptor original,
java.lang.String newName)
|
ServiceComponentDefn |
createServiceComponentDefn(Configuration configuration,
ComponentTypeID typeID,
java.lang.String componentName)
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 |
ServiceComponentDefn |
createServiceComponentDefn(Configuration configuration,
ServiceComponentDefn originalServiceComponentDefn,
java.lang.String newName)
Creates a new ServiceComponentDefn in the indicated Configuration, copied from the indicated original ServiceComponentDefn, with the indicated new name. |
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 |
VMComponentDefn |
createVMComponentDefn(Configuration configuration,
VMComponentDefn original,
java.lang.String newName)
|
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 |
void |
delete(PropDefnAllowedValue target)
|
SharedResource |
delete(SharedResource target)
Deletes the shared resource. |
DeployedComponent |
deployServiceDefn(Configuration configuration,
ServiceComponentDefn serviceComponentDefn,
VMComponentDefnID vmID)
Deploys a ServiceComponentDefn to the specified VM This method is harmless to call if the ServiceComponentDefn is already deployed anywhere. |
java.util.Properties |
getEditableProperties(ComponentObject t)
Returns a modifiable properties object for the specified ComponentObject. |
boolean |
isDeployed(ServiceComponentDefnID defnID,
Configuration config)
|
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 . |
VMComponentDefn |
renameVM(VMComponentDefn vm,
java.lang.String name)
Change the name of a previously defined VM in the Next Startup config. |
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 ComponentTypeDefn s for a local ComponentType
object. |
Configuration |
setConfigurationComponentDefns(Configuration t,
java.util.Collection componentDefns)
|
Configuration |
setConfigurationDeployedComponents(Configuration t,
java.util.Collection deployedComponents)
|
Configuration |
setConfigurationHostComponents(Configuration t,
java.util.Collection hostComponents)
|
ComponentObject |
setCreationChangedHistory(ComponentObject defn,
java.lang.String createdBy,
java.lang.String creationDate)
|
ComponentType |
setCreationChangedHistory(ComponentType type,
java.lang.String createdBy,
java.lang.String creationDate)
|
DeployedComponent |
setEnabled(DeployedComponent deployedcomponent,
boolean enabled)
It updates the DeployedComponent by setting its enabled flag. |
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 defn,
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 |
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; |
Configuration |
undoAction(ActionDefinition action,
BaseObject target)
|
ComponentObject |
undoAction(ActionDefinition action,
ComponentObject target)
Modify the specified target object by undoing the specified action. |
ComponentType |
updateComponentType(ComponentType origType,
ComponentType replaceType)
This will update / replace the existing component type with the specified component type. |
Methods inherited from class com.metamatrix.common.actions.AbstractObjectEditor |
---|
createAddAction, createAddNamedAction, createCreationAction, createDestroyAction, createExchangeAction, createExchangeBoolean, createExchangeNamedAction, createRemoveAction, createRemoveNamedAction, doCreateActions, getDestination, getLabel, setCreateActions, setDestination, verifyCommand, verifyTargetClass |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.metamatrix.common.actions.ObjectEditor |
---|
getDestination, setDestination |
Constructor Detail |
---|
public BasicConfigurationObjectEditor(boolean createActions)
createActions
- flag specifying whether modification actions should be created
for each invocation to modifyObject
java.lang.IllegalArgumentException
- if the defaults reference is nullpublic BasicConfigurationObjectEditor()
java.lang.IllegalArgumentException
- if the defaults reference is nullMethod Detail |
---|
public ComponentObject undoAction(ActionDefinition action, ComponentObject target)
In general, the client user of this class should (prior to invoking this method) obtain the target MetadataID from the action and find the corresponding Component, and pass the resulting Component in as the target argument. In the case of a DestroyObject action being undone, the corresponding Component may not exist in the client's universe - it has already been destroyed; passing a null as the target argument in this case is acceptable. For all other actions, the target argument may not be null.
The result of this object will be the target after being modified by the specified action. In the case of a CreateObject action being undone, this method 'destroys' the object, so a null result is returned; the client should ensure this object is removed from its context. In all other cases, this method returns the modified target.
action
- the action to be undone (may not be null).target
- the Component that is the target of the action.
java.lang.IllegalArgumentException
- if the action reference is null, or
if the target is null and the action is not a DestroyObject.public Configuration undoAction(ActionDefinition action, BaseObject target)
public Host createHost(java.lang.String hostName)
ConfigurationObjectEditor
createHost
in interface ConfigurationObjectEditor
hostName
- for the new Host (may not be null).
public Host createHost(ConfigurationID configurationID, java.lang.String hostName)
createHost
in interface ConfigurationObjectEditor
public Host createHost(Configuration configuration, java.lang.String hostName)
createHost
in interface ConfigurationObjectEditor
public Host createHost(Configuration configuration, Host original, java.lang.String newName)
public Configuration createConfiguration(java.lang.String configurationName)
ConfigurationObjectEditor
createConfiguration
in interface ConfigurationObjectEditor
configurationName
- for the new configuration (may not be null).
public Configuration createConfiguration(java.lang.String configurationName, java.util.Date creationDate, java.util.Date lastChangedDate)
createConfiguration(String)
createConfiguration
in interface ConfigurationObjectEditor
configurationName
- for the new configuration (may not be null).creationDate
- Date the configuration was created.creationDate
- Date the configuration was last modified.
java.lang.IllegalArgumentException
- if the configurationName is nullpublic void createConfiguration(ConfigurationID configID, java.util.Collection configObjects)
ConfigurationObjectEditor
createConfiguration
in interface ConfigurationObjectEditor
public ComponentType createComponentType(int classTypeCode, java.lang.String name, ComponentTypeID parentID, ComponentTypeID superID, boolean deployable, boolean monitored)
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
in interface ConfigurationObjectEditor
classTypeCode
- identifies the type of class this component type should representname
- is the name of the ComponentTypeparentID
- is the component type that is the parent, can be nullsuperID
- is the component type that is a super type of this component type, can be nulldeployable
- is a boolean indicating if the type can be deployed in a configurationmonitored
- is a boolean insdicating if the type is to be monitored
for type codes
public ComponentType createComponentType(ComponentType componentType, java.lang.String name)
ConfigurationObjectEditor
createComponentType
in interface ConfigurationObjectEditor
componentType
- is the original component type to copy fromname
- is the name of the ComponentType
public BasicComponentDefn createComponentDefn(int defnTypeCode, ConfigurationID configID, ComponentTypeID typeID, java.lang.String defnName)
public ComponentTypeDefn createComponentTypeDefn(ComponentType type, PropertyDefinition propertyDefinition, boolean isEffectiveImmediately)
ConfigurationObjectEditor
createComponentTypeDefn
in interface ConfigurationObjectEditor
type
- is the ComponentType the definition will be added topropertyDefinition
- are the attributes describing this definitionisEffectiveImmediately
- 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)
public ComponentTypeDefn createComponentTypeDefn(ComponentType type, PropertyDefinition propertyDefinition)
createComponentTypeDefn(ComponentType, PropertyDefinition, boolean)
public ComponentTypeDefn createComponentTypeDefn(ComponentTypeID typeID, PropertyDefinition propertyDefinition, boolean isEffectiveImmediately)
ConfigurationObjectEditor
createComponentTypeDefn
in interface ConfigurationObjectEditor
typeID
- for the parent component type this definitions is used bypropertyDefinition
- are the attributes describing this definitionisEffectiveImmediately
- 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)
createComponentTypeDefn(ComponentType, PropertyDefinition, boolean)
public ComponentTypeDefn createComponentTypeDefn(ComponentTypeID typeID, PropertyDefinition propertyDefinition)
createComponentTypeDefn(ComponentTypeID, PropertyDefinition, boolean)
public PropDefnAllowedValue createPropDefnAllowedValue(ComponentTypeDefn typeDefn, PropertyDefinition propDefn, java.lang.String value) throws InvalidComponentException
ConfigurationObjectEditor
createPropDefnAllowedValue
in interface ConfigurationObjectEditor
typeDefn
- is the ComponentTypeDefn the allowed value will be added topropDefn
- is the PropertyDefinition that the new create PropDefnAllowedValue will
be added to.value
- is the allowed value
InvalidComponentException
- if the existing allowed values in the typeDefn are not
of type PropDefnAllowedValuepublic DeployedComponent createDeployedServiceComponent(java.lang.String name, Configuration configuration, HostID hostId, VMComponentDefnID vmId, ServiceComponentDefn serviceComponentDefn)
public DeployedComponent createDeployedServiceComponent(java.lang.String name, ConfigurationID configurationID, HostID hostId, VMComponentDefnID vmId, ServiceComponentDefnID serviceComponentDefnID, ComponentTypeID serviceComponentTypeID)
ConfigurationObjectEditor
createDeployedServiceComponent
in interface ConfigurationObjectEditor
name
- is the name assigned to this instanceconfigurationID
- 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 deployedserviceComponentTypeID
- is type of the service to be deployed
createDeployedServiceComponent(String, Configuration, HostID, VMComponentDefn)
public DeployedComponent createDeployedVMComponentx(java.lang.String name, Configuration configuration, VMComponentDefn vmComponentDefn)
public DeployedComponent createDeployedVMComponentx(java.lang.String instanceName, ConfigurationID configurationID, HostID hostId, VMComponentDefnID vmComponentDefnID, ComponentTypeID componentTypeID)
public ServiceComponentDefn createServiceComponentDefn(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String componentName)
ConfigurationObjectEditor
createServiceComponentDefn
in interface ConfigurationObjectEditor
typeID
- is the type of component definition to createcomponentName
- is the name of the component
ConfigurationObjectEditor.createServiceComponentDefn(Configuration, ComponentTypeID, String)
public ServiceComponentDefn createServiceComponentDefn(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String componentName, java.lang.String routingUUID)
ConfigurationObjectEditor
createServiceComponentDefn
in interface ConfigurationObjectEditor
typeID
- is the type of component definition to createcomponentName
- is the name of the componentroutingUUID
- the globally unique routing UUID of the Service Component Defn
ConfigurationObjectEditor.createServiceComponentDefn(Configuration, ComponentTypeID, String)
public ServiceComponentDefn createServiceComponentDefn(Configuration configuration, ComponentTypeID typeID, java.lang.String componentName)
createServiceComponentDefn
in interface ConfigurationObjectEditor
configuration
- the Configuration containing the PSC; this will
have the new ServiceComponentDefn added to it, plus any DeployedComponents
created for the ServiceComponentDefntypeID
- type of the new ServiceComponentDefncomponentName
- name for the new ServiceComponentDefnpscID
- ID of the ProductServiceConfig which this ServiceComponentDefn
will belong to
public ServiceComponentDefn createServiceComponentDefn(Configuration configuration, ComponentTypeID typeID, java.lang.String componentName, java.lang.String routingUUID)
ConfigurationObjectEditor
createServiceComponentDefn
in interface ConfigurationObjectEditor
configuration
- that will contain the new created component definitiontypeID
- is the type of component definition to createcomponentName
- is the name of the componentroutingUUID
- the globally unique routing UUID of the Service Component Defn
public ServiceComponentDefn createServiceComponentDefn(Configuration configuration, ServiceComponentDefn originalServiceComponentDefn, java.lang.String newName)
public ResourceDescriptor createResourceDescriptor(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String descriptorName)
ConfigurationObjectEditor
createResourceDescriptor
in interface ConfigurationObjectEditor
configurationID
- that the new created component definition will be a part oftypeID
- is the type of component definition to create
public ResourceDescriptor createResourceDescriptor(Configuration configuration, ComponentTypeID typeID, java.lang.String descriptorName)
ConfigurationObjectEditor
createResourceDescriptor
in interface ConfigurationObjectEditor
configuration
- that will contain the new created component definitiontypeID
- is the type of component definition to create
public ResourceDescriptor createResourceDescriptor(Configuration configuration, ResourceDescriptor original, java.lang.String newName)
public SharedResource createSharedResource(ComponentTypeID typeID, java.lang.String resourceName)
ConfigurationObjectEditor
createSharedResource
in interface ConfigurationObjectEditor
typeID
- is the type of component definition to createresourceName
- is the name of the shared resource
public VMComponentDefn createVMComponentDefn(ConfigurationID configurationID, HostID hostID, ComponentTypeID typeID, java.lang.String componentName)
ConfigurationObjectEditor
createVMComponentDefn
in interface ConfigurationObjectEditor
typeID
- is the type of component definition to createcomponentName
- is the name of the component
createVMComponentDefn(Configuration, ComponentTypeID, String)
public VMComponentDefn createVMComponentDefn(Configuration configuration, HostID hostID, ComponentTypeID typeID, java.lang.String componentName)
ConfigurationObjectEditor
createVMComponentDefn
in interface ConfigurationObjectEditor
configuration
- that will contain the new created component definitiontypeID
- is the type of component definition to createcomponentName
- is the name of the component
public VMComponentDefn createVMComponentDefn(Configuration configuration, VMComponentDefn original, java.lang.String newName)
public ComponentType updateComponentType(ComponentType origType, ComponentType replaceType)
t
- is the ComponentType to update / replace
createComponentTypeDefn(ComponentTypeID, PropertyDefinition, boolean)
public void setRoutingUUID(ServiceComponentDefn serviceComponentDefn, java.lang.String newRoutingUUID)
setRoutingUUID
in interface ConfigurationObjectEditor
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 onnewRoutingUUID
- new String routing UUID for the indicated
ServiceComponentDefnpublic DeployedComponent setEnabled(DeployedComponent deployedcomponent, boolean enabled)
ConfigurationObjectEditor
setEnabled
in interface ConfigurationObjectEditor
public Configuration setLogConfiguration(Configuration t, LogConfiguration logConfiguration)
setLogConfiguration
in interface ConfigurationObjectEditor
public ComponentObject addProperty(ComponentObject t, java.lang.String name, java.lang.String value)
ConfigurationObjectEditor
ComponentObject
.
This method assumes the named property does not exist.
addProperty
in interface ConfigurationObjectEditor
t
- is the ComponentObject
to set the value onname
- is the name of the propertyvalue
- is the value for the property
ComponentObject
public ComponentObject setProperty(ComponentObject t, java.lang.String name, java.lang.String value)
ConfigurationObjectEditor
ComponentObject
.
This method will replace the current property by the same name.
setProperty
in interface ConfigurationObjectEditor
t
- is the ComponentObject
to set the value onname
- is the name of the propertyvalue
- is the value for the property
ComponentObject
public ComponentObject removeProperty(ComponentObject t, java.lang.String name)
ConfigurationObjectEditor
ComponentObject
.
removeProperty
in interface ConfigurationObjectEditor
t
- is the ComponentObject
to set the value onname
- is the name of the property
ComponentObject
public ComponentTypeDefn modifyComponentTypeDefn(ComponentTypeDefn original, ComponentTypeDefn updated)
ConfigurationObjectEditor
ComponentTypeDefn
with the updated PropertyDefinition
.
modifyComponentTypeDefn
in interface ConfigurationObjectEditor
original
- is the original ComponentTypeDefn to be updated.updated
- is the updated ComponentTypeDefn to replace the original.
public ComponentObject modifyProperties(ComponentObject t, java.util.Properties props, int command)
ConfigurationObjectEditor
modifyProperties
in interface ConfigurationObjectEditor
t
- is the ComponentObject
to set the value onprops
- are the properties that will be used based on the commandcommand
- the object editor command (ADD, REMOVE, or SET) that defines the operation to be
performed.
ComponentObject
public Configuration setIsReleased(Configuration t, boolean newValue)
setIsReleased
in interface ConfigurationObjectEditor
public Configuration setIsDeployed(Configuration t, boolean newValue)
setIsDeployed
in interface ConfigurationObjectEditor
public ComponentType setIsDeployable(ComponentType t, boolean newValue)
setIsDeployable
in interface ConfigurationObjectEditor
public ComponentType setIsDeprecated(ComponentType t, boolean newValue)
setIsDeprecated
in interface ConfigurationObjectEditor
public ComponentType setIsMonitored(ComponentType t, boolean newValue)
setIsMonitored
in interface ConfigurationObjectEditor
public ComponentObject setComponentType(ComponentObject t, ComponentTypeID componentType)
ConfigurationObjectEditor
setComponentType
in interface ConfigurationObjectEditor
t
- is the ComponentObject to have its type setcomponentType
- is the ComponentType to set
public ComponentType setParentComponentTypeID(ComponentType t, ComponentTypeID parentID)
ConfigurationObjectEditor
setParentComponentTypeID
in interface ConfigurationObjectEditor
t
- is the ComponentTypeparentID
- is the parent component type (null allowed)
public ComponentType setSuperComponentTypeID(ComponentType t, ComponentTypeID superID)
ConfigurationObjectEditor
setSuperComponentTypeID
in interface ConfigurationObjectEditor
t
- is the ComponentTypesuperID
- is the super component type (null allowed)
public ComponentType setLastChangedHistory(ComponentType type, java.lang.String lastChangedBy, java.lang.String lastChangedDate)
setLastChangedHistory
in interface ConfigurationObjectEditor
public ComponentType setCreationChangedHistory(ComponentType type, java.lang.String createdBy, java.lang.String creationDate)
setCreationChangedHistory
in interface ConfigurationObjectEditor
public ComponentObject setLastChangedHistory(ComponentObject defn, java.lang.String lastChangedBy, java.lang.String lastChangedDate)
setLastChangedHistory
in interface ConfigurationObjectEditor
public ComponentObject setCreationChangedHistory(ComponentObject defn, java.lang.String createdBy, java.lang.String creationDate)
setCreationChangedHistory
in interface ConfigurationObjectEditor
public void delete(Host target) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- Host to delete
ConfigurationException
- if unable to delete the hostpublic void delete(ComponentTypeDefn target, ComponentType type) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- is the ComponentTypeDefn to deletetype
- is the ComponentType that it should be removed from.
ConfigurationException
- if unable to delete the configurationpublic void delete(PropDefnAllowedValue target) throws ConfigurationException
ConfigurationException
public void delete(ComponentType target) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- ComponentType and all its ComponentTypeDefns to delete
ConfigurationException
- if unable to delete the ComponentTypepublic void delete(ConfigurationID targetID) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
targetID
- ConfigurationID to delete
ConfigurationException
- if unable to delete the configurationpublic void delete(Configuration target) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- Configuration to delete
ConfigurationException
- if unable to delete the configurationto delete a configuration and all its
dependencies.
public void delete(Configuration target, boolean deleteDependencies) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- configuration to be deleted.
ConfigurationException
- if unable to delete the configurationpublic SharedResource delete(SharedResource target) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- configuration to be deleted.
ConfigurationException
- if unable to delete the configurationpublic Configuration delete(ComponentObject target, Configuration configuration) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- component object to be removedconfiguration
- that the object is to be removed from
ConfigurationException
- if unable to delete the configurationpublic Configuration delete(ComponentObject target, Configuration configuration, boolean deleteDependencies) throws ConfigurationException
ConfigurationObjectEditor
delete
in interface ConfigurationObjectEditor
target
- component object to be removed.configuration
- that the object is to be removed from
ConfigurationException
- if unable to delete the configurationpublic VMComponentDefn renameVM(VMComponentDefn vm, java.lang.String name) throws ConfigurationException
renameVM
in interface ConfigurationObjectEditor
vm
- The VM whose name to change.name
- The new name.
ConfigurationException
public boolean isDeployed(ServiceComponentDefnID defnID, Configuration config)
public ComponentType setComponentTypeDefinitions(ComponentType t, java.util.Collection defns)
ComponentTypeDefn
s 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.
setComponentTypeDefinitions
in interface ConfigurationObjectEditor
t
- is the ComponentType to set ondefns
- Collection of new definitions
createComponentTypeDefn(ComponentTypeID, PropertyDefinition, boolean)
public ComponentTypeDefn setPropertyDefinition(ComponentTypeDefn t, PropertyDefinition defn)
ConfigurationObjectEditor
PropertyDefinition
on the ComponentTypeDefn
setPropertyDefinition
in interface ConfigurationObjectEditor
t
- is the component type definition to update with the defintiondefn
- is the property defn that will be applied.
public Configuration setConfigurationComponentDefns(Configuration t, java.util.Collection componentDefns)
public Configuration setConfigurationDeployedComponents(Configuration t, java.util.Collection deployedComponents)
public Configuration setConfigurationHostComponents(Configuration t, java.util.Collection hostComponents)
public java.util.Properties getEditableProperties(ComponentObject t)
ConfigurationObjectEditor
getEditableProperties
in interface ConfigurationObjectEditor
t
- is the component object to obtain the properties from
public java.lang.Object assignConfigurationID(java.lang.Object t, ConfigurationID configurationID)
public ConnectorBinding createConnectorComponent(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String descriptorName, java.lang.String routingUUID)
ConfigurationObjectEditor
createConnectorComponent
in interface ConfigurationObjectEditor
typeID
- is the component type of the definition
public ConnectorBinding createConnectorComponent(ConfigurationID configurationID, ConnectorBinding original, java.lang.String newName, java.lang.String routingUUID)
ConfigurationObjectEditor
createConnectorComponent
in interface ConfigurationObjectEditor
configurationID
- Identifies which configuration this belongs tooriginal
- is the connector to copy the new connector fromnewName
- is the name to be given to the new connectorroutingUUID
- is the routingUUID to use in the copied connector
public ConnectorBinding createConnectorComponent(Configuration configuration, ConnectorBinding originalConnector, java.lang.String newName)
public void addAuthenticationProvider(Configuration configuration, AuthenticationProvider provider)
ConfigurationObjectEditor
addAuthenticationProvider
in interface ConfigurationObjectEditor
configuration
- the Configuration containing the PSC; this will
have the new ServiceComponentDefn added to it, plus any DeployedComponents
created for the ServiceComponentDefnpublic AuthenticationProvider createAuthenticationProviderComponent(Configuration configuration, AuthenticationProvider originalProvider, java.lang.String newName)
ConfigurationObjectEditor
createAuthenticationProviderComponent
in interface ConfigurationObjectEditor
originalProvider
- is the connector to copy the new provider fromnewName
- is the name to be given to the new provider
public AuthenticationProvider createAuthenticationProviderComponent(ConfigurationID configurationID, ComponentTypeID typeID, java.lang.String descriptorName)
ConfigurationObjectEditor
createAuthenticationProviderComponent
in interface ConfigurationObjectEditor
typeID
- is the component type of the definition
public AuthenticationProvider createAuthenticationProviderComponent(ConfigurationID configurationID, AuthenticationProvider original, java.lang.String newName)
ConfigurationObjectEditor
createAuthenticationProviderComponent
in interface ConfigurationObjectEditor
configurationID
- Identifies which configuration this belongs tooriginal
- is the connector to copy the new provider fromnewName
- is the name to be given to the new provider
public DeployedComponent deployServiceDefn(Configuration configuration, ServiceComponentDefn serviceComponentDefn, VMComponentDefnID vmID)
deployServiceDefn
in interface ConfigurationObjectEditor
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 deployedVMID
- VM ID indicates the process to deploy the service to
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |