| org.apache.wsrp4j.consumer.URLTemplateComposer
All known Subclasses: com.liferay.portlet.wsrp.URLTemplateComposerImpl,
| URLTemplateComposer | | public interface URLTemplateComposer (Code) | | This interface provides methods to generate URL templates.
The generated templates will be transmitted to Producers (or respectively portlets)
that are willing to properly write URLs for a Consumer. (With templates the Consumer
indicates how it needs URLs formatted in order to process them properly.)
author:
Stefan Behl
version:
1.1 |
| Method Summary | |
| public String | createBlockingActionTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a blocking action template. | | public String | createDefaultTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a default template. | | public String | createRenderTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a render template. | | public String | createResourceTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a resource template. | | public String | createSecureBlockingActionTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a secure blocking action template. | | public String | createSecureDefaultTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a secure default template. | | public String | createSecureRenderTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a secure render template. | | public String | createSecureResourceTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)
Creates a secure resource template. | | public String | getNamespacePrefix()
Get the consumers namespace prefix which is used by the portlet
to namespace tokens which need to be unique on a aggregated page. | | public void | setURLGenerator(URLGenerator urlGenerator)
Sets the URLGenerator to be used. |
| createBlockingActionTemplate | | public String createBlockingActionTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a blocking action template. Includes tokens for url-type, portletMode,
navigationalState, interactionState and windowState to be replaced by the producer.
String representing the entire template. |
| createDefaultTemplate | | public String createDefaultTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a default template. Includes tokens for url-type, portletMode,
navigationalState, interactionState, windowState, url, rewriteResource
and secureURL to be replaced by the producer.
String representing the entire template. |
| createRenderTemplate | | public String createRenderTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a render template. Includes tokens for url-type, portletMode,
navigationalState, interactionState and windowState to be replaced by the producer.
String representing the entire template. |
| createResourceTemplate | | public String createResourceTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a resource template. Includes tokens for url-type,
rewriteResource and url to be replaced by the producer.
String representing the entire template. |
| createSecureBlockingActionTemplate | | public String createSecureBlockingActionTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a secure blocking action template. Includes tokens for url-type,
portletMode, navigationalState, interactionState, windowState and secureURL to be replaced by
the producer.
String representing the entire template. |
| createSecureDefaultTemplate | | public String createSecureDefaultTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a secure default template. Includes tokens for url-type, portletMode,
navigationalState, interactionState, windowState, url, rewriteResource and secureURL
to be replaced by the producer.
String representing the entire template. |
| createSecureRenderTemplate | | public String createSecureRenderTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a secure render template. Includes tokens for url-type, portletMode,
navigationalState, interactionState, windowState and secureURL to be replaced by the producer.
String representing the entire template. |
| createSecureResourceTemplate | | public String createSecureResourceTemplate(boolean includePortletHandle, boolean includeUserContextKey, boolean includePortletInstanceKey, boolean includeSessionID)(Code) | | Creates a secure resource template. Includes tokens for url-type, url,
rewriteResource, and secureURL to be replaced by the producer.
String representing the entire template. |
| getNamespacePrefix | | public String getNamespacePrefix()(Code) | | Get the consumers namespace prefix which is used by the portlet
to namespace tokens which need to be unique on a aggregated page.
The namespace prefix of the consumer. |
| setURLGenerator | | public void setURLGenerator(URLGenerator urlGenerator)(Code) | | Sets the URLGenerator to be used.
|
|
|