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

Class AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl

java.lang.Object

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

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

All Implemented Interfaces:

AttributeReadDefaultFailureCallback, AttributeWriteDefaultFailureCallback, RemoteInvocationQueue, AbstractRemoteInvocationServiceCaller, RemoteInvocationServiceQueue, AttributeReadId<String>

Enclosing class:

AbstractRemoteInvocationServiceCaller

protected class AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl
extends AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue
implements RemoteInvocationServiceQueue

This inner class is the implementation of RemoteInvocationServiceQueue.

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractRemoteInvocationServiceCaller.ServiceCallData<?>	currentCall The current AbstractRemoteInvocationServiceCaller.ServiceCallData or null.

Constructor Summary

Constructors

Constructor and Description
RemoteInvocationServiceQueueImpl(RemoteInvocationQueueSettings settings) The constructor.
RemoteInvocationServiceQueueImpl(RemoteInvocationQueueSettings settings, AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl parentQueue) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addCall(GenericRemoteInvocationRpcCall call, Class<?> returnType) This method adds the given GenericRemoteInvocationRpcCall to this queue.
<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.AbstractRemoteInvocationQueue

addCall, cancel, commit, getCallQueue, getDefaultFailureCallback, getId, getIdInfo, getParentQueue, getSettings, getState, requireNoChildQueue, requireNoCurrentCall, requireOpen, setDefaultFailureCallback

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.rpc.client.RemoteInvocationServiceQueue

setDefaultFailureCallback

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

cancel, commit, getDefaultFailureCallback, getId, getState

Field Detail

currentCall

private AbstractRemoteInvocationServiceCaller.ServiceCallData<?> currentCall

The current AbstractRemoteInvocationServiceCaller.ServiceCallData or null.

Constructor Detail

RemoteInvocationServiceQueueImpl

public RemoteInvocationServiceQueueImpl(RemoteInvocationQueueSettings settings)

The constructor.

Parameters:

settings - - see AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.getSettings().

RemoteInvocationServiceQueueImpl

public RemoteInvocationServiceQueueImpl(RemoteInvocationQueueSettings settings,
                                        AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl parentQueue)

The constructor.

Parameters:

settings - - see AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.getSettings().

parentQueue - - see AbstractRemoteInvocationCaller.AbstractRemoteInvocationQueue.getParentQueue().

Method Detail

addCall

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

This method adds the given GenericRemoteInvocationRpcCall to this queue.

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.
ATTENTION:
After the service method has been called, no technical request will be send to the server unless this queue is committed. This allows multiple invocations of this method and subsequent service method calls in order to collect service invocations that shall be send to the server within the same technical request.

Specified by:

getServiceClient in interface AbstractRemoteInvocationServiceCaller

Specified by:

getServiceClient in interface RemoteInvocationServiceQueue

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.

See Also:

RemoteInvocationServiceQueue.setDefaultFailureCallback(Consumer)

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:
After the service method has been called, no technical request will be send to the server unless this queue is committed. This allows multiple invocations of this method and subsequent service method calls in order to collect service invocations that shall be send to the server within the same technical request.

Specified by:

getServiceClient in interface AbstractRemoteInvocationServiceCaller

Specified by:

getServiceClient in interface RemoteInvocationServiceQueue

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.