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

Interface RemoteInvocationCommandCaller

All Superinterfaces:

AbstractRemoteInvocationCommandCaller, RemoteInvocationCaller<RemoteInvocationCommandQueue>

All Known Implementing Classes:

AbstractRemoteInvocationCommandCaller

@ComponentSpecification
public interface RemoteInvocationCommandCaller
extends AbstractRemoteInvocationCommandCaller, RemoteInvocationCaller<RemoteInvocationCommandQueue>

This is the interface for the key component to invoke one or multiple RemoteInvocationCommands from the client-side. The most simple usage is given in the following example:

 RemoteInvocationCommandCaller caller = getCommandCaller();
 MyCommand command = new MyCommand(payload);
 caller.callCommand(command, this::onSuccess, this::onFailure);
 

However, there are advanced features such as queuing command calls and send them in a single technical request. Therefore you should use RemoteInvocationCommandQueue as illustrated by this example:

 RemoteInvocationCommandCaller caller = getCommandCaller();
 RemoteInvocationCommandQueue queue = caller.RemoteInvocationCaller.newQueue();
 MyCommand command = new MyCommand(payload);
 queue.setDefaultFailureCallback(this::onFailure);
 queue.callCommand(command, this::onSuccess);
 ...
 queue.commit();
 

This might look a little complex on the first view, but it allows very powerful but quite easy usage of asynchronous service invocations. In the example above a specific command is created that represents a particular service invocation. This command is recorded by the RemoteInvocationCommandQueue. It will be send to the server when the top-level queue is committed. When the result is received from the server, it will be passed to the provided success callback function.
NOTE:
We have prepared everything for Java 1.8 so you can use lambdas. See net.sf.mmm.util.lang.api.function for details. If you are using a java version less than 1.8, you can NOT use lambdas and have to provide instances via anonymous classes.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Methods inherited from interface net.sf.mmm.service.api.command.client.AbstractRemoteInvocationCommandCaller

callCommand, callCommand

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

getCurrentQueue, newQueue, newQueue, newQueue