com.vaadin.terminal
Interface WrappedRequest

All Superinterfaces:

Serializable

All Known Implementing Classes:

CombinedRequest, WrappedHttpServletRequest, WrappedPortletRequest

public interface WrappedRequest
extends Serializable

A generic request to the server, wrapping a more specific request type, e.g. HttpServletReqest or PortletRequest.

Since:

7.0

Nested Class Summary

static interface

WrappedRequest.BrowserDetails Detailed information extracted from the browser.

Method Summary

Object	getAttribute(String name) Gets a request attribute.
WrappedRequest.BrowserDetails	getBrowserDetails() Gets detailed information about the browser from which the request originated.
int	getContentLength() Returns the length of the request content that can be read from the input stream returned by getInputStream().
String	getContentType() Returns the MIME type of the body of the request, or null if the type is not known.
DeploymentConfiguration	getDeploymentConfiguration() Gets the deployment configuration for the context of this request.
String	getHeader(String headerName) Gets the value of a request header, e.g.
InputStream	getInputStream() Returns an input stream from which the request content can be read.
Locale	getLocale() Gets locale information from the query, e.g.
String	getParameter(String parameter) Gets the named request parameter This is typically a HTTP GET or POST parameter, though other request types might have other ways of representing parameters.
Map<String,String[]>	getParameterMap() Gets all the parameters of the request.
String	getRemoteAddr() Returns the IP address from which the request came.
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.
boolean	isSecure() Checks whether the request was made using a secure channel, e.g.
void	setAttribute(String name, Object value) Defines a request attribute.
void	setSessionAttribute(String name, Object attribute) Saves an attribute value in the session associated with this request.

Method Detail

getParameter

String getParameter(String parameter)

Gets the named request parameter This is typically a HTTP GET or POST parameter, though other request types might have other ways of representing parameters.

Parameters:

parameter - the name of the parameter

Returns:

The paramter value, or null if no parameter with the given name is present

See Also:

ServletRequest.getParameter(String), javax.portlet.PortletRequest#getParameter(String)

getParameterMap

Map<String,String[]> getParameterMap()

Gets all the parameters of the request.

Returns:

A mapping of parameter names to arrays of parameter values

See Also:

getParameter(String), ServletRequest.getParameterMap(), javax.portlet.PortletRequest#getParameter(String)

getContentLength

int getContentLength()

Returns the length of the request content that can be read from the input stream returned by getInputStream().

Returns:

content length in bytes

See Also:

ServletRequest.getContentLength(), javax.portlet.ClientDataRequest#getContentLength()

getInputStream

InputStream getInputStream()
                           throws IOException

Returns an input stream from which the request content can be read. The request content length can be obtained with getContentLength() without reading the full stream contents.

Returns:

the input stream from which the contents of the request can be read

Throws:

IOException - if the input stream can not be opened

See Also:

ServletRequest.getInputStream(), javax.portlet.ClientDataRequest#getPortletInputStream()

getAttribute

Object getAttribute(String name)

Gets a request attribute.

Parameters:

name - the name of the attribute

Returns:

the value of the attribute, or null if there is no attribute with the given name

See Also:

ServletRequest.getAttribute(String), javax.portlet.PortletRequest#getAttribute(String)

setAttribute

void setAttribute(String name,
                  Object value)

Defines a request attribute.

Parameters:

name - the name of the attribute

value - the attribute value

See Also:

ServletRequest.setAttribute(String, Object), javax.portlet.PortletRequest#setAttribute(String, Object)

getRequestPathInfo

String getRequestPathInfo()

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.

Returns:

a string with the path relative to the application.

See Also:

HttpServletRequest.getPathInfo()

getSessionMaxInactiveInterval

int getSessionMaxInactiveInterval()

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

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

Object getSessionAttribute(String name)

Gets an attribute from the session associated with this request.

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

void setSessionAttribute(String name,
                         Object attribute)

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

Parameters:

name - the name of the attribute

attribute - the attribute value

See Also:

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

getContentType

String getContentType()

Returns the MIME type of the body of the request, or null if the type is not known.

Returns:

a string containing the name of the MIME type of the request, or null if the type is not known

See Also:

ServletRequest.getContentType(), javax.portlet.ResourceRequest#getContentType()

getBrowserDetails

WrappedRequest.BrowserDetails getBrowserDetails()

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

Returns:

the browser details, or null if details are not available

See Also:

WrappedRequest.BrowserDetails

getLocale

Locale getLocale()

Gets locale information from the query, e.g. using the Accept-Language header.

Returns:

the preferred Locale

See Also:

ServletRequest.getLocale(), PortletRequest#getLocale()

getRemoteAddr

String getRemoteAddr()

Returns the IP address from which the request came. This might also be the address of a proxy between the server and the original requester.

Returns:

a string containing the IP address, or null if the address is not available

See Also:

ServletRequest.getRemoteAddr()

isSecure

boolean isSecure()

Checks whether the request was made using a secure channel, e.g. using https.

Returns:

a boolean indicating if the request is secure

See Also:

ServletRequest.isSecure(), PortletRequest#isSecure()

getHeader

String getHeader(String headerName)

Gets the value of a request header, e.g. a http header for a HttpServletRequest.

Parameters:

headerName - the name of the header

Returns:

the header value, or null if the header is not present in the request

See Also:

HttpServletRequest.getHeader(String)

getDeploymentConfiguration

DeploymentConfiguration getDeploymentConfiguration()

Gets the deployment configuration for the context of this request.

Returns:

the deployment configuration

See Also:

DeploymentConfiguration