Package org.forgerock.openam.cts.worker.process

Class MaxSessionTimeExpiredProcess

java.lang.Object

org.forgerock.openam.cts.worker.process.CTSWorkerBaseProcess

org.forgerock.openam.cts.worker.process.MaxSessionTimeExpiredProcess

All Implemented Interfaces:

CTSWorkerProcess

public class MaxSessionTimeExpiredProcess
extends CTSWorkerBaseProcess

A process which handles max session time timeouts.

Constructor Summary

Constructors

Constructor	Description
MaxSessionTimeExpiredProcess(org.forgerock.openam.cts.worker.process.SessionExpiryBatchHandler timeoutHandler, Debug debug)	Generates a new CTSWorkerDeleteProcess which can be used across multiple CTSWorkerTask, with various CTSWorkerQuery and CTSWorkerFilter.

Method Summary

Modifier and Type	Method	Description
protected CountDownLatch	handleBatch(Collection<PartialToken> batch)	Hook method allowing subclasses to define the actual work to be carried out by this CTSWorkerProcess.
protected void	handleFailed(Exception exception)	Hook method called when CTSWorkerBaseProcess.handle(org.forgerock.openam.cts.impl.query.worker.CTSWorkerQuery, org.forgerock.openam.cts.worker.CTSWorkerFilter) fails to complete due to an error.
protected void	handleSucceeded(org.apache.commons.lang3.time.StopWatch queryStopWatch, org.apache.commons.lang3.time.StopWatch waitingStopWatch, long total)	Hook method called when CTSWorkerBaseProcess.handle(org.forgerock.openam.cts.impl.query.worker.CTSWorkerQuery, org.forgerock.openam.cts.worker.CTSWorkerFilter) completes successfully.

Methods inherited from class org.forgerock.openam.cts.worker.process.CTSWorkerBaseProcess

handle, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MaxSessionTimeExpiredProcess

@Inject
public MaxSessionTimeExpiredProcess(@Named("MaxSessionTimeExpired")
                                    org.forgerock.openam.cts.worker.process.SessionExpiryBatchHandler timeoutHandler,
                                    @Named("amCoreTokenService")
                                    Debug debug)

Generates a new CTSWorkerDeleteProcess which can be used across multiple CTSWorkerTask, with various CTSWorkerQuery and CTSWorkerFilter.

Method Detail

handleBatch

protected CountDownLatch handleBatch(Collection<PartialToken> batch)
                              throws CoreTokenException

Description copied from class: CTSWorkerBaseProcess

Hook method allowing subclasses to define the actual work to be carried out by this CTSWorkerProcess.

Specified by:

handleBatch in class CTSWorkerBaseProcess

Parameters:

batch - the filtered page of query results to be processed.

Returns:

CountDownLatch which will open once the batch has been processed.

Throws:

CoreTokenException - if an exception occurs while handling the batch.

handleSucceeded

protected void handleSucceeded(org.apache.commons.lang3.time.StopWatch queryStopWatch,
                               org.apache.commons.lang3.time.StopWatch waitingStopWatch,
                               long total)

Description copied from class: CTSWorkerBaseProcess

Hook method called when CTSWorkerBaseProcess.handle(org.forgerock.openam.cts.impl.query.worker.CTSWorkerQuery, org.forgerock.openam.cts.worker.CTSWorkerFilter) completes successfully.

This method can be overridden by subclasses for monitoring or debug logging.

Specified by:

handleSucceeded in class CTSWorkerBaseProcess

Parameters:

queryStopWatch - timing of the query and task spawning step.

waitingStopWatch - timing of the task completion wait time.

total - number of query results which matched the filter and were processed.

handleFailed

protected void handleFailed(Exception exception)

Description copied from class: CTSWorkerBaseProcess

Hook method called when CTSWorkerBaseProcess.handle(org.forgerock.openam.cts.impl.query.worker.CTSWorkerQuery, org.forgerock.openam.cts.worker.CTSWorkerFilter) fails to complete due to an error.

This method can be overridden by subclasses for debug logging.

Specified by:

handleFailed in class CTSWorkerBaseProcess

Parameters:

exception - the exception which prevented the call to CTSWorkerBaseProcess.handle(org.forgerock.openam.cts.impl.query.worker.CTSWorkerQuery, org.forgerock.openam.cts.worker.CTSWorkerFilter) from completing successfully.