com.vaadin.terminal.gwt.server
Class WrappedHttpServletRequest

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

All Implemented Interfaces:

WrappedRequest, Serializable, HttpServletRequest, ServletRequest

public class WrappedHttpServletRequest
extends 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.terminal.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(HttpServletRequest request, DeploymentConfiguration deploymentConfiguration)
Wraps a http servlet request and associates with a deployment configuration

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.
DeploymentConfiguration	getDeploymentConfiguration() Gets the deployment configuration for the context of this request.
HttpServletRequest	getHttpServletRequest() Gets the original, unwrapped HTTP servlet request.
String	getRequestPathInfo() Gets the path of the requested resource relative to the application.
Object	getSessionAttribute(String name) Gets an attribute from the session associated with this request.
int	getSessionMaxInactiveInterval() Returns the maximum time interval, in seconds, that the session associated with this request will be kept open between client accesses.
void	setSessionAttribute(String name, Object attribute) Saves an attribute value in 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.terminal.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(HttpServletRequest request,
                                 DeploymentConfiguration deploymentConfiguration)

Wraps a http servlet request and associates with a deployment configuration

Parameters:

request - the http servlet request to wrap

deploymentConfiguration - the associated deployment configuration

Method Detail

getRequestPathInfo

public 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()

getSessionMaxInactiveInterval

public int getSessionMaxInactiveInterval()

Description copied from interface: WrappedRequest

Returns the maximum time interval, in seconds, that the session associated with this request will be kept open between client accesses.

Specified by:

getSessionMaxInactiveInterval in interface WrappedRequest

Returns:

an integer specifying the number of seconds the session associated with this request remains open between client requests

See Also:

HttpSession.getMaxInactiveInterval(), javax.portlet.PortletSession#getMaxInactiveInterval()

getSessionAttribute

public Object getSessionAttribute(String name)

Description copied from interface: WrappedRequest

Gets an attribute from the session associated with this request.

Specified by:

getSessionAttribute in interface WrappedRequest

Parameters:

name - the name of the attribute

Returns:

the attribute value, or null if the attribute is not defined in the session

See Also:

HttpSession.getAttribute(String), javax.portlet.PortletSession#getAttribute(String)

setSessionAttribute

public void setSessionAttribute(String name,
                                Object attribute)

Description copied from interface: WrappedRequest

Saves an attribute value in the session associated with this request.

Specified by:

setSessionAttribute in interface WrappedRequest

Parameters:

name - the name of the attribute

attribute - the attribute value

See Also:

HttpSession.setAttribute(String, Object), javax.portlet.PortletSession#setAttribute(String, Object)

getHttpServletRequest

public HttpServletRequest getHttpServletRequest()

Gets the original, unwrapped HTTP servlet request.

Returns:

the servlet request

getDeploymentConfiguration

public DeploymentConfiguration getDeploymentConfiguration()

Description copied from interface: WrappedRequest

Gets the deployment configuration for the context of this request.

Specified by:

getDeploymentConfiguration in interface WrappedRequest

Returns:

the deployment configuration

See Also:

DeploymentConfiguration

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 when Application.getRoot(com.vaadin.terminal.WrappedRequest) is called again after throwing RootRequiresMoreInformationException or in Root.init(WrappedRequest) for a Root class not annotated with EagerInit

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:

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