Package com.vaadin.testbench.unit.mocks

Class MockSpringServletService

java.lang.Object

com.vaadin.flow.server.VaadinService

com.vaadin.flow.server.VaadinServletService

com.vaadin.flow.spring.SpringVaadinServletService

com.vaadin.testbench.unit.mocks.MockSpringServletService

All Implemented Interfaces:

Serializable

public class MockSpringServletService
extends SpringVaadinServletService

A mocking service that performs three very important tasks:

• Overrides isAtmosphereAvailable() to tell Vaadin that we don't have Atmosphere (otherwise Vaadin will crash)
• Provides some dummy value as a root ID via getMainDivId(com.vaadin.flow.server.VaadinSession, com.vaadin.flow.server.VaadinRequest) (otherwise the mocked servlet env will crash).
• Provides a MockSpringVaadinSession instead of SpringVaadinSession.

The class is intentionally opened, to be extensible in user's library.

Author:

mavi

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
MockSpringServletService(MockSpringServlet servlet, DeploymentConfiguration deploymentConfiguration, org.springframework.context.ApplicationContext ctx, com.vaadin.testbench.unit.internal.UIFactory uiFactory)
MockSpringServletService(MockSpringServlet servlet, DeploymentConfiguration deploymentConfiguration, org.springframework.context.ApplicationContext ctx, kotlin.jvm.functions.Function0<UI> uiFactory)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected VaadinSession	createVaadinSession(VaadinRequest request)	Creates a new Vaadin session for this service and request.
Instantiator	getInstantiator()	Gets the instantiator used by this service.
String	getMainDivId(VaadinSession session, VaadinRequest request)	Creates and returns a unique ID for the DIV where the UI is to be rendered.
protected boolean	isAtmosphereAvailable()	Checks whether Atmosphere is available for use.

Methods inherited from class com.vaadin.flow.spring.SpringVaadinServletService

createDefaultExecutor, getExecutor, getStaticResource, init, loadInstantiators

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

constructVaadinContext, createRequestHandlers, getContextRootRelativePath, getCurrentResponse, getCurrentServletRequest, getMimeType, getPwaRegistry, getResource, getResourceAsStream, getResourceInServletContext, getRouteRegistry, getServiceName, getServlet, 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, destroy, ensureAccessQueuePurged, ensurePushAvailable, findUI, findVaadinSession, fireSessionDestroy, fireUIInitListeners, getBootstrapInitialPredicate, getBootstrapUrlPredicate, getClassLoader, getContext, getCsrfTokenAttributeName, getCurrent, getCurrentRequest, getDependencyFilters, getDeploymentConfiguration, getExistingSession, getRequestHandlers, getRouter, getSessionAttributeName, getSessionLock, getSystemMessages, getSystemMessagesProvider, getVaadinRequestInterceptors, handleRequest, handleSessionExpired, 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

MockSpringServletService

@Deprecated(forRemoval=true)
public MockSpringServletService(@NotNull
 MockSpringServlet servlet,
 @NotNull
 DeploymentConfiguration deploymentConfiguration,
 @NotNull
 org.springframework.context.ApplicationContext ctx,
 @NotNull
 kotlin.jvm.functions.Function0<UI> uiFactory)

Deprecated, for removal: This API element is subject to removal in a future version.

MockSpringServletService

public MockSpringServletService(@NotNull
 MockSpringServlet servlet,
 @NotNull
 DeploymentConfiguration deploymentConfiguration,
 @NotNull
 org.springframework.context.ApplicationContext ctx,
 @NotNull
 com.vaadin.testbench.unit.internal.UIFactory uiFactory)

Method Details

isAtmosphereAvailable

protected boolean isAtmosphereAvailable()

Description copied from class: VaadinService

Checks whether Atmosphere is available for use.

Overrides:

isAtmosphereAvailable in class VaadinService

Returns:

true if Atmosphere is available, false otherwise

getMainDivId

public String getMainDivId(VaadinSession session,
 VaadinRequest request)

Description copied from class: VaadinService

Creates and returns a unique ID for the DIV where the UI is to be rendered.

Overrides:

getMainDivId in class VaadinServletService

Parameters:

session - The service session to which the bootstrapped UI will belong.

request - The request for which a div id is needed

Returns:

the id to use in the DOM

createVaadinSession

protected VaadinSession createVaadinSession(VaadinRequest request)

Description copied from class: VaadinService

Creates a new Vaadin session for this service and request.

Overrides:

createVaadinSession in class SpringVaadinServletService

Parameters:

request - The request for which to create a VaadinSession

Returns:

A new VaadinSession

getInstantiator

public Instantiator getInstantiator()

Description copied from class: VaadinService

Gets the instantiator used by this service.

Overrides:

getInstantiator in class VaadinService

Returns:

the used instantiator, or null if this service has not yet been initialized

See Also:

• VaadinService.createInstantiator()
• Instantiator