|
||||||||||
| 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
MimeResponse.createActionURL() and
MimeResponse.createRenderURL() APIs.
| Field Summary | |
|---|---|
static java.lang.String |
ENCODING
|
protected static java.lang.String |
PORTLETMODE_NAME_EDIT
|
protected static java.lang.String |
PORTLETMODE_NAME_HELP
|
protected static java.lang.String |
PORTLETMODE_NAME_VIEW
|
protected static java.lang.String |
URLTYPE_NAME_ACTION
|
protected static java.lang.String |
URLTYPE_NAME_RESOURCE
|
| Constructor Summary | |
|---|---|
PortletUrlHelper()
|
|
| Method Summary | |
|---|---|
java.lang.String |
buildResourceUrl(java.lang.String value,
java.util.Map params)
Encode an url to a non Struts action resource, like stylesheet, image or servlet. |
java.lang.String |
buildUrl(java.lang.String action,
java.lang.String namespace,
java.lang.String method,
java.util.Map<java.lang.String,java.lang.Object> params,
java.lang.String type,
java.lang.String mode,
java.lang.String state)
Create a portlet URL with for the specified action and namespace. |
java.lang.String |
buildUrl(java.lang.String action,
java.lang.String namespace,
java.lang.String method,
java.util.Map<java.lang.String,java.lang.Object> params,
java.lang.String scheme,
java.lang.String type,
java.lang.String portletMode,
java.lang.String windowState,
boolean includeContext,
boolean encodeResult)
Create a portlet URL with for the specified action and namespace. |
protected java.lang.Object |
createUrl(java.lang.String scheme,
java.lang.String type,
java.util.Map<java.lang.String,java.lang.String[]> portletParams)
|
protected java.lang.String |
encodeUrl(java.lang.StringBuffer sb,
javax.portlet.PortletRequest req)
|
static java.util.Map<java.lang.String,java.lang.String[]> |
ensureParamsAreStringArrays(java.util.Map<java.lang.String,java.lang.Object> 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 |
| Field Detail |
|---|
public static final java.lang.String ENCODING
protected static final java.lang.String PORTLETMODE_NAME_EDIT
protected static final java.lang.String PORTLETMODE_NAME_VIEW
protected static final java.lang.String PORTLETMODE_NAME_HELP
protected static final java.lang.String URLTYPE_NAME_ACTION
protected static final java.lang.String URLTYPE_NAME_RESOURCE
| Constructor Detail |
|---|
public PortletUrlHelper()
| Method Detail |
|---|
public java.lang.String buildUrl(java.lang.String action,
java.lang.String namespace,
java.lang.String method,
java.util.Map<java.lang.String,java.lang.Object> params,
java.lang.String type,
java.lang.String mode,
java.lang.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 java.lang.String buildUrl(java.lang.String action,
java.lang.String namespace,
java.lang.String method,
java.util.Map<java.lang.String,java.lang.Object> params,
java.lang.String scheme,
java.lang.String type,
java.lang.String portletMode,
java.lang.String windowState,
boolean includeContext,
boolean encodeResult)
buildUrl(String, String, String, java.util.Map, String, String, String)
protected java.lang.Object createUrl(java.lang.String scheme,
java.lang.String type,
java.util.Map<java.lang.String,java.lang.String[]> portletParams)
public java.lang.String buildResourceUrl(java.lang.String value,
java.util.Map params)
value -
protected java.lang.String encodeUrl(java.lang.StringBuffer sb,
javax.portlet.PortletRequest req)
public static java.util.Map<java.lang.String,java.lang.String[]> ensureParamsAreStringArrays(java.util.Map<java.lang.String,java.lang.Object> params)
params are String arrays,
as requried by the setParameters on the PortletURL.
params - The parameters to the URL.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||