org.alfresco.jlan.server.thread

Class TimedThreadRequest

java.lang.Object

org.alfresco.jlan.server.thread.TimedThreadRequest

All Implemented Interfaces:

Comparable<TimedThreadRequest>, ThreadRequest

public abstract class TimedThreadRequest
extends Object
implements ThreadRequest, Comparable<TimedThreadRequest>

Timer Thread Request Class

Run a thread request at a particular time, with options to repeat.

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
static long	TimedRequestPaused

Constructor Summary

Constructors

Constructor and Description
TimedThreadRequest(String desc, long runAt) Class constructor
TimedThreadRequest(String desc, long runAt, long repeatSecs) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(TimedThreadRequest timedReq) Compare timed thread requests for ordering
String	getDescription() Return the timed reqeust description/name string
long	getRepeatInterval() Return the repeat interval for the timed request, or zero if this is not a repeating request.
long	getRunAtTime() Return the time the request should run at
ThreadRequestPool	getThreadRequestPool() Return the associated thread pool
boolean	hasRepeatInterval() Check if the timed request has a repeat interval
boolean	hasThreadRequestPool() Check if the request is associated with a thread pool, ie.
boolean	isPaused() Check if hte timed thread request has been paused
void	restartRequest() Restart a timed request that has been paused
void	runRequest() Run the request in a thread from the thread pool
protected abstract void	runTimedRequest() Timed request processing
void	setRepeatInterval(long repeatSecs) Set the repeat interval, in seconds
void	setRunAtTime(long runAt) Set the time to run the interval.
protected void	setThreadRequestPool(ThreadRequestPool threadPool) Thread request pool that the request is queued to
String	toString() Return the timed thread request as a string

Methods inherited from class java.lang.Object

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

Field Detail

TimedRequestPaused

public static final long TimedRequestPaused

See Also:

Constant Field Values

Constructor Detail

TimedThreadRequest

public TimedThreadRequest(String desc,
                  long runAt)

Class constructor

Parameters:

desc - String

runAt - long

TimedThreadRequest

public TimedThreadRequest(String desc,
                  long runAt,
                  long repeatSecs)

Class constructor

Parameters:

desc - String

runAt - long

repeatSecs - long

Method Detail

getDescription

public final String getDescription()

Return the timed reqeust description/name string

Returns:

String

getRunAtTime

public final long getRunAtTime()

Return the time the request should run at

Returns:

long

isPaused

public final boolean isPaused()

Check if hte timed thread request has been paused

Returns:

boolean

hasRepeatInterval

public final boolean hasRepeatInterval()

Check if the timed request has a repeat interval

Returns:

boolean

getRepeatInterval

public final long getRepeatInterval()

Return the repeat interval for the timed request, or zero if this is not a repeating request.

Returns:

long

hasThreadRequestPool

public final boolean hasThreadRequestPool()

Check if the request is associated with a thread pool, ie. queued

Returns:

boolean

getThreadRequestPool

public final ThreadRequestPool getThreadRequestPool()

Return the associated thread pool

Returns:

ThreadRequestPool

setRunAtTime

public final void setRunAtTime(long runAt)

Set the time to run the interval. A positive value indicates an absolute time value, a negative value indicates the number of seconds from now.

Parameters:

runAt - long

setRepeatInterval

public final void setRepeatInterval(long repeatSecs)

Set the repeat interval, in seconds

Parameters:

repeatSecs - long

setThreadRequestPool

protected final void setThreadRequestPool(ThreadRequestPool threadPool)

Thread request pool that the request is queued to

Parameters:

threadPool - ThreadRequestPool

restartRequest

public final void restartRequest()

Restart a timed request that has been paused

runRequest

public void runRequest()

Run the request in a thread from the thread pool

Specified by:

runRequest in interface ThreadRequest

runTimedRequest

protected abstract void runTimedRequest()

Timed request processing

compareTo

public int compareTo(TimedThreadRequest timedReq)

Compare timed thread requests for ordering

Specified by:

compareTo in interface Comparable<TimedThreadRequest>

Parameters:

timedReq - TimedThreadRequest

Returns:

int

toString

public String toString()

Return the timed thread request as a string

Overrides:

toString in class Object

Returns:

String