net.sf.mmm.service.base.command.client

Class AbstractRemoteInvocationCommandCaller

java.lang.Object

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

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

net.sf.mmm.service.base.client.AbstractRemoteInvocationCaller<RemoteInvocationCommandQueue,RemoteInvocationCommand<?>,GenericRemoteInvocationCommandTransactionalCalls,GenericRemoteInvocationCommandRequest>

net.sf.mmm.service.base.command.client.AbstractRemoteInvocationCommandCaller

All Implemented Interfaces:

AttributeReadDefaultFailureCallback, AttributeWriteDefaultFailureCallback, AttributeWriteTransactionMode, RemoteInvocationCaller<RemoteInvocationCommandQueue>, AbstractRemoteInvocationCommandCaller, RemoteInvocationCommandCaller

public abstract class AbstractRemoteInvocationCommandCaller
extends AbstractRemoteInvocationCaller<RemoteInvocationCommandQueue,RemoteInvocationCommand<?>,GenericRemoteInvocationCommandTransactionalCalls,GenericRemoteInvocationCommandRequest>
implements RemoteInvocationCommandCaller

This is the abstract base implementation of RemoteInvocationCommandCaller.

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	AbstractRemoteInvocationCommandCaller.RemoteInvocationCommandQueueImpl This is the implementation of RemoteInvocationCommandQueue.

Nested classes/interfaces inherited from class net.sf.mmm.service.base.client.AbstractRemoteInvocationCaller

AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue, AbstractRemoteInvocationCaller.RequestBuilder, AbstractRemoteInvocationCaller.TransactionalCallBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteInvocationCommandCaller() The constructor.

Method Summary

Modifier and Type	Method and Description
<RESULT extends Serializable> void	callCommand(RemoteInvocationCommand<RESULT> command, Consumer<? extends RESULT> successCallback) Same as AbstractRemoteInvocationCommandCaller.callCommand(RemoteInvocationCommand, Consumer) but using the default failure callback.
<RESULT extends Serializable> void	callCommand(RemoteInvocationCommand<RESULT> command, Consumer<? extends RESULT> successCallback, Consumer<Throwable> failureCallback) This method invokes the given RemoteInvocationCommand on a RemoteInvocationService.
protected RemoteInvocationCommandQueue	createQueue(RemoteInvocationQueueSettings settings, AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue)
protected GenericRemoteInvocationCommandTransactionalCalls	createRemoteInvocationTransactionalCalls(List<RemoteInvocationCommand<?>> calls)
protected GenericRemoteInvocationCommandRequest	createRequest(int requestId, CsrfToken token, List<GenericRemoteInvocationCommandTransactionalCalls> transactionalCalls) Creates a new GenericRemoteInvocationRequest instance.

Methods inherited from class net.sf.mmm.service.base.client.AbstractRemoteInvocationCaller

createQueue, getCurrentQueue, getDefaultFailureCallback, getTransactionMode, getXsrfToken, handleFailure, handleResponse, newQueue, newQueue, newQueue, newQueueForAutoCommit, nextRequestId, performRequest, performRequest, requireCurrentQueue, setDefaultFailureCallback, setTransactionMode

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

Methods inherited from interface net.sf.mmm.service.api.client.RemoteInvocationCaller

getCurrentQueue, newQueue, newQueue, newQueue

Constructor Detail

AbstractRemoteInvocationCommandCaller

public AbstractRemoteInvocationCommandCaller()

The constructor.

Method Detail

callCommand

public <RESULT extends Serializable> void callCommand(RemoteInvocationCommand<RESULT> command,
                                                      Consumer<? extends RESULT> successCallback)

Same as AbstractRemoteInvocationCommandCaller.callCommand(RemoteInvocationCommand, Consumer) but using the default failure callback.

Specified by:

callCommand in interface AbstractRemoteInvocationCommandCaller

Type Parameters:

RESULT - is the generic type of returnType.

Parameters:

command - is the RemoteInvocationCommand to invoke.

successCallback - is the Consumer that is asynchronously invoked on success with when the result of the invoked service Method has been received. The generic type may extend result if it is generic itself. E.g. your service might return List<String> but you can only supply List.class as return type.

callCommand

public <RESULT extends Serializable> void callCommand(RemoteInvocationCommand<RESULT> command,
                                                      Consumer<? extends RESULT> successCallback,
                                                      Consumer<Throwable> failureCallback)

This method invokes the given RemoteInvocationCommand on a RemoteInvocationService.

Specified by:

callCommand in interface AbstractRemoteInvocationCommandCaller

Type Parameters:

RESULT - is the generic type of returnType.

Parameters:

command - is the RemoteInvocationCommand to invoke.

successCallback - is the Consumer that is asynchronously invoked on success with when the result of the invoked service Method has been received. The generic type may extend result if it is generic itself. E.g. your service might return List<String> but you can only supply List.class as return type.

failureCallback - is the Consumer that is asynchronously invoked on failure with the Throwable that occurred when calling the invoked service Method.

createQueue

protected RemoteInvocationCommandQueue createQueue(RemoteInvocationQueueSettings settings,
                                                   AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue)

Specified by:

createQueue in class AbstractRemoteInvocationCaller<RemoteInvocationCommandQueue,RemoteInvocationCommand<?>,GenericRemoteInvocationCommandTransactionalCalls,GenericRemoteInvocationCommandRequest>

Parameters:

settings - are the RemoteInvocationQueueSettings.

parentQueue - is the parent queue.

Returns:

the new queue instance.

See Also:

AbstractRemoteInvocationCaller.createQueue(RemoteInvocationQueueSettings)

createRemoteInvocationTransactionalCalls

protected GenericRemoteInvocationCommandTransactionalCalls createRemoteInvocationTransactionalCalls(List<RemoteInvocationCommand<?>> calls)

Specified by:

createRemoteInvocationTransactionalCalls in class AbstractRemoteInvocationCaller<RemoteInvocationCommandQueue,RemoteInvocationCommand<?>,GenericRemoteInvocationCommandTransactionalCalls,GenericRemoteInvocationCommandRequest>

Parameters:

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

Returns:

an instance of <TX_CALLS> wrapping the given calls.

createRequest

protected GenericRemoteInvocationCommandRequest createRequest(int requestId,
                                                              CsrfToken token,
                                                              List<GenericRemoteInvocationCommandTransactionalCalls> transactionalCalls)

Creates a new GenericRemoteInvocationRequest instance.

Specified by:

createRequest in class AbstractRemoteInvocationCaller<RemoteInvocationCommandQueue,RemoteInvocationCommand<?>,GenericRemoteInvocationCommandTransactionalCalls,GenericRemoteInvocationCommandRequest>

Parameters:

requestId - - see GenericRemoteInvocationRequest.getRequestId().

token - - see GenericRemoteInvocationRequest.getXsrfToken().

transactionalCalls - - see GenericRemoteInvocationRequest.getTransactionalCalls().

Returns:

the new request.