com.metamatrix.platform.config.api.service
Interface ConfigurationServiceInterface

All Superinterfaces:

ServiceInterface

All Known Implementing Classes:

ConfigurationServiceImpl

public interface ConfigurationServiceInterface
extends ServiceInterface

Field Summary

static java.lang.String

NAME

Fields inherited from interface com.metamatrix.platform.service.api.ServiceInterface

WAIT_TO_DIE_TIME

Method Summary

Host	addHost(java.lang.String hostName, java.lang.String principalName, java.util.Properties properties) Add Host to Configuration Add a new Host to the System (MetaMatrix Cluster)
VMComponentDefn	addProcess(java.lang.String processName, java.lang.String hostName, java.lang.String principalName, java.util.Properties properties) Add Process for the specified Host to Configuration Add a new Virtuial Machine to the System (MetaMatrix Cluster)
void	baselineCurrentConfiguration(java.lang.String principalName) Baselines the realtime portion of the current (operational) configuration into the next-startup configuration.
java.util.List	checkPropertiesDecryptable(java.util.List defns) Check whether the encrypted properties for the specified ComponentDefns can be decrypted.
boolean	checkPropertiesDecryptable(java.util.Properties props, java.lang.String componentTypeIdentifier) Check whether the given properties pertaining to the given component (name and type) contain at least one value that the server cannot decrypt with its current keystore.
void	clearHistory() Clear the history of all actions without undoing any of them.
ConnectorBinding	createConnectorBinding(java.lang.String connectorBindingName, java.lang.String connectorType, java.lang.String pscName, java.lang.String principalName, java.util.Properties properties) Deploy a new Connector Binding into Configuration
ConfigurationObjectEditor	createEditor() Returns a ConfigurationObjectEditor to perform editing operations on a configuration type object.
void	delete(ComponentObject theObject, boolean theDeleteDependenciesFlag, java.lang.String principalName) Deletes a component object.
void	delete(ComponentType componentType, java.lang.String principalName) Delete a Component Type
java.util.Collection	deployPSC(Host theHost, VMComponentDefn theProcess, java.lang.String pscName, java.lang.String principalName) Deploys the ServiceComponentDefns indicated by the ProductServiceConfig, contained by the Configuration, onto the specified Host and VM.
java.util.Set	executeInsertTransaction(ConfigurationID assignConfigurationID, java.util.List actions, java.lang.String principalName) Execute a list of insert actions and for actions on objects of type ComponentDefn or DeployedComponent object, it will have its configuration id resassigned, and optionally return the set of objects or object IDs that were affected/modified by the action.
java.util.Set	executeTransaction(ActionDefinition action, java.lang.String principalName) Execute as a single transaction the specified action, and optionally return the set of objects or object IDs that were affected/modified by the action.
java.util.Set	executeTransaction(java.util.List actions, java.lang.String principalName) Execute a list of actions, and optionally return the set of objects or object IDs that were affected/modified by the action.
java.util.Collection	getAllComponentTypeDefinitions(ComponentTypeID componentTypeID) Returns the all component type definitions for the specified ComponentTypeID.
java.util.Collection	getAllComponentTypes(boolean includeDeprecated) Returns a List of type ComponentType that represents all the ComponentTypes defined.
java.util.Collection	getAllGlobalConfigObjects() This method will return a Collection of objects that represent the set of global configuration objects currently represented in the configuration database.
ComponentDefn	getComponentDefn(ConfigurationID configurationID, ComponentDefnID componentDefnID) Returns a ComponentDefn for the specified ComponentDefnID.
java.util.Collection	getComponentDefns(java.util.Collection componentDefnIDs, ConfigurationID configurationID) Returns a collection of ComponentDefns for the specified collection of ComponentDefnIDs and ConfigurationID.
ComponentType	getComponentType(ComponentTypeID id) Returns a ComponentType for the specified ComponentTypeID
java.util.Map	getComponentTypeDefinitions(java.util.Collection componentIDs) Returns a Map of component type definitions for each ComponentTypeID that is contained in the passed Collection.
java.util.Collection	getComponentTypeDefinitions(ComponentTypeID componentTypeID) Returns the component type definitions for the specified ComponentTypeID.
Configuration	getConfiguration(java.lang.String configName) Returns the named Configuration.
java.util.Collection	getConfigurationAndDependents(ConfigurationID configID) Returns a Collection containing the Configuration object for the specified ConfigurationID id, and also any dependant objects needed to fully define this configuration, such as Host objects, ComponentType objects, and ComponentTypeDefn objects.
ConfigurationModelContainer	getConfigurationModel(java.lang.String configName) Returns the ConfigurationModelContainer that contains everything (i.e., ComponentTypes, Shared Resources and ComponentDefns) that the server needs to start.
Configuration	getCurrentConfiguration() Returns the current deployed Configuration.
ConfigurationID	getCurrentConfigurationID() Returns the ConfigurationID for the operational configuration.
java.util.Map	getDependentComponentTypeDefinitions(java.util.Collection componentIDs) Returns a Map of all component type definitions for each ComponentTypeID that is contained in the passed Collection.
java.util.Collection	getDependentComponentTypeDefinitions(ComponentTypeID componentTypeID) Returns the component type definitions for the specified ComponentTypeID.
java.util.List	getHistory() Get the history of actions executed in transactions by this editor.
int	getHistoryLimit() Set the limit on the number of actions in the history.
int	getHistorySize() Get the number of actions that are currently in the history.
Host	getHost(HostID hostID) Returns a Host for the specified HostID.
java.util.Collection	getHosts() Returns a Collection of currently defined hosts.
java.util.Collection	getMonitoredComponentTypes(boolean includeDeprecated) Returns a List of type ComponentType .
Configuration	getNextStartupConfiguration() Returns the next startup Configuration, the Configuration that the system will next boot up with (once it is entirely shut down).
ConfigurationID	getNextStartupConfigurationID() Returns the ID of the next startup Configuration, which should reflect the desired runtime state of the system.
java.util.Collection	getProductReleaseInfos() Obtain the List of ReleaseInfo objects which represent the products of the system.
java.util.Collection	getResources() Returns a Collection of ResourceDescriptor for all internal resources defined to the system.
java.util.Collection	getResources(ComponentTypeID componentTypeID) Returns a Collection of ResourceDescriptor that are of the specified resource type.
java.util.Date	getServerStartupTime() Return the time the server was started.
Configuration	getStartupConfiguration() Returns the startup Configuration, the Configuration that the system booted up with.
ConfigurationID	getStartupConfigurationID() Returns the ID of the startup Configuration, which should reflect the desired runtime state of the system.
ConnectorBinding	importConnectorBinding(java.io.InputStream inputStream, java.lang.String name, java.lang.String pscName, java.lang.String principalName) Import a connector Binding from InputStream, and deploy it to a PSC.
ComponentType	importConnectorType(java.io.InputStream inputStream, java.lang.String name, java.lang.String principalName) Import a Connector Type
java.lang.Object	modify(ComponentObject theObject, java.util.Properties theProperties, java.lang.String principalName) Modify a Component in Configuration
void	saveResources(java.util.Collection resourceDescriptors, java.lang.String principalName) Save the resource changes based on each ResourceDescriptor in the collection.
void	setHistoryLimit(int maximumHistoryCount) Set the limit on the number of actions in the history.
void	setSystemPropertyValue(java.lang.String propertyName, java.lang.String propertyValue, java.lang.String principalName) Set System Property Value in Configuration
java.util.Set	undoActionsAsTransaction(int numberOfActions, java.lang.String principalName) Undo the specified number of previously-committed transactions.
void	updateSystemPropertyValues(java.util.Properties properties, java.lang.String principalName) Set System Property Values in Configuration.

Methods inherited from interface com.metamatrix.platform.service.api.ServiceInterface

checkState, die, dieNow, getCurrentState, getHostname, getID, getInitException, getProcessName, getProperties, getQueueStatistics, getQueueStatistics, getServiceType, getStartTime, getStateChangeTime, init, isAlive, setInitException, updateState

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

createEditor

ConfigurationObjectEditor createEditor()
                                       throws ConfigurationException

Returns a ConfigurationObjectEditor to perform editing operations on a configuration type object. The editing process will create actions for each specific type of editing operation. Those actions are what need to be submitted to the ConfigurationService for actual updates to occur.

Returns:

ConfigurationObjectEditor

Throws:

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

getCurrentConfigurationID

ConfigurationID getCurrentConfigurationID()
                                          throws ConfigurationException

Returns the ConfigurationID for the operational configuration.

Returns:

ConfigurationID for current configuration

Throws:

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

getNextStartupConfigurationID

ConfigurationID getNextStartupConfigurationID()
                                              throws ConfigurationException

Returns the ID of the next startup Configuration, which should reflect the desired runtime state of the system.

Returns:

ID of next startup configuration

Throws:

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

getStartupConfigurationID

ConfigurationID getStartupConfigurationID()
                                          throws ConfigurationException

Returns the ID of the startup Configuration, which should reflect the desired runtime state of the system.

Returns:

ID of startup configuration

Throws:

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

baselineCurrentConfiguration

void baselineCurrentConfiguration(java.lang.String principalName)
                                  throws ConfigurationException

Baselines the realtime portion of the current (operational) configuration into the next-startup configuration.

Parameters:

principalName - the name of the principal that is requesting the baselining

Throws:

ConfigurationException

getCurrentConfiguration

Configuration getCurrentConfiguration()
                                      throws ConfigurationException

Returns the current deployed Configuration. Note, this configuration may not match the actual configuration the system is currently executing under due to administrative task that can be done to tune the system. Those administrative task do not change the actual Configuration stored in the ConfigurationService.

Returns:

Configuration that is currently in use

Throws:

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

getNextStartupConfiguration

Configuration getNextStartupConfiguration()
                                          throws ConfigurationException

Returns the next startup Configuration, the Configuration that the system will next boot up with (once it is entirely shut down).

Returns:

Configuration that the system will next start up with.

Throws:

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

getStartupConfiguration

Configuration getStartupConfiguration()
                                      throws ConfigurationException

Returns the startup Configuration, the Configuration that the system booted up with.

Returns:

Configuration that the system booted up with.

Throws:

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

getConfiguration

Configuration getConfiguration(java.lang.String configName)
                               throws InvalidConfigurationException,
                                      ConfigurationException

Returns the named Configuration.

Parameters:

configName - is the name of the Configuration to obtain

Returns:

Configuration

Throws:

InvalidConfigurationException - if the specified name does not exist

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

getConfigurationModel

ConfigurationModelContainer getConfigurationModel(java.lang.String configName)
                                                  throws InvalidConfigurationException,
                                                         ConfigurationException

Returns the ConfigurationModelContainer that contains everything (i.e., ComponentTypes, Shared Resources and ComponentDefns) that the server needs to start.

Parameters:

configName - if the name of the configuration model to obtain

Returns:

ConfigurationModelContainer

Throws:

InvalidConfigurationException

ConfigurationException

getConfigurationAndDependents

java.util.Collection getConfigurationAndDependents(ConfigurationID configID)
                                                   throws ConfigurationException

Returns a Collection containing the Configuration object for the specified ConfigurationID id, and also any dependant objects needed to fully define this configuration, such as Host objects, ComponentType objects, and ComponentTypeDefn objects.

A Configuration instance contains all of the ComponentDefn objects that "belong" to just that Configuration: VM component definitions, service component definitions, product service configurations, and deployed components. Objects such as Host objects, ComponentType objects, and ComponentTypeDefn objects describe ComponentDefns, but are not contained by a Configuration. Therefore, they are included in this Collection for convenience.

The Collection will contain instances of BaseObject. Specifically, this Map should contain the objects for: one configuration object, one or more Host objects, one or more ComponentType objects, and one or more ComponentTypeDefn objects.

This method is intended to facilitate exporting a configuration to XML.

Here is what the Collection would contain at runtime:

 
  Configuration instance
  Host instance1
  Host instance2
  ...
  ComponentType instance1
  ComponentType instance2
  ...
  ComponentTypeDefn instance1
  ComponentTypeDefn instance2
  
 

Parameters:

configID - ID Of a Configuration

Returns:

Collection of BaseObject instances

Throws:

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

getAllGlobalConfigObjects

java.util.Collection getAllGlobalConfigObjects()
                                               throws ConfigurationException

This method will return a Collection of objects that represent the set of global configuration objects currently represented in the configuration database. This method will generally be used when attempting to import a configuration into the database as the 'Next Startup' configuration. This information is important when importing a new configuration so that any global type configuration objects that are to be imported can be resolved against the global objects that currently exist in the database.

 
  The Collection of objects will contain the following configuration 
  object types:
  
  ComponentTypes
  ProductTypes
  Hosts
  
 

Returns:

a Collection of all of the global configuration objects as they exist in the database.

Throws:

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

InvalidSessionException - if there is not a valid administrative session

AuthorizationException - if the administrator does not have privileges to use this method

MetaMatrixComponentException - if a general remote system problem occurred

getComponentTypeDefinitions

java.util.Map getComponentTypeDefinitions(java.util.Collection componentIDs)
                                          throws ConfigurationException

Returns a Map of component type definitions for each ComponentTypeID that is contained in the passed Collection. This does not return the dependent definitions for service type components.

Parameters:

componentIDs - is a Collection

Returns:

Map of a Map of component type difinitions keyed by ComponentTypeID

Throws:

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

See Also:

getDependentComponentTypeDefintions(Collection)

getComponentTypeDefinitions

java.util.Collection getComponentTypeDefinitions(ComponentTypeID componentTypeID)
                                                 throws ConfigurationException

Returns the component type definitions for the specified ComponentTypeID. This does not return the dependent definitions for service type components.

Parameters:

componentTypeID - is a ComponentTypeID

Returns:

Collection of ComponentTypeDefns

Throws:

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

See Also:

getDependentComponentTypeDefinitions(ComponentTypeID)

getAllComponentTypeDefinitions

java.util.Collection getAllComponentTypeDefinitions(ComponentTypeID componentTypeID)
                                                    throws ConfigurationException

Returns the all component type definitions for the specified ComponentTypeID. This includes the dependent definitions for service type components.

Parameters:

componentTypeID - is a ComponentTypeID

Returns:

Collection of ComponentTypeDefns

Throws:

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

See Also:

getDependentComponentTypeDefinitions(ComponentTypeID)

getDependentComponentTypeDefinitions

java.util.Map getDependentComponentTypeDefinitions(java.util.Collection componentIDs)
                                                   throws ConfigurationException

Returns a Map of all component type definitions for each ComponentTypeID that is contained in the passed Collection. This only returns the dependent definitions for service type components where the component type is defined as having a super component type.

Parameters:

componentIDs - is a Collection

Returns:

Map of component type difinitions keyed by ComponentTypeID

Throws:

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

See Also:

getComponentTypeDefinitions(Collection), getDependentComponentTypeDefinitions(ComponentType)

getDependentComponentTypeDefinitions

java.util.Collection getDependentComponentTypeDefinitions(ComponentTypeID componentTypeID)
                                                          throws ConfigurationException

Returns the component type definitions for the specified ComponentTypeID. This only returns the dependent definitions for service type components where the component type is defined as having a super component type.

Parameters:

componentTypeID - is a ComponentTypeID

Returns:

Collection of ComponentTypeDefns

Throws:

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

See Also:

getComponentTypeDefinitions(ComponentTypeID)

getMonitoredComponentTypes

java.util.Collection getMonitoredComponentTypes(boolean includeDeprecated)
                                                throws ConfigurationException

Returns a List of type ComponentType . that are flagged as being monitored. A component of this type is considered to be available for monitoring statistics.

Parameters:

includeDeprecated - true if class names that have been deprecated should be included in the returned list, or false if only non-deprecated constants should be returned.

Returns:

Collection of type ComponentType

Throws:

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

See Also:

#ComponentType

getComponentType

ComponentType getComponentType(ComponentTypeID id)
                               throws ConfigurationException

Returns a ComponentType for the specified ComponentTypeID

Parameters:

id - is for the requested component type.

Returns:

ComponentType based on the id

Throws:

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

getAllComponentTypes

java.util.Collection getAllComponentTypes(boolean includeDeprecated)
                                          throws ConfigurationException

Returns a List of type ComponentType that represents all the ComponentTypes defined.

Parameters:

includeDeprecated - true if class names that have been deprecated should be included in the returned list, or false if only non-deprecated constants should be returned.

Returns:

Collection of type ComponentType

Throws:

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

See Also:

#ComponentType

getHost

Host getHost(HostID hostID)
             throws ConfigurationException

Returns a Host for the specified HostID.

Returns:

Host

Throws:

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

getHosts

java.util.Collection getHosts()
                              throws ConfigurationException

Returns a Collection of currently defined hosts. This method does not cache, it re-retrieves the data every time.

Returns:

Collection of type Host

Throws:

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

getComponentDefn

ComponentDefn getComponentDefn(ConfigurationID configurationID,
                               ComponentDefnID componentDefnID)
                               throws ConfigurationException

Returns a ComponentDefn for the specified ComponentDefnID.

Parameters:

configurationID - is the configuration for which the component exist

componentDefnID - is the component being requested

Returns:

ComponentDefn

Throws:

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

getComponentDefns

java.util.Collection getComponentDefns(java.util.Collection componentDefnIDs,
                                       ConfigurationID configurationID)
                                       throws ConfigurationException

Returns a collection of ComponentDefns for the specified collection of ComponentDefnIDs and ConfigurationID. If the configuration is null the parent name from the componentID will be used.
The reason for adding the option to specify the configurationID is so that the same collection of componentIDs can be used to obtain the componentDefns from the different configurations. Otherwise, the requestor would have to create a new set of componetDefnIDs for each configuration.

Parameters:

componentDefnIDs - contains all the ids for which componet defns to be returned

configurationID - is the configuration from which the component defns are to be derived; optional, nullalble

Returns:

Collection of ComponentDefn objects

Throws:

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

getResources

java.util.Collection getResources()
                                  throws ConfigurationException

Returns a Collection of ResourceDescriptor for all internal resources defined to the system. The internal resources are not managed with the other configuration related information. They are not dictated based on which configuration they will operate (i.e., next startup or operational);

Throws:

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

getResources

java.util.Collection getResources(ComponentTypeID componentTypeID)
                                  throws ConfigurationException

Returns a Collection of ResourceDescriptor that are of the specified resource type.

Parameters:

componentTypeID - that identifies the type of resources to be returned

Throws:

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

saveResources

void saveResources(java.util.Collection resourceDescriptors,
                   java.lang.String principalName)
                   throws ConfigurationException

Save the resource changes based on each ResourceDescriptor in the collection.

Parameters:

resourceDescriptors - for the resources to be changed *

Throws:

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

getProductReleaseInfos

java.util.Collection getProductReleaseInfos()
                                            throws ConfigurationException

Obtain the List of ReleaseInfo objects which represent the products of the system. Each ReleaseInfo contains the name of the product, as well as release info.

Returns:

Collection of ReleaseInfo objects of licensed products.

Throws:

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

executeTransaction

java.util.Set executeTransaction(ActionDefinition action,
                                 java.lang.String principalName)
                                 throws ModificationException,
                                        ConfigurationLockException,
                                        ConfigurationException

Execute as a single transaction the specified action, and optionally return the set of objects or object IDs that were affected/modified by the action.

Parameters:

action - the definition of the action to be performed on data within the repository.

principalName - of the person executing the transaction

Returns:

the set of objects that were affected by this transaction.

Throws:

ModificationException - if the target of the action is invalid, or if the target object is not a supported class of targets.

java.lang.IllegalArgumentException - if the action is null or if the result specification is invalid

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

ConfigurationLockException

executeTransaction

java.util.Set executeTransaction(java.util.List actions,
                                 java.lang.String principalName)
                                 throws ModificationException,
                                        ConfigurationLockException,
                                        ConfigurationException

Execute a list of actions, and optionally return the set of objects or object IDs that were affected/modified by the action.

Parameters:

actions - the ordered list of actions that are to be performed on data within the repository.

principalName - of the person executing the transaction

Returns:

the set of objects that were affected by this transaction.

Throws:

ModificationException - if the target of any of the actions is invalid, or if the target object is not a supported class of targets.

java.lang.IllegalArgumentException - if the action is null or if the result specification is invalid

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

ConfigurationLockException

executeInsertTransaction

java.util.Set executeInsertTransaction(ConfigurationID assignConfigurationID,
                                       java.util.List actions,
                                       java.lang.String principalName)
                                       throws ModificationException,
                                              ConfigurationLockException,
                                              ConfigurationException

Execute a list of insert actions and for actions on objects of type ComponentDefn or DeployedComponent object, it will have its configuration id resassigned, and optionally return the set of objects or object IDs that were affected/modified by the action. Only insert actions can be performed here because changing a configuration id on a modify action has larger consequences.

Parameters:

assignConfigurationID - the configuration for which any action for a component object will have its configurationID set to this.

actions - the ordered list of actions that are to be performed on data within the repository.

principalName - of the person executing the transaction

Returns:

the set of objects that were affected by this transaction.

Throws:

ModificationException - if the target of any of the actions is invalid, or an action that is not an insert, or if the target object is not a supported class of targets.

java.lang.IllegalArgumentException - if the action is null or if the result specification is invalid

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

ConfigurationLockException

undoActionsAsTransaction

java.util.Set undoActionsAsTransaction(int numberOfActions,
                                       java.lang.String principalName)
                                       throws ConfigurationException

Undo the specified number of previously-committed transactions.

Parameters:

numberOfActions - the number of actions in the history that are to be undone.

principalName - of the person executing the transaction

Returns:

the set of objects that were affected by undoing these actions.

Throws:

java.lang.IllegalArgumentException - if the number is negative.

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

getHistory

java.util.List getHistory()
                          throws ConfigurationException

Get the history of actions executed in transactions by this editor. The actions at the front of the list will be those most recently executed.

Returns:

the ordered list of actions in the history.

Throws:

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

clearHistory

void clearHistory()
                  throws ConfigurationException

Clear the history of all actions without undoing any of them.

Throws:

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

getHistorySize

int getHistorySize()
                   throws ConfigurationException

Get the number of actions that are currently in the history.

Returns:

the number of actions in the history.

Throws:

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

getHistoryLimit

int getHistoryLimit()
                    throws ConfigurationException

Set the limit on the number of actions in the history. Note that the history may at times be greater than this limit, because when actions are removed from the history, all actions for a transactions are removed at the same time. If doing so would make the history size smaller than the limit, no actions are removed.

Throws:

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

setHistoryLimit

void setHistoryLimit(int maximumHistoryCount)
                     throws ConfigurationException

Set the limit on the number of actions in the history. Note that the history may at times be greater than this limit, because when actions are removed from the history, all actions for a transactions are removed at the same time. If doing so would make the history size smaller than the limit, no actions are removed.

Throws:

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

getServerStartupTime

java.util.Date getServerStartupTime()
                                    throws ConfigurationException

Return the time the server was started. If the state of the server is not "Started" then a null is returned.

Returns:

Date Time server was started.

Throws:

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

addHost

Host addHost(java.lang.String hostName,
             java.lang.String principalName,
             java.util.Properties properties)
             throws ConfigurationException

Add Host to Configuration Add a new Host to the System (MetaMatrix Cluster)

Parameters:

hostName - Host Name of new Host being added to Configuration

principalName -

properties -

Returns:

Host

Throws:

ConfigurationException

Since:

4.3

addProcess

VMComponentDefn addProcess(java.lang.String processName,
                           java.lang.String hostName,
                           java.lang.String principalName,
                           java.util.Properties properties)
                           throws ConfigurationException

Add Process for the specified Host to Configuration Add a new Virtuial Machine to the System (MetaMatrix Cluster)

Parameters:

processName - Name of the New Process being Added to Configuration

hostName - Name of the Host that the new Process is being added

principalName - User Name of user who is making the change

properties - name, value need to setup a Host

Returns:

VMComponentDefn

Throws:

ConfigurationException

Since:

4.3

setSystemPropertyValue

void setSystemPropertyValue(java.lang.String propertyName,
                            java.lang.String propertyValue,
                            java.lang.String principalName)
                            throws ConfigurationException

Set System Property Value in Configuration

Parameters:

propertyName - Name of Property

propertyValue - Value of Property

principalName - User Name of user who is making the change

Throws:

ConfigurationException

Since:

4.3

updateSystemPropertyValues

void updateSystemPropertyValues(java.util.Properties properties,
                                java.lang.String principalName)
                                throws ConfigurationException

Set System Property Values in Configuration. Any properties not set will be left unchanged.

Parameters:

properties - Properties to set

principalName - User Name of user who is making the change

Throws:

ConfigurationException

Since:

4.3

createConnectorBinding

ConnectorBinding createConnectorBinding(java.lang.String connectorBindingName,
                                        java.lang.String connectorType,
                                        java.lang.String pscName,
                                        java.lang.String principalName,
                                        java.util.Properties properties)
                                        throws ConfigurationException

Deploy a new Connector Binding into Configuration

Parameters:

connectorBindingName -

connectorType - Connector Type for this Connector Binding

pscName - Name of the PSC to deploy the Connector Binding to. If pscName is null, this method does not deploy the Connector Binding to a PSC.

principalName - User Name of user who is making the change

properties -

Returns:

ConnectorBinding object

Throws:

ConfigurationException

Since:

4.3

modify

java.lang.Object modify(ComponentObject theObject,
                        java.util.Properties theProperties,
                        java.lang.String principalName)
                        throws ConfigurationException,
                               ModificationException

Modify a Component in Configuration

Parameters:

theObject -

theProperties -

principalName -

Returns:

Throws:

ModificationException

java.lang.Exception

ConfigurationException

Since:

4.3

importConnectorType

ComponentType importConnectorType(java.io.InputStream inputStream,
                                  java.lang.String name,
                                  java.lang.String principalName)
                                  throws ConfigurationException

Import a Connector Type

Parameters:

inputStream -

name - Name of the Connector Type to import

principalName - User Name of user who is making the change

Returns:

ComponentType

Throws:

ConfigurationException

Since:

4.3

importConnectorBinding

ConnectorBinding importConnectorBinding(java.io.InputStream inputStream,
                                        java.lang.String name,
                                        java.lang.String pscName,
                                        java.lang.String principalName)
                                        throws ConfigurationException

Import a connector Binding from InputStream, and deploy it to a PSC.

Parameters:

inputStream -

name - Name of Connector Binding to import

pscName - Name of the PSC to deploy the Connector Binding to. If pscName is null, this method does not deploy the Connector Binding to a PSC.

principalName -

Returns:

ConnectorBinding

Throws:

ConfigurationException

Since:

4.3

delete

void delete(ComponentObject theObject,
            boolean theDeleteDependenciesFlag,
            java.lang.String principalName)
            throws ConfigurationException,
                   ModificationException

Deletes a component object.

Parameters:

theObject - the object being deleted

theDeleteDependenciesFlag - boolean flag for deleting dependencies

principalName - User Name of user who is making the change

Throws:

ConfigurationException

ModificationException

Since:

4.3

delete

void delete(ComponentType componentType,
            java.lang.String principalName)
            throws ConfigurationException,
                   ModificationException

Delete a Component Type

Parameters:

componentType - Component Type Object being deleted

principalName - User Name who is making the change

Throws:

ConfigurationException

ModificationException

Since:

4.3

deployPSC

java.util.Collection deployPSC(Host theHost,
                               VMComponentDefn theProcess,
                               java.lang.String pscName,
                               java.lang.String principalName)
                               throws ConfigurationException,
                                      ModificationException

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

Parameters:

theHost - host on which the services will be deployed

theProcess - VM on which the services will be deployed

pscName - Name of the PSC

principalName - User Name deploying the Services

Returns:

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

Throws:

ConfigurationException

ModificationException

Since:

4.3

checkPropertiesDecryptable

java.util.List checkPropertiesDecryptable(java.util.List defns)
                                          throws ConfigurationException

Check whether the encrypted properties for the specified ComponentDefns can be decrypted.

Parameters:

defns - List

Returns:

List in the same order as the parameter defns. For each, true if the properties could be decrypted for that defn.

Throws:

ConfigurationException

Since:

4.3

checkPropertiesDecryptable

boolean checkPropertiesDecryptable(java.util.Properties props,
                                   java.lang.String componentTypeIdentifier)
                                   throws ConfigurationException

Check whether the given properties pertaining to the given component (name and type) contain at least one value that the server cannot decrypt with its current keystore.

Parameters:

props - component properties possibly containing encrypted values.

componentTypeIdentifier - The type identifier of the component to which the properties belong.

Returns:

true if all of the encrypted properties, if any, can be decrypted.

Throws:

ConfigurationException

Since:

4.3