com.vaadin.server
Class WrappedHttpServletRequest

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper
          com.vaadin.server.WrappedHttpServletRequest

All Implemented Interfaces:

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

public class WrappedHttpServletRequest
extends javax.servlet.http.HttpServletRequestWrapper
implements WrappedRequest

Wrapper for HttpServletRequest.

Since:

7.0

Author:

Vaadin Ltd.

See Also:

WrappedRequest, WrappedHttpServletResponse, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.WrappedRequest

WrappedRequest.BrowserDetails

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

WrappedHttpServletRequest(javax.servlet.http.HttpServletRequest request, VaadinServlet.ServletService vaadinService)
Wraps a http servlet request and associates with a vaadin service

Method Summary

static WrappedHttpServletRequest	cast(WrappedRequest request) Helper method to get a WrappedHttpServletRequest from a WrappedRequest.
WrappedRequest.BrowserDetails	getBrowserDetails() Gets detailed information about the browser from which the request originated.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Gets the original, unwrapped HTTP servlet request.
java.lang.String	getRequestPathInfo() Gets the path of the requested resource relative to the application.
VaadinServlet.ServletService	getVaadinService() Gets the vaadin service for the context of this request.
WrappedSession	getWrappedSession() Gets the session associated with this request.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

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

Methods inherited from class javax.servlet.ServletRequestWrapper

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.WrappedRequest

getAttribute, getContentLength, getContentType, getHeader, getInputStream, getLocale, getParameter, getParameterMap, getRemoteAddr, isSecure, setAttribute

Methods inherited from interface javax.servlet.ServletRequest

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

Constructor Detail

WrappedHttpServletRequest

public WrappedHttpServletRequest(javax.servlet.http.HttpServletRequest request,
                                 VaadinServlet.ServletService 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

getRequestPathInfo

public java.lang.String getRequestPathInfo()

Description copied from interface: WrappedRequest

Gets the path of the requested resource relative to the application. The path be null if no path information is available. Does always start with / if the path isn't null.

Specified by:

getRequestPathInfo in interface WrappedRequest

Returns:

a string with the path relative to the application.

See Also:

HttpServletRequest.getPathInfo()

getWrappedSession

public WrappedSession getWrappedSession()

Description copied from interface: WrappedRequest

Gets the session associated with this request.

Specified by:

getWrappedSession in interface WrappedRequest

Returns:

the wrapped session for this request

See Also:

WrappedSession, HttpServletRequest.getSession(), PortletRequest.getPortletSession()

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Gets the original, unwrapped HTTP servlet request.

Returns:

the servlet request

getVaadinService

public VaadinServlet.ServletService getVaadinService()

Description copied from interface: WrappedRequest

Gets the vaadin service for the context of this request.

Specified by:

getVaadinService in interface WrappedRequest

Returns:

the vaadin service

See Also:

VaadinService

getBrowserDetails

public WrappedRequest.BrowserDetails getBrowserDetails()

Description copied from interface: WrappedRequest

Gets detailed information about the browser from which the request originated. This consists of information that is not available from normal HTTP requests, but requires additional information to be extracted for instance using javascript in the browser. This information is only guaranteed to be available in some special cases, for instance in UI.init(WrappedRequest).

Specified by:

getBrowserDetails in interface WrappedRequest

Returns:

the browser details, or null if details are not available

See Also:

WrappedRequest.BrowserDetails

cast

public static WrappedHttpServletRequest cast(WrappedRequest request)

Helper method to get a WrappedHttpServletRequest from a WrappedRequest. Aside from casting, this method also takes care of situations where there's another level of wrapping.

Parameters:

request - a wrapped request

Returns:

a wrapped http servlet request

Throws:

java.lang.ClassCastException - if the wrapped request doesn't wrap a http servlet request