Package com.vaadin.portlet

Class VaadinPortletRequest

java.lang.Object

javax.portlet.filter.PortletRequestWrapper

com.vaadin.portlet.VaadinPortletRequest

All Implemented Interfaces:

VaadinRequest, Serializable, javax.portlet.PortletRequest

Direct Known Subclasses:

VaadinPortlet.VaadinHttpAndPortletRequest

public class VaadinPortletRequest
extends javax.portlet.filter.PortletRequestWrapper
implements VaadinRequest

Wrapper for PortletRequest and its subclasses.

Since:

7.0

Author:

Vaadin Ltd.

See Also:

VaadinRequest, VaadinPortletResponse, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.portlet.PortletRequest

javax.portlet.PortletRequest.P3PUserInfos

Field Summary

Fields inherited from interface javax.portlet.PortletRequest

ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO

Constructor Summary

Constructors

Constructor	Description
VaadinPortletRequest(javax.portlet.PortletRequest request, VaadinPortletService vaadinService)	Wraps a portlet request and an associated vaadin service.

Method Summary

Modifier and Type	Method	Description
String	getCharacterEncoding()
int	getContentLength()
String	getContentType()
static VaadinPortletRequest	getCurrent()	Gets the currently processed Vaadin portlet request.
static javax.portlet.PortletRequest	getCurrentPortletRequest()	Gets the currently processed portlet request.
long	getDateHeader(String name)
String	getHeader(String string)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String name)
InputStream	getInputStream()
String	getMethod()
String	getPathInfo()
String	getPortalProperty(String name)	Reads a portal property from the portal context of the Vaadin request.
String	getPortletPreference(String name)	Reads a portlet preference from the portlet of the request.
javax.portlet.PortletRequest	getPortletRequest()	Gets the original, unwrapped portlet request.
BufferedReader	getReader()
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
VaadinPortletService	getService()
WrappedSession	getWrappedSession()
WrappedSession	getWrappedSession(boolean allowSessionCreation)

Methods inherited from class javax.portlet.filter.PortletRequestWrapper

getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequest, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute, 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.VaadinRequest

getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getRemoteUser, getUserPrincipal, isSecure, isUserInRole, removeAttribute, setAttribute

Constructor Detail

VaadinPortletRequest

public VaadinPortletRequest(javax.portlet.PortletRequest request,
                            VaadinPortletService vaadinService)

Wraps a portlet request and an associated vaadin service.

Parameters:

request - the portlet request to wrap

vaadinService - the associated vaadin service

Method Detail

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface VaadinRequest

See Also:

ClientDataRequest.getContentLength()

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface VaadinRequest

Throws:

IOException

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface VaadinRequest

Throws:

IOException

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface VaadinRequest

getWrappedSession

public WrappedSession getWrappedSession()

Specified by:

getWrappedSession in interface VaadinRequest

See Also:

PortletRequest.getPortletSession()

getWrappedSession

public WrappedSession getWrappedSession(boolean allowSessionCreation)

Specified by:

getWrappedSession in interface VaadinRequest

See Also:

PortletRequest.getPortletSession(boolean)

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

Gets the original, unwrapped portlet request.

Returns:

the unwrapped portlet request

getContentType

public String getContentType()

Specified by:

getContentType in interface VaadinRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface VaadinRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface VaadinRequest

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface VaadinRequest

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface VaadinRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface VaadinRequest

getHeader

public String getHeader(String string)

Specified by:

getHeader in interface VaadinRequest

getPortalProperty

public String getPortalProperty(String name)

Reads a portal property from the portal context of the Vaadin request.

Parameters:

name - a string with the name of the portal property to get

Returns:

a string with the value of the property, or null if the property is not defined

getPortletPreference

public String getPortletPreference(String name)

Reads a portlet preference from the portlet of the request.

Parameters:

name - The name of the portlet preference. Cannot be null.

Returns:

The value of the portlet preference, null if the preference is not defined.

getService

public VaadinPortletService getService()

Specified by:

getService in interface VaadinRequest

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface VaadinRequest

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface VaadinRequest

getHeaders

public Enumeration<String> getHeaders(String name)

Specified by:

getHeaders in interface VaadinRequest

getCurrentPortletRequest

public static javax.portlet.PortletRequest getCurrentPortletRequest()

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

Returns:

the current portlet request instance if available, otherwise null

Since:

7.3

getCurrent

public static VaadinPortletRequest getCurrent()

Gets the currently processed Vaadin portlet 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 portlet request instance if available, otherwise null

Since:

7.3