net.sf.mmm.service.base.rpc.client

Class AbstractRemoteInvocationServiceCaller

java.lang.Object

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

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

net.sf.mmm.service.base.client.AbstractRemoteInvocationCaller<RemoteInvocationServiceQueue,GenericRemoteInvocationRpcCall,GenericRemoteInvocationRpcTransactionalCalls,GenericRemoteInvocationRpcRequest>

net.sf.mmm.service.base.rpc.client.AbstractRemoteInvocationServiceCaller

All Implemented Interfaces:

AttributeReadDefaultFailureCallback, AttributeWriteDefaultFailureCallback, AttributeWriteTransactionMode, RemoteInvocationCaller<RemoteInvocationServiceQueue>, AbstractRemoteInvocationServiceCaller, RemoteInvocationServiceCaller

Direct Known Subclasses:

AbstractRemoteInvocationServiceCallerWithClientMap, RemoteInvocationServiceCallerImplSpring

public abstract class AbstractRemoteInvocationServiceCaller
extends AbstractRemoteInvocationCaller<RemoteInvocationServiceQueue,GenericRemoteInvocationRpcCall,GenericRemoteInvocationRpcTransactionalCalls,GenericRemoteInvocationRpcRequest>
implements RemoteInvocationServiceCaller

This is the abstract base-implementation of RemoteInvocationServiceCaller.

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	AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl This inner class is the implementation of RemoteInvocationServiceQueue.
protected static class	AbstractRemoteInvocationServiceCaller.ServiceCallData<RESULT> This inner class is a simple container for the data of an invocation of a RemoteInvocationService method.

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

AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue, AbstractRemoteInvocationCaller.RequestBuilder, AbstractRemoteInvocationCaller.TransactionalCallBuilder

Field Summary

Fields inherited from interface net.sf.mmm.service.api.rpc.client.RemoteInvocationServiceCaller

CDI_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteInvocationServiceCaller() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addCall(GenericRemoteInvocationRpcCall call, Class<?> returnType) This method is called from the service-client stub to add a GenericRemoteInvocationRpcCall.
protected RemoteInvocationServiceQueue	createQueue(RemoteInvocationQueueSettings settings, AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue parentQueue)
protected GenericRemoteInvocationRpcTransactionalCalls	createRemoteInvocationTransactionalCalls(List<GenericRemoteInvocationRpcCall> calls)
protected GenericRemoteInvocationRpcRequest	createRequest(int requestId, CsrfToken token, List<GenericRemoteInvocationRpcTransactionalCalls> transactionalCalls) Creates a new GenericRemoteInvocationRequest instance.
protected abstract <SERVICE extends RemoteInvocationService> SERVICE	getServiceClient(Class<SERVICE> serviceInterface)
<SERVICE extends RemoteInvocationService,RESULT> SERVICE	getServiceClient(Class<SERVICE> serviceInterface, Class<RESULT> returnType, Consumer<? extends RESULT> successCallback) Same as AbstractRemoteInvocationServiceCaller.getServiceClient(Class, Class, Consumer, Consumer) but using the default failure callback.
<SERVICE extends RemoteInvocationService,RESULT> SERVICE	getServiceClient(Class<SERVICE> serviceInterface, Class<RESULT> returnType, Consumer<? extends RESULT> successCallback, Consumer<Throwable> failureCallback) This method gets a client-stub for calling exactly one single method on a RemoteInvocationService.

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

AbstractRemoteInvocationServiceCaller

public AbstractRemoteInvocationServiceCaller()

The constructor.

Method Detail

createQueue

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

Specified by:

createQueue in class AbstractRemoteInvocationCaller<RemoteInvocationServiceQueue,GenericRemoteInvocationRpcCall,GenericRemoteInvocationRpcTransactionalCalls,GenericRemoteInvocationRpcRequest>

Parameters:

settings - are the RemoteInvocationQueueSettings.

parentQueue - is the parent queue.

Returns:

the new queue instance.

See Also:

AbstractRemoteInvocationCaller.createQueue(RemoteInvocationQueueSettings)

createRemoteInvocationTransactionalCalls

protected GenericRemoteInvocationRpcTransactionalCalls createRemoteInvocationTransactionalCalls(List<GenericRemoteInvocationRpcCall> calls)

Specified by:

createRemoteInvocationTransactionalCalls in class AbstractRemoteInvocationCaller<RemoteInvocationServiceQueue,GenericRemoteInvocationRpcCall,GenericRemoteInvocationRpcTransactionalCalls,GenericRemoteInvocationRpcRequest>

Parameters:

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

Returns:

an instance of <TX_CALLS> wrapping the given calls.

createRequest

protected GenericRemoteInvocationRpcRequest createRequest(int requestId,
                                                          CsrfToken token,
                                                          List<GenericRemoteInvocationRpcTransactionalCalls> transactionalCalls)

Creates a new GenericRemoteInvocationRequest instance.

Specified by:

createRequest in class AbstractRemoteInvocationCaller<RemoteInvocationServiceQueue,GenericRemoteInvocationRpcCall,GenericRemoteInvocationRpcTransactionalCalls,GenericRemoteInvocationRpcRequest>

Parameters:

requestId - - see GenericRemoteInvocationRequest.getRequestId().

token - - see GenericRemoteInvocationRequest.getXsrfToken().

transactionalCalls - - see GenericRemoteInvocationRequest.getTransactionalCalls().

Returns:

the new request.

addCall

protected void addCall(GenericRemoteInvocationRpcCall call,
                       Class<?> returnType)

This method is called from the service-client stub to add a GenericRemoteInvocationRpcCall.

Parameters:

call - is the GenericRemoteInvocationRpcCall to add.

returnType - is the return type of the invoked Method.

getServiceClient

public <SERVICE extends RemoteInvocationService,RESULT> SERVICE getServiceClient(Class<SERVICE> serviceInterface,
                                                                                 Class<RESULT> returnType,
                                                                                 Consumer<? extends RESULT> successCallback)

Same as AbstractRemoteInvocationServiceCaller.getServiceClient(Class, Class, Consumer, Consumer) but using the default failure callback.

Specified by:

getServiceClient in interface AbstractRemoteInvocationServiceCaller

Type Parameters:

SERVICE - is the generic type of serviceInterface.

RESULT - is the generic type of returnType.

Parameters:

serviceInterface - is the interface of the RemoteInvocationService.

returnType - is the return type of the Method 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.

Returns:

the client-stub of the RemoteInvocationService.

getServiceClient

public <SERVICE extends RemoteInvocationService,RESULT> SERVICE getServiceClient(Class<SERVICE> serviceInterface,
                                                                                 Class<RESULT> returnType,
                                                                                 Consumer<? extends RESULT> successCallback,
                                                                                 Consumer<Throwable> failureCallback)

This method gets a client-stub for calling exactly one single method on a RemoteInvocationService. After this method has been called, the intended method (with the given returnType) has to be invoked on the resulting client-stub exactly once. This records the desired method invocation and returns a dummy result (typically null) that shall be ignored.
ATTENTION:
This is a convenience method for simplicity. It will create an implicit queue that gets committed automatically after a service method has been called on the returned client-stub.

Specified by:

getServiceClient in interface AbstractRemoteInvocationServiceCaller

Specified by:

getServiceClient in interface RemoteInvocationServiceCaller

Type Parameters:

SERVICE - is the generic type of serviceInterface.

RESULT - is the generic type of returnType.

Parameters:

serviceInterface - is the interface of the RemoteInvocationService.

returnType - is the return type of the Method 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.

Returns:

the client-stub of the RemoteInvocationService.

getServiceClient

protected abstract <SERVICE extends RemoteInvocationService> SERVICE getServiceClient(Class<SERVICE> serviceInterface)

Type Parameters:

SERVICE - is the generic type of serviceInterface.

Parameters:

serviceInterface - is the interface of the RemoteInvocationService.

Returns:

the according client-service stub.

See Also:

RemoteInvocationServiceQueue.getServiceClient(Class, Class, Consumer, Consumer)