net.sf.mmm.service.api.client

Interface RemoteInvocationCaller<QUEUE extends RemoteInvocationQueue>

Type Parameters:

QUEUE - is the generic type of the queues managed by this caller.

All Known Subinterfaces:

RemoteInvocationCommandCaller, RemoteInvocationServiceCaller

All Known Implementing Classes:

AbstractRemoteInvocationCaller, AbstractRemoteInvocationCommandCaller, AbstractRemoteInvocationServiceCaller, AbstractRemoteInvocationServiceCallerGwt, AbstractRemoteInvocationServiceCallerWithClientMap, RemoteInvocationServiceCallerImplSpring

public interface RemoteInvocationCaller<QUEUE extends RemoteInvocationQueue>

This is the abstract interface for a component that allows to invoke one or multiple remote invocations to a server from the client-side. As described in net.sf.mmm.service.api there are two variants available:

• RPC style
• command style

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
QUEUE	getCurrentQueue() This method gets the current queue.
QUEUE	newQueue() This method opens a queue that collects remote invocations to send to the server.
QUEUE	newQueue(RemoteInvocationQueueSettings settings) This method opens a queue that collects remote invocations to send to the server.
QUEUE	newQueue(String id) This method opens a queue that collects remote invocations to send to the server.

Method Detail

getCurrentQueue

QUEUE getCurrentQueue()

This method gets the current queue. This is the last queue that has been created and is still open.
NOTE:
This method is only for specific scenarios. You should typically use newQueue() instead, to retrieve a queue and perform service invocations.

Returns:

the current queue or null if no queue is open.

newQueue

QUEUE newQueue()

This method opens a queue that collects remote invocations to send to the server.

Returns:

the new queue.

See Also:

newQueue(RemoteInvocationQueueSettings)

newQueue

QUEUE newQueue(String id)

This method opens a queue that collects remote invocations to send to the server.

Parameters:

id - is the identifier of the new queue.

Returns:

the new queue.

See Also:

newQueue(RemoteInvocationQueueSettings)

newQueue

QUEUE newQueue(RemoteInvocationQueueSettings settings)

This method opens a queue that collects remote invocations to send to the server. If a queue is currently open this method will create a child-queue of that queue.

Parameters:

settings - are the RemoteInvocationQueueSettings.

Returns:

the new queue.