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.spring.
Package com.vaadin.flow.spring
Class SpringVaadinServletService
java.lang.Object
com.vaadin.flow.server.VaadinService
com.vaadin.flow.server.VaadinServletService
com.vaadin.flow.spring.SpringVaadinServletService
All Implemented Interfaces:
Direct Known Subclasses:
Spring application context aware Vaadin servlet service implementation.
Author:
Vaadin Ltd
See Also:
-
Field Summary
Fields inherited from class com.vaadin.flow.server.VaadinService
ATMOSPHERE_MISSING_ERROR, INVALID_ATMOSPHERE_VERSION_WARNING -
Constructor Summary
ConstructorsConstructorDescriptionSpringVaadinServletService(VaadinServlet servlet, DeploymentConfiguration deploymentConfiguration, org.springframework.context.ApplicationContext context) Creates an instance connected to the given servlet and using the given configuration with provided application
context. -
Method Summary
Modifier and TypeMethodDescriptionprotected ExecutorCreates a default executor instance to use with this service.
protected VaadinSessioncreateVaadinSession(VaadinRequest request) Creates a new Vaadin session for this service and request.
Gets the executor instance used by Vaadin for managing concurrent tasks.
getStaticResource(String path) Returns a URL to the static resource at the given URI or null if no file found.
voidinit()Initializes this service.
protected Optional<Instantiator>Loads and initializes instantiators.
Methods inherited from class com.vaadin.flow.server.VaadinServletService
constructVaadinContext, createRequestHandlers, getContextRootRelativePath, getCurrentResponse, getCurrentServletRequest, getMainDivId, getMimeType, getPwaRegistry, getResource, getResourceAsStream, getResourceInServletContext, getRouteRegistry, getServiceName, getServlet, requestCanCreateSession, resolveResource, setDefaultClassLoaderMethods inherited from class com.vaadin.flow.server.VaadinService
accessSession, addServiceDestroyListener, addSessionDestroyListener, addSessionInitListener, addUIInitListener, closeSession, createCriticalNotificationJSON, createCriticalNotificationJSON, createDefaultObjectMapper, createInstantiator, createSessionExpiredJSON, createUINotFoundJSON, createVaadinRequestInterceptors, destroy, ensureAccessQueuePurged, ensurePushAvailable, findUI, findVaadinSession, fireSessionDestroy, fireUIInitListeners, getBootstrapInitialPredicate, getBootstrapUrlPredicate, getClassLoader, getContext, getCsrfTokenAttributeName, getCurrent, getCurrentRequest, getDependencyFilters, getDeploymentConfiguration, getExistingSession, getInstantiator, getRequestHandlers, getRouter, getSessionAttributeName, getSessionLock, getSystemMessages, getSystemMessagesProvider, getVaadinRequestInterceptors, handleRequest, handleSessionExpired, isAtmosphereAvailable, isCsrfTokenValid, isOtherSessionLocked, isResourceAvailable, isUIActive, loadSession, lockSession, modifyIndexHtmlResponse, readFromHttpSession, reinitializeSession, removeFromHttpSession, removeSession, requestEnd, requestStart, runPendingAccessTasks, setBootstrapInitialPredicate, setBootstrapUrlPredicate, setClassLoader, setCurrent, setCurrentInstances, setSystemMessagesProvider, storeSession, unlockSession, verifyNoOtherSessionLocked, writeStringResponse, writeToHttpSession, writeUncachedStringResponse
-
Constructor Details
-
SpringVaadinServletService
public SpringVaadinServletService(VaadinServlet servlet, DeploymentConfiguration deploymentConfiguration, org.springframework.context.ApplicationContext context) Creates an instance connected to the given servlet and using the given configuration with provided application
context.Parameters:
servlet- the servlet which receives requestsdeploymentConfiguration- the configuration to usecontext- the Spring application context
-
-
Method Details
-
loadInstantiators
Description copied from class:
VaadinServiceLoads and initializes instantiators.
A custom Vaadin service implementation can override this method to pick an instantiator in some other way instead of the default implementation that uses
ServiceLoader.There may be only one applicable instantiator. Otherwise
ServiceExceptionwill be thrown.Overrides:
loadInstantiatorsin classVaadinServiceReturns:
an optional instantator, or an empty optional if no instantiator found
Throws:
ServiceException- if there are multiple applicable instantiatorsSee Also:
-
createDefaultExecutor
Description copied from class:
VaadinServiceCreates a default executor instance to use with this service.
This default implementation creates a thread pool executor with a custom thread factory to generate daemon threads. It uses a core pool size of 8, an unbounded maximum pool size, and a keep-alive time of 60 seconds for idle threads. The thread pool grows dynamically as required, and idle core threads are allowed to time out.
A custom
VaadinServiceimplementation can override this method to provide its own ad-hoc executor tailored to specific environments like CDI or Spring.Implementors should never return null; if an executor instance cannot be provided, the method should call
super.createDefaultExecutor().The application can provide a more appropriate executor implementation through a
VaadinServiceInitListenerand callingServiceInitEvent.setExecutor(Executor).Overrides:
createDefaultExecutorin classVaadinServiceReturns:
a default executor instance to use, never null.
See Also:
-
getExecutor
Description copied from class:
VaadinServiceGets the executor instance used by Vaadin for managing concurrent tasks.
By default, a thread pool executor with a custom with core pool size of 8, an unbounded maximum pool size, and a keep-alive time of 60 seconds for idle threads is provided. The thread pool grows dynamically as required, and idle core threads are allowed to time out.
VaadinServiceimplementations for specific environments like CDI or Spring might provide their own ad-hoc Executors tailored to those environments.A custom executor can be configured by registering a
VaadinServiceInitListenerand providing the executor instance to theServiceInitEvent.A Vaadin application can also benefit from this executor to submit asynchronous tasks.
Overrides:
getExecutorin classVaadinServiceReturns:
the Executor instance, never null.
See Also:
-
init
Description copied from class:
VaadinServiceInitializes this service. The service should be initialized before it is used.
Overrides:
initin classVaadinServiceThrows:
ServiceException- if a problem occurs when creating the service -
createVaadinSession
Description copied from class:
VaadinServiceCreates a new Vaadin session for this service and request.
Overrides:
createVaadinSessionin classVaadinServiceParameters:
request- The request for which to create a VaadinSessionReturns:
A new VaadinSession
-
getStaticResource
Description copied from class:
VaadinServiceReturns a URL to the static resource at the given URI or null if no file found.
Overrides:
getStaticResourcein classVaadinServletServiceParameters:
path- the URL for the resourceReturns:
the resource located at the named path, or
nullif there is no resource at that path
-