com.vaadin.flow.server.communication

Interface IndexHtmlRequestListener

All Superinterfaces:

EventListener, Serializable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IndexHtmlRequestListener
extends EventListener, Serializable

This event listener is notified when the Single Page Application's HTML page is about to be generated and sent to the client. The Index HTML response is first constructed as an in-memory DOM representation which registered listeners can modify before the final HTML is generated.

Index HTML request listeners are registered using the ServiceInitEvent during the initialization of the application. Index HTML request listener is used when the application flag InitParameters.SERVLET_PARAMETER_USE_V14_BOOTSTRAP is not set.

See Also:

ServiceInitEvent.addIndexHtmlRequestListener(IndexHtmlRequestListener), IndexHtmlRequestHandler, InitParameters.SERVLET_PARAMETER_USE_V14_BOOTSTRAP

Method Summary

Modifier and Type	Method and Description
void	modifyIndexHtmlResponse(IndexHtmlResponse indexHtmlResponse) The method allows to modify the Index HTML response before it is sent to browser.

Method Detail

modifyIndexHtmlResponse

void modifyIndexHtmlResponse(IndexHtmlResponse indexHtmlResponse)

The method allows to modify the Index HTML response before it is sent to browser.

Parameters:

indexHtmlResponse - the response object which includes the VaadinRequest, VaadinResponse, and Document