com.ibm.itim.apps.lifecycle

Class LifecycleManager

java.lang.Object

com.ibm.itim.apps.lifecycle.LifecycleManager

public class LifecycleManager
extends java.lang.Object

Provides lifecycle management capabilities on supported business domain objects, including Person and Account. It provides an interface to invoke global operations, static operations defined for specific type of object, or operations on the object instance. Please refer to "Designing and Implementing Workflows" in the IBM Tivoli Identity Governance InfoCenter for more information.

Constructor Summary

Constructors

Constructor and Description
LifecycleManager(PlatformContext platform, javax.security.auth.Subject subject) Constructs the manager with a platform context and a subject.

Method Summary

Modifier and Type	Method and Description
Request	executeGlobalOperation(java.lang.String operationName, java.lang.Object[] args) Executes a global operation in the provisioning platform
Request	executeObjectOperation(DirectoryObject managedObject, java.lang.String operationName, java.lang.Object[] args) Executes an operation on a specific object in the provisioning platform
Request	executeStaticOperation(java.lang.String categoryName, java.lang.String profileName, java.lang.String operationName, java.lang.Object[] args) Executes a static operation on a specific type of object in the provisioning platform.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LifecycleManager

public LifecycleManager(PlatformContext platform,
                        javax.security.auth.Subject subject)

Constructs the manager with a platform context and a subject.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

See Also:

PlatformContext, Subject

Method Detail

executeGlobalOperation

public Request executeGlobalOperation(java.lang.String operationName,
                                      java.lang.Object[] args)
                               throws java.rmi.RemoteException,
                                      AuthorizationException,
                                      ApplicationException

Executes a global operation in the provisioning platform

Parameters:

operationName - operation name as specified in the IBM Tivoli Identity Governance "Entity Type->Global->Define Operation" UI.

args - operation input parameters as specified in the workflow definition for the target operation. Use the workflow designer UI to view the workflow definition and discover the list of input parameters. The parameters must appear in the args array in the same order which they appear in the workflow designer. The workflowDataSyntax.xml file in the {itim-home}/data folder documents the Java to workflow data type mappings.

Returns:

Request object representing the operation's status.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

AuthorizationException - Thrown if client is unauthorized to create the person in the given container.

ApplicationException - Thrown if unable to submit the request. This may possibly be caused by the container being removed by another client previous to this call.

See Also:

Request

executeStaticOperation

public Request executeStaticOperation(java.lang.String categoryName,
                                      java.lang.String profileName,
                                      java.lang.String operationName,
                                      java.lang.Object[] args)
                               throws java.rmi.RemoteException,
                                      AuthorizationException,
                                      ApplicationException

Executes a static operation on a specific type of object in the provisioning platform. The object type is identified by its category name and its profile name

Parameters:

categoryName - the object category name. Must be one of the values defined in the com.ibm.itim.dataservices.model.ManagableCategoryConstant interface.

profileName - the object profile name. The name of the entity for which the target operation has been specified. This value must be null for entity type level operations.

operationName - operation name as specified in the IBM Tivoli Identity Governance "Entities/Entity Type Define Operation" UI.

args - operation input parameters as specified in the workflow definition for the target operation. Use the workflow designer UI to view the workflow definition and discover the list of input parameters. The parameters must appear in the args array in the same order which they appear in the workflow designer. The workflowDataSyntax.xml file in the {itim-home}/data folder documents the Java to workflow data type mappings.

Returns:

Request object representing the operation's status.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

AuthorizationException - Thrown if client is unauthorized to create the person in the given container.

ApplicationException - Thrown if unable to submit the request. This may possibly be caused by the container being removed by another client previous to this call.

See Also:

ManagableCategoryConstant, Request

executeObjectOperation

public Request executeObjectOperation(DirectoryObject managedObject,
                                      java.lang.String operationName,
                                      java.lang.Object[] args)
                               throws java.rmi.RemoteException,
                                      AuthorizationException,
                                      ApplicationException

Executes an operation on a specific object in the provisioning platform

Parameters:

managedObject - the target object for which the operation in invoked. This object must be of type Person or Account.

operationName - operation name as specified in the IBM Tivoli Identity Governance "Entities/Entity Type Define Operation" UI.

args - operation input parameters as specified in the workflow definition for the target operation. Use the workflow designer UI to view the workflow definition and discover the list of input parameters. The parameters must appear in the args array in the same order which they appear in the workflow designer. The workflowDataSyntax.xml file in the {itim-home}/data folder documents the Java to workflow data type mappings.

Returns:

Request object representing the operation's status.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

AuthorizationException - Thrown if client is unauthorized to create the person in the given container.

ApplicationException - Thrown if unable to submit the request. This may possibly be caused by the container being removed by another client previous to this call.

See Also:

Request, Person, Account