net.sf.mmm.service.api.rpc.client

Interface RemoteInvocationServiceQueue

All Superinterfaces:

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

All Known Implementing Classes:

AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl

public interface RemoteInvocationServiceQueue
extends RemoteInvocationQueue, AbstractRemoteInvocationServiceCaller

This is the interface for a remote invocation queue based on RemoteInvocationServiceCaller.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

RemoteInvocationQueue, getServiceClient(Class, Class, Consumer, Consumer)

Method Summary

Modifier and Type	Method and Description
<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.
void	setDefaultFailureCallback(Consumer<Throwable> failureCallback) This method sets the default failure callback.

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

cancel, commit, getDefaultFailureCallback, getId, getState

Method Detail

setDefaultFailureCallback

void setDefaultFailureCallback(Consumer<Throwable> failureCallback)

This method sets the default failure callback. If such callback has been set, invocations of getServiceClient(Class, Class, Consumer, Consumer) may omit the failure callback by providing null.

Specified by:

setDefaultFailureCallback in interface AttributeWriteDefaultFailureCallback

Parameters:

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

getServiceClient

<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

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:

setDefaultFailureCallback(Consumer)

getServiceClient

<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

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.