org.jboss.portal.portlet.impl
Class RenderRequestImpl

java.lang.Object
  org.jboss.portal.portlet.impl.PortletRequestImpl
      org.jboss.portal.portlet.impl.RenderRequestImpl

All Implemented Interfaces:

PortletRequest, RenderRequest

Direct Known Subclasses:

JBossRenderRequest

public class RenderRequestImpl
extends PortletRequestImpl
implements RenderRequest

Field Summary

Fields inherited from class org.jboss.portal.portlet.impl.PortletRequestImpl

component, contentTypes, dreq, instance, instanceCtx, log, portalContext, preferences, psession, req, resp, sessionStatus, userContext, userInfo, window, windowCtx

Fields inherited from interface javax.portlet.PortletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH, USER_INFO

Constructor Summary

RenderRequestImpl(UserContext userContext, PortletPreferences preferences, Window window, WindowContext windowContext, PortalRequest req, PortalResponse resp, javax.servlet.http.HttpServletRequest dreq)

Method Summary

java.lang.String	getParameter(java.lang.String name) Returns the value of a request parameter as a String, or null if the parameter does not exist.
java.util.Map	getParameterMap() Returns a Map of the parameters of this request.
java.util.Enumeration	getParameterNames() Returns an Enumeration of String objects containing the names of the parameters contained in this request.
java.lang.String[]	getParameterValues(java.lang.String name) Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

Methods inherited from class org.jboss.portal.portlet.impl.PortletRequestImpl

getAttribute, getAttributeNames, getAuthType, getContextPath, getLocale, getLocales, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getProperties, getProperty, getPropertyNames, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.portlet.PortletRequest

getAttribute, getAttributeNames, getAuthType, getContextPath, getLocale, getLocales, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getProperties, getProperty, getPropertyNames, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute

Constructor Detail

RenderRequestImpl

public RenderRequestImpl(UserContext userContext,
                         PortletPreferences preferences,
                         Window window,
                         WindowContext windowContext,
                         PortalRequest req,
                         PortalResponse resp,
                         javax.servlet.http.HttpServletRequest dreq)

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String name)

Description copied from interface: PortletRequest

Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. The returned parameter are "x-www-form-urlencoded" decoded.

Only parameters targeted to the current portlet are accessible.

This method should only be used if the parameter has only one value. If the parameter might have more than one value, use PortletRequest.getParameterValues(java.lang.String).

If this method is used with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

Specified by:

getParameter in interface PortletRequest

Parameters:

name - a String specifying the name of the parameter

Returns:

a String representing the single value of the parameter

See Also:

PortletRequest.getParameterValues(java.lang.String)

getParameterNames

public java.util.Enumeration getParameterNames()

Description copied from interface: PortletRequest

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Only parameters targeted to the current portlet are returned.

Specified by:

getParameterNames in interface PortletRequest

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Description copied from interface: PortletRequest

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist. The returned parameters are "x-www-form-urlencoded" decoded.

If the parameter has a single value, the array has a length of 1.

Specified by:

getParameterValues in interface PortletRequest

Parameters:

name - a String containing the name of the parameter the value of which is requested

Returns:

an array of String objects containing the parameter values.

See Also:

PortletRequest.getParameter(java.lang.String)

getParameterMap

public java.util.Map getParameterMap()

Description copied from interface: PortletRequest

Returns a Map of the parameters of this request. Request parameters are extra information sent with the request. The returned parameters are "x-www-form-urlencoded" decoded.

The values in the returned Map are from type String array (String[]).

If no parameters exist this method returns an empty Map.

Specified by:

getParameterMap in interface PortletRequest

Returns:

an immutable Map containing parameter names as keys and parameter values as map values, or an empty Map if no parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]).