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

Interface AbstractRemoteInvocationServiceCaller

All Known Subinterfaces:

RemoteInvocationServiceCaller, RemoteInvocationServiceQueue

All Known Implementing Classes:

AbstractRemoteInvocationServiceCaller, AbstractRemoteInvocationServiceCaller.RemoteInvocationServiceQueueImpl, AbstractRemoteInvocationServiceCallerGwt, AbstractRemoteInvocationServiceCallerWithClientMap, RemoteInvocationServiceCallerImplSpring

public interface AbstractRemoteInvocationServiceCaller

This is the abstract interface to call a RemoteInvocationService from the client.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

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 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.

Method Detail

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.

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

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

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

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.