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.
Class SynchronizedRequestHandler
- java.lang.Object
-
- com.vaadin.server.SynchronizedRequestHandler
-
All Implemented Interfaces:
Direct Known Subclasses:
BootstrapHandler,HeartbeatHandler,UidlRequestHandler,UIInitHandler,UnsupportedBrowserHandlerpublic abstract class SynchronizedRequestHandler extends Object implements RequestHandlerRequestHandler which takes care of locking and unlocking of the VaadinSession automatically. The session is locked before
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)is called and unlocked after it has completed.Since:
7.1
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSynchronizedRequestHandler.ResponseWriterResponseWriter is optionally returned by request handlers which implement
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse, String)The ResponseWriter will be executed byhandleRequest(VaadinSession, VaadinRequest, VaadinResponse)without holding Vaadin session lock.
-
Field Summary
Fields Modifier and Type Field Description static intMAX_BUFFER_SIZEMaximum capacity of request body.
-
Constructor Summary
Constructors Constructor Description SynchronizedRequestHandler()
-
Method Summary
All Methods Modifier and Type Method Description protected booleancanHandleRequest(VaadinRequest request)Check whether a request may be handled by this handler.
static StringgetRequestBody(Reader reader)Reads the request body into a String.
booleanhandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)Called when a request needs to be handled.
booleanisReadAndWriteOutsideSessionLock()Returns whether request body should be read and the response written without holding
VaadinSessionlock.abstract booleansynchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)Identical to
handleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis locked before this is called and unlocked after this has completed.Optional<SynchronizedRequestHandler.ResponseWriter>synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response, String requestBody)Identical to
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis locked before this is called and the response requestBody has been read before locking the session and is provided as a separate parameter.
-
-
-
Method Detail
-
handleRequest
public boolean handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) throws IOExceptionDescription copied from interface:
RequestHandlerCalled when a request needs to be handled. If a response is written, this method should return
trueto indicate that no more request handlers should be invoked for the request.Note that request handlers by default do not lock the session. If you are using VaadinSession or anything inside the VaadinSession you must ensure the session is locked. This can be done by extending
SynchronizedRequestHandleror by usingVaadinSession.accessSynchronously(Runnable)orUI.accessSynchronously(Runnable).Specified by:
handleRequestin interfaceRequestHandlerParameters:
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 occurred
-
synchronizedHandleRequest
public abstract boolean synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) throws IOExceptionIdentical to
handleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis locked before this is called and unlocked after this has completed.Parameters:
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:
-
isReadAndWriteOutsideSessionLock
public boolean isReadAndWriteOutsideSessionLock()Returns whether request body should be read and the response written without holding
VaadinSessionlock.Returns:
true if
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse, String)should be called. Returns false ifsynchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)should be called.Since:
-
synchronizedHandleRequest
public Optional<SynchronizedRequestHandler.ResponseWriter> synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response, String requestBody) throws IOException, UnsupportedOperationExceptionIdentical to
synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis locked before this is called and the response requestBody has been read before locking the session and is provided as a separate parameter.Parameters:
session- The session for the requestrequest- The request to handleresponse- The response object to which a response can be written.requestBody- Request body pre-read from the request objectReturns:
a ResponseWriter wrapped into an Optional, if this handler will write the response and no further request handlers should be called, otherwise an empty Optional. The ResponseWriter will be executed after the VaadinSession is unlocked.
Throws:
IOException- If an IO error occurred.Since:
See Also:
-
canHandleRequest
protected boolean canHandleRequest(VaadinRequest request)Check 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 callingsynchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)with the session locked.Parameters:
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.Since:
7.2
-
getRequestBody
public static String getRequestBody(Reader reader) throws IOExceptionReads the request body into a String.
Parameters:
reader- a Reader containing the body of the requestReturns:
request body as a String
Throws:
IOException- If an IO error occurred.Since:
-
-