com.vaadin.terminal.gwt.server.


Interface AbstractCommunicationManager.Request

Enclosing class:

AbstractCommunicationManager

public static interface AbstractCommunicationManager.Request

Generic interface of a (HTTP or Portlet) request to the application. This is a wrapper interface that allows AbstractCommunicationManager to use a unified API.

Author:

peholmst

See Also:

ServletRequest, PortletRequest

Method Summary
 Object getAttribute(String name)
           
 int getContentLength()
          Returns the length of the request content that can be read from the input stream returned by getInputStream().
 InputStream getInputStream()
          Returns an input stream from which the request content can be read.
 String getParameter(String name)
          Get the named HTTP or portlet request parameter.
 String getRequestID()
          Returns the request identifier that identifies the target Vaadin window for the request.
 AbstractCommunicationManager.Session getSession()
          Gets a AbstractCommunicationManager.Session wrapper implementation representing the session for which this request was sent.
 Object getWrappedRequest()
          Gets the underlying request object.
 boolean isRunningInPortlet()
          Are the applications in this session running in a portlet or directly as servlets.
 void setAttribute(String name, Object value)
           
 

Method Detail

getSession

AbstractCommunicationManager.Session getSession()

Gets a AbstractCommunicationManager.Session wrapper implementation representing the session for which this request was sent. Multiple Vaadin applications can be associated with a single session.

Returns:
Session

isRunningInPortlet

boolean isRunningInPortlet()

Are the applications in this session running in a portlet or directly as servlets.

Returns:
true if in a portlet

getParameter

String getParameter(String name)

Get the named HTTP or portlet request parameter.

Parameters:
name -
Returns:
See Also:
ServletRequest.getParameter(String), 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

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:
Throws:
IOException

getRequestID

String getRequestID()

Returns the request identifier that identifies the target Vaadin window for the request.

Returns:
String identifier for the request target window

getAttribute

Object getAttribute(String name)

See Also:
ServletRequest.getAttribute(String), PortletRequest.getAttribute(String)

setAttribute

void setAttribute(String name,
                  Object value)

See Also:
ServletRequest.setAttribute(String, Object), PortletRequest.setAttribute(String, Object)

getWrappedRequest

Object getWrappedRequest()

Gets the underlying request object. The request is typically either a ServletRequest or a PortletRequest.

Returns:
wrapped request object