Package com.identityworksllc.iiq.common.task

Class ThreadedRuleRunner

java.lang.Object

sailpoint.task.AbstractTaskExecutor

com.identityworksllc.iiq.common.task.AbstractThreadedTask<ItemType>

com.identityworksllc.iiq.common.task.AbstractThreadedObjectIteratorTask<Object>

com.identityworksllc.iiq.common.task.ThreadedRuleRunner

All Implemented Interfaces:

PrivateContextObjectConsumer<Object>, sailpoint.object.BaseExecutor, sailpoint.object.TaskExecutor

public class ThreadedRuleRunner
extends AbstractThreadedObjectIteratorTask<Object>

A threaded task executor to run an iterator rule or script.

The rule or script will be invoked in parallel for each of the objects returned by the iterator query. The object will be passed as ‘object’ to Beanshell.

NOTE that if you are iterating over a very large set of Sailpoint objects, it will be vastly more efficient to return a string ID from your object retriever and then look up each object in the iterator rule or script. This will also avoid problems with multiple contexts acting on the same object. The task option ‘extractReferences’ will do this for you automatically and is true by default.

Nested Class Summary

Nested classes/interfaces inherited from class com.identityworksllc.iiq.common.task.AbstractThreadedObjectIteratorTask

AbstractThreadedObjectIteratorTask.CloseableIteratorWrapper, AbstractThreadedObjectIteratorTask.ResultTransformingIterator

Field Summary

Fields

Modifier and Type	Field	Description
protected sailpoint.object.Rule	afterBatchRule	An optional rule to run after the batch
protected sailpoint.object.Script	afterBatchScript	An optional script to run after the batch
protected sailpoint.object.Rule	beforeBatchRule	An optional rule to run before the batch
protected sailpoint.object.Script	beforeBatchScript	An optional script to run prior to the batch
protected Map<String,Object>	extraArguments	JSON arguments
protected sailpoint.object.Rule	iteratorRule	The iterator rule, if specified
protected sailpoint.object.Script	iteratorScript	The iterator script, if specified
protected ThreadLocal<Map<String,Object>>	threadState	The state that is shared between each item in a batch

Fields inherited from class com.identityworksllc.iiq.common.task.AbstractThreadedTask

beforeExecutionHook, context, executor, failureCounter, log, successCounter, taskResult, taskSchedule, terminated, threadCount

Fields inherited from class sailpoint.task.AbstractTaskExecutor

ARG_FILTER, ARG_LOCK_MODE, ARG_LOCK_TIMEOUT, ARG_PROFILE, ARG_RESTARTABLE, ARG_TRACE, DEFAULT_LOCK_TIMEOUT, RET_TOTAL

Constructor Summary

Constructors

Constructor	Description
ThreadedRuleRunner()

Method Summary

Modifier and Type	Method	Description
void	afterBatch(sailpoint.api.SailPointContext threadContext)	Invoked by the worker thread after each batch
void	beforeBatch(sailpoint.api.SailPointContext threadContext)	Invoked by the worker thread before each batch
protected Object	convertObject(Object input)	If the extract reference flag is set, and this is a SailPointObject, transforms it into a Reference object instead.
protected void	parseArgs(sailpoint.object.Attributes<String,Object> args)	Extracts the arguments passed to this task.
Object	threadExecute(sailpoint.api.SailPointContext threadContext, Map<String,Object> parameters, Object obj)	Executes this rule or script against the given object

Methods inherited from class com.identityworksllc.iiq.common.task.AbstractThreadedObjectIteratorTask

getObjectIterator, getObjectRetriever, isTerminated, supportsRetrievalType

Methods inherited from class com.identityworksllc.iiq.common.task.AbstractThreadedTask

addTerminationHandler, afterCompletion, createBatchIterator, execute, getBatchSize, getExecutor, markFailure, markSuccess, prepareExecutor, setBeforeExecutionHook, setFailureMarker, setSuccessMarker, setWorkerCreator, submitAndWait, terminate

Methods inherited from class sailpoint.task.AbstractTaskExecutor

getMonitor, getSuggestedPartitionCount, getSuggestedPartitionCount, launchPartitions, processCommand, saveRequest, setMonitor, updateProgress, updateProgress

Methods inherited from class java.lang.Object

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

Field Detail

afterBatchRule

protected sailpoint.object.Rule afterBatchRule

An optional rule to run after the batch

afterBatchScript

protected sailpoint.object.Script afterBatchScript

An optional script to run after the batch

beforeBatchRule

protected sailpoint.object.Rule beforeBatchRule

An optional rule to run before the batch

beforeBatchScript

protected sailpoint.object.Script beforeBatchScript

An optional script to run prior to the batch

iteratorRule

protected sailpoint.object.Rule iteratorRule

The iterator rule, if specified

iteratorScript

protected sailpoint.object.Script iteratorScript

The iterator script, if specified

extraArguments

protected Map<String,Object> extraArguments

JSON arguments

threadState

protected ThreadLocal<Map<String,Object>> threadState

The state that is shared between each item in a batch

Constructor Detail

ThreadedRuleRunner

public ThreadedRuleRunner()

Method Detail

afterBatch

public void afterBatch(sailpoint.api.SailPointContext threadContext)
                throws sailpoint.tools.GeneralException

Invoked by the worker thread after each batch

Overrides:

afterBatch in class AbstractThreadedTask<Object>

Parameters:

threadContext - The context for this thread

Throws:

sailpoint.tools.GeneralException - if anything fails

beforeBatch

public void beforeBatch(sailpoint.api.SailPointContext threadContext)
                 throws sailpoint.tools.GeneralException

Invoked by the worker thread before each batch

Overrides:

beforeBatch in class AbstractThreadedTask<Object>

Parameters:

threadContext - The context for this thread

Throws:

sailpoint.tools.GeneralException - if anything fails

convertObject

protected Object convertObject(Object input)

If the extract reference flag is set, and this is a SailPointObject, transforms it into a Reference object instead.

This will make everything enormously more efficient and avoid weird issues with Hibernate context.

Overrides:

convertObject in class AbstractThreadedObjectIteratorTask<Object>

Parameters:

input - The input

Returns:

The reference, or the original object

parseArgs

protected void parseArgs(sailpoint.object.Attributes<String,Object> args)
                  throws Exception

Extracts the arguments passed to this task.

This is the ONLY place that you ought to use the parent context.

Overrides:

parseArgs in class AbstractThreadedObjectIteratorTask<Object>

Parameters:

args - The arguments to read

Throws:

Exception - if there are any failures during parsing

threadExecute

public Object threadExecute(sailpoint.api.SailPointContext threadContext,
                            Map<String,Object> parameters,
                            Object obj)
                     throws sailpoint.tools.GeneralException

Executes this rule or script against the given object

Specified by:

threadExecute in interface PrivateContextObjectConsumer<Object>

Specified by:

threadExecute in class AbstractThreadedTask<Object>

Parameters:

threadContext - The context created for this specific thread

parameters - The parameters created for this thread

obj - The input object for this thread

Returns:

Always null (no meaningful result)

Throws:

sailpoint.tools.GeneralException - if any failures occur