All Known Implementing Classes:
RenderRequest, ActionRequest
PortletRequest
defines the base interface to provide client
request information to a portlet. The portlet container uses two specialized
versions of this interface when invoking a portlet, ActionRequest
and RenderRequest
. The portlet container creates these objects and
passes them as arguments to the portlet's processAction
and
render
methods.Field Summary | ||
---|---|---|
public static final String | USER_INFO | Used to retrieve user information attributes with the
getAttribute call. The user information is returned
as a Map object. The portlet must define the
user information attribute it is interested in inside the
user-attribute section of the deployment descriptor.
If an attribute is not supported
by the current runtime system it will not show up in the user
attribute map.If the user-attribute is supported by the runtime system, but not defined for a particular user, then for that user the attribute exists in the returned map and the attribute has a null value.
If the user-attribute is not defined for the current user it
will not show up in the Map.
The value is javax.portlet.userinfo . |
public static final String | BASIC_AUTH | String identifier for Basic authentication. Value "BASIC". |
public static final String | FORM_AUTH | String identifier for Form based authentication. Value "FORM". |
public static final String | CLIENT_CERT_AUTH | String identifier for Certification based authentication. Value "CLIENT_CERT". |
public static final String | DIGEST_AUTH | String identifier for Digest based authentication. Value "DIGEST". |
Method from javax.portlet.PortletRequest Detail: |
---|
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. |
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. |
BASIC_AUTH , CLIENT_CERT_AUTH ,
a custom one or null if there was no authentication. |
|
|
|
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 #getParameterValues .
If this method is used with a multivalued
parameter, the value returned is equal to the first value
in the array returned by getParameterValues . |
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 . |
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. |
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. |
|
|
HttpSession on which the portlet session is based on. |
true , creates one and returns
the new session.
If the given flag is HttpSession on which the portlet session is based on. |
|
Enumeration of String objects.
If the request did not include any propertys
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. |
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 #getProperties .
If this method is used with a multivalued
parameter, the value returned is equal to the first value
in the Enumeration returned by getProperties . |
Enumeration of all the property names
this request contains. If the request has no
properties, this method returns an empty Enumeration . |
|
null . |
'*' or '* / *' as supported content
types, these may also be valid return values. |
'*' or '* / *' as supported content
types, these may also be valid return values. |
http , https , or ftp .
Different schemes have different rules for constructing URLs,
as noted in RFC 1738. |
|
|
|
|
|
|
|
false . |
|
Attribute names should follow the same conventions as
package names. Names beginning with |
Attribute names should follow the same conventions as
package names. Names beginning with |