|
||||||||||
| 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 | |
|---|---|
java.lang.Object |
getAttribute(java.lang.String name)
Returns the value of the named attribute as an Object,
or null if no attribute of the given name exists. |
java.util.Enumeration |
getAttributeNames()
Returns an Enumeration containing the
names of the attributes available to this request. |
java.lang.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. |
java.lang.String |
getContextPath()
Returns the context path which is the path prefix associated with the deployed portlet application. |
java.util.Locale |
getLocale()
Returns the preferred Locale in which the portal will accept content. |
java.util.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. |
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. |
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. |
java.util.Map<java.lang.String,java.lang.String[]> |
getPrivateParameterMap()
Returns a Map of the private parameters of this request. |
java.util.Enumeration |
getProperties(java.lang.String name)
Returns all the values of the specified request property as a Enumeration of String objects. |
java.lang.String |
getProperty(java.lang.String name)
Returns the value of the specified request property as a String. |
java.util.Enumeration |
getPropertyNames()
Returns a Enumeration of all the property names
this request contains. |
java.util.Map<java.lang.String,java.lang.String[]> |
getPublicParameterMap()
Returns a Map of the public parameters of this request. |
java.lang.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. |
java.lang.String |
getRequestedSessionId()
Returns the session ID indicated in the client request. |
java.lang.String |
getResponseContentType()
Returns the portal preferred content type for the response. |
java.util.Enumeration |
getResponseContentTypes()
Gets a list of content types which the portal accepts for the response. |
java.lang.String |
getScheme()
Returns the name of the scheme used to make this request. |
java.lang.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. |
java.security.Principal |
getUserPrincipal()
Returns a java.security.Principal object containing the name of the current authenticated user. |
java.lang.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(java.lang.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(java.lang.String name)
Removes an attribute from this request. |
void |
setAttribute(java.lang.String name,
java.lang.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)
java.lang.IllegalArgumentException - if the request is null.| Method Detail |
|---|
public boolean isWindowStateAllowed(WindowState state)
PortletRequest
isWindowStateAllowed in interface PortletRequeststate - window state to checked
public boolean isPortletModeAllowed(PortletMode mode)
PortletRequest
isPortletModeAllowed in interface PortletRequestmode - portlet mode to check
public PortletMode getPortletMode()
PortletRequest
getPortletMode in interface PortletRequestpublic WindowState getWindowState()
PortletRequest
getWindowState in interface PortletRequestpublic PortletPreferences getPreferences()
PortletRequest
getPreferences in interface PortletRequestpublic 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 PortletRequestpublic PortletSession getPortletSession(boolean create)
PortletRequesttrue, 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 PortletRequestcreate - true to create a new session, false to return null if there
is no current session
public java.lang.String getProperty(java.lang.String name)
PortletRequestString. 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 PortletRequestname - 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 java.util.Enumeration getProperties(java.lang.String name)
PortletRequestEnumeration 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 PortletRequestname - 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 java.util.Enumeration getPropertyNames()
PortletRequestEnumeration of all the property names
this request contains. If the request has no
properties, this method returns an empty Enumeration.
getPropertyNames in interface PortletRequestEnumeration 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 PortletRequestpublic java.lang.String getAuthType()
PortletRequestBASIC_AUTH, CLIENT_CERT_AUTH,
a custom one or null if there was no authentication.
getAuthType in interface PortletRequestgetAuthType in interface javax.servlet.http.HttpServletRequestgetAuthType in class javax.servlet.http.HttpServletRequestWrapperBASIC_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 java.lang.String getContextPath()
PortletRequest
To encode a URL the PortletResponse.encodeURL(java.lang.String) method must be used.
getContextPath in interface PortletRequestgetContextPath in interface javax.servlet.http.HttpServletRequestgetContextPath in class javax.servlet.http.HttpServletRequestWrapperString specifying the
portion of the request URL that indicates the context
of the requestPortletResponse.encodeURL(java.lang.String)public java.lang.String getRemoteUser()
PortletRequest
getRemoteUser in interface PortletRequestgetRemoteUser in interface javax.servlet.http.HttpServletRequestgetRemoteUser in class javax.servlet.http.HttpServletRequestWrapperString specifying the login
of the user making this request, or null
if the user login is not known.public java.security.Principal getUserPrincipal()
PortletRequest
getUserPrincipal in interface PortletRequestgetUserPrincipal in interface javax.servlet.http.HttpServletRequestgetUserPrincipal in class javax.servlet.http.HttpServletRequestWrapperjava.security.Principal containing
the name of the user making this request, or
null if the user has not been
authenticated.public boolean isUserInRole(java.lang.String role)
PortletRequestfalse.
isUserInRole in interface PortletRequestisUserInRole in interface javax.servlet.http.HttpServletRequestisUserInRole in class javax.servlet.http.HttpServletRequestWrapperrole - 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 java.lang.Object getAttribute(java.lang.String name)
PortletRequestObject,
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 PortletRequestgetAttribute in interface javax.servlet.ServletRequestgetAttribute in class javax.servlet.ServletRequestWrappername - a String specifying the name of
the attribute
Object containing the value
of the attribute, or null if
the attribute does not exist.public java.util.Enumeration getAttributeNames()
PortletRequestEnumeration 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 PortletRequestgetAttributeNames in interface javax.servlet.ServletRequestgetAttributeNames in class javax.servlet.ServletRequestWrapperEnumeration of strings
containing the names
of the request attributes, or an empty
Enumeration if the request
has no attributes available to it.public java.lang.String getParameter(java.lang.String name)
PortletRequestString,
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 PortletRequestgetParameter in interface javax.servlet.ServletRequestgetParameter in class javax.servlet.ServletRequestWrappername - a String specifying the
name of the parameter
String representing the
single value of the parameterPortletRequest.getParameterValues(java.lang.String)public java.util.Enumeration getParameterNames()
PortletRequestEnumeration 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 PortletRequestgetParameterNames in interface javax.servlet.ServletRequestgetParameterNames in class javax.servlet.ServletRequestWrapperEnumeration of String
objects, each String containing
the name of a request parameter; or an
empty Enumeration if the
request has no parameters.public java.lang.String[] getParameterValues(java.lang.String name)
PortletRequestString 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 PortletRequestgetParameterValues in interface javax.servlet.ServletRequestgetParameterValues in class javax.servlet.ServletRequestWrappername - 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 java.util.Map getParameterMap()
PortletRequestMap 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 PortletRequestgetParameterMap in interface javax.servlet.ServletRequestgetParameterMap in class javax.servlet.ServletRequestWrapperMap 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 PortletRequestisSecure in interface javax.servlet.ServletRequestisSecure in class javax.servlet.ServletRequestWrapper
public void setAttribute(java.lang.String name,
java.lang.Object o)
PortletRequestAttribute 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 PortletRequestsetAttribute in interface javax.servlet.ServletRequestsetAttribute in class javax.servlet.ServletRequestWrappername - a String specifying
the name of the attributeo - the Object to be storedpublic void removeAttribute(java.lang.String name)
PortletRequestAttribute names should follow the same conventions as
package names. Names beginning with java.*,
javax.*, and com.sun.* are
reserved.
removeAttribute in interface PortletRequestremoveAttribute in interface javax.servlet.ServletRequestremoveAttribute in class javax.servlet.ServletRequestWrappername - a String specifying
the name of the attribute to be removedpublic java.lang.String getRequestedSessionId()
PortletRequestnull.
getRequestedSessionId in interface PortletRequestgetRequestedSessionId in interface javax.servlet.http.HttpServletRequestgetRequestedSessionId in class javax.servlet.http.HttpServletRequestWrapperString specifying the session
ID, or null if the request did
not specify a session IDPortletRequest.isRequestedSessionIdValid()public boolean isRequestedSessionIdValid()
PortletRequest
isRequestedSessionIdValid in interface PortletRequestisRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequestisRequestedSessionIdValid in class javax.servlet.http.HttpServletRequestWrappertrue if this
request has an id for a valid session
in the current session context;
false otherwisePortletRequest.getRequestedSessionId(),
PortletRequest.getPortletSession()public java.lang.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 PortletRequestpublic java.util.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 PortletRequestpublic java.util.Locale getLocale()
PortletRequest
getLocale in interface PortletRequestgetLocale in interface javax.servlet.ServletRequestgetLocale in class javax.servlet.ServletRequestWrapperpublic java.util.Enumeration getLocales()
PortletRequest
getLocales in interface PortletRequestgetLocales in interface javax.servlet.ServletRequestgetLocales in class javax.servlet.ServletRequestWrapperpublic java.lang.String getScheme()
PortletRequesthttp, https, or ftp.
Different schemes have different rules for constructing URLs,
as noted in RFC 1738.
getScheme in interface PortletRequestgetScheme in interface javax.servlet.ServletRequestgetScheme in class javax.servlet.ServletRequestWrapperString containing the name
of the scheme used to make this requestpublic java.lang.String getServerName()
PortletRequest
getServerName in interface PortletRequestgetServerName in interface javax.servlet.ServletRequestgetServerName in class javax.servlet.ServletRequestWrapperString containing the name
of the server to which the request was sentpublic int getServerPort()
PortletRequest
getServerPort in interface PortletRequestgetServerPort in interface javax.servlet.ServletRequestgetServerPort in class javax.servlet.ServletRequestWrapperpublic java.lang.String getWindowID()
PortletRequestThis ID is the same that is used by the portlet container for scoping the portlet-scope session attributes.
getWindowID in interface PortletRequestpublic PortletRequest getPortletRequest()
public void setRequest(PortletRequest request)
java.lang.IllegalArgumentException - if the request is null.public java.util.Map<java.lang.String,java.lang.String[]> getPrivateParameterMap()
PortletRequestMap 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 PortletRequestMap 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 java.util.Map<java.lang.String,java.lang.String[]> getPublicParameterMap()
PortletRequestMap 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 PortletRequestMap 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 | |||||||||