er.extensions.concurrency

Class ERXTimerTask

java.lang.Object

java.util.TimerTask

er.extensions.concurrency.ERXTimerTask

All Implemented Interfaces:

Runnable

public abstract class ERXTimerTask
extends TimerTask

A convenience class that provides some common logic that is used in TimerTask tasks. It provides support for cleaning up editing context locks at the end of your task's run() method just like the behavior at the end of a normal R-R loop.

Author:

q

Constructor Summary

Constructors

Constructor and Description
ERXTimerTask()

Method Summary

Modifier and Type	Method and Description
abstract void	_run() Override _run to provide your task's implementation.
protected EOEditingContext	newEditingContext() You must manually lock and unlock the editing context returned by this method. It is not recommended that you depend on auto locking in background threads.
protected EOObjectStore	parentObjectStore() See Effective Java item #71 for explanation of this threadsafe lazy initialization technique
void	run() Do not override run like implementing TimeTask directly.
void	setParentObjectStore(EOObjectStore parentObjectStore)

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXTimerTask

public ERXTimerTask()

Method Detail

run

public final void run()

Do not override run like implementing TimeTask directly. Instead, override _run. The run method in ERXTimerTask makes your _run method appear to be in a request, and cleans up resources at the end of the request.

Specified by:

run in interface Runnable

Specified by:

run in class TimerTask

_run

public abstract void _run()

Override _run to provide your task's implementation.

parentObjectStore

protected final EOObjectStore parentObjectStore()

See Effective Java item #71 for explanation of this threadsafe lazy initialization technique

Returns:

the parent, usually an EOObjectStoreCoordinator to partition the task's EOF intensive work form the rest of the app.

setParentObjectStore

public final void setParentObjectStore(EOObjectStore parentObjectStore)

Parameters:

parentObjectStore - the parent, usually an EOObjectStoreCoordinator to partition the task's EOF intensive work from the rest of the app. If you are going to manually set this, you should do it before starting the task.

newEditingContext

protected EOEditingContext newEditingContext()

You must manually lock and unlock the editing context returned by this method. It is not recommended that you depend on auto locking in background threads. Even though this method currently returns an auto-locking EC if auto-locking is turned on for the app, a future update is planned that will return a manually locking EC from this method even if auto-locking is turned on for regular ECs used in normal request-response execution.

Returns:

a new EOEditingContext.