net.sf.mmm.service.base.client

Class AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue

java.lang.Object

net.sf.mmm.service.base.client.AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue

All Implemented Interfaces:

AttributeReadDefaultFailureCallback, AttributeWriteDefaultFailureCallback, RemoteInvocationQueue, AttributeReadId<String>

Direct Known Subclasses:

AbstractRemoteInvocationCommandCaller.RemoteInvocationCommandQueueImpl, AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl

Enclosing class:

AbstractRemoteInvocationCaller<QUEUE extends RemoteInvocationQueue,CALL extends RemoteInvocationCall,TX_CALLS extends GenericRemoteInvocationTransactionalCalls<CALL>,REQUEST extends GenericRemoteInvocationRequest<CALL,TX_CALLS>>

protected abstract class AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue
extends Object
implements RemoteInvocationQueue

This is the abstract base implementation of RemoteInvocationQueue.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	autoCommit
private List<RemoteInvocationCallData<?,CALL>>	callQueue
private AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue	childQueue
private AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue	parentQueue
private Consumer<Throwable>	queueFailureCallback
private RemoteInvocationQueueSettings	settings
private RemoteInvocationQueueState	state
private List<AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue>	subQueues

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteInvocationQueue(RemoteInvocationQueueSettings settings) The constructor.
AbstractRemoteInvocationQueue(RemoteInvocationQueueSettings settings, AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addCall(RemoteInvocationCallData<?,CALL> callData) This method adds the given RemoteInvocationCallData to this queue.
void	cancel() This method cancels this queue.
private void	close() This method closes this queue.
(package private) boolean	collectCalls(AbstractRemoteInvocationCaller.RequestBuilder requestBuilder, boolean hasOpenTransaction) This method collects the GenericRemoteInvocationTransactionalCalls for this queue recursively.
void	commit() This method completes this queue.
List<RemoteInvocationCallData<?,CALL>>	getCallQueue()
Consumer<Throwable>	getDefaultFailureCallback() This method gets the default callback to handle failures that occurred on service invocations.
String	getId() This method gets the ID used to identify this object.
protected String	getIdInfo()
AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue	getParentQueue()
RemoteInvocationQueueSettings	getSettings()
RemoteInvocationQueueState	getState() This method gets the RemoteInvocationQueueState of this queue.
protected void	requireNoChildQueue() Internal method to ensure that this queue is the current active queue and no child-queue has been opened and not completed.
protected void	requireNoCurrentCall() Internal method to ensure that no current call is pending.
protected void	requireOpen() Internal method to ensure this queue is still open.
void	setDefaultFailureCallback(Consumer<Throwable> failureCallback) This method sets the default failure callback.

Methods inherited from class java.lang.Object

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

Field Detail

settings

private final RemoteInvocationQueueSettings settings

See Also:

getSettings()

parentQueue

private AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue

See Also:

getParentQueue()

subQueues

private List<AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue> subQueues

See Also:

getCallQueue()

callQueue

private List<RemoteInvocationCallData<?,CALL extends RemoteInvocationCall>> callQueue

See Also:

getCallQueue()

queueFailureCallback

private Consumer<Throwable> queueFailureCallback

See Also:

getDefaultFailureCallback()

state

private RemoteInvocationQueueState state

See Also:

getState()

childQueue

private AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue childQueue

See Also:

getParentQueue()

autoCommit

private boolean autoCommit

See Also:

addCall(RemoteInvocationCallData)

Constructor Detail

AbstractRemoteInvocationQueue

public AbstractRemoteInvocationQueue(RemoteInvocationQueueSettings settings)

The constructor.

Parameters:

settings - - see getSettings().

AbstractRemoteInvocationQueue

public AbstractRemoteInvocationQueue(RemoteInvocationQueueSettings settings,
                                     AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue)

The constructor.

Parameters:

settings - - see getSettings().

parentQueue - - see getParentQueue().

Method Detail

collectCalls

boolean collectCalls(AbstractRemoteInvocationCaller.RequestBuilder requestBuilder,
                     boolean hasOpenTransaction)

This method collects the GenericRemoteInvocationTransactionalCalls for this queue recursively.

Parameters:

requestBuilder - is the AbstractRemoteInvocationCaller.RequestBuilder.

hasOpenTransaction - - true if a transaction has already been opened, false otherwise.

Returns:

true if a transaction is currently open, false otherwise.

setDefaultFailureCallback

public void setDefaultFailureCallback(Consumer<Throwable> failureCallback)

This method sets the default failure callback.

Specified by:

setDefaultFailureCallback in interface AttributeWriteDefaultFailureCallback

Parameters:

failureCallback - is the new value of AttributeReadDefaultFailureCallback.getDefaultFailureCallback().

getDefaultFailureCallback

public Consumer<Throwable> getDefaultFailureCallback()

Description copied from interface: RemoteInvocationQueue

This method gets the default callback to handle failures that occurred on service invocations. It will be used as fallback if no failure callback is specified explicitly. Queues will inherit the default failure callback from their parent. A toplevel queue inherits from the invocation caller.

Specified by:

getDefaultFailureCallback in interface AttributeReadDefaultFailureCallback

Specified by:

getDefaultFailureCallback in interface RemoteInvocationQueue

Returns:

the default failure-callback.

getCallQueue

public List<RemoteInvocationCallData<?,CALL>> getCallQueue()

Returns:

the callQueue

addCall

protected void addCall(RemoteInvocationCallData<?,CALL> callData)

This method adds the given RemoteInvocationCallData to this queue.

Parameters:

callData - is the RemoteInvocationCallData to add.

getSettings

public RemoteInvocationQueueSettings getSettings()

Returns:

the RemoteInvocationQueueSettings given when this queue has been created.

getId

public String getId()

This method gets the ID used to identify this object. An ID should be unique. It will be used for error messages, logging, etc. and will therefore help you debugging problems if you specify a reasonable ID.

Specified by:

getId in interface RemoteInvocationQueue

Specified by:

getId in interface AttributeReadId<String>

Returns:

the object's ID.

See Also:

RemoteInvocationCaller.newQueue(String)

getIdInfo

protected String getIdInfo()

Returns:

an info string with the ID or the empty string if not present.

getParentQueue

public AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue getParentQueue()

Returns:

the parentQueue

getState

public RemoteInvocationQueueState getState()

This method gets the RemoteInvocationQueueState of this queue. The RemoteInvocationQueueState of a new queue is initially RemoteInvocationQueueState.OPEN. After RemoteInvocationQueue.commit() is called the status turns to RemoteInvocationQueueState.COMITTED. After RemoteInvocationQueue.cancel() is called it turns to RemoteInvocationQueueState.CANCELLED. As soon as the status is closed (NOT RemoteInvocationQueueState.OPEN), it can NOT be opened anymore and further adding of service invocations to the queue will fail.

Specified by:

getState in interface RemoteInvocationQueue

Returns:

the RemoteInvocationQueueState of this queue.

requireOpen

protected void requireOpen()

Internal method to ensure this queue is still open.

requireNoCurrentCall

protected void requireNoCurrentCall()

Internal method to ensure that no current call is pending.

requireNoChildQueue

protected void requireNoChildQueue()

Internal method to ensure that this queue is the current active queue and no child-queue has been opened and not completed.

commit

public void commit()

This method completes this queue. After the call of this method the queue can NOT be used anymore.
If this is the root-queue all collected invocations will be send to the server immediately on RemoteInvocationQueue.commit(). Otherwise, if this is a sub-queue (a queue created while another queue was already open), the collected invocations will be appended to the parent queue.
NOTE:
Committing an empty queue is cheap and will have no effect but closing the queue. Therefore it is totally legal to open a queue in your generic infrastructure by default then perform some sort of initialization that may or may not cause service invocations on that queue and finally commit the queue.

Specified by:

commit in interface RemoteInvocationQueue

close

private void close()

This method closes this queue. It is called from commit() and cancel().

cancel

public void cancel()

This method cancels this queue. All collected invocations will be discarded including those from sub-queues. If this queue has a parent queue, the parent queue is NOT affected by this operation.
NOTE:
This operation should only be used in very specific situations.

Specified by:

cancel in interface RemoteInvocationQueue