C G I R S T W

C

cancel() - Method in interface commonj.timers.Timer

This cancels the timer and all future TimerListener invocations and may be called during the TimerListener.timerExpired method.

CancelTimerListener - Interface in commonj.timers

This is implemented by developers that require a cancel event.

commonj.timers - package commonj.timers

This package has the timer related function.

commonj.work - package commonj.work

Provides for the full support of application controlled threading.

G

getException() - Method in interface commonj.work.WorkEvent

This returns the exception if any in the case of WORK_COMPLETED.

getExceptionList() - Method in exception commonj.work.WorkCompletedException

This allows a list of exceptions to be returned.

getPeriod() - Method in interface commonj.timers.Timer

Return the period used to compute the time this timer will repeat.

getPinnedWorkManager() - Method in interface commonj.work.RemoteWorkItem

This returns a pinned WorkManager which represents the JVM that was used to execute this Work.

getResult() - Method in interface commonj.work.WorkItem

This returns the Work once it has completed.

getScheduledExecutionTime() - Method in interface commonj.timers.Timer

Returns the next absolute scheduled execution time in milliseconds.

getStatus() - Method in interface commonj.work.WorkItem

This returns the current status of dispatching the Work.

getTimerListener() - Method in interface commonj.timers.Timer

Returns the application-supplied TimerListener associated with this Timer.

getType() - Method in interface commonj.work.WorkEvent

This returns WORK_ACCEPTED etc

getWorkItem() - Method in interface commonj.work.WorkEvent

This returns a WorkItem that represents the Work submitted to a WorkManager.

I

IMMEDIATE - Static variable in interface commonj.timers.TimerManager

This constant can be used as a timeout for the waitForXXX methods.

IMMEDIATE - Static variable in interface commonj.work.WorkManager

This constant can be used as a timeout for the waitForXXX methods.

INDEFINITE - Static variable in interface commonj.timers.TimerManager

This constant can be used as a timeout for either the waitForXXX methods.

INDEFINITE - Static variable in interface commonj.work.WorkManager

This constant can be used as a timeout for either the waitForXXX methods.

isDaemon() - Method in interface commonj.work.Work

This should return true if the work is long lived (Daemon) versus short-lived.

isStopped() - Method in interface commonj.timers.TimerManager

Returns true if all TimerListeners have completed following stop.

isStopping() - Method in interface commonj.timers.TimerManager

Returns true if this TimerManager is stopping or has been stopped.

isSuspended() - Method in interface commonj.timers.TimerManager

Returns true if all TimerListeners have completed following suspend.

isSuspending() - Method in interface commonj.timers.TimerManager

Returns true if this TimerManager is in the process of or has completed suspending.

R

release() - Method in interface commonj.work.RemoteWorkItem

Calls the remote Work object's Work.release() method.

release() - Method in interface commonj.work.Work

The implementor should return from the Runnable.run method once this is called.

RemoteWorkItem - Interface in commonj.work

If a Work instance is serializable and the WorkManager implementation supports Remoteable WorkManager then the Work can be sent to a remote member of the application cluster for execution.

resume() - Method in interface commonj.timers.TimerManager

Resume the TimerManager.

S

schedule(TimerListener, Date) - Method in interface commonj.timers.TimerManager

Schedules a TimerListener to execute at a specified time.

schedule(TimerListener, long) - Method in interface commonj.timers.TimerManager

Schedules a TimerListener to execute once after the specified delay.

schedule(TimerListener, Date, long) - Method in interface commonj.timers.TimerManager

Schedules a TimerListener to execute repeatedly using fixed-delay execution after the firstTime elapses.

schedule(TimerListener, long, long) - Method in interface commonj.timers.TimerManager

Schedules a TimerListener to execute repeatedly using fixed-delay execution after the specified delay.

schedule(Work) - Method in interface commonj.work.WorkManager

Dispatches a Work asynchronously.

schedule(Work, WorkListener) - Method in interface commonj.work.WorkManager

Dispatches a Work asynchronously.

scheduleAtFixedRate(TimerListener, Date, long) - Method in interface commonj.timers.TimerManager

Schedules a TimerListener to execute repeatedly using fixed-rate execution after the firstTime elapses.

scheduleAtFixedRate(TimerListener, long, long) - Method in interface commonj.timers.TimerManager

Schedules a TimerListener to execute repeatedly using fixed-rate execution after the specified delay.

stop() - Method in interface commonj.timers.TimerManager

Destroy the TimerManager.

StopTimerListener - Interface in commonj.timers

Applications requiring timer stop events should have their timers implement this interface.

suspend() - Method in interface commonj.timers.TimerManager

Suspend the TimerManager.

T

Timer - Interface in commonj.timers

A Timer is returned when a TimerListener is scheduled using one of the TimerManager.schedule methods.

timerCancel(Timer) - Method in interface commonj.timers.CancelTimerListener

This is called when timer is cancelled using the Timer.cancel() method.

timerExpired(Timer) - Method in interface commonj.timers.TimerListener

This method is called when a Timer expires and will run with the J2EE context of the scheduler.

TimerListener - Interface in commonj.timers

Objects that implement this interface and are supplied to one of the TimerManager#schedule methods can receieve timer notifications.

TimerManager - Interface in commonj.timers

Applications use a TimerManager to schedule TimerListeners.

timerStop(Timer) - Method in interface commonj.timers.StopTimerListener

This is called if the timer is stopped.

W

waitForAll(Collection, long) - Method in interface commonj.work.WorkManager

Wait for all WorkItems in the collection to finish successfully or otherwise.

waitForAny(Collection, long) - Method in interface commonj.work.WorkManager

Wait for any of the WorkItems in the collection to finish.

waitForStop(long) - Method in interface commonj.timers.TimerManager

Blocks until all TimerListeners have completed execution after a stop request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

waitForSuspend(long) - Method in interface commonj.timers.TimerManager

Blocks until all TimerListeners have completed execution after a suspend request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Work - Interface in commonj.work

This is implemented by applications when they want to run code blocks asynchronously.

WORK_ACCEPTED - Static variable in interface commonj.work.WorkEvent

Work has been accepted

WORK_COMPLETED - Static variable in interface commonj.work.WorkEvent

Work has completed.

WORK_REJECTED - Static variable in interface commonj.work.WorkEvent

Work has been rejected.

WORK_STARTED - Static variable in interface commonj.work.WorkEvent

Work is currently running.

workAccepted(WorkEvent) - Method in interface commonj.work.WorkListener

This is called when the Work is accepted for dispatching.

workCompleted(WorkEvent) - Method in interface commonj.work.WorkListener

This is called once Work.run returns.

WorkCompletedException - Exception in commonj.work

This exception indicates that a Work started but completed with an exception.

WorkCompletedException() - Constructor for exception commonj.work.WorkCompletedException

Constructor for a WorkCompletedException

WorkCompletedException(String) - Constructor for exception commonj.work.WorkCompletedException

Constructor for a WorkCompletedException

WorkCompletedException(String, Throwable) - Constructor for exception commonj.work.WorkCompletedException

Constructor for a WorkCompletedException

WorkCompletedException(Throwable) - Constructor for exception commonj.work.WorkCompletedException

Constructor for a WorkCompletedException

WorkCompletedException(String, List) - Constructor for exception commonj.work.WorkCompletedException

Constructor for a WorkCompletedException

WorkEvent - Interface in commonj.work

This is sent to a WorkListener as the Work is processed by a WorkManager.

WorkException - Exception in commonj.work

This is the base class for all Work related exceptions.

WorkException() - Constructor for exception commonj.work.WorkException

Constructor for WorkException

WorkException(String) - Constructor for exception commonj.work.WorkException

Constructor for WorkException

WorkException(String, Throwable) - Constructor for exception commonj.work.WorkException

Constructor for WorkException

WorkException(Throwable) - Constructor for exception commonj.work.WorkException

Constructor for WorkException

WorkItem - Interface in commonj.work

This is returned once a Work is submitted to a WorkManager.

WorkListener - Interface in commonj.work

This is a callback interface called to report on the dispatching of a Work.

WorkManager - Interface in commonj.work

The WorkManager is the abstraction for dispatching and monitoring asynchronous work and is a factory for creating application short or long lived Works.

workRejected(WorkEvent) - Method in interface commonj.work.WorkListener

This is called when the Work cannot be processed prior to starting but after accept.

WorkRejectedException - Exception in commonj.work

This is thrown then the Work cannot be started.

WorkRejectedException() - Constructor for exception commonj.work.WorkRejectedException

Constructor for a WorkRejectedException

WorkRejectedException(String) - Constructor for exception commonj.work.WorkRejectedException

Constructor for a WorkRejectedException

WorkRejectedException(String, Throwable) - Constructor for exception commonj.work.WorkRejectedException

Constructor for a WorkRejectedException

WorkRejectedException(Throwable) - Constructor for exception commonj.work.WorkRejectedException

Constructor for a WorkRejectedException

workStarted(WorkEvent) - Method in interface commonj.work.WorkListener

This is called when the Work is about to start.

C G I R S T W