|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.struts2.portlet.util.PortletUrlHelper
public class PortletUrlHelper
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.
Field Summary | |
---|---|
static String |
ENCODING
|
private static Log |
LOG
|
Constructor Summary | |
---|---|
PortletUrlHelper()
|
Method Summary | |
---|---|
static String |
buildResourceUrl(String value,
Map params)
Encode an url to a non Struts 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. |
private static javax.portlet.PortletMode |
getPortletMode(javax.portlet.RenderRequest portletReq,
String portletMode)
Convert the given String to a PortletMode object. |
private static javax.portlet.WindowState |
getWindowState(javax.portlet.RenderRequest portletReq,
String windowState)
Convert the given String to a WindowState object. |
private static String |
prependNamespace(String namespace,
String portletMode)
Prepend the namespace configuration for the specified namespace and PortletMode. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ENCODING
private static final Log LOG
Constructor Detail |
---|
public PortletUrlHelper()
Method Detail |
---|
public static String buildUrl(String action, String namespace, Map params, String type, String mode, String state)
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.
public static String buildUrl(String action, String namespace, Map params, String scheme, String type, String portletMode, String windowState, boolean includeContext, boolean encodeResult)
buildUrl(String, String, Map, String, String, String)
private static String prependNamespace(String namespace, String portletMode)
namespace
- The base namespace.portletMode
- The PortletMode.
public static String buildResourceUrl(String value, Map params)
value
-
public static Map ensureParamsAreStringArrays(Map params)
params
are String arrays,
as requried by the setParameters on the PortletURL.
params
- The parameters to the URL.
private static javax.portlet.WindowState getWindowState(javax.portlet.RenderRequest portletReq, String windowState)
portletReq
- The RenderRequest.windowState
- The WindowState as a String.
private static javax.portlet.PortletMode getPortletMode(javax.portlet.RenderRequest portletReq, String portletMode)
portletReq
- The RenderRequest.portletMode
- The PortletMode as a String.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |