net.sf.mmm.service.base.client

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

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.service.base.client.AbstractRemoteInvocationCaller<QUEUE,CALL,TX_CALLS,REQUEST>

Type Parameters:

QUEUE - is the generic type of the queue. The queue implementation must extend AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.

CALL - is the generic type of the remote invocation call. For command style this is just the RemoteInvocationCommand itself, for RPC style this is GenericRemoteInvocationRpcCall.

TX_CALLS - is the generic type of the transfer object that wraps a <CALL>-array with the calls to perform in a single transaction.

REQUEST - is the generic type of the GenericRemoteInvocationRequest to build and send to the server.

All Implemented Interfaces:

AttributeReadDefaultFailureCallback, AttributeWriteDefaultFailureCallback, AttributeWriteTransactionMode, RemoteInvocationCaller<QUEUE>

Direct Known Subclasses:

AbstractRemoteInvocationCommandCaller, AbstractRemoteInvocationServiceCaller

public abstract class AbstractRemoteInvocationCaller<QUEUE extends RemoteInvocationQueue,CALL extends RemoteInvocationCall,TX_CALLS extends GenericRemoteInvocationTransactionalCalls<CALL>,REQUEST extends GenericRemoteInvocationRequest<CALL,TX_CALLS>>
extends AbstractLoggableComponent
implements RemoteInvocationCaller<QUEUE>, AttributeWriteTransactionMode, AttributeWriteDefaultFailureCallback

This is the abstract base-implementation of RemoteInvocationCaller.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue This is the abstract base implementation of RemoteInvocationQueue.
protected class	AbstractRemoteInvocationCaller.RequestBuilder This class is a builder for GenericRemoteInvocationRequests.
protected class	AbstractRemoteInvocationCaller.TransactionalCallBuilder This inner calls is a builder for GenericRemoteInvocationTransactionalCalls.

Field Summary

Fields

Modifier and Type	Field and Description
private QUEUE	currentQueue The current queue or null for none.
private Consumer<Throwable>	defaultFailureCallback
private int	requestCount
private TransactionMode	transactionMode
private CsrfToken	xsrfToken

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteInvocationCaller() The constructor.

Method Summary

Modifier and Type	Method and Description
protected QUEUE	createQueue(RemoteInvocationQueueSettings settings) This method creates a new AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.
protected abstract QUEUE	createQueue(RemoteInvocationQueueSettings settings, AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue)
protected abstract TX_CALLS	createRemoteInvocationTransactionalCalls(List<CALL> calls)
protected abstract REQUEST	createRequest(int requestId, CsrfToken token, List<TX_CALLS> transactionalCalls) Creates a new GenericRemoteInvocationRequest instance.
QUEUE	getCurrentQueue() This method gets the current queue.
Consumer<Throwable>	getDefaultFailureCallback() This method gets the default callback to handle failures that occurred on service invocations.
TransactionMode	getTransactionMode() This method gets the TransactionMode.
CsrfToken	getXsrfToken()
protected void	handleFailure(REQUEST request, AbstractRemoteInvocationCaller.RequestBuilder builder, Throwable failure) This method should be called from performRequest(GenericRemoteInvocationRequest, RequestBuilder) if a general failure occurred on the client side (in case of a network error or the like).
protected void	handleResponse(REQUEST request, AbstractRemoteInvocationCaller.RequestBuilder builder, GenericRemoteInvocationResponse response) This method should be called from performRequest(GenericRemoteInvocationRequest, RequestBuilder) if a GenericRemoteInvocationResponse has been received.
QUEUE	newQueue() This method opens a queue that collects remote invocations to send to the server.
QUEUE	newQueue(RemoteInvocationQueueSettings settings) This method opens a queue that collects remote invocations to send to the server.
QUEUE	newQueue(String id) This method opens a queue that collects remote invocations to send to the server.
protected QUEUE	newQueueForAutoCommit()
protected int	nextRequestId()
protected void	performRequest(AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue queue) This method finally performs a request with the invocations collected by the given queue.
protected abstract void	performRequest(REQUEST request, AbstractRemoteInvocationCaller.RequestBuilder builder) Actually performs the given request by sending it to the server and handling the response asynchronously.
protected QUEUE	requireCurrentQueue()
void	setDefaultFailureCallback(Consumer<Throwable> failureCallback) This method sets the default failure callback.
void	setTransactionMode(TransactionMode transactionMode)

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, doInitialize, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

requestCount

private int requestCount

See Also:

nextRequestId()

currentQueue

private QUEUE extends RemoteInvocationQueue currentQueue

The current queue or null for none.

transactionMode

private TransactionMode transactionMode

See Also:

getTransactionMode()

defaultFailureCallback

private Consumer<Throwable> defaultFailureCallback

See Also:

getDefaultFailureCallback()

xsrfToken

private CsrfToken xsrfToken

See Also:

getXsrfToken()

Constructor Detail

AbstractRemoteInvocationCaller

public AbstractRemoteInvocationCaller()

The constructor.

Method Detail

getTransactionMode

public TransactionMode getTransactionMode()

This method gets the TransactionMode.

Specified by:

getTransactionMode in interface AttributeWriteTransactionMode

Returns:

the TransactionMode.

setTransactionMode

public void setTransactionMode(TransactionMode transactionMode)

Specified by:

setTransactionMode in interface AttributeWriteTransactionMode

Parameters:

transactionMode - is the new value of AttributeWriteTransactionMode.getTransactionMode().

getDefaultFailureCallback

public Consumer<Throwable> getDefaultFailureCallback()

This method gets the default callback to handle failures that occurred on service invocations.

Specified by:

getDefaultFailureCallback in interface AttributeReadDefaultFailureCallback

Returns:

the default failure callback or null if no default is configured.

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().

newQueue

public QUEUE newQueue()

This method opens a queue that collects remote invocations to send to the server.

Specified by:

newQueue in interface RemoteInvocationCaller<QUEUE extends RemoteInvocationQueue>

Returns:

the new queue.

See Also:

RemoteInvocationCaller.newQueue(RemoteInvocationQueueSettings)

newQueue

public QUEUE newQueue(String id)

This method opens a queue that collects remote invocations to send to the server.

Specified by:

newQueue in interface RemoteInvocationCaller<QUEUE extends RemoteInvocationQueue>

Parameters:

id - is the identifier of the new queue.

Returns:

the new queue.

See Also:

RemoteInvocationCaller.newQueue(RemoteInvocationQueueSettings)

newQueue

public QUEUE newQueue(RemoteInvocationQueueSettings settings)

This method opens a queue that collects remote invocations to send to the server. If a queue is currently open this method will create a child-queue of that queue.

Specified by:

newQueue in interface RemoteInvocationCaller<QUEUE extends RemoteInvocationQueue>

Parameters:

settings - are the RemoteInvocationQueueSettings.

Returns:

the new queue.

newQueueForAutoCommit

protected QUEUE newQueueForAutoCommit()

Returns:

creates a new queue for auto-commit.

createQueue

protected QUEUE createQueue(RemoteInvocationQueueSettings settings)

This method creates a new AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue. If a current queue is present, the new queue has to use it as parent.

Parameters:

settings - are the RemoteInvocationQueueSettings for the new queue.

Returns:

the new AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.

createQueue

protected abstract QUEUE createQueue(RemoteInvocationQueueSettings settings,
                                     AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue)

Parameters:

settings - are the RemoteInvocationQueueSettings.

parentQueue - is the parent queue.

Returns:

the new queue instance.

See Also:

createQueue(RemoteInvocationQueueSettings)

getCurrentQueue

public QUEUE getCurrentQueue()

This method gets the current queue. This is the last queue that has been created and is still open.
NOTE:
This method is only for specific scenarios. You should typically use RemoteInvocationCaller.newQueue() instead, to retrieve a queue and perform service invocations.

Specified by:

getCurrentQueue in interface RemoteInvocationCaller<QUEUE extends RemoteInvocationQueue>

Returns:

the current queue or null if no queue is open.

nextRequestId

protected int nextRequestId()

Returns:

the next request ID.

requireCurrentQueue

protected QUEUE requireCurrentQueue()

Returns:

the current AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.

getXsrfToken

public CsrfToken getXsrfToken()

Returns:

the last received CsrfToken or null if not available.

performRequest

protected void performRequest(AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue queue)

This method finally performs a request with the invocations collected by the given queue.

Parameters:

queue - is the AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.

performRequest

protected abstract void performRequest(REQUEST request,
                                       AbstractRemoteInvocationCaller.RequestBuilder builder)

Actually performs the given request by sending it to the server and handling the response asynchronously.

Parameters:

request - is the GenericRemoteInvocationRequest to perform.

builder - is the AbstractRemoteInvocationCaller.RequestBuilder that created the request and is to be used for handling the results (dispatching to the asynchronous callback functions).

handleResponse

protected void handleResponse(REQUEST request,
                              AbstractRemoteInvocationCaller.RequestBuilder builder,
                              GenericRemoteInvocationResponse response)

This method should be called from performRequest(GenericRemoteInvocationRequest, RequestBuilder) if a GenericRemoteInvocationResponse has been received.

Parameters:

request - is the GenericRemoteInvocationRequest that has been performed.

builder - is the AbstractRemoteInvocationCaller.RequestBuilder corresponding to the given request.

response - is the GenericRemoteInvocationResponse to handle.

handleFailure

protected void handleFailure(REQUEST request,
                             AbstractRemoteInvocationCaller.RequestBuilder builder,
                             Throwable failure)

This method should be called from performRequest(GenericRemoteInvocationRequest, RequestBuilder) if a general failure occurred on the client side (in case of a network error or the like).

Parameters:

request - is the GenericRemoteInvocationRequest that has been performed.

builder - is the AbstractRemoteInvocationCaller.RequestBuilder corresponding to the given request.

failure - is the Throwable that has been catched on the client.

createRemoteInvocationTransactionalCalls

protected abstract TX_CALLS createRemoteInvocationTransactionalCalls(List<CALL> calls)

Parameters:

calls - is the List with the <CALL>s.

Returns:

an instance of <TX_CALLS> wrapping the given calls.

createRequest

protected abstract REQUEST createRequest(int requestId,
                                         CsrfToken token,
                                         List<TX_CALLS> transactionalCalls)

Creates a new GenericRemoteInvocationRequest instance.

Parameters:

requestId - - see GenericRemoteInvocationRequest.getRequestId().

token - - see GenericRemoteInvocationRequest.getXsrfToken().

transactionalCalls - - see GenericRemoteInvocationRequest.getTransactionalCalls().

Returns:

the new request.