Package com.vaadin.flow.server.communication

Class ServerRpcHandler

java.lang.Object

com.vaadin.flow.server.communication.ServerRpcHandler

All Implemented Interfaces:

Serializable

public class ServerRpcHandler
extends Object
implements Serializable

Handles a client-to-server message containing serialized RPC invocations.

For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerRpcHandler.ClientResentPayloadException	Exception thrown when the client side re-sends the same request.
static class	ServerRpcHandler.InvalidUIDLSecurityKeyException	Exception thrown then the security key sent by the client does not match the expected one.
static class	ServerRpcHandler.ResynchronizationRequiredException	Exception thrown then the client side resynchronization is required.
static class	ServerRpcHandler.RpcRequest	A data transfer object representing an RPC request sent by the client side.

Constructor Summary

Constructors

Constructor	Description
ServerRpcHandler()

Method Summary

Modifier and Type	Method	Description
protected Map<String,RpcInvocationHandler>	getInvocationHandlers()	Gets RpcInvocationHandlers map where the key is the type of the handler gotten via RpcInvocationHandler.getRpcType().
protected String	getMessage(Reader reader)
void	handleRpc(UI ui, Reader reader, VaadinRequest request)	Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.
void	handleRpc(UI ui, String message, VaadinRequest request)	Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ServerRpcHandler

public ServerRpcHandler()

Method Details

handleRpc

public void handleRpc(UI ui,
 Reader reader,
 VaadinRequest request)
               throws IOException,
ServerRpcHandler.InvalidUIDLSecurityKeyException

Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.

Parameters:

ui - The UI receiving the calls. Cannot be null.

reader - The Reader used to read the JSON.

request - The request through which the RPC was received

Throws:

IOException - If reading the message fails.

ServerRpcHandler.InvalidUIDLSecurityKeyException - If the received security key does not match the one stored in the session.

handleRpc

public void handleRpc(UI ui,
 String message,
 VaadinRequest request)
               throws ServerRpcHandler.InvalidUIDLSecurityKeyException

Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.

Parameters:

ui - The UI receiving the calls. Cannot be null.

message - The JSON message from the request.

request - The request through which the RPC was received

Throws:

ServerRpcHandler.InvalidUIDLSecurityKeyException - If the received security key does not match the one stored in the session.

getInvocationHandlers

protected Map<String,RpcInvocationHandler> getInvocationHandlers()

Gets RpcInvocationHandlers map where the key is the type of the handler gotten via RpcInvocationHandler.getRpcType().

This map is used to delegate RPC requests to a specific invocation handler using the type of the request.

Subclasses can overwrite this method to return custom invocation handlers.

Returns:

invocation handlers map

getMessage

protected String getMessage(Reader reader)
                     throws IOException

Throws:

IOException