com.netegrity.imapi
Class BLTHAdapter

java.lang.Object
  LifeCycleImpl
      com.netegrity.imapi.BLTHAdapter

All Implemented Interfaces:

LifeCycle, Logger

public abstract class BLTHAdapter
extends LifeCycleImpl
implements LifeCycle, Logger

The base class for custom business logic task handlers. All business logic task handlers must extend this class. Identity Manager executes a business logic task handler by calling the methods in this class.

Business logic task handlers validate the information within a task session. Task session information includes the managed object that is the subject of the task (for example, a User object is the subject of a Create User task). Identity Manager passes task session information into BLTHAdapter methods through BLTHContext.

Identity Manager invokes business logic task handlers after the completion of all logical attribute handler processing. Business logic task handlers therefore will have access to the logical attribute values and physical attribute values that the logical attribute handlers may have defined.

Identity Manager invokes business logic task handlers in the following order:

• Task-specific handlers are invokeded first, in the order in which they are referenced on the task screen.
• After all task-specific handlers are invoked, global handlers are invoked in the order in which they are listed in the Management Console.

You can initialize or process task data at several different times during task execution:

• At the beginning of the task (implement handleStart())
• After selecting the subject from the search result (implement handleSetSubject())
• After the user has submitted the task, but before the security check (implement handleValidation())
• After a security check and the events are ready to be posted (implement handleSubmission())

If a business logic task handler throws an exception, the exception message is displayed to the administrator, giving the administrator a chance to address the issue.



Note: You can also validate task session information using regular expressions or JavaScript. For information, see the CA Identity Manager Configuration Guide.

Since:

IdentityMinder 5.6

Constructor Summary

BLTHAdapter()

Method Summary

void	handleSetSubject(BLTHContext blthContext) Processes task data after selecting a subject from the search result, but before presenting the data to the user.
void	handleStart(BLTHContext blthContext) Initializes or processes task data when the task session is created.
void	handleSubmission(BLTHContext blthContext) Processes task data after a security check has been done and all events are ready to be posted.
int	handleTask(BLTHContext blthContext) Deprecated. Deprecated in Idenity Manager 8.0.
void	handleValidation(BLTHContext blthContext) Processes task data after the user has submitted the task, but before a security check.
void	handleValidationBeforeSubmission(BLTHContext blthContext) Processes task data before the user has submitted the task
boolean	shouldExecute(BLTHContext blthContext) Deprecated. Deprecated in Identity Manager 8.1.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netegrity.imapi.LifeCycle

init, init, shutdown, startup, uninit

Methods inherited from interface com.netegrity.imapi.Logger

logDebugMessage, logErrorMessage, logInfoMessage, logWarningMessage

Constructor Detail

BLTHAdapter

public BLTHAdapter()

Method Detail

handleTask

public int handleTask(BLTHContext blthContext)
               throws java.lang.Exception

Deprecated. Deprecated in Idenity Manager 8.0.

Performs whatever business logic is required for the task. Identity Manager calls this method only in the following cases:

• With global business logic task handlers, if the previous call to shouldExecute() returns true.
• With task-specific business logic task handlers, if the handler is assigned to the current task. A task-specific handler is assigned to a task on the task screen during task screen configuration.

On return from the method, Identity Manager invokes the next business logic task handler.

Parameters:

blthContext - Business logic task handler context information that Identity Manager passes into the method.

Returns:

This method should always return CONTINUE to indicate that execution of this business logic task handler is complete, and that Identity Manager should execute the next business logic task handler.

Throws:

java.lang.Exception

shouldExecute

public boolean shouldExecute(BLTHContext blthContext)
                      throws java.lang.Exception

Deprecated. Deprecated in Identity Manager 8.1.

Determines whether a global handler applies to the current task. For example, a handler that checks whether a newly created object is a duplicate of an existsing object would apply to any Create... task, such as Create User.

If the method returns true, the global handler applies to the task, and Identity Manager calls handleTask() to allow the handler to perform its business logic. If the method returns false, Identity Manager abandons further calls to this handler, and invokes the next handler defined in the Identity Manager Management Console.

shouldExecute() is called only for global business logic task handlers. With task-specific handlers, the handler is assumed to apply to the current task, since it is referenced on the task screen for the task. Thus, Identity Manager calls handleTask() for task-specific handlers without having to call shouldExecute().

Parameters:

blthContext - Business logic task handler context information that Identity Manager passes into the method.

Returns:

true if the global handler's validation logic should be executed for the task, or false otherwise.

Throws:

java.lang.Exception

handleStart

public void handleStart(BLTHContext blthContext)
                 throws java.lang.Exception

Initializes or processes task data when the task session is created.

Parameters:

blthContext - Business logic task handler context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

handleSetSubject

public void handleSetSubject(BLTHContext blthContext)
                      throws java.lang.Exception

Processes task data after selecting a subject from the search result, but before presenting the data to the user.

Parameters:

blthContext - Business logic task handler context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

handleValidation

public void handleValidation(BLTHContext blthContext)
                      throws java.lang.Exception

Processes task data after the user has submitted the task, but before a security check.

Parameters:

blthContext - Business logic task handler context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

handleSubmission

public void handleSubmission(BLTHContext blthContext)
                      throws java.lang.Exception

Processes task data after a security check has been done and all events are ready to be posted.

Parameters:

blthContext - Business logic task handler context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

handleValidationBeforeSubmission

public void handleValidationBeforeSubmission(BLTHContext blthContext)
                                      throws java.lang.Exception

Processes task data before the user has submitted the task

Parameters:

blthContext - Business logic task handler context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

Since:

Identity Manager r12.5 SP1