org.eclipse.keyple.distributed

Interface SyncNodeServer

public interface SyncNodeServer

API of the Node associated to a server endpoint using a synchronous network protocol.

You must bind this kind of node on the server's side if you plan to use a Client-Server communication protocol, such as standard HTTP for example.

Keyple provides its own implementations of this interface and manages their lifecycle.
This kind of node can be bind to a all server remote plugins and local services :

• RemotePluginServer
• LocalServiceServer
• PoolLocalServiceServer

To create it, you must only bind a sync node during the initialization process.
Then, you can access it everywhere on the server's side using one of the following utility methods, depending on your use case :

• RemotePluginServerUtils.getSyncNode()
• LocalServiceServerUtils.getSyncNode()
• PoolLocalServiceServerUtils.getSyncNode()

Since:

1.0

Method Summary

Modifier and Type	Method and Description
java.util.List<MessageDto>	onRequest(MessageDto msg) Must be invoked by the server controller endpoint following the reception and deserialization of a MessageDto from the client.

Method Detail

onRequest

java.util.List<MessageDto> onRequest(MessageDto msg)

Must be invoked by the server controller endpoint following the reception and deserialization of a MessageDto from the client. Following the receive of a request, the controller must :

• Retrieve the node SyncNodeServer using one of the following utility methods, depending on your use case :
  • RemotePluginServerUtils.getSyncNode()
  • LocalServiceServerUtils.getSyncNode()
  • PoolLocalServiceServerUtils.getSyncNode()
• Invoke this method on the node.
• Serialize the result en return it to the client.

Parameters:

msg - The message to process.

Returns:

not null but empty list if there is no result.

Throws:

java.lang.IllegalArgumentException - if some arguments are incorrect.

Since:

1.0