net.sf.mmm.service.api.command.client

Interface RemoteInvocationCommandQueue

All Superinterfaces:

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

All Known Implementing Classes:

AbstractRemoteInvocationCommandCaller.RemoteInvocationCommandQueueImpl

public interface RemoteInvocationCommandQueue
extends AbstractRemoteInvocationCommandCaller, RemoteInvocationQueue

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

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

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.

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

cancel, commit, getDefaultFailureCallback, getId, getState

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

setDefaultFailureCallback

Method Detail

callCommand

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

Same as AbstractRemoteInvocationCommandCaller.callCommand(RemoteInvocationCommand, Consumer) but using the default failure callback.
ATTENTION:
This will NOT send a technical request to the server unless this queue is committed. A queue allows multiple invocations of this method in order to collect remote invocations that shall be send to the server within the same technical request.

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.

See Also:

AttributeWriteDefaultFailureCallback.setDefaultFailureCallback(Consumer)

callCommand

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

This method invokes the given RemoteInvocationCommand on a RemoteInvocationService.
ATTENTION:
This will NOT send a technical request to the server unless this queue is committed. A queue allows multiple invocations of this method in order to collect remote invocations that shall be send to the server within the same technical request.

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.