|
Portlet API (V0.7.1) | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The PortletURL
interface represents a URL
that reference the portlet itself.
A URL is created through the RenderResponse
and
additional parameters can be added to this URL. The complete URL can
be converted to a String
which is ready for embedding into markup.
There are two types of PortletURLs:
RenderResponse.createRenderURL
as optimzed action,
only setting the render parameters
RenderResponse.createActionURL
for
triggering an action request
A portlet URL does not need to be a valid URL when converted to a String. It may contain special tokens that will be converted to a URL by the portal.
Method Summary | |
void |
addParameter(java.lang.String name,
java.lang.String value)
Adds the given String parameter to this URL. |
void |
addParameter(java.lang.String name,
java.lang.String[] values)
Adds the given String array parameter to this URL. |
void |
setParameters(java.util.Map parameters)
Sets a parameter map for this URL. |
void |
setPortletMode(PortletMode portletMode)
Indicates the portlet mode the portlet must be in, if this portlet URL triggers a request. |
void |
setSecure(boolean secure)
Indicated the security setting for this URL. |
void |
setWindowState(WindowState windowState)
Indicates the window state the portlet should be in, if this portlet URL triggers a request. |
java.lang.String |
toString()
Returns the complete URL as a string. |
Method Detail |
public void setWindowState(WindowState windowState) throws WindowStateException
A URL can not have more than one window state attached to it. If more than one window state is set only the last one set is attached to the URL.
windowState
- the portlet window stateWindowStateException
- if the portlet cannot switch to this state,
because the portal does not support this state, the portlet has not
declared in its deployment descriptor that it supports this state, or the current
user is not allowed to switch to this state.
To avoid this exception the portlet can check the allowed
window states with Request.isWindowStateAllowed()
.public void setPortletMode(PortletMode portletMode) throws PortletModeException
A URL can not have more than one portlet mode attached to it. If more than one portlet mode is set only the last one set is attached to the URL.
portletMode
- the portlet modePortletModeException
- if the portlet cannot switch to this mode,
because the portal does not support this mode, the portlet has not
declared in its deployment descriptor that it supports this mode for the current markup,
or the current user is not allowed to switch to this mode
To avoid this exception the portlet can check the allowed
portlet modes with Request.isPortletModeAllowed()
.public void addParameter(java.lang.String name, java.lang.String value)
This method does not url encode parameters. Parameters that need
url encoding must be "x-www-form-urlencoded" before using the
addParameter
method, e.g. by using the
java.net.URLEncoder.encode
method.
A portlet container may prefix the attribute names internally in order to preserve a unique namespace for the portlet.
name
- the parameter namevalue
- the parameter valuejava.lang.IllegalArgumentException
- if name or value is null
.public void addParameter(java.lang.String name, java.lang.String[] values)
This method does not url encode parameters. Parameters that need
url encoding must be "x-www-form-urlencoded" before using the
addParameter
method, e.g. by using the
java.net.URLEncoder.encode
method.
A portlet container may prefix the attribute names internally in order to preserve a unique namespace for the portlet.
name
- the parameter namevalues
- the parameter valuesjava.lang.IllegalArgumentException
- if name or values is null
.public void setParameters(java.util.Map parameters)
All previously set parameters are cleared.
A portlet container may prefix the attribute names internally, in order to preserve a unique namespace for the portlet.
parameters
- Map containing parameter names for
the render phase as
keys and parameter values as map
values. The keys in the parameter
map must be of type String. The values
in the parameter map must be of type
String array (String[]
).java.lang.IllegalArgumentException
- if parameters is null
.public void setSecure(boolean secure) throws PortletSecurityException
Secure set to true
indicates that the portlet requests
a secure connection between the client and the portlet window for
this URL. Secure set to false
indicates that the portlet
does not need a secure connection for this URL. If the security is not
set for a URL, it will stay the same as the current request.
NOTE: using this URL may result in loosing the current session, depending on the session implementation.
secure
- true, if portlet requests to have a secure connection
between its portlet window and the client; false, if
the portlet does not require a secure connection.PortletSecurityException
- if the run-time environment does
not support the indicated settingpublic java.lang.String toString()
toString
in class java.lang.Object
|
Portlet API (V0.7.1) | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |