com.netegrity.imapi
Class LogicalAttributeAdapter

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

All Implemented Interfaces:

LifeCycle, Logger

Direct Known Subclasses:

ForgottenPasswordHandler, OrgSelectorAdapter

public abstract class LogicalAttributeAdapter
extends LifeCycleImpl
implements LifeCycle, Logger

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

A logical attribute handler allows you to perform custom processing of managed object attribute data before it is displayed on a task screen and after a user executes (submits) a task on the task screen. For example, a logical attribute handler can convert between logical attribute data and physical attribute data, validate user-supplied data, and populate an option list on a task screen.

Note: You can also validate user-supplied data through regular expressions or JavaScript. For information, see the CA Identity Manager Configuration Guide.

Since:

IdentityMinder 5.6

Constructor Summary

LogicalAttributeAdapter()

Method Summary

void	initialize(LogicalAttributeContext apiContext) Supplies default values to logical attributes during a Create...
void	initializeOptionList(LogicalAttributeContext apiContext) Populates any option lists on a task screen.
void	toLogical(LogicalAttributeContext apiContext) Converts physical attribute data to logical attribute data.
void	toPhysical(LogicalAttributeContext apiContext) Converts logical attribute data to physical attribute data.
void	validate(LogicalAttributeContext apiContext) Validates logical attribute values and physical attribute values supplied on a task screen.

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

LogicalAttributeAdapter

public LogicalAttributeAdapter()

Method Detail

initializeOptionList

public void initializeOptionList(LogicalAttributeContext apiContext)
                          throws java.lang.Exception

Populates any option lists on a task screen.

This is the first LogicalAttributeAdapter method that Identity Manager calls after a user requests a task.

Parameters:

apiContext - Logical attribute context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

toLogical

public void toLogical(LogicalAttributeContext apiContext)
               throws java.lang.Exception

Converts physical attribute data to logical attribute data.

When a user requests a task against an existing managed object (for example, Modify User or Delete User), Identity Manager retrieves the managed object attribute data from the data store and displays it on the task screen. Before the data is displayed, Identity Manager calls toLogical() to allow conversion of physical attribute data to logical attribute data.

When a user requests a Create... task, Identity Manager calls initialize() instead of toLogical().

Parameters:

apiContext - Logical attribute context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

toPhysical

public void toPhysical(LogicalAttributeContext apiContext)
                throws java.lang.Exception

Converts logical attribute data to physical attribute data.

Identity Manager calls this method after the user submits a task on the task screen and after validate() is called.

Parameters:

apiContext - Logical attribute context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

validate

public void validate(LogicalAttributeContext apiContext)
              throws java.lang.Exception

Validates logical attribute values and physical attribute values supplied on a task screen.

Identity Manager calls this method after a user submits a task on the task screen.

Parameters:

apiContext - Logical attribute context information that Identity Manager passes into the method.

Throws:

java.lang.Exception

initialize

public void initialize(LogicalAttributeContext apiContext)
                throws java.lang.Exception

Supplies default values to logical attributes during a Create... task. Identity Manager calls this method after the user requests the Create... task and before displaying the task screen.

For tasks against existing managed objects (such as Modify User tasks), Identity Manager calls toLogical() instead of initialize().

Parameters:

apiContext - Logical attribute context information that Identity Manager passes into the method.

Throws:

java.lang.Exception