Package org.forgerock.openidm.scheduler.impl

Class TaskScannerContext

java.lang.Object

org.forgerock.openidm.scheduler.impl.TaskScannerContext

public class TaskScannerContext
extends Object

Represents the information for a recurring TaskScannerJob. This is carried over across all instances of the TaskScannerJob

Constructor Summary

Constructors

Constructor	Description
TaskScannerContext(String invokerName, String scriptName, org.forgerock.json.JsonValue params, org.forgerock.services.context.Context context, org.forgerock.script.ScriptEntry scriptEntry)

Method Summary

Modifier and Type	Method	Description
void	cancel()
void	endJob()
void	endQuery()
org.forgerock.json.JsonPointer	getCompletedField()
org.forgerock.services.context.Context	getContext()
String	getInvokerName()
Integer	getMaxRecords()
int	getNumberOfThreads()
String	getObjectID()
org.forgerock.json.JsonValue	getParams()
Map<String,Object>	getProgress()
org.joda.time.ReadablePeriod	getRecoveryTimeout()	Retrieve the timeout period from the supplied config.
org.forgerock.json.JsonValue	getScanValue()
org.forgerock.script.ScriptEntry	getScriptEntry()
String	getScriptName()
org.forgerock.json.JsonPointer	getStartField()
String	getState()
TaskScannerStatistic	getStatistics()
String	getTaskScanID()
boolean	getWaitForCompletion()
boolean	hasError()
void	interrupted()
boolean	isCanceled()
boolean	isCompleted()
boolean	isInactive()
boolean	isStarted()
void	setNumberOfTasksToProcess(int number)
void	startJob()
void	startQuery()

Methods inherited from class java.lang.Object

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

Constructor Details

TaskScannerContext

public TaskScannerContext(String invokerName,
 String scriptName,
 org.forgerock.json.JsonValue params,
 org.forgerock.services.context.Context context,
 org.forgerock.script.ScriptEntry scriptEntry)
                   throws ScriptException

Throws:

ScriptException

Method Details

startJob

public void startJob()

endJob

public void endJob()

startQuery

public void startQuery()

endQuery

public void endQuery()

cancel

public void cancel()

interrupted

public void interrupted()

isStarted

public boolean isStarted()

isCompleted

public boolean isCompleted()

hasError

public boolean hasError()

isInactive

public boolean isInactive()

isCanceled

public boolean isCanceled()

getState

public String getState()

setNumberOfTasksToProcess

public void setNumberOfTasksToProcess(int number)

getContext

public org.forgerock.services.context.Context getContext()

getParams

public org.forgerock.json.JsonValue getParams()

getInvokerName

public String getInvokerName()

getScriptName

public String getScriptName()

getScriptEntry

public org.forgerock.script.ScriptEntry getScriptEntry()

getTaskScanID

public String getTaskScanID()

getRecoveryTimeout

public org.joda.time.ReadablePeriod getRecoveryTimeout()

Retrieve the timeout period from the supplied config.

Returns:

the timeout period taken from the config

getMaxRecords

public Integer getMaxRecords()

getScanValue

public org.forgerock.json.JsonValue getScanValue()

getObjectID

public String getObjectID()

getStartField

public org.forgerock.json.JsonPointer getStartField()

getCompletedField

public org.forgerock.json.JsonPointer getCompletedField()

getWaitForCompletion

public boolean getWaitForCompletion()

getNumberOfThreads

public int getNumberOfThreads()

getStatistics

public TaskScannerStatistic getStatistics()

getProgress

public Map<String,Object> getProgress()