C G I R S W

C

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 class commonj.work.WorkCompletedException

This allows a list of exceptions to be returned.

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.RemoteWorkItem

This returns the Work once the Remote Work is completed.

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

This returns the current status of dispatching the Work.

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

This returns WORK_ACCEPTED etc

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

This returns a copy of the Work in progress.

I

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.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 versus short lived.

R

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

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

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

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

RemoteWorkItem - interface commonj.work.RemoteWorkItem.

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.

S

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.

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.

Work - interface commonj.work.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 commonj.work.WorkCompletedException.

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

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

Constructor for a WorkCompletedException

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

Constructor for a WorkCompletedException

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

Constructor for a WorkCompletedException

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

Constructor for a WorkCompletedException

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

Constructor for a WorkCompletedException

WorkEvent - interface commonj.work.WorkEvent.

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

WorkException - exception commonj.work.WorkException.

This is the base class for all Work related exceptions.

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

Constructor for WorkException

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

Constructor for WorkException

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

Constructor for WorkException

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

Constructor for WorkException

WorkItem - interface commonj.work.WorkItem.

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

WorkListener - interface commonj.work.WorkListener.

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

WorkManager - interface commonj.work.WorkManager.

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 commonj.work.WorkRejectedException.

This is thrown then the Work cannot be started.

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

Constructor for a WorkRejectedException

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

Constructor for a WorkRejectedException

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

Constructor for a WorkRejectedException

WorkRejectedException(Throwable) - Constructor for class 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 W