Package com.vaadin.flow.server.communication

Class IndexHtmlRequestHandler

java.lang.Object

com.vaadin.flow.server.SynchronizedRequestHandler

com.vaadin.flow.server.BootstrapHandler

com.vaadin.flow.server.communication.JavaScriptBootstrapHandler

com.vaadin.flow.server.communication.IndexHtmlRequestHandler

All Implemented Interfaces:

RequestHandler, Serializable

public class IndexHtmlRequestHandler
extends JavaScriptBootstrapHandler

This class is responsible for serving the index.html according to the template provided in the frontend folder. The handler will calculate and inject baseHref as well as the bundle scripts into the template.

For internal use only. May be renamed or removed in a future release.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler

JavaScriptBootstrapHandler.JavaScriptBootstrapContext

Nested classes/interfaces inherited from class com.vaadin.flow.server.BootstrapHandler

BootstrapHandler.BootstrapContext, BootstrapHandler.BootstrapPageBuilder, BootstrapHandler.BootstrapUriResolver, BootstrapHandler.PageBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIVE_RELOAD_PORT_ATTR

Fields inherited from class com.vaadin.flow.server.BootstrapHandler

SCRIPT_TAG, SCRIPT_TEMPLATE_FOR_STYLESHEET_LINK_TAG, SERVICE_WORKER_HEADER

Constructor Summary

Constructors

Constructor	Description
IndexHtmlRequestHandler()

Method Summary

Modifier and Type	Method	Description
protected static void	addGeneratedIndexContent(org.jsoup.nodes.Document targetDocument, elemental.json.JsonObject statsJson)
static void	addLicenseChecker(org.jsoup.nodes.Document indexDocument)	Adds the needed overrides for the license checker to work when in development mode.
protected boolean	canHandleRequest(VaadinRequest request)	Check whether a request may be handled by this handler.
protected void	initializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui)
boolean	synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)	Identical to SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse) except the VaadinSession is locked before this is called and unlocked after this has completed.

Methods inherited from class com.vaadin.flow.server.communication.JavaScriptBootstrapHandler

createAndInitUI, createBootstrapContext, getInitialJson, getRequestUrl, getServiceUrl

Methods inherited from class com.vaadin.flow.server.BootstrapHandler

getInitialUidl, getPageBuilder, getPushScript, getStatsJson, getStylesheetLinks, getStylesheetTags, getUIClass, isFrameworkInternalRequest, isRequestForHtml, isVaadinStaticFileRequest, readResource, resolvePageTitle, setupErrorDialogs, setupHiddenElement, setupPushConnectionFactory, setupPwa, writeErrorCodeIfRequestLocationIsInvalid

Methods inherited from class com.vaadin.flow.server.SynchronizedRequestHandler

handleRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LIVE_RELOAD_PORT_ATTR

public static final String LIVE_RELOAD_PORT_ATTR

See Also:

• Constant Field Values

Constructor Details

IndexHtmlRequestHandler

public IndexHtmlRequestHandler()

Method Details

synchronizedHandleRequest

public boolean synchronizedHandleRequest(VaadinSession session,
 VaadinRequest request,
 VaadinResponse response)
                                  throws IOException

Description copied from class: SynchronizedRequestHandler

Identical to SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse) except the VaadinSession is locked before this is called and unlocked after this has completed.

Overrides:

synchronizedHandleRequest in class JavaScriptBootstrapHandler

Parameters:

session - The session for the request

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

See Also:

• SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)

addLicenseChecker

public static void addLicenseChecker(org.jsoup.nodes.Document indexDocument)

Adds the needed overrides for the license checker to work when in development mode.

canHandleRequest

protected boolean canHandleRequest(VaadinRequest request)

Description copied from class: SynchronizedRequestHandler

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 true which means that all requests will be handled by calling SynchronizedRequestHandler.synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse) with the session locked.

Overrides:

canHandleRequest in class JavaScriptBootstrapHandler

Parameters:

request - the request to handle

Returns:

true 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.

initializeUIWithRouter

protected void initializeUIWithRouter(BootstrapHandler.BootstrapContext context,
 UI ui)

Overrides:

initializeUIWithRouter in class JavaScriptBootstrapHandler

addGeneratedIndexContent

protected static void addGeneratedIndexContent(org.jsoup.nodes.Document targetDocument,
 elemental.json.JsonObject statsJson)