We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.server.communication.
Class UidlRequestHandler
- java.lang.Object
-
- com.vaadin.server.SynchronizedRequestHandler
-
- com.vaadin.server.communication.UidlRequestHandler
-
All Implemented Interfaces:
public class UidlRequestHandler extends SynchronizedRequestHandler implements SessionExpiredHandlerProcesses a UIDL request from the client. Uses
ServerRpcHandlerto execute client-to-server RPC invocations andUidlWriterto write state changes and client RPC calls back to the client.Since:
7.1
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Constructor and Description UidlRequestHandler()
-
Method Summary
All Methods Modifier and Type Method and Description protected booleancanHandleRequest(VaadinRequest request)Check whether a request may be handled by this handler.
protected voidcloseJsonMessage(Writer outWriter)protected ServerRpcHandlercreateRpcHandler()Creates the ServerRpcHandler to use
booleanhandleSessionExpired(VaadinRequest request, VaadinResponse response)Called when the a session expiration has occured and a notification needs to be sent to the user.
protected voidopenJsonMessage(Writer outWriter, VaadinResponse response)Writes the opening of JSON message to be sent to client.
booleansynchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)Identical to
SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis locked before this is called and unlocked after this has completed.-
Methods inherited from class com.vaadin.server.SynchronizedRequestHandler
handleRequest
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.server.RequestHandler
handleRequest
-
-
-
-
Field Detail
-
UIDL_PATH
public static final String UIDL_PATHSee Also:
-
-
Method Detail
-
createRpcHandler
protected ServerRpcHandler createRpcHandler()Creates the ServerRpcHandler to use
Returns:
the ServerRpcHandler to use
Since:
7.7
-
canHandleRequest
protected boolean canHandleRequest(VaadinRequest request)Description copied from class:
SynchronizedRequestHandlerCheck whether a request may be handled by this handler. This can be used as an optimization to avoid locking the session just to investigate some method property. The default implementation just returns
truewhich means that all requests will be handled by callingSynchronizedRequestHandler.synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)with the session locked.Overrides:
canHandleRequestin classSynchronizedRequestHandlerParameters:
request- the request to handleReturns:
trueif the request handling should continue once the session has been locked;falseif there's no need to lock the session since the request would still not be handled.
-
synchronizedHandleRequest
public boolean synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) throws IOExceptionDescription copied from class:
SynchronizedRequestHandlerIdentical to
SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis locked before this is called and unlocked after this has completed.Specified by:
synchronizedHandleRequestin classSynchronizedRequestHandlerParameters:
session- The session for the requestrequest- The request to handleresponse- The response object to which a response can be written.Returns:
true if a response has been written and no further request handlers should be called, otherwise false
Throws:
IOException- If an IO error occurredSee Also:
SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)
-
closeJsonMessage
protected void closeJsonMessage(Writer outWriter) throws IOExceptionThrows:
-
openJsonMessage
protected void openJsonMessage(Writer outWriter, VaadinResponse response) throws IOExceptionWrites the opening of JSON message to be sent to client.
Parameters:
outWriter-response-Throws:
-
handleSessionExpired
public boolean handleSessionExpired(VaadinRequest request, VaadinResponse response) throws IOExceptionDescription copied from interface:
SessionExpiredHandlerCalled when the a session expiration has occured and a notification needs to be sent to the user. If a response is written, this method should return
trueto indicate that no moreSessionExpiredHandlerhandlers should be invoked for the request.Specified by:
handleSessionExpiredin interfaceSessionExpiredHandlerParameters:
request- The request to handleresponse- The response object to which a response can be written.Returns:
true if a response has been written and no further request handlers should be called, otherwise false
Throws:
IOException- If an IO error occurred
-
-