We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
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:
public class IndexHtmlRequestHandler extends JavaScriptBootstrapHandlerThis class is responsible for serving the
index.htmlaccording 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:
-
-
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 inherited from class com.vaadin.flow.server.BootstrapHandler
SERVICE_WORKER_HEADER
-
-
Constructor Summary
Constructors Constructor Description IndexHtmlRequestHandler()
-
Method Summary
All Methods Modifier and Type Method Description protected booleancanHandleRequest(VaadinRequest request)Check whether a request may be handled by this handler.
protected voidinitializeUIWithRouter(BootstrapHandler.BootstrapContext context, UI ui)booleansynchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)Identical to
SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis 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, getUIClass, isFrameworkInternalRequest, isRequestForHtml, isVaadinStaticFileRequest, readResource, resolvePageTitle, setupErrorDialogs, setupPushConnectionFactory, setupPwa, showWebpackErrors, writeErrorCodeIfRequestLocationIsInvalid
-
Methods inherited from class com.vaadin.flow.server.SynchronizedRequestHandler
handleRequest
-
-
-
-
Method Detail
-
synchronizedHandleRequest
public boolean synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) throws IOExceptionDescription copied from class:
SynchronizedRequestHandlerIdentical to
SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)except theVaadinSessionis locked before this is called and unlocked after this has completed.Overrides:
synchronizedHandleRequestin classJavaScriptBootstrapHandlerParameters:
session- The session for the requestrequest- The request to handleresponse- 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 occurredSee Also:
SynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)
-
canHandleRequest
protected boolean canHandleRequest(VaadinRequest request)Description copied from class:
SynchronizedRequestHandlerCheck 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
truewhich means that all requests will be handled by callingSynchronizedRequestHandler.synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse)with the session locked.Overrides:
canHandleRequestin classJavaScriptBootstrapHandlerParameters:
request- the request to handleReturns:
trueif the request handling should continue once the session has been locked;falseif 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:
-
-