com.vaadin.flow.server

Class ServletHelper

java.lang.Object

com.vaadin.flow.server.ServletHelper

All Implemented Interfaces:

Serializable

Deprecated.

Use HandlerHelper instead

@Deprecated
public class ServletHelper
extends Object
implements Serializable

Contains helper methods for VaadinServlet and generally for handling VaadinRequests.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServletHelper.RequestType Deprecated. Framework internal enum for tracking the type of a request.

Method Summary

Modifier and Type	Method and Description
static Locale	findLocale(VaadinSession session, VaadinRequest request) Deprecated. Use HandlerHelper.findLocale(VaadinSession, VaadinRequest) instead
static String	getCancelingRelativePath(String pathToCancel) Deprecated. Use HandlerHelper.getCancelingRelativePath(String) instead
static String	getContextRootRelativePath(VaadinServletRequest request) Deprecated. Don't use this method since it's tied to VaadinServletRequest
static boolean	isRequestType(VaadinRequest request, ServletHelper.RequestType requestType) Deprecated. Use HandlerHelper.isRequestType(VaadinRequest, com.vaadin.flow.server.HandlerHelper.RequestType) instead
static void	setResponseNoCacheHeaders(BiConsumer<String,String> headerSetter, BiConsumer<String,Long> longHeaderSetter) Deprecated. Use HandlerHelper.setResponseNoCacheHeaders(BiConsumer, BiConsumer) instead

Methods inherited from class java.lang.Object

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

Method Detail

isRequestType

@Deprecated
public static boolean isRequestType(VaadinRequest request,
                                                ServletHelper.RequestType requestType)

Deprecated. Use HandlerHelper.isRequestType(VaadinRequest, com.vaadin.flow.server.HandlerHelper.RequestType) instead

Returns whether the given request is of the given type.

Parameters:

request - the request to check

requestType - the type to check for

Returns:

true if the request is of the given type, false otherwise

findLocale

@Deprecated
public static Locale findLocale(VaadinSession session,
                                            VaadinRequest request)

Deprecated. Use HandlerHelper.findLocale(VaadinSession, VaadinRequest) instead

Helper to find the most most suitable Locale. These potential sources are checked in order until a Locale is found:

1. The passed component (or UI) if not null
2. UI.getCurrent() if defined
3. The passed session if not null
4. VaadinSession.getCurrent() if defined
5. The passed request if not null
6. VaadinService.getCurrentRequest() if defined
7. Locale.getDefault()

Parameters:

session - the session that is searched for locale or null if not available

request - the request that is searched for locale or null if not available

Returns:

the found locale

setResponseNoCacheHeaders

@Deprecated
public static void setResponseNoCacheHeaders(BiConsumer<String,String> headerSetter,
                                                         BiConsumer<String,Long> longHeaderSetter)

Deprecated. Use HandlerHelper.setResponseNoCacheHeaders(BiConsumer, BiConsumer) instead

Sets no cache headers to the specified response.

Parameters:

headerSetter - setter for string value headers

longHeaderSetter - setter for long value headers

getCancelingRelativePath

@Deprecated
public static String getCancelingRelativePath(String pathToCancel)

Deprecated. Use HandlerHelper.getCancelingRelativePath(String) instead

Gets a relative path that cancels the provided path. This essentially adds one .. for each part of the path to cancel.

Parameters:

pathToCancel - the path that should be canceled

Returns:

a relative path that cancels out the provided path segment

getContextRootRelativePath

@Deprecated
public static String getContextRootRelativePath(VaadinServletRequest request)

Deprecated. Don't use this method since it's tied to VaadinServletRequest

Gets a relative path you can use to refer to the context root.

Parameters:

request - the request for which the location should be determined

Returns:

A relative path to the context root. Never ends with a slash (/).