|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.apache.pluto.wrappers.PortletRequestWrapper
public class PortletRequestWrapper
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest |
---|
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 |
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
PortletRequestWrapper(PortletRequest portletRequest)
Creates a ServletRequest adaptor wrapping the given request object. |
Method Summary | |
---|---|
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 |
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. |
Locale |
getLocale()
Returns the preferred Locale in which the portal will accept content. |
Enumeration |
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)
Returns the value of a request parameter as a String ,
or null if the parameter does not exist. |
Map |
getParameterMap()
Returns a Map of the parameters of this request. |
Enumeration |
getParameterNames()
Returns an Enumeration of String
objects containing the names of the parameters contained
in this request. |
String[] |
getParameterValues(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. |
PortalContext |
getPortalContext()
Returns the context of the calling portal. |
PortletMode |
getPortletMode()
Returns the current portlet mode of the portlet. |
PortletRequest |
getPortletRequest()
Return the wrapped ServletRequest object. |
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()
Returns a Map of the private parameters of this request. |
Enumeration |
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 |
getPropertyNames()
Returns a Enumeration of all the property names
this request contains. |
Map<String,String[]> |
getPublicParameterMap()
Returns a Map of the public parameters of this request. |
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. |
String |
getRequestedSessionId()
Returns the session ID indicated in the client request. |
String |
getResponseContentType()
Returns the portal preferred content type for the response. |
Enumeration |
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. |
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 being wrapped. |
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper |
---|
getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRequestURI, getRequestURL, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL |
Methods inherited from class javax.servlet.ServletRequestWrapper |
---|
getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, setCharacterEncoding, setRequest |
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 |
---|
getCookies |
Methods inherited from interface javax.servlet.ServletRequest |
---|
getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, setCharacterEncoding |
Constructor Detail |
---|
public PortletRequestWrapper(PortletRequest portletRequest)
IllegalArgumentException
- if the request is null.Method Detail |
---|
public boolean isWindowStateAllowed(WindowState state)
PortletRequest
isWindowStateAllowed
in interface PortletRequest
state
- window state to checked
public boolean isPortletModeAllowed(PortletMode mode)
PortletRequest
isPortletModeAllowed
in interface PortletRequest
mode
- portlet mode to check
public PortletMode getPortletMode()
PortletRequest
getPortletMode
in interface PortletRequest
public WindowState getWindowState()
PortletRequest
getWindowState
in interface PortletRequest
public PortletPreferences getPreferences()
PortletRequest
getPreferences
in interface PortletRequest
public PortletSession getPortletSession()
PortletRequest
Creating a new portlet session will result in creating
a new HttpSession
on which the portlet session is based on.
getPortletSession
in interface PortletRequest
public PortletSession getPortletSession(boolean create)
PortletRequest
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 on.
getPortletSession
in interface PortletRequest
create
- true
to create a new session, false
to return null
if there
is no current session
public String getProperty(String name)
PortletRequest
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
.
getProperty
in interface PortletRequest
name
- a String
specifying the
property name
String
containing the
value of the requested
property, or null
if the request does not
have a property of that name.public Enumeration getProperties(String name)
PortletRequest
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.
getProperties
in interface PortletRequest
name
- a String
specifying the
property name
Enumeration
containing
the values of the requested property. If
the request does not have any properties of
that name return an empty Enumeration
.public Enumeration getPropertyNames()
PortletRequest
Enumeration
of all the property names
this request contains. If the request has no
properties, this method returns an empty Enumeration
.
getPropertyNames
in interface PortletRequest
Enumeration
of all the
property names sent with this
request; if the request has
no properties, an empty Enumeration
.public PortalContext getPortalContext()
PortletRequest
getPortalContext
in interface PortletRequest
public String getAuthType()
PortletRequest
BASIC_AUTH
, CLIENT_CERT_AUTH
,
a custom one or null
if there was no authentication.
getAuthType
in interface PortletRequest
getAuthType
in interface javax.servlet.http.HttpServletRequest
getAuthType
in class javax.servlet.http.HttpServletRequestWrapper
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.public String getContextPath()
PortletRequest
To encode a URL the PortletResponse.encodeURL(java.lang.String)
method must be used.
getContextPath
in interface PortletRequest
getContextPath
in interface javax.servlet.http.HttpServletRequest
getContextPath
in class javax.servlet.http.HttpServletRequestWrapper
String
specifying the
portion of the request URL that indicates the context
of the requestPortletResponse.encodeURL(java.lang.String)
public String getRemoteUser()
PortletRequest
getRemoteUser
in interface PortletRequest
getRemoteUser
in interface javax.servlet.http.HttpServletRequest
getRemoteUser
in class javax.servlet.http.HttpServletRequestWrapper
String
specifying the login
of the user making this request, or null
if the user login is not known.public Principal getUserPrincipal()
PortletRequest
getUserPrincipal
in interface PortletRequest
getUserPrincipal
in interface javax.servlet.http.HttpServletRequest
getUserPrincipal
in class javax.servlet.http.HttpServletRequestWrapper
java.security.Principal
containing
the name of the user making this request, or
null
if the user has not been
authenticated.public boolean isUserInRole(String role)
PortletRequest
false
.
isUserInRole
in interface PortletRequest
isUserInRole
in interface javax.servlet.http.HttpServletRequest
isUserInRole
in class javax.servlet.http.HttpServletRequestWrapper
role
- a String
specifying the name
of the role
boolean
indicating whether
the user making this request belongs to a given role;
false
if the user has not been
authenticated.public Object getAttribute(String name)
PortletRequest
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.
getAttribute
in interface PortletRequest
getAttribute
in interface javax.servlet.ServletRequest
getAttribute
in class javax.servlet.ServletRequestWrapper
name
- a String
specifying the name of
the attribute
Object
containing the value
of the attribute, or null
if
the attribute does not exist.public Enumeration getAttributeNames()
PortletRequest
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.
getAttributeNames
in interface PortletRequest
getAttributeNames
in interface javax.servlet.ServletRequest
getAttributeNames
in class javax.servlet.ServletRequestWrapper
Enumeration
of strings
containing the names
of the request attributes, or an empty
Enumeration
if the request
has no attributes available to it.public String getParameter(String name)
PortletRequest
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
.
getParameter
in interface PortletRequest
getParameter
in interface javax.servlet.ServletRequest
getParameter
in class javax.servlet.ServletRequestWrapper
name
- a String
specifying the
name of the parameter
String
representing the
single value of the parameterPortletRequest.getParameterValues(java.lang.String)
public Enumeration getParameterNames()
PortletRequest
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.
getParameterNames
in interface PortletRequest
getParameterNames
in interface javax.servlet.ServletRequest
getParameterNames
in class javax.servlet.ServletRequestWrapper
Enumeration
of String
objects, each String
containing
the name of a request parameter; or an
empty Enumeration
if the
request has no parameters.public String[] getParameterValues(String name)
PortletRequest
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.
getParameterValues
in interface PortletRequest
getParameterValues
in interface javax.servlet.ServletRequest
getParameterValues
in class javax.servlet.ServletRequestWrapper
name
- a String
containing the name of
the parameter the value of which is requested
String
objects
containing the parameter values.PortletRequest.getParameter(java.lang.String)
public Map getParameterMap()
PortletRequest
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
.
getParameterMap
in interface PortletRequest
getParameterMap
in interface javax.servlet.ServletRequest
getParameterMap
in class javax.servlet.ServletRequestWrapper
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[]
).public boolean isSecure()
PortletRequest
isSecure
in interface PortletRequest
isSecure
in interface javax.servlet.ServletRequest
isSecure
in class javax.servlet.ServletRequestWrapper
public void setAttribute(String name, Object o)
PortletRequest
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)
.
setAttribute
in interface PortletRequest
setAttribute
in interface javax.servlet.ServletRequest
setAttribute
in class javax.servlet.ServletRequestWrapper
name
- a String
specifying
the name of the attributeo
- the Object
to be storedpublic void removeAttribute(String name)
PortletRequest
Attribute names should follow the same conventions as
package names. Names beginning with java.*
,
javax.*
, and com.sun.*
are
reserved.
removeAttribute
in interface PortletRequest
removeAttribute
in interface javax.servlet.ServletRequest
removeAttribute
in class javax.servlet.ServletRequestWrapper
name
- a String
specifying
the name of the attribute to be removedpublic String getRequestedSessionId()
PortletRequest
null
.
getRequestedSessionId
in interface PortletRequest
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
getRequestedSessionId
in class javax.servlet.http.HttpServletRequestWrapper
String
specifying the session
ID, or null
if the request did
not specify a session IDPortletRequest.isRequestedSessionIdValid()
public boolean isRequestedSessionIdValid()
PortletRequest
isRequestedSessionIdValid
in interface PortletRequest
isRequestedSessionIdValid
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdValid
in class javax.servlet.http.HttpServletRequestWrapper
true
if this
request has an id for a valid session
in the current session context;
false
otherwisePortletRequest.getRequestedSessionId()
,
PortletRequest.getPortletSession()
public String getResponseContentType()
PortletRequest
For ActionRequest, EventRequest
, and
RenderRequest
the following restrictions apply:
MimeResponse.getCharacterEncoding()
.'*'
or '* / *'
as supported content
types, these may also be valid return values.
getResponseContentType
in interface PortletRequest
public Enumeration getResponseContentTypes()
PortletRequest
For ActionRequest, EventRequest
, and
RenderRequest
the following restrictions apply:
'*'
or '* / *'
as supported content
types, these may also be valid return values.
getResponseContentTypes
in interface PortletRequest
public Locale getLocale()
PortletRequest
getLocale
in interface PortletRequest
getLocale
in interface javax.servlet.ServletRequest
getLocale
in class javax.servlet.ServletRequestWrapper
public Enumeration getLocales()
PortletRequest
getLocales
in interface PortletRequest
getLocales
in interface javax.servlet.ServletRequest
getLocales
in class javax.servlet.ServletRequestWrapper
public String getScheme()
PortletRequest
http
, https
, or ftp
.
Different schemes have different rules for constructing URLs,
as noted in RFC 1738.
getScheme
in interface PortletRequest
getScheme
in interface javax.servlet.ServletRequest
getScheme
in class javax.servlet.ServletRequestWrapper
String
containing the name
of the scheme used to make this requestpublic String getServerName()
PortletRequest
getServerName
in interface PortletRequest
getServerName
in interface javax.servlet.ServletRequest
getServerName
in class javax.servlet.ServletRequestWrapper
String
containing the name
of the server to which the request was sentpublic int getServerPort()
PortletRequest
getServerPort
in interface PortletRequest
getServerPort
in interface javax.servlet.ServletRequest
getServerPort
in class javax.servlet.ServletRequestWrapper
public String getWindowID()
PortletRequest
This ID is the same that is used by the portlet container for scoping the portlet-scope session attributes.
getWindowID
in interface PortletRequest
public PortletRequest getPortletRequest()
public void setRequest(PortletRequest request)
IllegalArgumentException
- if the request is null.public Map<String,String[]> getPrivateParameterMap()
PortletRequest
Map
of the private parameters of this request.
Private parameters 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
.
getPrivateParameterMap
in interface PortletRequest
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[]
).public Map<String,String[]> getPublicParameterMap()
PortletRequest
Map
of the public parameters of this request.
Public parameters may be shared with other portlets or components and
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
.
getPublicParameterMap
in interface PortletRequest
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[]
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |