PortletRequestWrapper (JSR 362 Portlet 3.0 API Specification)

java.lang.Object
- javax.portlet.filter.RenderStateWrapper
- - javax.portlet.filter.PortletRequestWrapper

All Implemented Interfaces:

PortletRequest, RenderState

Direct Known Subclasses:

ClientDataRequestWrapper, EventRequestWrapper, RenderRequestWrapper
```
public class PortletRequestWrapper
extends RenderStateWrapper
implements PortletRequest
```
The PortletRequestWrapper provides a convenient implementation of the PortletRequest interface and is extended by other request wrappers. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.

Since:

2.0

See Also:

PortletRequest

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.portlet.PortletRequest
  PortletRequest.P3PUserInfos

Field Summary
- Fields inherited from class javax.portlet.filter.RenderStateWrapper
  wrapped
- 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, HEADER_PHASE, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO

Constructor Summary

Constructors
Constructor and Description

PortletRequestWrapper(PortletRequest request)
Creates an PortletRequest adaptor wrapping the given request object.

Constructors
Constructor and Description
`PortletRequestWrapper(PortletRequest request)` Creates an `PortletRequest` adaptor wrapping the given request object.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`getAttribute(String name)` Returns the value of the named attribute as an `Object`, or `null` if no attribute of the given name exists.
`Enumeration<String>`	`getAttributeNames()` Returns an `Enumeration` containing the names of the attributes available to this request.
`String`	`getAuthType()` Returns the name of the authentication scheme used for the connection between client and portal, for example, `BASIC_AUTH`, `CLIENT_CERT_AUTH`, a custom one or `null` if there was no authentication.
`String`	`getContextPath()` Returns the context path which is the path prefix associated with the deployed portlet application.
`javax.servlet.http.Cookie[]`	`getCookies()` Returns an array containing all of the Cookie properties.
`Locale`	`getLocale()` Returns the preferred Locale in which the portal will accept content.
`Enumeration<Locale>`	`getLocales()` Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale in which the portal will accept content for this request.
`String`	`getParameter(String name)` Deprecated.
`Map<String,String[]>`	`getParameterMap()` Deprecated.
`Enumeration<String>`	`getParameterNames()` Deprecated.
`String[]`	`getParameterValues(String name)` Deprecated.
`PortalContext`	`getPortalContext()` Returns the context of the calling portal.
`PortletContext`	`getPortletContext()` Returns the `PortletContext` of the portlet application the portlet is in.
`PortletMode`	`getPortletMode()` Returns the current portlet mode of the portlet.
`PortletSession`	`getPortletSession()` Returns the current portlet session or, if there is no current session, creates one and returns the new session.
`PortletSession`	`getPortletSession(boolean create)` Returns the current portlet session or, if there is no current session and the given flag is `true`, creates one and returns the new session.
`PortletPreferences`	`getPreferences()` Returns the preferences object associated with the portlet.
`Map<String,String[]>`	`getPrivateParameterMap()` Deprecated.
`Enumeration<String>`	`getProperties(String name)` Returns all the values of the specified request property as a `Enumeration` of `String` objects.
`String`	`getProperty(String name)` Returns the value of the specified request property as a `String`.
`Enumeration<String>`	`getPropertyNames()` Returns a `Enumeration` of all the property names this request contains.
`Map<String,String[]>`	`getPublicParameterMap()` Deprecated.
`String`	`getRemoteUser()` Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
`RenderParameters`	`getRenderParameters()` Gets the render parameters.
`PortletRequest`	`getRequest()` Return the wrapped request object.
`String`	`getRequestedSessionId()` Returns the session ID indicated in the client request.
`String`	`getResponseContentType()` Returns the portal preferred content type for the response.
`Enumeration<String>`	`getResponseContentTypes()` Gets a list of content types which the portal accepts for the response.
`String`	`getScheme()` Returns the name of the scheme used to make this request.
`String`	`getServerName()` Returns the host name of the server that received the request.
`int`	`getServerPort()` Returns the port number on which this request was received.
`String`	`getUserAgent()` Returns the user agent for the request.
`Principal`	`getUserPrincipal()` Returns a java.security.Principal object containing the name of the current authenticated user.
`String`	`getWindowID()` Returns the portlet window ID.
`WindowState`	`getWindowState()` Returns the current window state of the portlet.
`boolean`	`isPortletModeAllowed(PortletMode mode)` Returns true, if the given portlet mode is a valid one to set for this portlet in the context of the current request.
`boolean`	`isRequestedSessionIdValid()` Checks whether the requested session ID is still valid.
`boolean`	`isSecure()` Returns a boolean indicating whether this request was made using a secure channel between client and the portal, such as HTTPS.
`boolean`	`isUserInRole(String role)` Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
`boolean`	`isWindowStateAllowed(WindowState state)` Returns true, if the given window state is valid to be set for this portlet in the context of the current request.
`void`	`removeAttribute(String name)` Removes an attribute from this request.
`void`	`setAttribute(String name, Object o)` Stores an attribute in this request.
`void`	`setRequest(PortletRequest request)` Sets the request object being wrapped.

Methods inherited from class javax.portlet.filter.RenderStateWrapper
getWrapped, setWrapped

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PortletRequestWrapper
```
public PortletRequestWrapper(PortletRequest request)
```
    Creates an PortletRequest adaptor wrapping the given request object.
    
    Parameters:
    
    request - the portlet request to wrap
    
    Throws:
    
    IllegalArgumentException - if the request is null
- Method Detail
  - getRequest
```
public PortletRequest getRequest()
```
    Return the wrapped request object.
    
    Returns:
    
    the wrapped request
  - setRequest
```
public void setRequest(PortletRequest request)
```
    Sets the request object being wrapped.
    
    Parameters:
    
    request - the request to set
    
    Throws:
    
    IllegalArgumentException - if the request is null.
  - getAttribute
```
public Object getAttribute(String name)
```
    Description copied from interface: PortletRequest
    
    Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
    Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, and javax.*.
    In a distributed portlet web application the Object needs to be serializable.
    
    Specified by:
    
    getAttribute in interface PortletRequest
    
    Parameters:
    
    name - a String specifying the name of the attribute
    
    Returns:
    
    an Object containing the value of the attribute, or null if the attribute does not exist.
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Description copied from interface: PortletRequest
    
    Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.
    
    Specified by:
    
    getAttributeNames in interface PortletRequest
    
    Returns:
    
    an Enumeration of strings containing the names of the request attributes, or an empty Enumeration if the request has no attributes available to it.
  - getAuthType
```
public String getAuthType()
```
    Description copied from interface: PortletRequest
    
    Returns the name of the authentication scheme used for the connection between client and portal, for example, BASIC_AUTH, CLIENT_CERT_AUTH, a custom one or null if there was no authentication.
    
    Specified by:
    
    getAuthType in interface PortletRequest
    
    Returns:
    
    one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) indicating the authentication scheme, a custom one, or null if the request was not authenticated.
  - getContextPath
```
public String getContextPath()
```
    Description copied from interface: PortletRequest
    
    Returns the context path which is the path prefix associated with the deployed portlet application. If the portlet application is rooted at the base of the web server URL namespace (also known as "default" context), this path must be an empty string. Otherwise, it must be the path the portlet application is rooted to, the path must start with a '/' and it must not end with a '/' character.
    To encode a URL the PortletResponse.encodeURL(java.lang.String) method must be used.
    
    Specified by:
    
    getContextPath in interface PortletRequest
    
    Returns:
    
    a String specifying the portion of the request URL that indicates the context of the request
    
    See Also:
    
    PortletResponse.encodeURL(java.lang.String)
  - getLocale
```
public Locale getLocale()
```
    Description copied from interface: PortletRequest
    
    Returns the preferred Locale in which the portal will accept content. The Locale may be based on the Accept-Language header of the client.
    
    Specified by:
    
    getLocale in interface PortletRequest
    
    Returns:
    
    the preferred Locale in which the portal will accept content.
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Description copied from interface: PortletRequest
    
    Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale in which the portal will accept content for this request. The Locales may be based on the Accept-Language header of the client.
    
    Specified by:
    
    getLocales in interface PortletRequest
    
    Returns:
    
    an Enumeration of Locales, in decreasing order, in which the portal will accept content for this request
  - getRenderParameters
```
public RenderParameters getRenderParameters()
```
    Description copied from interface: RenderState
    
    Gets the render parameters.
    
    Specified by:
    
    getRenderParameters in interface RenderState
    
    Overrides:
    
    getRenderParameters in class RenderStateWrapper
    
    Returns:
    
    an immutable RenderParameters object representing the private and public render parameters
    
    See Also:
    
    PortletParameters, RenderParameters
  - getParameter
```
@Deprecated
public String getParameter(String name)
```
    Deprecated.
    
    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)
  - getParameterMap
```
@Deprecated
public Map<String,String[]> getParameterMap()
```
    Deprecated.
    
    Description copied from interface: PortletRequest
    
    Returns a Map of all public and private 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[]).
  - getParameterNames
```
@Deprecated
public Enumeration<String> getParameterNames()
```
    Deprecated.
    
    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
```
@Deprecated
public String[] getParameterValues(String name)
```
    Deprecated.
    
    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)
  - getPortalContext
```
public PortalContext getPortalContext()
```
    Description copied from interface: PortletRequest
    
    Returns the context of the calling portal.
    
    Specified by:
    
    getPortalContext in interface PortletRequest
    
    Returns:
    
    the context of the calling portal
  - getPortletContext
```
public PortletContext getPortletContext()
```
    Description copied from interface: PortletRequest
    
    Returns the PortletContext of the portlet application the portlet is in.
    
    Specified by:
    
    getPortletContext in interface PortletRequest
    
    Returns:
    
    a PortletContext object, used by the caller to interact with its portlet container
    
    See Also:
    
    PortletContext
  - getPortletMode
```
public PortletMode getPortletMode()
```
    Description copied from interface: RenderState
    
    Returns the current portlet mode of the portlet.
    
    Specified by:
    
    getPortletMode in interface RenderState
    
    Overrides:
    
    getPortletMode in class RenderStateWrapper
    
    Returns:
    
    the portlet mode. If the portlet mode is not available, PortletMode.UNDEFINED is returned.
    
    See Also:
    
    PortletMode
  - getPortletSession
```
public PortletSession getPortletSession()
```
    Description copied from interface: PortletRequest
    
    Returns the current portlet session or, if there is no current session, creates one and returns the new session.
    Creating a new portlet session will result in creating a new HttpSession on which the portlet session is based.
    To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
    
    Specified by:
    
    getPortletSession in interface PortletRequest
    
    Returns:
    
    the portlet session
  - getPortletSession
```
public PortletSession getPortletSession(boolean create)
```
    Description copied from interface: PortletRequest
    
    Returns the current portlet session or, if there is no current session and the given flag is true, creates one and returns the new session.
    If the given flag is false and there is no current portlet session, this method returns null.
    Creating a new portlet session will result in creating a new HttpSession on which the portlet session is based.
    To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
    
    Specified by:
    
    getPortletSession in interface PortletRequest
    
    Parameters:
    
    create - true to create a new session,
    false to return null if there is no current session
    
    Returns:
    
    the portlet session
  - getPreferences
```
public PortletPreferences getPreferences()
```
    Description copied from interface: PortletRequest
    
    Returns the preferences object associated with the portlet.
    
    Specified by:
    
    getPreferences in interface PortletRequest
    
    Returns:
    
    the portlet preferences
  - getProperties
```
public Enumeration<String> getProperties(String name)
```
    Description copied from interface: PortletRequest
    
    Returns all the values of the specified request property as a Enumeration of String objects.
    If the request did not include any properties of the specified name, this method returns an empty Enumeration. The property name is case insensitive. You can use this method with any request property.
    
    Specified by:
    
    getProperties in interface PortletRequest
    
    Parameters:
    
    name - a String specifying the property name
    
    Returns:
    
    a Enumeration containing the values of the requested property. If the request does not have any properties of that name return an empty Enumeration.
  - getProperty
```
public String getProperty(String name)
```
    Description copied from interface: PortletRequest
    
    Returns the value of the specified request property as a String. If the request did not include a property of the specified name, this method returns null.
    A portlet can access portal/portlet-container specific properties through this method and, if available, the headers of the HTTP client request.
    This method should only be used if the property has only one value. If the property might have more than one value, use PortletRequest.getProperties(java.lang.String).
    If this method is used with a multivalued parameter, the value returned is equal to the first value in the Enumeration returned by getProperties.
    
    Specified by:
    
    getProperty in interface PortletRequest
    
    Parameters:
    
    name - a String specifying the property name
    
    Returns:
    
    a String containing the value of the requested property, or null if the request does not have a property of that name.
  - getPropertyNames
```
public Enumeration<String> getPropertyNames()
```
    Description copied from interface: PortletRequest
    
    Returns a Enumeration of all the property names this request contains. If the request has no properties, this method returns an empty Enumeration.
    
    Specified by:
    
    getPropertyNames in interface PortletRequest
    
    Returns:
    
    an Enumeration of all the property names sent with this request; if the request has no properties, an empty Enumeration.
  - getRemoteUser
```
public String getRemoteUser()
```
    Description copied from interface: PortletRequest
    
    Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
    
    Specified by:
    
    getRemoteUser in interface PortletRequest
    
    Returns:
    
    a String specifying the login of the user making this request, or null if the user login is not known.
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Description copied from interface: PortletRequest
    
    Returns the session ID indicated in the client request. This session ID may not be a valid one, it may be an old one that has expired or has been invalidated. If the client request did not specify a session ID, this method returns null.
    
    Specified by:
    
    getRequestedSessionId in interface PortletRequest
    
    Returns:
    
    a String specifying the session ID, or null if the request did not specify a session ID
    
    See Also:
    
    PortletRequest.isRequestedSessionIdValid()
  - getResponseContentType
```
public String getResponseContentType()
```
    Description copied from interface: PortletRequest
    Returns the portal preferred content type for the response.
    The following restrictions apply:
    - The content type only includes the MIME type, not the character set. The character set of the response can be retrieved via the MimeResponse.getCharacterEncoding().
    - If the portlet has defined '*' or '*/*' as supported content types in the portlet configuration, these may also be valid return values.

Specified by:: getResponseContentType in interface PortletRequest
Returns:: preferred MIME type of the response

getResponseContentTypes
```
public Enumeration<String> getResponseContentTypes()
```
Description copied from interface: PortletRequest
Gets a list of content types which the portal accepts for the response. This list is ordered with the most preferable types listed first.
The following restrictions apply:
- The content type only includes the MIME type, not the character set.
- If the portlet has defined '*' or '*/*' as supported content types in the portlet configuration, these may also be valid return values.
Specified by:

getResponseContentTypes in interface PortletRequest

Returns:

ordered list of MIME types for the response

getScheme
```
public String getScheme()
```
Description copied from interface: PortletRequest

Returns the name of the scheme used to make this request. For example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.

Specified by:

getScheme in interface PortletRequest

Returns:

a String containing the name of the scheme used to make this request

getServerName
```
public String getServerName()
```
Description copied from interface: PortletRequest

Returns the host name of the server that received the request.

Specified by:

getServerName in interface PortletRequest

Returns:

a String containing the name of the server to which the request was sent

getServerPort
```
public int getServerPort()
```
Description copied from interface: PortletRequest

Returns the port number on which this request was received.

Specified by:

getServerPort in interface PortletRequest

Returns:

an integer specifying the port number

getUserPrincipal
```
public Principal getUserPrincipal()
```
Description copied from interface: PortletRequest

Returns a java.security.Principal object containing the name of the current authenticated user.

Specified by:

getUserPrincipal in interface PortletRequest

Returns:

a java.security.Principal containing the name of the user making this request, or null if the user has not been authenticated.

getWindowID
```
public String getWindowID()
```
Description copied from interface: PortletRequest

Returns the portlet window ID. The portlet window ID is unique for this portlet window and is constant for the lifetime of the portlet window.
This ID is the same that is used by the portlet container for scoping the portlet-scope session attributes.

Specified by:

getWindowID in interface PortletRequest

Returns:

the portlet window ID

getWindowState
```
public WindowState getWindowState()
```
Description copied from interface: RenderState

Returns the current window state of the portlet.

Specified by:

getWindowState in interface RenderState

Overrides:

getWindowState in class RenderStateWrapper

Returns:

the window state. If the window state is not available, WindowState.UNDEFINED is returned.

See Also:

WindowState

isPortletModeAllowed
```
public boolean isPortletModeAllowed(PortletMode mode)
```
Description copied from interface: PortletRequest

Returns true, if the given portlet mode is a valid one to set for this portlet in the context of the current request.

Specified by:

isPortletModeAllowed in interface PortletRequest

Parameters:

mode - portlet mode to check

Returns:

true, if it is valid for this portlet in this request to change to the given portlet mode

isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
Description copied from interface: PortletRequest

Checks whether the requested session ID is still valid.

Specified by:

isRequestedSessionIdValid in interface PortletRequest

Returns:

true if this request has an id for a valid session in the current session context; false otherwise

See Also:

PortletRequest.getRequestedSessionId(), PortletRequest.getPortletSession()

isSecure
```
public boolean isSecure()
```
Description copied from interface: PortletRequest

Returns a boolean indicating whether this request was made using a secure channel between client and the portal, such as HTTPS.

Specified by:

isSecure in interface PortletRequest

Returns:

true, if the request was made using a secure channel.

isUserInRole
```
public boolean isUserInRole(String role)
```
Description copied from interface: PortletRequest

Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.

Specified by:

isUserInRole in interface PortletRequest

Parameters:

role - a String specifying the name of the role

Returns:

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated.

isWindowStateAllowed
```
public boolean isWindowStateAllowed(WindowState state)
```
Description copied from interface: PortletRequest

Returns true, if the given window state is valid to be set for this portlet in the context of the current request.

Specified by:

isWindowStateAllowed in interface PortletRequest

Parameters:

state - window state to checked

Returns:

true, if it is valid for this portlet in this request to change to the given window state

removeAttribute
```
public void removeAttribute(String name)
```
Description copied from interface: PortletRequest

Removes an attribute from this request. This method is not generally needed, as attributes only persist as long as the request is being handled.
Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.* are reserved.

Specified by:

removeAttribute in interface PortletRequest

Parameters:

name - a String specifying the name of the attribute to be removed

setAttribute
```
public void setAttribute(String name,
                         Object o)
```
Description copied from interface: PortletRequest

Stores an attribute in this request.
Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.* are reserved.
If the value passed into this method is null, the effect is the same as calling PortletRequest.removeAttribute(java.lang.String).

Specified by:

setAttribute in interface PortletRequest

Parameters:

name - a String specifying the name of the attribute

o - the Object to be stored

getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
Description copied from interface: PortletRequest

Returns an array containing all of the Cookie properties.
This method returns null if no cookies exist.

Specified by:

getCookies in interface PortletRequest

Returns:

array of cookie properties, or null if no cookies exist.

See Also:

PortletResponse.addProperty(Cookie)

getPrivateParameterMap
```
@Deprecated
public Map<String,String[]> getPrivateParameterMap()
```
Deprecated.

Description copied from interface: PortletRequest

Returns a Map of the private parameters of this request. Private parameters are all those not declared to be public parameters in the portlet deployment descriptor. They are not shared with other portlets or components. The returned parameters are "x-www-form-urlencoded" decoded.
The values in the returned Map are from type String array (String[]).
If no private parameters exist this method returns an empty Map.

Specified by:

getPrivateParameterMap in interface PortletRequest

Returns:

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

getPublicParameterMap
```
@Deprecated
public Map<String,String[]> getPublicParameterMap()
```
Deprecated.

Description copied from interface: PortletRequest

Returns a Map of the public parameters of this request. Public parameters may be shared with other portlets or components as defined in the portlet deployment descriptor with the supported-public-render-parameter element. The returned parameters are "x-www-form-urlencoded" decoded.
The values in the returned Map are from type String array (String[]).
If no public parameters exist this method returns an empty Map.

Specified by:

getPublicParameterMap in interface PortletRequest

Returns:

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

getUserAgent
```
public String getUserAgent()
```
Description copied from interface: PortletRequest

Returns the user agent for the request.

Specified by:

getUserAgent in interface PortletRequest

Returns:

The user agent string.

Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.

Class PortletRequestWrapper

Nested Class Summary

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

Field Summary

Fields inherited from class javax.portlet.filter.RenderStateWrapper

Fields inherited from interface javax.portlet.PortletRequest

Constructor Summary

Method Summary

Methods inherited from class javax.portlet.filter.RenderStateWrapper

Methods inherited from class java.lang.Object

Constructor Detail

PortletRequestWrapper

Method Detail

getRequest

setRequest

getAttribute

getAttributeNames

getAuthType

getContextPath

getLocale

getLocales

getRenderParameters

getParameter

getParameterMap

getParameterNames

getParameterValues

getPortalContext

getPortletContext

getPortletMode

getPortletSession

getPortletSession

getPreferences

getProperties

getProperty

getPropertyNames

getRemoteUser

getRequestedSessionId

getResponseContentType

getResponseContentTypes

getScheme

getServerName

getServerPort

getUserPrincipal

getWindowID

getWindowState

isPortletModeAllowed

isRequestedSessionIdValid

isSecure

isUserInRole

isWindowStateAllowed

removeAttribute

setAttribute

getCookies

getPrivateParameterMap

getPublicParameterMap

getUserAgent