| org.apache.wsrp4j.producer.provider.URLComposer
All known Subclasses: org.apache.wsrp4j.producer.provider.driver.URLComposerImpl,
| URLComposer | | public interface URLComposer (Code) | | This interface provides methods generating URLs or namespacing
tokens that should be called within the getMarkup method of a service.
There are two kinds of methods:
- Methods defining URLs or tokens to be rewritten by the consumer.
- Methods defining complete URLs or namespaced tokens according to the
templates delivered by the Consumer.
author:
Stefan Behl
author:
Stephan Laertz |
| Method Summary | |
| public String | createBlockingActionURL(String portletMode, String navigationalState, String interactionState, String windowState, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext)
Creates an complete parameter string for a blocking action link. | | public String | createNamespacedToken(String token, RuntimeContext runtimeContext)
Marks a token that has to be namespaced by the consumer.
If a RuntimeContext with a non-null namespace prefix
attributed is passed then this prefix is used to namespace the given token.
Passing a null RuntimeContext results in a namespace url that requires consumer
rewriting. | | public String | createRenderURL(String portletMode, String navigationalState, String windowState, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext)
Creates an complete parameter string for a render link. | | public String | createResourceURL(String url, boolean rewriteResource, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext)
Creates an complete parameter string for a resource link. |
| createBlockingActionURL | | public String createBlockingActionURL(String portletMode, String navigationalState, String interactionState, String windowState, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext)(Code) | | Creates an complete parameter string for a blocking action link. Depended on
the passed RuntimeContext and appearance of a non-null
(secure)blockingaction or (secure)default template the url are either furnished with embracing rewrite
tokens or not.
Passing a null value for any of the provided parameters implicates that
these url-parameters will not be included in the resulting url.
Passing a null RuntimeContext or a RuntimeContext with a null blockingAction
and default templates implicates the generation of url's which need to be rewritten at the
consumer side. Otherwise the consumers template is used to generate the urls.
If a UserContext and/or PortletContext is also passed
then the portlethandle and userContextKey from these strutures is used to make
the produce url specific to that values.
Parameters:
portletMode - The portlet mode to be inserted into the parameterstring of the url.
Parameters:
navigationalState - The navigational state to be inserted into theparameter string of the url.
Parameters:
interactionState - The interaction state to be inserted into theparameter string of the url.
Parameters:
windowState - The window State to be inserted into the parameterstring of the url.
Parameters:
secureURL - Boolean flag indicating if securecommunications should be used when activatingthe link.
Parameters:
runtimeContext - The RuntimeContext object from thewsrp request. Passing a null results in url's wichrequire consumer rewriting.
Parameters:
portletContext - If a portlet context is passed with a valid portlet handlethen this handle is used to be inserted in the url onlyif the runtimecontext contained a valid blockingAction or default template. |
| createNamespacedToken | | public String createNamespacedToken(String token, RuntimeContext runtimeContext)(Code) | | Marks a token that has to be namespaced by the consumer.
If a RuntimeContext with a non-null namespace prefix
attributed is passed then this prefix is used to namespace the given token.
Passing a null RuntimeContext results in a namespace url that requires consumer
rewriting.
Parameters:
token - Token to be namespaced.
Parameters:
runtimeContext - A RuntimeContext with a valid namespaceprefix or null. |
| createRenderURL | | public String createRenderURL(String portletMode, String navigationalState, String windowState, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext)(Code) | | Creates an complete parameter string for a render link. Depended on
the passed RuntimeContext and appearance of a non-null
render or default template the url are either furnished with embracing rewrite
tokens or not.
Passing a null value for any of the provided parameters implicates that
these url-parameters will not be included in the resulting url.
Passing a null RuntimeContext or a RuntimeContext with a null render and default
templates implicates the generation of url's which need to be rewritten at the
consumer side. Otherwise the consumers template is used to generate the urls.
If a UserContext and/or PortletContext is also passed
then the portlethandle and userContextKey from these strutures is used to make
the produce url specific to that values.
Parameters:
portletMode - The portlet mode to be inserted into the parameterstring of the url.
Parameters:
navigationalState - The navigational state to be inserted into theparameter string of the url.
Parameters:
windowState - The window State to be inserted into the parameterstring of the url.
Parameters:
secureURL - Boolean flag indicating if securecommunications should be used when activatingthe link.
Parameters:
runtimeContext - The RuntimeContext object from thewsrp request. Passing a null results in url's wichrequire consumer rewriting.
Parameters:
portletContext - If a portlet context is passed with a valid portlet handlethen this handle is used to be inserted in the url onlyif the runtimecontext contained a valid render or default template. |
| createResourceURL | | public String createResourceURL(String url, boolean rewriteResource, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext)(Code) | | Creates an complete parameter string for a resource link. Depended on
the passed RuntimeContext and appearance of a non-null
render or default template the url are either furnished with embracing rewrite
tokens or not.
Passing a null value for any of the provided parameters implicates that
these url-parameters will not be included in the resulting url.
Passing a null RuntimeContext or a RuntimeContext with a null render and default
templates implicates the generation of url's which need to be rewritten at the
consumer side. Otherwise the consumers template is used to generate the urls.
If a UserContext and/or PortletContext is also passed
then the portlethandle and userContextKey from these strutures is used to make
the produce url specific to that values.
Parameters:
url - Provides the actual url to the resource.
Parameters:
rewriteResource - Boolean flag informing the Consumer that theresource needs to be parsed for URL rewriting.
Parameters:
secureURL - Boolean flag indicating whether securecommunications should be used when activatingthe link.
Parameters:
runtimeContext - The RuntimeContext object from thewsrp request. Passing a null results in url's wichrequire consumer rewriting.
Parameters:
portletContext - If a portlet context is passed with a valid portlet handlethen this handle is used to be inserted in the url onlyif the runtimecontext contained a valid resource or default template. |
|
|