com.vaadin.server.SessionExpiredHandler Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import java.io.IOException;
/**
* A specialized RequestHandler which is capable of sending session expiration
* messages to the user.
*
* @since 7.1
* @author Vaadin Ltd
*/
public interface SessionExpiredHandler extends RequestHandler {
/**
* 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
* {@link SessionExpiredHandler} handlers should be invoked for the request.
*
* @param request
* The request to handle
* @param response
* The response object to which a response can be written.
* @return true if a response has been written and no further request
* handlers should be called, otherwise false
* @throws IOException
* If an IO error occurred
* @since 7.1
*/
boolean handleSessionExpired(VaadinRequest request, VaadinResponse response)
throws IOException;
}