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.
Class BootstrapHandler
- java.lang.Object
-
- com.vaadin.flow.server.SynchronizedRequestHandler
-
- com.vaadin.flow.server.BootstrapHandler
-
All Implemented Interfaces:
Direct Known Subclasses:
public class BootstrapHandler extends SynchronizedRequestHandlerRequest handler which handles bootstrapping of the application, i.e. the initial GET request.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description protected static classBootstrapHandler.BootstrapContextProvides context information for the bootstrap process.
protected static classBootstrapHandler.BootstrapPageBuilderBuilds bootstrap pages.
static classBootstrapHandler.BootstrapUriResolverThe URI resolver used in the bootstrap process.
static interfaceBootstrapHandler.PageBuilderInterface for objects capable of building the bootstrap page.
-
Constructor Summary
Constructors Modifier Constructor and Description BootstrapHandler()Creates an instance of the handler with default
BootstrapHandler.PageBuilder.protectedBootstrapHandler(BootstrapHandler.PageBuilder pageBuilder)Creates an instance of the handler using provided page builder.
-
Method Summary
All Methods Modifier and Type Method and Description protected BootstrapHandler.BootstrapContextcreateAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)protected BootstrapHandler.BootstrapContextcreateBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> contextPathCallback)Creates a new instance of
BootstrapHandler.BootstrapContextfor givenrequest,responseandui.protected static elemental.json.JsonObjectgetInitialUidl(UI ui)Generates the initial UIDL message which is included in the initial bootstrap page.
protected BootstrapHandler.PageBuildergetPageBuilder()Returns the current page builder object.
protected static StringgetPushScript(BootstrapHandler.BootstrapContext context)protected static Class<? extends UI>getUIClass(VaadinRequest request)Returns the UI class mapped for servlet that handles the given request.
protected voidinitializeUIWithRouter(VaadinRequest request, UI ui)protected static StringreadResource(String fileName)protected static Optional<String>resolvePageTitle(BootstrapHandler.BootstrapContext context)Resolves the initial page title for the given bootstrap context and cancels any pending JS execution for it.
protected static voidsetupErrorDialogs(org.jsoup.nodes.Element style)protected voidsetupPushConnectionFactory(PushConfiguration pushConfiguration, BootstrapHandler.BootstrapContext context)protected static voidsetupPwa(org.jsoup.nodes.Document document, VaadinService service)protected static voidshowWebpackErrors(org.jsoup.nodes.Document document)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.SynchronizedRequestHandler
canHandleRequest, handleRequest
-
-
-
-
Constructor Detail
-
BootstrapHandler
public BootstrapHandler()Creates an instance of the handler with default
BootstrapHandler.PageBuilder.
-
BootstrapHandler
protected BootstrapHandler(BootstrapHandler.PageBuilder pageBuilder)Creates an instance of the handler using provided page builder.
Parameters:
pageBuilder- Page builder to use.
-
-
Method Detail
-
getPageBuilder
protected BootstrapHandler.PageBuilder getPageBuilder()Returns the current page builder object.
Returns:
Page builder in charge of constructing the resulting page.
-
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.Specified by:
synchronizedHandleRequestin classSynchronizedRequestHandlerParameters:
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)
-
resolvePageTitle
protected static Optional<String> resolvePageTitle(BootstrapHandler.BootstrapContext context)Resolves the initial page title for the given bootstrap context and cancels any pending JS execution for it.
Parameters:
context- the bootstrap contextReturns:
the optional initial page title
-
createAndInitUI
protected BootstrapHandler.BootstrapContext createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)
-
initializeUIWithRouter
protected void initializeUIWithRouter(VaadinRequest request, UI ui)
-
createBootstrapContext
protected BootstrapHandler.BootstrapContext createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> contextPathCallback)Creates a new instance of
BootstrapHandler.BootstrapContextfor givenrequest,responseandui.Parameters:
request- the request objectresponse- the response objectui- the UI objectReturns:
a new bootstrap context instance
-
setupPushConnectionFactory
protected void setupPushConnectionFactory(PushConfiguration pushConfiguration, BootstrapHandler.BootstrapContext context)
-
getUIClass
protected static Class<? extends UI> getUIClass(VaadinRequest request)Returns the UI class mapped for servlet that handles the given request.
This method is protected for testing purposes.
Parameters:
request- the request for the UIReturns:
the UI class for the request
-
getInitialUidl
protected static elemental.json.JsonObject getInitialUidl(UI ui)Generates the initial UIDL message which is included in the initial bootstrap page.
Parameters:
ui- the UI for which the UIDL should be generatedReturns:
a JSON object with the initial UIDL message
-
getPushScript
protected static String getPushScript(BootstrapHandler.BootstrapContext context)
-
showWebpackErrors
protected static void showWebpackErrors(org.jsoup.nodes.Document document)
-
setupErrorDialogs
protected static void setupErrorDialogs(org.jsoup.nodes.Element style)
-
setupPwa
protected static void setupPwa(org.jsoup.nodes.Document document, VaadinService service)
-
-