com.vaadin.flow.server.SessionExpiredHandler API 11.0.4 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.server.

All Superinterfaces:

RequestHandler, Serializable

All Known Implementing Classes:

HeartbeatHandler, PushRequestHandler, UidlRequestHandler
```
public interface SessionExpiredHandler
extends RequestHandler
```
A specialized RequestHandler which is capable of sending session expiration messages to the user.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

All Methods
Modifier and Type	Method and Description
`boolean`	`handleSessionExpired(VaadinRequest request, VaadinResponse response)` Called when the a session expiration has occurred and a notification needs to be sent to the user.

Methods inherited from interface com.vaadin.flow.server.RequestHandler
handleRequest

- Method Detail
  - handleSessionExpired
```
boolean handleSessionExpired(VaadinRequest request,
                             VaadinResponse response)
                      throws IOException
```
    Called when the a session expiration has occurred and a notification needs to be sent to the user. If a response is written, this method should return true to indicate that no more SessionExpiredHandler handlers should be invoked for the request.
    
    Parameters:
    
    request - The request to handle
    
    response - 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