Uses of Interface
com.vaadin.flow.server.VaadinRequest

Packages that use VaadinRequest

Package	Description
com.vaadin.base.devserver
com.vaadin.flow.component
com.vaadin.flow.component.webcomponent
com.vaadin.flow.internal
com.vaadin.flow.internal.springcsrf
com.vaadin.flow.server
com.vaadin.flow.server.auth
com.vaadin.flow.server.communication
com.vaadin.flow.spring
com.vaadin.flow.spring.security
com.vaadin.testbench.unit.mocks

Uses of VaadinRequest in com.vaadin.base.devserver

Methods in com.vaadin.base.devserver with parameters of type VaadinRequest

Modifier and Type	Method	Description
boolean	AbstractDevServerRunner.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	DevBundleBuildingHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)

Uses of VaadinRequest in com.vaadin.flow.component

Methods in com.vaadin.flow.component with parameters of type VaadinRequest

Modifier and Type	Method	Description
void	UI.doInit(VaadinRequest request, int uiId)	Deprecated. Use UI.doInit(VaadinRequest, int, String) instead
void	UI.doInit(VaadinRequest request, int uiId, String appId)	Internal initialization method, should not be overridden.
protected void	UI.init(VaadinRequest request)	Initializes this UI.

Uses of VaadinRequest in com.vaadin.flow.component.webcomponent

Methods in com.vaadin.flow.component.webcomponent with parameters of type VaadinRequest

Modifier and Type	Method	Description
void	WebComponentUI.doInit(VaadinRequest request, int uiId, String appId)

Uses of VaadinRequest in com.vaadin.flow.internal

Methods in com.vaadin.flow.internal with parameters of type VaadinRequest

Modifier and Type	Method	Description
static Optional<Locale>	LocaleUtil.getExactLocaleMatch(VaadinRequest request, List<Locale> providedLocales)	Get the exact locale match for the given request in the provided locales.
static Optional<Locale>	LocaleUtil.getLocaleMatchByLanguage(VaadinRequest request, List<Locale> providedLocales)	Get the locale matching the language of the request locale in the provided locales.
static String	BootstrapHandlerHelper.getPushURL(VaadinSession vaadinSession, VaadinRequest vaadinRequest)	Gets the push URL as a URL relative to the request URI.
static String	BootstrapHandlerHelper.getServiceUrl(VaadinRequest vaadinRequest)	Gets the service URL as a URL relative to the request URI.

Uses of VaadinRequest in com.vaadin.flow.internal.springcsrf

Methods in com.vaadin.flow.internal.springcsrf with parameters of type VaadinRequest

Modifier and Type	Method	Description
static void	SpringCsrfTokenUtil.addTokenAsMetaTagsToHeadIfPresentInRequest(org.jsoup.nodes.Element head, VaadinRequest request)
static Optional<SpringCsrfToken>	SpringCsrfTokenUtil.getSpringCsrfToken(VaadinRequest request)

Uses of VaadinRequest in com.vaadin.flow.server

Classes in com.vaadin.flow.server that implement VaadinRequest

Modifier and Type	Class	Description
class	VaadinServletRequest	Wrapper for HttpServletRequest.

Methods in com.vaadin.flow.server that return VaadinRequest

Modifier and Type	Method	Description
static VaadinRequest	VaadinRequest.getCurrent()	Gets the currently processed Vaadin request.
static VaadinRequest	VaadinService.getCurrentRequest()	Gets the currently processed Vaadin request.
VaadinRequest	AppShellSettings.getRequest()	Get the current request.
VaadinRequest	BootstrapHandler.BootstrapContext.getRequest()	Gets the Vaadin/HTTP request.
VaadinRequest	SessionInitEvent.getRequest()	Gets the request that triggered the initialization.
VaadinRequest	SystemMessagesInfo.getRequest()	Gets the request currently in progress.

Methods in com.vaadin.flow.server with parameters of type VaadinRequest

Modifier and Type	Method	Description
protected boolean	BootstrapHandler.canHandleRequest(VaadinRequest request)
protected boolean	SynchronizedRequestHandler.canHandleRequest(VaadinRequest request)	Check whether a request may be handled by this handler.
protected BootstrapHandler.BootstrapContext	BootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)
protected BootstrapHandler.BootstrapContext	BootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> contextPathCallback)	Creates a new instance of BootstrapHandler.BootstrapContext for given request, response and ui.
protected VaadinSession	VaadinService.createVaadinSession(VaadinRequest request)	Creates a new Vaadin session for this service and request.
static Locale	HandlerHelper.findLocale(VaadinSession session, VaadinRequest request)	Helper to find the most most suitable Locale.
UI	VaadinService.findUI(VaadinRequest request)	Finds the UI that belongs to the provided request.
VaadinSession	VaadinService.findVaadinSession(VaadinRequest request)	Attempts to find a Vaadin service session associated with this request.
abstract String	VaadinService.getContextRootRelativePath(VaadinRequest request)	Returns relative context path for given request.
String	VaadinServletService.getContextRootRelativePath(VaadinRequest request)
protected VaadinSession	VaadinService.getExistingSession(VaadinRequest request, boolean allowSessionCreation)
abstract String	VaadinService.getMainDivId(VaadinSession session, VaadinRequest request)	Creates and returns a unique ID for the DIV where the UI is to be rendered.
String	VaadinServletService.getMainDivId(VaadinSession session, VaadinRequest request)
SystemMessages	VaadinService.getSystemMessages(Locale locale, VaadinRequest request)	Gets the system message to use for a specific locale.
protected static Class<? extends UI>	BootstrapHandler.getUIClass(VaadinRequest request)	Returns the UI class mapped for servlet that handles the given request.
void	VaadinRequestInterceptor.handleException(VaadinRequest request, VaadinResponse response, VaadinSession vaadinSession, Exception t)	Called when an exception occurred
boolean	RequestHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)	Called when a request needs to be handled.
boolean	SynchronizedRequestHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	UnsupportedBrowserHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
void	VaadinService.handleRequest(VaadinRequest request, VaadinResponse response)	Handles the incoming request and writes the response into the response object.
boolean	SessionExpiredHandler.handleSessionExpired(VaadinRequest request, VaadinResponse response)	Called when the a session expiration has occurred and a notification needs to be sent to the user.
protected void	VaadinService.handleSessionExpired(VaadinRequest request, VaadinResponse response)	Called when the session has expired and the request handling is therefore aborted.
boolean	BootstrapInitialPredicate.includeInitialUidl(VaadinRequest request)	Return whether the bootstrap handler has to include initial UIDL in the response.
static boolean	BootstrapHandler.isFrameworkInternalRequest(VaadinRequest request)	Checks whether the request is an internal request.
protected boolean	BootstrapHandler.isRequestForHtml(VaadinRequest request)	Checks if the request is potentially a request for an HTML page.
static boolean	HandlerHelper.isRequestType(VaadinRequest request, HandlerHelper.RequestType requestType)	Returns whether the given request is of the given type.
static boolean	BootstrapHandler.isVaadinStaticFileRequest(VaadinRequest request)	Checks whether the request is a request for /VAADIN/*.
boolean	BootstrapUrlPredicate.isValidUrl(VaadinRequest request)	Return whether the bootstrap handler should render the page.
void	AppShellRegistry.modifyIndexHtml(org.jsoup.nodes.Document document, VaadinRequest request)	Modifies the `index.html` document based on the AppShellConfigurator annotations or AppShellConfigurator.configurePage(AppShellSettings) method.
static void	VaadinService.reinitializeSession(VaadinRequest request)	Discards the current session and creates a new session with the same contents.
protected abstract boolean	VaadinService.requestCanCreateSession(VaadinRequest request)	Checks whether it's valid to create a new service session as a result of the given request.
protected boolean	VaadinServletService.requestCanCreateSession(VaadinRequest request)
void	VaadinRequestInterceptor.requestEnd(VaadinRequest request, VaadinResponse response, VaadinSession session)	Called in the finally block of processing a request.
void	VaadinService.requestEnd(VaadinRequest request, VaadinResponse response, VaadinSession session)	Called after the framework has handled a request and the response has been written.
void	VaadinRequestInterceptor.requestStart(VaadinRequest request, VaadinResponse response)	Called when request is about to be processed.
void	VaadinService.requestStart(VaadinRequest request, VaadinResponse response)	Called before the framework starts handling a request.
void	VaadinService.setCurrentInstances(VaadinRequest request, VaadinResponse response)	Sets the this Vaadin service as the current service and also sets the current Vaadin request and Vaadin response.
boolean	BootstrapHandler.synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
abstract boolean	SynchronizedRequestHandler.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.
protected boolean	BootstrapHandler.writeErrorCodeIfRequestLocationIsInvalid(VaadinRequest request, VaadinResponse response)	Checks whether the request is for a valid location, and if not, writes the error code for the response.

Method parameters in com.vaadin.flow.server with type arguments of type VaadinRequest

Modifier and Type	Method	Description
protected BootstrapHandler.BootstrapContext	BootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> contextPathCallback)	Creates a new instance of BootstrapHandler.BootstrapContext for given request, response and ui.

Constructors in com.vaadin.flow.server with parameters of type VaadinRequest

Modifier	Constructor	Description
protected	BootstrapContext(VaadinRequest request, VaadinResponse response, VaadinSession session, UI ui, Function<VaadinRequest,String> contextCallback)	Creates a new context instance using the given parameters.
protected	BootstrapContext(VaadinRequest request, VaadinResponse response, VaadinSession session, UI ui, Function<VaadinRequest,String> contextCallback, Function<VaadinRequest,Location> routeCallback)	Creates a new context instance using the given parameters.
	SessionInitEvent(VaadinService service, VaadinSession session, VaadinRequest request)	Creates a new event.
	SystemMessagesInfo(Locale locale, VaadinRequest request, VaadinService service)	Creates an instance based on the given locale, request and service.

Constructor parameters in com.vaadin.flow.server with type arguments of type VaadinRequest

Modifier	Constructor	Description
protected	BootstrapContext(VaadinRequest request, VaadinResponse response, VaadinSession session, UI ui, Function<VaadinRequest,String> contextCallback)	Creates a new context instance using the given parameters.
protected	BootstrapContext(VaadinRequest request, VaadinResponse response, VaadinSession session, UI ui, Function<VaadinRequest,String> contextCallback, Function<VaadinRequest,Location> routeCallback)	Creates a new context instance using the given parameters.

Uses of VaadinRequest in com.vaadin.flow.server.auth

Methods in com.vaadin.flow.server.auth with parameters of type VaadinRequest

Modifier and Type	Method	Description
protected Principal	NavigationAccessControl.getPrincipal(VaadinRequest request)	Gets the principal for the currently logged in user.
protected Principal	ViewAccessChecker.getPrincipal(VaadinRequest request)	Deprecated, for removal: This API element is subject to removal in a future version. Gets the principal for the currently logged in user.
protected String	NavigationAccessControl.getRequestURL(VaadinRequest vaadinRequest)	Gets the URL the client used to make the request.
protected Predicate<String>	NavigationAccessControl.getRolesChecker(VaadinRequest request)	Gets a function for checking roles for the currently logged in user.
protected Function<String,Boolean>	ViewAccessChecker.getRolesChecker(VaadinRequest request)	Deprecated, for removal: This API element is subject to removal in a future version. Gets a function for checking roles for the currently logged in user.

Uses of VaadinRequest in com.vaadin.flow.server.communication

Methods in com.vaadin.flow.server.communication that return VaadinRequest

Modifier and Type	Method	Description
VaadinRequest	IndexHtmlResponse.getVaadinRequest()	Get the request which triggers the Index HTML response.

Methods in com.vaadin.flow.server.communication with parameters of type VaadinRequest

Modifier and Type	Method	Description
protected boolean	HeartbeatHandler.canHandleRequest(VaadinRequest request)
protected boolean	IndexHtmlRequestHandler.canHandleRequest(VaadinRequest request)
protected boolean	JavaScriptBootstrapHandler.canHandleRequest(VaadinRequest request)
protected boolean	UidlRequestHandler.canHandleRequest(VaadinRequest request)
protected boolean	WebComponentBootstrapHandler.canHandleRequest(VaadinRequest request)
protected boolean	WebComponentProvider.canHandleRequest(VaadinRequest request)
protected BootstrapHandler.BootstrapContext	JavaScriptBootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)
protected BootstrapHandler.BootstrapContext	WebComponentBootstrapHandler.createAndInitUI(Class<? extends UI> uiClass, VaadinRequest request, VaadinResponse response, VaadinSession session)
protected BootstrapHandler.BootstrapContext	JavaScriptBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)
protected BootstrapHandler.BootstrapContext	WebComponentBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)
protected void	StreamReceiverHandler.doHandleMultipartFileUpload(VaadinSession session, VaadinRequest request, VaadinResponse response, StreamReceiver streamReceiver, StateNode owner)	Streams content from a multipart request to given StreamVariable.
protected void	StreamReceiverHandler.doHandleXhrFilePost(VaadinSession session, VaadinRequest request, VaadinResponse response, StreamReceiver streamReceiver, StateNode owner, long contentLength)	Used to stream plain file post (aka XHR2.post(File))
protected String	WebComponentProvider.generateNPMResponse(String tagName, VaadinRequest request, VaadinResponse response)	Generate the npm response for the web component.
protected elemental.json.JsonObject	JavaScriptBootstrapHandler.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.
protected org.apache.commons.fileupload2.core.FileItemInputIterator	StreamReceiverHandler.getItemIterator(VaadinRequest request)
protected Collection<jakarta.servlet.http.Part>	StreamReceiverHandler.getParts(VaadinRequest request)
protected String	JavaScriptBootstrapHandler.getRequestUrl(VaadinRequest request)
protected String	WebComponentBootstrapHandler.getRequestUrl(VaadinRequest request)	Returns the request's base url to use in constructing and initialising ui.
protected static String	JavaScriptBootstrapHandler.getServiceUrl(VaadinRequest vaadinRequest)	Gets the service URL as a URL relative to the request URI.
protected String	WebComponentBootstrapHandler.getServiceUrl(VaadinRequest request, VaadinResponse response)	Returns the service url needed for initialising the UI.
boolean	FaviconHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	PushRequestHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	PwaHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	SessionRequestHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
void	StreamReceiverHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response, StreamReceiver streamReceiver, String uiId, String securityKey)	Handle reception of incoming stream from the client.
boolean	StreamRequestHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
void	StreamResourceHandler.handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response, StreamResource streamResource)	Handle sending for a stream resource request.
void	ServerRpcHandler.handleRpc(UI ui, Reader reader, VaadinRequest request)	Reads JSON containing zero or more serialized RPC calls (including legacy variable changes) and executes the calls.
boolean	HeartbeatHandler.handleSessionExpired(VaadinRequest request, VaadinResponse response)
boolean	PushRequestHandler.handleSessionExpired(VaadinRequest request, VaadinResponse response)
boolean	UidlRequestHandler.handleSessionExpired(VaadinRequest request, VaadinResponse response)
protected boolean	WebComponentBootstrapHandler.handleWebComponentResyncRequest(BootstrapHandler.BootstrapContext context, VaadinRequest request, VaadinResponse response)	Handles WebComponents resynchronization request
protected boolean	StreamReceiverHandler.isMultipartUpload(VaadinRequest request)
boolean	HeartbeatHandler.synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)	Handles a heartbeat request for the given session.
boolean	IndexHtmlRequestHandler.synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	JavaScriptBootstrapHandler.synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	UidlRequestHandler.synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	WebComponentBootstrapHandler.synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
boolean	WebComponentProvider.synchronizedHandleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)

Method parameters in com.vaadin.flow.server.communication with type arguments of type VaadinRequest

Modifier and Type	Method	Description
protected BootstrapHandler.BootstrapContext	JavaScriptBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)
protected BootstrapHandler.BootstrapContext	WebComponentBootstrapHandler.createBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)

Constructors in com.vaadin.flow.server.communication with parameters of type VaadinRequest

Modifier	Constructor	Description
	IndexHtmlResponse(VaadinRequest vaadinRequest, VaadinResponse vaadinResponse, org.jsoup.nodes.Document document)	Create a response object for client side bootstrapping.
	IndexHtmlResponse(VaadinRequest vaadinRequest, VaadinResponse vaadinResponse, org.jsoup.nodes.Document document, UI ui)	Create a response object for client side bootstrapping with UI.
	JavaScriptBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)	Creates a new context instance using the given parameters.
	RpcRequest(String jsonString, VaadinRequest request)	Creates an instance based on the given JSON received through the given request.

Constructor parameters in com.vaadin.flow.server.communication with type arguments of type VaadinRequest

Modifier	Constructor	Description
	JavaScriptBootstrapContext(VaadinRequest request, VaadinResponse response, UI ui, Function<VaadinRequest,String> callback)	Creates a new context instance using the given parameters.

Uses of VaadinRequest in com.vaadin.flow.spring

Methods in com.vaadin.flow.spring with parameters of type VaadinRequest

Modifier and Type	Method	Description
protected VaadinSession	SpringVaadinServletService.createVaadinSession(VaadinRequest request)
protected Principal	SpringViewAccessChecker.getPrincipal(VaadinRequest request)	Deprecated, for removal: This API element is subject to removal in a future version.
protected Function<String,Boolean>	SpringViewAccessChecker.getRolesChecker(VaadinRequest request)	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of VaadinRequest in com.vaadin.flow.spring.security

Methods in com.vaadin.flow.spring.security with parameters of type VaadinRequest

Modifier and Type	Method	Description
protected Principal	SpringNavigationAccessControl.getPrincipal(VaadinRequest request)
protected Predicate<String>	SpringNavigationAccessControl.getRolesChecker(VaadinRequest request)
void	VaadinRolePrefixHolder.resetRolePrefix(VaadinRequest request)	Reset role prefix from the given request.

Uses of VaadinRequest in com.vaadin.testbench.unit.mocks

Methods in com.vaadin.testbench.unit.mocks with parameters of type VaadinRequest

Modifier and Type	Method	Description
protected VaadinSession	MockSpringServletService.createVaadinSession(VaadinRequest request)
String	MockSpringServletService.getMainDivId(VaadinSession session, VaadinRequest request)