alma.ACS.jbaci

Class BACIDispatchAction

java.lang.Object

alma.ACS.jbaci.BACIDispatchAction

All Implemented Interfaces:

PrioritizedRunnable, java.lang.Runnable

public class BACIDispatchAction
extends java.lang.Object
implements PrioritizedRunnable

BACI dispatch action.

Author:

Matej Sekoranja

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BACIDispatchAction.DispatchFailedListener Dispatch failed listener interface.
class	BACIDispatchAction.DispatchRequest Class containing request data.

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 static int	DEFAULT_FAILURE_COUNT_LIMIT Failure limit.
protected CBDescOut	descOut Callback out descriptor.
protected int	failureCount Failure count.
protected int	failureCountLimit Failure limit (number of retries), 0 means until successfull.
protected java.util.ArrayList<BACIDispatchAction.DispatchFailedListener>	listeners List of registered listeners.
protected boolean	overridePolicy Override policy for request queue.
protected BACIDispatchAction.DispatchRequest	pendingRequest Pending request.
protected BACIPriority	priority Action priority.
protected java.util.LinkedList	queue Ordered dispatch queue.
protected boolean	submitPending Flag indicating pending submit.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addDispatchFailedListener(BACIDispatchAction.DispatchFailedListener listener) Add dispatch failed listener.
protected boolean	dispatch() Dispatch method.
void	dispatchDoneRequest(Completion completion) Added done callback request to dispatch queue.
void	dispatchDoneRequest(Completion completion, java.lang.Object value) Added done callback request to dispatch queue.
protected void	dispatchRequest(BACIDispatchAction.DispatchRequest request) Added request to dispatch queue (internal).
void	dispatchRequest(int type, Completion completion, java.lang.Object value) Added request to dispatch queue.
void	dispatchWorkingRequest(Completion completion) Added working callback request to dispatch queue.
void	dispatchWorkingRequest(Completion completion, java.lang.Object value) Added working callback request to dispatch queue.
protected boolean	failed() Call this metod to notify dispatch failure.
protected static CBDescOut	generateCBDescOut(CBDescIn descIn) Generates callback out descriptor from in descriptor.
CBDescOut	getDescOut() Get callback out-descriptor.
BACIPriority	getPriority() Return priority of the task.
boolean	isOverridePolicy() Get current override policy.
void	removeDispatchFailedListener(BACIDispatchAction.DispatchFailedListener listener) Remove dispatch failed listener.
void	run() NOT TO BE CHANGED.
void	setOverridePolicy(boolean b) Set current override policy.
void	setPriority(BACIPriority priority) Set dispatching priority.
protected 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.

descOut

protected CBDescOut descOut

Callback out descriptor.

callback

protected Callback callback

Callback.

callbackDispatcher

protected CallbackDispatcher callbackDispatcher

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

DEFAULT_FAILURE_COUNT_LIMIT

protected static final int DEFAULT_FAILURE_COUNT_LIMIT

Failure limit.

See Also:

Constant Field Values

failureCountLimit

protected int failureCountLimit

Failure limit (number of retries), 0 means until successfull.

failureCount

protected int failureCount

Failure count.

queue

protected java.util.LinkedList queue

Ordered dispatch queue.

pendingRequest

protected BACIDispatchAction.DispatchRequest pendingRequest

Pending request. NOTE: synchronized on queue's monitor.

submitPending

protected boolean submitPending

Flag indicating pending submit. NOTE: synchronized on queue's monitor.

overridePolicy

protected boolean overridePolicy

Override policy for request queue. If true newer request will override request in the queue. If false (default) requests will form a linked list.

listeners

protected java.util.ArrayList<BACIDispatchAction.DispatchFailedListener> listeners

List of registered listeners.

Constructor Detail

BACIDispatchAction

public BACIDispatchAction(CBvoid callback,
                          CBDescIn descIn)

Constructor of NORMAL priority action (CBvoid callback).

Parameters:

callback - action callback.

descIn - action callback in descriptor.

BACIDispatchAction

public BACIDispatchAction(Callback callback,
                          CBDescIn descIn,
                          CallbackDispatcher callbackDispatcher)

Constructor of NORMAL priority action.

Parameters:

callback - action callback.

descIn - action callback in descriptor.

callbackDispatcher - callback dispatcher (value dependend).

BACIDispatchAction

public BACIDispatchAction(CBvoid callback,
                          CBDescIn descIn,
                          BACIPriority priority)

Constructor.

Parameters:

callback - action callback.

descIn - action in descriptor.

priority - action priority.

BACIDispatchAction

public BACIDispatchAction(Callback callback,
                          CBDescIn descIn,
                          CallbackDispatcher callbackDispatcher,
                          BACIPriority priority)

Constructor.

Parameters:

callback - action callback.

descIn - action in descriptor.

callbackDispatcher - callback dispatcher (value dependend).

priority - action priority.

Method Detail

dispatchWorkingRequest

public void dispatchWorkingRequest(Completion completion)

Added working callback request to dispatch queue.

Parameters:

completion - completion.

value - value.

dispatchWorkingRequest

public void dispatchWorkingRequest(Completion completion,
                                   java.lang.Object value)

Added working callback request to dispatch queue.

Parameters:

completion - completion.

dispatchDoneRequest

public void dispatchDoneRequest(Completion completion)

Added done callback request to dispatch queue.

Parameters:

completion - completion.

dispatchDoneRequest

public void dispatchDoneRequest(Completion completion,
                                java.lang.Object value)

Added done callback request to dispatch queue.

Parameters:

completion - completion.

value - value.

dispatchRequest

public void dispatchRequest(int type,
                            Completion completion,
                            java.lang.Object value)

Added request to dispatch queue.

dispatchRequest

protected void dispatchRequest(BACIDispatchAction.DispatchRequest request)

Added request to dispatch queue (internal).

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. Dispatching is done one by one - to achieve better fairness.

Specified by:

run in interface java.lang.Runnable

failed

protected boolean failed()

Call this metod to notify dispatch failure.

Returns:

true, if dispaching is to be canceled (e.g. failure counter reached its failure limit)

dispatch

protected boolean dispatch()

Dispatch method. Dispatches pendingRequest, should be non-null.

Returns:

true if successfully dispatched.

submit

protected void submit()

Sumbit action to be BACIExecutor to be executed.

getDescOut

public CBDescOut getDescOut()

Get callback out-descriptor.

Returns:

callback out-descriptor.

isOverridePolicy

public boolean isOverridePolicy()

Get current override policy.

Returns:

current override policy.

setOverridePolicy

public void setOverridePolicy(boolean b)

Set current override policy.

Parameters:

b - override policy to set.

setPriority

public void setPriority(BACIPriority priority)

Set dispatching priority.

Parameters:

priority - dispatching priority to set.

addDispatchFailedListener

public void addDispatchFailedListener(BACIDispatchAction.DispatchFailedListener listener)

Add dispatch failed listener.

Parameters:

listener - listener to listen failed dispatch notifications.

removeDispatchFailedListener

public void removeDispatchFailedListener(BACIDispatchAction.DispatchFailedListener listener)

Remove dispatch failed listener.

Parameters:

listener - listener to remove.