Package com.vaadin.server

Class VaadinServletRequest

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

com.vaadin.server.VaadinServletRequest

All Implemented Interfaces:

VaadinRequest, java.io.Serializable, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class VaadinServletRequest
extends javax.servlet.http.HttpServletRequestWrapper
implements VaadinRequest

Wrapper for HttpServletRequest.

Since:

7.0

Author:

Vaadin Ltd.

See Also:

VaadinRequest, VaadinServletResponse, Serialized Form

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
VaadinServletRequest(javax.servlet.http.HttpServletRequest request, VaadinServletService vaadinService)	Wraps a http servlet request and associates with a vaadin service.

Method Summary

Modifier and Type	Method	Description
static VaadinServletRequest	getCurrent()	Gets the currently processed Vaadin servlet request.
javax.servlet.http.HttpServletRequest	getHttpServletRequest()	Gets the original, unwrapped HTTP servlet request.
VaadinServletService	getService()	Gets the vaadin service for the context of this request.
WrappedSession	getWrappedSession()	Gets the session associated with this request, creating a new if there is no session.
WrappedSession	getWrappedSession(boolean allowSessionCreation)	Gets the session associated with this request, optionally creating a new if there is no session.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Methods inherited from interface com.vaadin.server.VaadinRequest

getAttribute, getAttributeNames, getAuthType, getCharacterEncoding, getContentLength, getContentType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getInputStream, getLocale, getLocales, getMethod, getParameter, getParameterMap, getPathInfo, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getUserPrincipal, isSecure, isUserInRole, removeAttribute, setAttribute

Constructor Detail

VaadinServletRequest

public VaadinServletRequest(javax.servlet.http.HttpServletRequest request,
                            VaadinServletService vaadinService)

Wraps a http servlet request and associates with a vaadin service.

Parameters:

request - the http servlet request to wrap

vaadinService - the associated vaadin service

Method Detail

getWrappedSession

public WrappedSession getWrappedSession()

Description copied from interface: VaadinRequest

Gets the session associated with this request, creating a new if there is no session.

Specified by:

getWrappedSession in interface VaadinRequest

Returns:

the wrapped session for this request

See Also:

WrappedSession, HttpServletRequest.getSession()

getWrappedSession

public WrappedSession getWrappedSession(boolean allowSessionCreation)

Description copied from interface: VaadinRequest

Gets the session associated with this request, optionally creating a new if there is no session.

Specified by:

getWrappedSession in interface VaadinRequest

Parameters:

allowSessionCreation - true to create a new session for this request if necessary; false to return null if there's no current session

Returns:

the wrapped session for this request

See Also:

WrappedSession, HttpServletRequest.getSession(boolean), "PortletRequest#getPortletSession(boolean)"

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Gets the original, unwrapped HTTP servlet request.

Returns:

the servlet request

getService

public VaadinServletService getService()

Description copied from interface: VaadinRequest

Gets the vaadin service for the context of this request.

Specified by:

getService in interface VaadinRequest

Returns:

the vaadin service

See Also:

VaadinService

getCurrent

public static VaadinServletRequest getCurrent()

Gets the currently processed Vaadin servlet request. The current request is automatically defined when the request is started. The current request can not be used in e.g. background threads because of the way server implementations reuse request instances.

Returns:

the current Vaadin servlet request instance if available, otherwise null

Since:

8.1