com.opensymphony.webwork.portlet.util
Class PortletUrlHelper
java.lang.Object
com.opensymphony.webwork.portlet.util.PortletUrlHelper
public class PortletUrlHelper - extends Object
Helper class for creating Portlet URLs. Portlet URLs are fundamentally different from regular
servlet URLs since they never target the application itself; all requests go through the portlet
container and must therefore be programatically constructed using the
RenderResponse.createActionURL() and
RenderResponse.createRenderURL() APIs.
- Author:
- Nils-Helge Garli
|
Method Summary |
static String |
buildResourceUrl(String value,
Map params)
Encode an url to a non webwork action resource, like stylesheet, image or
servlet. |
static String |
buildUrl(String action,
String namespace,
Map params,
String type,
String mode,
String state)
Create a portlet URL with for the specified action and namespace. |
static String |
buildUrl(String action,
String namespace,
Map params,
String scheme,
String type,
String portletMode,
String windowState,
boolean includeContext,
boolean encodeResult)
Create a portlet URL with for the specified action and namespace. |
static Map |
ensureParamsAreStringArrays(Map params)
Will ensure that all entries in params are String arrays,
as requried by the setParameters on the PortletURL. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PortletUrlHelper
public PortletUrlHelper()
buildUrl
public static String buildUrl(String action,
String namespace,
Map params,
String type,
String mode,
String state)
- Create a portlet URL with for the specified action and namespace.
- Parameters:
action - The action the URL should invoke.namespace - The namespace of the action to invoke.params - The parameters of the URL.type - The type of the url, either action or rendermode - The PortletMode of the URL.state - The WindowState of the URL.
- Returns:
- The URL String.
buildUrl
public static String buildUrl(String action,
String namespace,
Map params,
String scheme,
String type,
String portletMode,
String windowState,
boolean includeContext,
boolean encodeResult)
- Create a portlet URL with for the specified action and namespace.
- See Also:
buildUrl(String, String, Map, String, String, String)
buildResourceUrl
public static String buildResourceUrl(String value,
Map params)
- Encode an url to a non webwork action resource, like stylesheet, image or
servlet.
- Parameters:
value -
- Returns:
- encoded url to non webwork action resources.
ensureParamsAreStringArrays
public static Map ensureParamsAreStringArrays(Map params)
- Will ensure that all entries in
params are String arrays,
as requried by the setParameters on the PortletURL.
- Parameters:
params - The parameters to the URL.
- Returns:
- A Map with all parameters as String arrays.
|