public class PortletUrlHelper extends Object
MimeResponse.createActionURL() and
 MimeResponse.createRenderURL() APIs.| Modifier and Type | Field and Description | 
|---|---|
| static String | ENCODING | 
| protected static String | PORTLETMODE_NAME_EDIT | 
| protected static String | PORTLETMODE_NAME_HELP | 
| protected static String | PORTLETMODE_NAME_VIEW | 
| protected static String | URLTYPE_NAME_ACTION | 
| protected static String | URLTYPE_NAME_RESOURCE | 
| Constructor and Description | 
|---|
| PortletUrlHelper() | 
| Modifier and Type | Method and Description | 
|---|---|
| String | buildResourceUrl(String value,
                Map params)Encode an url to a non Struts action resource, like stylesheet, image or
 servlet. | 
| String | buildUrl(String action,
        String namespace,
        String method,
        Map<String,Object> params,
        String type,
        String mode,
        String state)Create a portlet URL with for the specified action and namespace. | 
| String | buildUrl(String action,
        String namespace,
        String method,
        Map<String,Object> params,
        String scheme,
        String type,
        String portletMode,
        String windowState,
        boolean includeContext,
        boolean encodeResult)Create a portlet URL with for the specified action and namespace. | 
| protected Object | createUrl(String scheme,
         String type,
         Map<String,String[]> portletParams) | 
| protected String | encodeUrl(StringBuffer sb,
         javax.portlet.PortletRequest req) | 
| static Map<String,String[]> | ensureParamsAreStringArrays(Map<String,Object> params)Will ensure that all entries in  paramsare String arrays,
 as requried by the setParameters on the PortletURL. | 
public static final String ENCODING
protected static final String PORTLETMODE_NAME_EDIT
protected static final String PORTLETMODE_NAME_VIEW
protected static final String PORTLETMODE_NAME_HELP
protected static final String URLTYPE_NAME_ACTION
protected static final String URLTYPE_NAME_RESOURCE
public String buildUrl(String action, String namespace, String method, Map<String,Object> params, String type, String mode, String state)
action - The action the URL should invoke.namespace - The namespace of the action to invoke.method - The method 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.public String buildUrl(String action, String namespace, String method, Map<String,Object> params, String scheme, String type, String portletMode, String windowState, boolean includeContext, boolean encodeResult)
action - The action the URL should invoke.namespace - The namespace of the action to invoke.method - The method of the action to invoke.params - The parameters of the URL.type - The type of the url, either action or renderscheme - The scheme of the URL.portletMode - The Portlet Mode of the URL.windowState - The Window StateincludeContext - true for including contextencodeResult - true for encode of the resultbuildUrl(String, String, String, java.util.Map, String, String, String)protected Object createUrl(String scheme, String type, Map<String,String[]> portletParams)
public String buildResourceUrl(String value, Map params)
value - base urlparams - url parametersprotected String encodeUrl(StringBuffer sb, javax.portlet.PortletRequest req)
public static Map<String,String[]> ensureParamsAreStringArrays(Map<String,Object> params)
params are String arrays,
 as requried by the setParameters on the PortletURL.params - The parameters to the URL.Copyright © 2000–2025 Apache Software Foundation. All rights reserved.