com.netegrity.imapi
Class ParticipantResolverAdapter

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

All Implemented Interfaces:

LifeCycle, Logger

public abstract class ParticipantResolverAdapter
extends LifeCycleImpl
implements LifeCycle, Logger

The base class for custom participant resolvers. All participant resolvers must extend this class. Identity Manager executes a participant resolver by calling the resolve() method in this class.

When a workflow activity needs a list of participants, the following events occur:

1. WorkPoint sends to Identity Manager the information on the User Data tab of the WorkPoint Designer Activity Properties dialog box. This information includes the name of your custom participant resolver, and any user-defined data associated with this workflow activity that your participant resolver might require.
   
   
2. Identity Manager calls the resolve() method in ParticipantResolverAdapter and passes the User Data information to it.
   
   
3. The participant resolver determines the list of participants and returns it to Identity Manager.
   
   
4. Identity Manager passes the participant list back to WorkPoint.

Since:

IdentityMinder 6.0

Field Summary

static java.lang.String

EDITOR_CLASSNAME The class name of the the participant policy editor for pp's using this resolver.

Constructor Summary

ParticipantResolverAdapter()

Method Summary

abstract java.util.Vector	resolve(ParticipantResolverContext partResolverApiContext, java.util.Hashtable userData, java.lang.String approvalTaskName) Determines the list of participants for the approval task passed in the approvalTaskName parameter and returns the list to Identity Manager.
void	setEventMapping(EventMapping mapping)
boolean	validate(IMContext imContext, java.lang.String mappingLevel, java.lang.String tabName, ParticipantPolicy policy) Validate a participant policy relevent to this resolver.

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

Field Detail

EDITOR_CLASSNAME

public static java.lang.String EDITOR_CLASSNAME

The class name of the the participant policy editor for pp's using this resolver. If it is not overridden, an editor allowing free-form name-value pairs to be created will be used. The class indicated here should implement IPage.

Constructor Detail

ParticipantResolverAdapter

public ParticipantResolverAdapter()

Method Detail

resolve

public abstract java.util.Vector resolve(ParticipantResolverContext partResolverApiContext,
                                         java.util.Hashtable userData,
                                         java.lang.String approvalTaskName)
                                  throws java.lang.Exception

Determines the list of participants for the approval task passed in the approvalTaskName parameter and returns the list to Identity Manager.

Parameters:

partResolverApiContext - Participant resolver context information that Identity Manager passes into the method.

userData - Any user-defined data or other information associated with a workflow activity as defined on the User Data tab of the WorkPoint Designer Activity Properties dialog box.

approvalTaskName - The name of the Identity Manager approval task that requires approval from a participant.

Returns:

A Vector of User objects containing the list of participants.

Throws:

java.lang.Exception

validate

public boolean validate(IMContext imContext,
                        java.lang.String mappingLevel,
                        java.lang.String tabName,
                        ParticipantPolicy policy)
                 throws java.lang.Exception

Validate a participant policy relevent to this resolver. Subclasses aren't obliged to override this, but of course it is recommended. Validation errors should be added directly to the task session, and the method should return true.

Throws:

java.lang.Exception

setEventMapping

public void setEventMapping(EventMapping mapping)