Package com.vaadin.quarkus

Class QuarkusVaadinServletService

java.lang.Object

com.vaadin.flow.server.VaadinService

com.vaadin.flow.server.VaadinServletService

com.vaadin.quarkus.QuarkusVaadinServletService

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MockQuarkusServletService

public class QuarkusVaadinServletService
extends VaadinServletService

An implementation of VaadinService for Quarkus environment. This class looks up for and therefore provides an Instantiator bean. It also forwards Vaadin events to CDI listeners.

Author:

Vaadin Ltd

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.vaadin.flow.server.VaadinService

ATMOSPHERE_MISSING_ERROR, INVALID_ATMOSPHERE_VERSION_WARNING

Constructor Summary

Constructors

Constructor	Description
QuarkusVaadinServletService(QuarkusVaadinServlet servlet, DeploymentConfiguration configuration, jakarta.enterprise.inject.spi.BeanManager beanManager)

Method Summary

Modifier and Type	Method	Description
protected Executor	createDefaultExecutor()	Creates a default executor instance to use with this service.
void	fireUIInitListeners(UI ui)	Fire UI initialization event to all registered UIInitListeners.
QuarkusVaadinServlet	getServlet()	Retrieves a reference to the servlet associated with this service.
void	init()	Initializes this service.
Optional<Instantiator>	loadInstantiators()	Loads and initializes instantiators.
<T> Optional<T>	lookup(Class<T> type)	Gets an instance of a @VaadinServiceEnabled annotated bean of the given type.

Methods inherited from class com.vaadin.flow.server.VaadinServletService

constructVaadinContext, createRequestHandlers, getContextRootRelativePath, getCurrentResponse, getCurrentServletRequest, getMainDivId, getMimeType, getPwaRegistry, getResource, getResourceAsStream, getResourceInServletContext, getRouteRegistry, getServiceName, getStaticResource, requestCanCreateSession, resolveResource, setDefaultClassLoader

Methods inherited from class com.vaadin.flow.server.VaadinService

accessSession, addServiceDestroyListener, addSessionDestroyListener, addSessionInitListener, addUIInitListener, closeSession, createCriticalNotificationJSON, createCriticalNotificationJSON, createDefaultObjectMapper, createInstantiator, createSessionExpiredJSON, createUINotFoundJSON, createVaadinRequestInterceptors, createVaadinSession, destroy, ensureAccessQueuePurged, ensurePushAvailable, findUI, findVaadinSession, fireSessionDestroy, getBootstrapInitialPredicate, getBootstrapUrlPredicate, getClassLoader, getContext, getCsrfTokenAttributeName, getCurrent, getCurrentRequest, getDependencyFilters, getDeploymentConfiguration, getExecutor, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QuarkusVaadinServletService

public QuarkusVaadinServletService(QuarkusVaadinServlet servlet,
 DeploymentConfiguration configuration,
 jakarta.enterprise.inject.spi.BeanManager beanManager)

Method Details

init

public void init()
          throws ServiceException

Description copied from class: VaadinService

Initializes this service. The service should be initialized before it is used.

Overrides:

init in class VaadinService

Throws:

ServiceException - if a problem occurs when creating the service

fireUIInitListeners

public void fireUIInitListeners(UI ui)

Description copied from class: VaadinService

Fire UI initialization event to all registered UIInitListeners.

Overrides:

fireUIInitListeners in class VaadinService

Parameters:

ui - the initialized UI

createDefaultExecutor

protected Executor createDefaultExecutor()

Description copied from class: VaadinService

Creates a default executor instance to use with this service. This default implementation creates a virtual tread executor.

A custom VaadinService implementation 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 VaadinServiceInitListener and calling ServiceInitEvent.setExecutor(Executor).

Overrides:

createDefaultExecutor in class VaadinService

Returns:

a default executor instance to use, never null.

See Also:

• VaadinServiceInitListener
• ServiceInitEvent.setExecutor(Executor)

loadInstantiators

public Optional<Instantiator> loadInstantiators()
                                         throws ServiceException

Description copied from class: VaadinService

Loads 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 ServiceException will be thrown.

Overrides:

loadInstantiators in class VaadinService

Returns:

an optional instantator, or an empty optional if no instantiator found

Throws:

ServiceException - if there are multiple applicable instantiators

See Also:

• VaadinService.createInstantiator()
• Instantiator

getServlet

public QuarkusVaadinServlet getServlet()

Description copied from class: VaadinServletService

Retrieves a reference to the servlet associated with this service. Should be overridden (or otherwise intercepted) if the no-arg constructor is used to prevent NPEs.

Overrides:

getServlet in class VaadinServletService

Returns:

A reference to the VaadinServlet this service is using

lookup

public <T> Optional<T> lookup(Class<T> type)
                       throws ServiceException

Gets an instance of a @VaadinServiceEnabled annotated bean of the given type.

Type Parameters:

T - the type of the service

Parameters:

type - the required service type

Returns:

an Optional wrapping the service instance, or Optional.empty() if no bean definition exists for given type.

Throws:

ServiceException - if multiple beans exists for the given type.