alma.ACS.jbaci

Class BACIAction

java.lang.Object

alma.ACS.jbaci.BACIAction

All Implemented Interfaces:

PrioritizedRunnable, java.lang.Runnable

Direct Known Subclasses:

CommonPropertyImpl.GetAsyncAction, CommonPropertyImpl.SetAsyncAction, ReflectionBACIAction, RWCommonComparablePropertyImpl.DecrementAction, RWCommonComparablePropertyImpl.IncrementAction

public abstract class BACIAction
extends java.lang.Object
implements PrioritizedRunnable

BACI action.

Author:

Matej Sekoranja

Field Summary

Fields

Modifier and Type	Field and Description
protected Callback	callback Callback.
protected CallbackDispatcher	callbackDispatcher Callback dispatcher (used to dispatch non-CBvoid callbacks).
protected Completion	completion Completion.
protected CBDescOut	descOut Callback out descriptor.
protected PrioritizedExecutor	executor Executor.
protected BACIPriority	priority Action priority.
protected java.lang.Object	returnValue Return value.

Constructor Summary

Constructors

Constructor and Description
BACIAction(PrioritizedExecutor executor, Callback callback, CBDescIn descIn, CallbackDispatcher callbackDispatcher) Constructor of NORMAL priority action.
BACIAction(PrioritizedExecutor executor, Callback callback, CBDescIn descIn, CallbackDispatcher callbackDispatcher, BACIPriority priority) Constructor.
BACIAction(PrioritizedExecutor executor, CBvoid callback, CBDescIn descIn) Constructor of NORMAL priority action (CBvoid callback).
BACIAction(PrioritizedExecutor executor, CBvoid callback, CBDescIn descIn, BACIPriority priority) Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	dispatch() Dispatch method.
abstract java.lang.Object	execute() Action to be executed - implement it.
protected static CBDescOut	generateCBDescOut(CBDescIn descIn) Generates callback out descriptor from in descriptor.
BACIPriority	getPriority() Return priority of the task.
void	run() NOT TO BE CHANGED.
void	submit() Sumbit action to be BACIExecutor to be executed.

Methods inherited from class java.lang.Object

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

Field Detail

priority

protected BACIPriority priority

Action priority.

executor

protected PrioritizedExecutor executor

Executor.

descOut

protected CBDescOut descOut

Callback out descriptor.

callback

protected Callback callback

Callback.

callbackDispatcher

protected CallbackDispatcher callbackDispatcher

Callback dispatcher (used to dispatch non-CBvoid callbacks).

completion

protected Completion completion

Completion.

returnValue

protected java.lang.Object returnValue

Return value.

Constructor Detail

BACIAction

public BACIAction(PrioritizedExecutor executor,
                  CBvoid callback,
                  CBDescIn descIn)

Constructor of NORMAL priority action (CBvoid callback).

Parameters:

executor - executor to be used to execute action.

callback - action callback.

descIn - action callback in descriptor.

BACIAction

public BACIAction(PrioritizedExecutor executor,
                  Callback callback,
                  CBDescIn descIn,
                  CallbackDispatcher callbackDispatcher)

Constructor of NORMAL priority action.

Parameters:

executor - executor to be used to execute action.

callback - action callback.

descIn - action callback in descriptor.

callbackDispatcher - callback dispatcher (value dependend).

BACIAction

public BACIAction(PrioritizedExecutor executor,
                  CBvoid callback,
                  CBDescIn descIn,
                  BACIPriority priority)

Constructor.

Parameters:

executor - executor to be used to execute action.

callback - action callback.

descIn - action in descriptor.

priority - action priority.

BACIAction

public BACIAction(PrioritizedExecutor executor,
                  Callback callback,
                  CBDescIn descIn,
                  CallbackDispatcher callbackDispatcher,
                  BACIPriority priority)

Constructor.

Parameters:

executor - executor to be used to execute action.

callback - action callback.

descIn - action in descriptor.

callbackDispatcher - callback dispatcher (value dependend).

priority - action priority.

Method Detail

getPriority

public BACIPriority getPriority()

Description copied from interface: PrioritizedRunnable

Return priority of the task.

Specified by:

getPriority in interface PrioritizedRunnable

Returns:

priority of the task.

See Also:

PrioritizedRunnable.getPriority()

generateCBDescOut

protected static CBDescOut generateCBDescOut(CBDescIn descIn)

Generates callback out descriptor from in descriptor.

Parameters:

descIn - callback in descriptor.

Returns:

generated callback out descriptor.

run

public final void run()

NOT TO BE CHANGED.

Specified by:

run in interface java.lang.Runnable

dispatch

protected boolean dispatch()

Dispatch method.

Returns:

true if successfully dispatched.

execute

public abstract java.lang.Object execute()
                                  throws AcsJException

Action to be executed - implement it. If completion field is left to null (by this method), this class will create a no-error completion with current timestamp. Use alma.ACS.jbaci.CompletionUtil class to generate no-error completion.

Returns:

value to be send via callback, can be null.

Throws:

AcsJException

submit

public void submit()

Sumbit action to be BACIExecutor to be executed.