public class HeartbeatHandler extends SynchronizedRequestHandler implements SessionExpiredHandler
For internal use only. May be renamed or removed in a future release.
Constructor and Description |
---|
HeartbeatHandler() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canHandleRequest(VaadinRequest request)
Check whether a request may be handled by this handler.
|
boolean |
handleSessionExpired(VaadinRequest request,
VaadinResponse response)
Called when the a session expiration has occurred and a notification
needs to be sent to the user.
|
boolean |
synchronizedHandleRequest(VaadinSession session,
VaadinRequest request,
VaadinResponse response)
Handles a heartbeat request for the given session.
|
handleRequest
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
handleRequest
protected boolean canHandleRequest(VaadinRequest request)
SynchronizedRequestHandler
true
which means that all requests will be handled by
calling
SynchronizedRequestHandler.synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)
with the session locked.canHandleRequest
in class SynchronizedRequestHandler
request
- the request to handletrue
if the request handling should continue once
the session has been locked; false
if there's no
need to lock the session since the request would still not be
handled.public boolean synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) throws IOException
ApplicationConstants.UI_ID_PARAMETER
to identify
the UI. If the UI is found in the session, sets it
heartbeat timestamp
to
the current time. Otherwise, writes a HTTP Not Found error to the
response.synchronizedHandleRequest
in class SynchronizedRequestHandler
session
- The session for the requestrequest
- The request to handleresponse
- The response object to which a response can be written.IOException
- If an IO error occurredSynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)
public boolean handleSessionExpired(VaadinRequest request, VaadinResponse response) throws IOException
SessionExpiredHandler
true
to indicate that no more
SessionExpiredHandler
handlers should be invoked for the request.handleSessionExpired
in interface SessionExpiredHandler
request
- The request to handleresponse
- The response object to which a response can be written.IOException
- If an IO error occurredCopyright © 2022. All rights reserved.