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 JavaScriptBootstrapHandler
java.lang.Object
com.vaadin.flow.server.SynchronizedRequestHandler
com.vaadin.flow.server.BootstrapHandler
com.vaadin.flow.server.communication.JavaScriptBootstrapHandler
All Implemented Interfaces:
Direct Known Subclasses:
Processes a 'start' request type from the client to initialize server session and UI. It returns a JSON response with everything needed to bootstrap flow views.
The handler is for client driven projects where `index.html` does not contain bootstrap data. Bootstrapping is the responsibility of the `@vaadin/flow` client that is able to ask the server side to create the vaadin session and do the bootstrapping lazily.
For internal use only. May be renamed or removed in a future release.
See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classCustom BootstrapContext for
JavaScriptBootstrapHandler.Nested classes/interfaces inherited from class com.vaadin.flow.server.BootstrapHandler
BootstrapHandler.BootstrapContext, BootstrapHandler.BootstrapPageBuilder, BootstrapHandler.BootstrapUriResolver, BootstrapHandler.PageBuilderNested classes/interfaces inherited from class com.vaadin.flow.server.SynchronizedRequestHandler
SynchronizedRequestHandler.ResponseWriter -
Field Summary
Fields inherited from class com.vaadin.flow.server.BootstrapHandler
SCRIPT_TAG, SCRIPT_TEMPLATE_FOR_STYLESHEET_LINK_TAG, SERVICE_WORKER_HEADERFields inherited from class com.vaadin.flow.server.SynchronizedRequestHandler
MAX_BUFFER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new bootstrap handler with default page builder.
-
Method Summary
Modifier and TypeMethodDescriptionprotected booleancanHandleRequest(VaadinRequest request) Check whether a request may be handled by this handler.
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> callback) Creates a new instance of
BootstrapHandler.BootstrapContextfor givenrequest,responseandui.protected elemental.json.JsonObjectgetInitialJson(VaadinRequest request, VaadinResponse response, VaadinSession session) Returns the JSON object with the application config and UIDL info that can be used in the bootstrapper to embed that info in the initial page.
protected StringgetRequestUrl(VaadinRequest request) protected static StringgetServiceUrl(VaadinRequest vaadinRequest) Gets the service URL as a URL relative to the request URI.
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.BootstrapHandler
getInitialUidl, getPageBuilder, getPushScript, getStatsJson, getStylesheetLinks, getStylesheetLinks, getStylesheetTags, getUIClass, isFrameworkInternalRequest, isRequestForHtml, isVaadinStaticFileRequest, readResource, resolvePageTitle, setupErrorDialogs, setupHiddenElement, setupPushConnectionFactory, setupPwa, writeErrorCodeIfRequestLocationIsInvalidMethods inherited from class com.vaadin.flow.server.SynchronizedRequestHandler
getRequestBody, handleRequest, isReadAndWriteOutsideSessionLock, synchronizedHandleRequest
-
Constructor Details
-
JavaScriptBootstrapHandler
public JavaScriptBootstrapHandler()Creates a new bootstrap handler with default page builder.
-
-
Method Details
-
canHandleRequest
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 classBootstrapHandlerParameters:
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. -
getRequestUrl
-
createAndInitUI
protected BootstrapHandler.BootstrapContext createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session) Overrides:
createAndInitUIin classBootstrapHandler -
initializeUIWithRouter
Overrides:
initializeUIWithRouterin classBootstrapHandler -
createBootstrapContext
protected BootstrapHandler.BootstrapContext createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest, String> callback) Description copied from class:
BootstrapHandlerCreates a new instance of
BootstrapHandler.BootstrapContextfor givenrequest,responseandui.Overrides:
createBootstrapContextin classBootstrapHandlerParameters:
request- the request objectresponse- the response objectui- the UI objectReturns:
a new bootstrap context instance
-
synchronizedHandleRequest
public boolean synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) throws IOException Description 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 classBootstrapHandlerParameters:
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:
-
getServiceUrl
Gets the service URL as a URL relative to the request URI.
Parameters:
vaadinRequest- the requestReturns:
the relative service URL
-
getInitialJson
protected elemental.json.JsonObject getInitialJson(VaadinRequest request, VaadinResponse response, VaadinSession session) Returns the JSON object with the application config and UIDL info that can be used in the bootstrapper to embed that info in the initial page.
Parameters:
request- the vaadin request.response- the response.session- the vaadin session.Returns:
the initial application JSON.
-