Package com.vaadin.server.communication

Class ServerRpcHandler

java.lang.Object

com.vaadin.server.communication.ServerRpcHandler

All Implemented Interfaces:

Serializable

public class ServerRpcHandler
extends Object
implements Serializable

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

Since:

7.1

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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 void	changeVariables(Object source, VariableOwner owner, Map<String,Object> m)
static String	getIgnoredDisabledError(String what, ClientConnector connector)	Generates an error message when the client is trying to to something ('what') with a connector which is disabled or invisible.
protected String	getMessage(Reader reader)
protected String	getMessage(Reader reader, VaadinRequest request)	Reads the RPC message from the given reader, enforcing the maximum request body size configured for the given request.
protected void	handleInvocation(UI ui, ClientConnector connector, ServerRpcMethodInvocation invocation)	Handles the given RPC method invocation for the given connector
protected void	handleInvocation(UI ui, ClientConnector connector, LegacyChangeVariablesInvocation legacyInvocation)	Handles the given Legacy variable change RPC method invocation for the given connector
protected void	handleInvocations(UI ui, int lastSyncIdSeenByClient, elemental.json.JsonArray invocationsData)	Processes invocations data received from the client.
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 Detail

ServerRpcHandler

public ServerRpcHandler()

Method Detail

handleRpc

public void handleRpc(UI ui,
                      Reader reader,
                      VaadinRequest request)
               throws IOException,
                      LegacyCommunicationManager.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 -

Throws:

IOException - If reading the message fails.

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

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

Since:

handleInvocations

protected void handleInvocations(UI ui,
                                 int lastSyncIdSeenByClient,
                                 elemental.json.JsonArray invocationsData)

Processes invocations data received from the client.

The invocations data can contain any number of RPC calls, including legacy variable change calls that are processed separately.

Consecutive changes to the value of the same variable are combined and changeVariables() is only called once for them. This preserves the Vaadin 6 semantics for components and add-ons that do not use Vaadin 7 RPC directly.

Parameters:

ui - the UI receiving the invocations data

lastSyncIdSeenByClient - the most recent sync id the client has seen at the time the request was sent

invocationsData - JSON containing all information needed to execute all requested RPC calls.

Since:

7.7

handleInvocation

protected void handleInvocation(UI ui,
                                ClientConnector connector,
                                ServerRpcMethodInvocation invocation)

Handles the given RPC method invocation for the given connector

Parameters:

ui - the UI containing the connector

connector - the connector the RPC is targeted to

invocation - information about the rpc to invoke

Since:

7.7

handleInvocation

protected void handleInvocation(UI ui,
                                ClientConnector connector,
                                LegacyChangeVariablesInvocation legacyInvocation)

Handles the given Legacy variable change RPC method invocation for the given connector

Parameters:

ui - the UI containing the connector

connector - the connector the RPC is targeted to

invocation - information about the rpc to invoke

Since:

7.7

changeVariables

protected void changeVariables(Object source,
                               VariableOwner owner,
                               Map<String,Object> m)

getMessage

protected String getMessage(Reader reader)
                     throws IOException

Throws:

IOException

getMessage

protected String getMessage(Reader reader,
                            VaadinRequest request)
                     throws IOException

Reads the RPC message from the given reader, enforcing the maximum request body size configured for the given request.

Parameters:

reader - the reader to read the message from

request - the request the message was received through

Returns:

the message as a string

Throws:

IOException - if reading fails

RequestBodyTooLargeException - if the message exceeds the configured maximum size

Since:

getIgnoredDisabledError

public static String getIgnoredDisabledError(String what,
                                             ClientConnector connector)

Generates an error message when the client is trying to to something ('what') with a connector which is disabled or invisible.

Parameters:

connector - the connector which is disabled (or invisible)

Returns:

an error message

Since:

7.1.8