com.metamatrix.platform.admin.api
Interface ConfigurationAdminAPI

All Superinterfaces:

SubSystemAdminAPI

All Known Implementing Classes:

ConfigurationAdminAPIImpl

public interface ConfigurationAdminAPI
extends SubSystemAdminAPI

Method Summary

java.util.List	checkPropertiesDecryptable(java.util.List defns) Check whether the encrypted properties for the specified ComponentDefns can be decrypted.
ConfigurationObjectEditor	createEditor() Returns a ConfigurationObjectEditor to perform editing operations on a configuration type object.
java.util.Set	executeTransaction(ActionDefinition action) 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) 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.
ComponentDefn	getComponentDefn(ConfigurationID configurationID, ComponentDefnID componentDefnID) Returns a ComponentDefn for the specified ComponentDefnID.
ComponentType	getComponentType(ComponentTypeID id) Returns a ComponentType for the specified ComponentTypeID
java.util.Collection	getComponentTypeDefinitions(ComponentTypeID componentTypeID) Returns the component type definitions for the specified ComponentTypeID.
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 current ConfigurationModelContainer.
Configuration	getCurrentConfiguration() Returns the current deployed Configuration.
Host	getHost(HostID hostID) Returns a Host for the specified HostID.
Configuration	getNextStartupConfiguration() Returns the current deployed Configuration.
ConfigurationID	getNextStartupConfigurationID() Returns the ID of the next startup Configuration, which should reflect the desired runtime state of the system.
java.util.Collection	getResources() Returns a Collection of ResourceDescriptor for all internal resources defined to the system.
void	saveResources(java.util.Collection resourceDescriptors) Save the resource changes based on each ResourceDescriptor in the collection.

Method Detail

createEditor

ConfigurationObjectEditor createEditor()
                                       throws ConfigurationException,
                                              InvalidSessionException,
                                              AuthorizationException,
                                              MetaMatrixComponentException

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

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

getNextStartupConfigurationID

ConfigurationID getNextStartupConfigurationID()
                                              throws ConfigurationException,
                                                     InvalidSessionException,
                                                     AuthorizationException,
                                                     MetaMatrixComponentException

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.

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

getCurrentConfiguration

Configuration getCurrentConfiguration()
                                      throws ConfigurationException,
                                             InvalidSessionException,
                                             AuthorizationException,
                                             MetaMatrixComponentException

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.

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

getNextStartupConfiguration

Configuration getNextStartupConfiguration()
                                          throws ConfigurationException,
                                                 InvalidSessionException,
                                                 AuthorizationException,
                                                 MetaMatrixComponentException

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.

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

getConfigurationModel

ConfigurationModelContainer getConfigurationModel(java.lang.String configName)
                                                  throws ConfigurationException,
                                                         InvalidSessionException,
                                                         AuthorizationException,
                                                         MetaMatrixComponentException

Returns the current ConfigurationModelContainer. 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.

Parameters:

configName - is the name of the Configuration model to obtain

Returns:

Configuration that is currently in use

Throws:

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

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

getConfigurationAndDependents

java.util.Collection getConfigurationAndDependents(ConfigurationID configID)
                                                   throws ConfigurationException,
                                                          InvalidSessionException,
                                                          AuthorizationException,
                                                          MetaMatrixComponentException

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.

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.Collection getComponentTypeDefinitions(ComponentTypeID componentTypeID)
                                                 throws ConfigurationException,
                                                        InvalidSessionException,
                                                        AuthorizationException,
                                                        MetaMatrixComponentException

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

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

See Also:

getDependentComponentTypeDefinitions(ComponentTypeID)

getAllComponentTypeDefinitions

java.util.Collection getAllComponentTypeDefinitions(ComponentTypeID componentTypeID)
                                                    throws ConfigurationException,
                                                           InvalidSessionException,
                                                           AuthorizationException,
                                                           MetaMatrixComponentException

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

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

See Also:

getDependentComponentTypeDefinitions(ComponentTypeID)

getComponentType

ComponentType getComponentType(ComponentTypeID id)
                               throws ConfigurationException,
                                      InvalidSessionException,
                                      AuthorizationException,
                                      MetaMatrixComponentException

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.

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

getAllComponentTypes

java.util.Collection getAllComponentTypes(boolean includeDeprecated)
                                          throws ConfigurationException,
                                                 InvalidSessionException,
                                                 AuthorizationException,
                                                 MetaMatrixComponentException

Returns a List of type ComponentType that represents all the ComponentTypes defined. Note that this will include objects of type ProductType (a subclass of ComponentType).

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.

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

See Also:

ComponentType, #getAllProductTypes

getHost

Host getHost(HostID hostID)
             throws ConfigurationException,
                    InvalidSessionException,
                    AuthorizationException,
                    MetaMatrixComponentException

Returns a Host for the specified HostID.

Returns:

Host

Throws:

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

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

getResources

java.util.Collection getResources()
                                  throws ConfigurationException,
                                         InvalidSessionException,
                                         AuthorizationException,
                                         MetaMatrixComponentException

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:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

ConfigurationException

saveResources

void saveResources(java.util.Collection resourceDescriptors)
                   throws ConfigurationException,
                          InvalidSessionException,
                          AuthorizationException,
                          MetaMatrixComponentException

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

Parameters:

resourceDescriptors - for the resources to be changed *

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

ConfigurationException

getComponentDefn

ComponentDefn getComponentDefn(ConfigurationID configurationID,
                               ComponentDefnID componentDefnID)
                               throws ConfigurationException,
                                      InvalidSessionException,
                                      AuthorizationException,
                                      MetaMatrixComponentException

Returns a ComponentDefn for the specified ComponentDefnID.

Returns:

ComponentDefn

Throws:

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

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

executeTransaction

java.util.Set executeTransaction(ActionDefinition action)
                                 throws ModificationException,
                                        ConfigurationException,
                                        InvalidSessionException,
                                        AuthorizationException,
                                        MetaMatrixComponentException

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.

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 Metadata Service.

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

executeTransaction

java.util.Set executeTransaction(java.util.List actions)
                                 throws ModificationException,
                                        ConfigurationException,
                                        InvalidSessionException,
                                        AuthorizationException,
                                        MetaMatrixComponentException

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.

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 Metadata Service.

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

checkPropertiesDecryptable

java.util.List checkPropertiesDecryptable(java.util.List defns)
                                          throws ConfigurationException,
                                                 InvalidSessionException,
                                                 AuthorizationException,
                                                 MetaMatrixComponentException

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

Parameters:

defns - List

Returns:

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

Throws:

ConfigurationException

InvalidSessionException

AuthorizationException

MetaMatrixComponentException

Since:

4.3