com.centrasite.lcmapi

Interface LCMRuntimeManager

public interface LCMRuntimeManager

The LCMRuntimeManager provides all LCM runtime functionality , namely: searching for LCModels, finding & setting the LCState of a given registryObject

Method Summary

Modifier and Type	Method and Description
void	approveStateChange(javax.xml.registry.infomodel.RegistryObject registryObject) Approves the state change on the given registry object
java.util.Collection<LCMNode>	findAllLCMNodes() Finds all LCMNodes
java.util.Collection<LCModel>	findAllLCModels(javax.xml.registry.infomodel.Concept objectType, javax.xml.registry.infomodel.Organization organization) Finds all active and inactive LCModels that are applicable for the given object type/virtual type concept and the given organization.
java.util.Collection<LCModel>	findAllModels() Finds all LCModels that are currently within the scope.
java.util.Collection<LCModel>	findAllModels(com.centrasite.resourceaccess.managers.ResourceAccessManager resourceManager) Finds all LCModels that are currently within the scope.
java.util.Collection<javax.xml.registry.infomodel.Concept>	findAllTypesApplicableForLCM() Returns all types that can be lifecycle cycle enabled.
java.util.Collection<LCModel>	findInactiveModels() Finds all LCModels in the whole system that are not active
LCModel	findLCMForLCM() Finds the LCModel for LCModels.
LCModel	findLCModel(javax.xml.registry.infomodel.Concept objectType, javax.xml.registry.infomodel.Organization organization) Finds the active and inactive LCModel that is applicable for the given object type/virtual type concept and the given organization.
LCModel	findLCModel(javax.xml.registry.infomodel.RegistryObject registryObject) Finds the LCModel that is assigned to the given registryObject
LCModel	findLCModel(java.lang.String typeName) Finds the LCModel that is active for the given type If there are two LCModels active for the given type (one global and the other local), the global LCModel will be returned.
java.util.Collection<LCModel>	findLCModels(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypes, java.util.Collection<javax.xml.registry.infomodel.Organization> organizations) Finds the active LCModel that is applicable for the given object type/virtual type concept and the given organization.
java.util.Map<javax.xml.registry.infomodel.Concept,LCModel>	getApplicableLCModels(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypes, javax.xml.registry.infomodel.Organization organization) Returns a map containing the object types which have a global or org-specific LC Model applicable to them.
java.util.Map<javax.xml.registry.infomodel.Concept,LCModel>	getApplicableLCModels(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypes, javax.xml.registry.infomodel.Organization organization, boolean includeNativeType)
LCMNode	getLCMNode(java.lang.String nodeKey) Finds the LCMNode with the given LCMNode key
java.util.Collection<java.lang.String>	getLCMNodeURLsForImport(javax.xml.registry.infomodel.RegistryObject registryObject) Returns the collection of configuration URLs of nodes(stages), if any, into which the given registry object can be imported.
LCModel	getLCModel(java.lang.String lcModelKey) Gets the LCModel with the given key
java.util.Collection<javax.xml.registry.infomodel.RegistryObject>	getLcmRelatedExportObjects(javax.xml.registry.infomodel.RegistryObject objectToExport) Returns collection of registry objects for export which includes LC model classificationScheme, State Concepts, and their related stages returns an empty collection if the object sent is not a LC model classification scheme
LCRegistryObjectState	getLCState(javax.xml.registry.infomodel.RegistryObject registryObject) For the given registryObject returns the current state
LCModel	getNewVersion(LCModel oldVersionModel) Returns the new version, if any, that supersedes the given old version of the model
boolean	isLCModel(javax.xml.registry.infomodel.ClassificationScheme taxonomy) Checks if the given taxonomy represents an LCModel taxonomy
void	rejectStateChange(javax.xml.registry.infomodel.RegistryObject registryObject) Rejects the state change on the given registry object
void	rejectStateChange(javax.xml.registry.infomodel.RegistryObject registryObject, LCState rejectState) Rejects the state change and sets the state of the given registry object to the reject state, provided there is a valid state transition from the state of the object prior to approval to the reject state.
void	setInitialLCState(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> registryObjects, LCState initialState) Sets the initial states of the each registry object in the collection to the given state.
java.util.Collection<LCStateChangeStatus>	setLCState(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> registryObjects, LCState targetState) Sets the given registry objects to the given state
LCStateChangeStatus	setLCState(javax.xml.registry.infomodel.RegistryObject registryObject, LCState targetState) Sets the given registry object to the given state
void	setLCStateEx(javax.xml.registry.infomodel.RegistryObject registryObject, LCState targetState) Sets the given registry object to the given state.

Method Detail

findAllModels

java.util.Collection<LCModel> findAllModels(com.centrasite.resourceaccess.managers.ResourceAccessManager resourceManager)
                                     throws LCMException

Finds all LCModels that are currently within the scope. (global or organization specific) of the logged-in user.

Parameters:

resourceManager - the resource access manager object.

Returns:

all the LCModel as a collection, must not be null

Throws:

LCMException - if the LCM provider encounters an internal error

findAllModels

java.util.Collection<LCModel> findAllModels()
                                     throws LCMException

Finds all LCModels that are currently within the scope. (global or organization specific) of the logged-in user. Note: Please DO NOT USE this operation in POLICY implementation

Returns:

all the LCModel as a collection, must not be null

Throws:

LCMException - if the LCM provider encounters an internal error while searching for models

findInactiveModels

java.util.Collection<LCModel> findInactiveModels()
                                          throws LCMException

Finds all LCModels in the whole system that are not active

Returns:

the LCModel that are not active as a collection, must not be null

Throws:

LCMException - if the LCM provider encounters an internal error while searching for active models

findLCModel

LCModel findLCModel(java.lang.String typeName)
             throws LCMException

Finds the LCModel that is active for the given type If there are two LCModels active for the given type (one global and the other local), the global LCModel will be returned.

Parameters:

typeName - the name of the type for which the LCModel has to be found

Returns:

LCModel with the given name, null if no LCModel found

Throws:

LCMException - if the LCM provider encounters an internal error while searching for LCModel based on type

findLCModel

LCModel findLCModel(javax.xml.registry.infomodel.RegistryObject registryObject)
             throws LCMException

Finds the LCModel that is assigned to the given registryObject

Parameters:

registryObject - the registry object for which the LCModel has to be found

Returns:

LCModel of the registryObject, null if no LCModel found

Throws:

LCMException - If the LCM provider encounters an internal error while searching for LCModel based on registryObject

findLCModel

LCModel findLCModel(javax.xml.registry.infomodel.Concept objectType,
                    javax.xml.registry.infomodel.Organization organization)
             throws LCMException

Finds the active and inactive LCModel that is applicable for the given object type/virtual type concept and the given organization. If there is an exclusive LCM for the virtual type, that takes the highest priority If there is no exclusive LCM for the virtual type and if the inheritsLCM flag is true, finds an LCM for its base type

Parameters:

objectType - The type for which the LCModel has to be found. Can be a virtual type or base type concept.

organization - The organization for which the model has to be found

Returns:

LCModel for the specified object type/virtual type and the organization, null if no LCModel is found

Throws:

LCMException - If the LCM provider encounters an internal error

findLCModels

java.util.Collection<LCModel> findLCModels(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypes,
                                           java.util.Collection<javax.xml.registry.infomodel.Organization> organizations)
                                    throws LCMException

Finds the active LCModel that is applicable for the given object type/virtual type concept and the given organization. If there is an exclusive LCM for the virtual type, that takes the highest priority If there is no exclusive LCM for the virtual type and if the inheritsLCM flag is true, find an LCM for its base type

Parameters:

objectTypes - The type for which the LCModel has to be found. Can be a virtual type or base type concept.

organizations - The organization for which the model has to be found

Returns:

LCModels for the specified object type/virtual type and the organization, null if no LCModel is found

Throws:

LCMException - If the LCM provider encounters an internal error

findAllLCModels

java.util.Collection<LCModel> findAllLCModels(javax.xml.registry.infomodel.Concept objectType,
                                              javax.xml.registry.infomodel.Organization organization)
                                       throws LCMException

Finds all active and inactive LCModels that are applicable for the given object type/virtual type concept and the given organization. If there is an exclusive LCM for the virtual type, that takes the highest priority If there is no exclusive LCM for the virtual type and if the inheritsLCM flag is true, find an LCM for it's base type

Parameters:

objectType - The type for which the LCModel has to be found. Can be a virtual type or base type concept.

organization - The organization for which the model has to be found

Returns:

the LCModel that are applicable for the given object type

Throws:

LCMException - If the LCM provider encounters an internal error while searching for LCModels

findLCMForLCM

LCModel findLCMForLCM()
               throws LCMException

Finds the LCModel for LCModels. If two LCModel for LCModels, one local belonging to the organization of the logged in user and the other global are present, the global model is returned

Returns:

LCModel for LCModels

Throws:

LCMException - If the LCM provider encounters an internal error

getLCModel

LCModel getLCModel(java.lang.String lcModelKey)
            throws LCMException

Gets the LCModel with the given key

Parameters:

lcModelKey - the key of the LCModel which LCModel has to be retrieved

Returns:

LCModel with the given key, null if no LCModel found

Throws:

LCMException - if the LCM provider encounters an internal error

getLCState

LCRegistryObjectState getLCState(javax.xml.registry.infomodel.RegistryObject registryObject)
                          throws LCMException

For the given registryObject returns the current state

Parameters:

registryObject - the object for which the state is to be found

Returns:

state as a LCRegistryObjectState, null if no state defined

Throws:

LCMException - if the LCM provider encounters an internal error

setLCState

java.util.Collection<LCStateChangeStatus> setLCState(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> registryObjects,
                                                     LCState targetState)
                                              throws LCMException

Sets the given registry objects to the given state

Parameters:

registryObjects - the collection of registry objects for which the state is to be set

targetState - state to which the registryObject is to be set

Returns:

LCStateChangeStatus with possible values LCStateChangeStatus.OK / LCStateChangeStatus.PENDING / LCStateChangeStatus.FAILED

Throws:

LCMException - if the LCM provider encounters an internal error

setLCState

LCStateChangeStatus setLCState(javax.xml.registry.infomodel.RegistryObject registryObject,
                               LCState targetState)
                        throws LCMException

Sets the given registry object to the given state

Parameters:

registryObject - object for which the state is to be set

targetState - state to which the registryObject is to be set

Returns:

LCStateChangeStatus with possible values LCStateChangeStatus.OK / LCStateChangeStatus.PENDING / LCStateChangeStatus.FAILED

Throws:

LCMException - if the LCM provider encounters an internal error

setLCStateEx

void setLCStateEx(javax.xml.registry.infomodel.RegistryObject registryObject,
                  LCState targetState)
           throws LCMException

Sets the given registry object to the given state. The difference between setLCState(RegistryObject, LCState) and setLCStateEx(RegistryObject, LCState) is as follows:
-For setLCState(RegistryObject, LCState) the policies required to execute & persist the state happens immediately.
-For setLCStateEx(RegistryObject, LCState) we attach listeners to registry object to perform Pre and Post operations and those listeners are invoked by the LifeCycleManager, so the state change happens as part of saveObjects.

Parameters:

registryObject - object for which the state is to be set

targetState - state to which the registryObject is to be set

Throws:

LCMException - thrown if it is not possible to set the given state for RegistryObject.

approveStateChange

void approveStateChange(javax.xml.registry.infomodel.RegistryObject registryObject)
                 throws LCMException

Approves the state change on the given registry object

Parameters:

registryObject - registryObject for which the change state is triggered

Throws:

LCMException - if the LCM provider encounters an internal error while approving the state change

rejectStateChange

void rejectStateChange(javax.xml.registry.infomodel.RegistryObject registryObject)
                throws LCMException

Rejects the state change on the given registry object

Parameters:

registryObject - registryObject for which the change state is triggered

Throws:

LCMException - if the LCM provider encounters an internal error while rejecting the state change

rejectStateChange

void rejectStateChange(javax.xml.registry.infomodel.RegistryObject registryObject,
                       LCState rejectState)
                throws LCMException

Rejects the state change and sets the state of the given registry object to the reject state, provided there is a valid state transition from the state of the object prior to approval to the reject state. If there is no valid state transition from the state prior to approval to the reject state, the object stays in the state prior to approval.

Parameters:

registryObject - registryObject for which the state change is triggered

rejectState - state to which the registry object is to be set

Throws:

LCMException - if the LCM provider encounters an internal error while rejecting the state change

isLCModel

boolean isLCModel(javax.xml.registry.infomodel.ClassificationScheme taxonomy)
           throws LCMException

Checks if the given taxonomy represents an LCModel taxonomy

Parameters:

taxonomy - ClassificationScheme object

Returns:

true if the above condition met, false otherwise

Throws:

LCMException - if the LCM provider encounters an internal error

findAllTypesApplicableForLCM

java.util.Collection<javax.xml.registry.infomodel.Concept> findAllTypesApplicableForLCM()
                                                                                 throws LCMException

Returns all types that can be lifecycle cycle enabled. The objects returned here meet the condition that only object types that are classified as Assets can be LCM enabled, plus Policies (= PolicyInstances).

Returns:

collection of types of type Concept

Throws:

LCMException - if the LCM provider encounters an internal error

findAllLCMNodes

java.util.Collection<LCMNode> findAllLCMNodes()
                                       throws LCMException

Finds all LCMNodes

Returns:

collection of LCMNodes of type LCMNode

Throws:

LCMException - if the LCM provider encounters an internal error

getLCMNode

LCMNode getLCMNode(java.lang.String nodeKey)
            throws LCMException

Finds the LCMNode with the given LCMNode key

Parameters:

nodeKey - the key of the LCMNode to be retrieved

Returns:

LCMNode with the given key

Throws:

LCMException - if the LCM provider encounters an internal error

getNewVersion

LCModel getNewVersion(LCModel oldVersionModel)
               throws LCMException

Returns the new version, if any, that supersedes the given old version of the model

Parameters:

oldVersionModel - LCModel as object

Returns:

LCModel which supersedes the given old model, null if there is none.

Throws:

LCMException - if the LCM provider encounters an internal error while getting the new version

getApplicableLCModels

java.util.Map<javax.xml.registry.infomodel.Concept,LCModel> getApplicableLCModels(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypes,
                                                                                  javax.xml.registry.infomodel.Organization organization)
                                                                           throws LCMException

Returns a map containing the object types which have a global or org-specific LC Model applicable to them. Please note that the map will not contain object types which do not have any LC Model applicable to them.

Parameters:

objectTypes - object types for which LC Models are to be found

organization - the organization for which the model has to be found

Returns:

Map in which the key is the object type concept and the value is the corresponding LC Model.

Throws:

LCMException - if the LCM provider encounters an internal error while getting the applicable LCModels

getApplicableLCModels

java.util.Map<javax.xml.registry.infomodel.Concept,LCModel> getApplicableLCModels(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypes,
                                                                                  javax.xml.registry.infomodel.Organization organization,
                                                                                  boolean includeNativeType)
                                                                           throws LCMException

Parameters:

objectTypes - object types for which LC Models are to be found

organization - the organization for which the model has to be found

includeNativeType - a flag indicating whether the native type has to be considered or not

Returns:

Map with key as the object type concept and value as the corresponding LC Model.

Throws:

LCMException - if the LCM provider encounters an internal error while getting the applicable LCModels

getLcmRelatedExportObjects

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getLcmRelatedExportObjects(javax.xml.registry.infomodel.RegistryObject objectToExport)
                                                                                      throws LCMException

Returns collection of registry objects for export which includes LC model classificationScheme, State Concepts, and their related stages returns an empty collection if the object sent is not a LC model classification scheme

Parameters:

objectToExport - the possible LC model object for which export related objects have to be return

Returns:

Collection of Registry Objects of type RegistryObject

Throws:

LCMException - if the LCM provider encounters an internal error while getting LCM related export objects

getLCMNodeURLsForImport

java.util.Collection<java.lang.String> getLCMNodeURLsForImport(javax.xml.registry.infomodel.RegistryObject registryObject)
                                                        throws LCMException

Returns the collection of configuration URLs of nodes(stages), if any, into which the given registry object can be imported. Returns an empty collection if this registry object is not LCM enabled or no nodes are specified for the current state of the registry object. This method needs to be called before exporting any IRO, and if it returns a non empty collection, the export operation should include these stages as part of the export archive.

Parameters:

registryObject - import the registry object.

Returns:

A collection of configuration URLs of nodes(stages), if any, into which the given registry object can be imported.

Throws:

LCMException - if the LCM provider encounters an internal error while getting LCMNode URLS for export

setInitialLCState

void setInitialLCState(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> registryObjects,
                       LCState initialState)
                throws LCMException

Sets the initial states of the each registry object in the collection to the given state.

Parameters:

registryObjects - Collection of registry objects.

initialState - the initial state of the object.

Throws:

LCMException - if the LCM provider encounters an internal error while setting initial LCState