org.apache.wsrp4j.producer.provider
Interface URLComposer

All Known Implementing Classes:

URLComposerImpl

public interface URLComposer

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, Stephan Laertz

Method Summary

java.lang.String	createBlockingActionURL(java.lang.String portletMode, java.lang.String navigationalState, java.lang.String interactionState, java.lang.String windowState, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext) Creates an complete parameter string for a blocking action link.
java.lang.String	createNamespacedToken(java.lang.String token, RuntimeContext runtimeContext) Marks a token that has to be namespaced by the consumer.
java.lang.String	createRenderURL(java.lang.String portletMode, java.lang.String navigationalState, java.lang.String windowState, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext) Creates an complete parameter string for a render link.
java.lang.String	createResourceURL(java.lang.String url, boolean rewriteResource, boolean secureURL, RuntimeContext runtimeContext, PortletContext portletContext, UserContext userContext) Creates an complete parameter string for a resource link.

Method Detail

createBlockingActionURL

public java.lang.String createBlockingActionURL(java.lang.String portletMode,
                                                java.lang.String navigationalState,
                                                java.lang.String interactionState,
                                                java.lang.String windowState,
                                                boolean secureURL,
                                                RuntimeContext runtimeContext,
                                                PortletContext portletContext,
                                                UserContext userContext)

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 parameter string of the url.

navigationalState - The navigational state to be inserted into the parameter string of the url.

interactionState - The interaction state to be inserted into the parameter string of the url.

windowState - The window State to be inserted into the parameter string of the url.

secureURL - Boolean flag indicating if secure communications should be used when activating the link.

runtimeContext - The RuntimeContext object from the wsrp request. Passing a null results in url's wich require consumer rewriting.

portletContext - If a portlet context is passed with a valid portlet handle then this handle is used to be inserted in the url only if the runtimecontext contained a valid blockingAction or default template.

createRenderURL

public java.lang.String createRenderURL(java.lang.String portletMode,
                                        java.lang.String navigationalState,
                                        java.lang.String windowState,
                                        boolean secureURL,
                                        RuntimeContext runtimeContext,
                                        PortletContext portletContext,
                                        UserContext userContext)

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 parameter string of the url.

navigationalState - The navigational state to be inserted into the parameter string of the url.

windowState - The window State to be inserted into the parameter string of the url.

secureURL - Boolean flag indicating if secure communications should be used when activating the link.

runtimeContext - The RuntimeContext object from the wsrp request. Passing a null results in url's wich require consumer rewriting.

portletContext - If a portlet context is passed with a valid portlet handle then this handle is used to be inserted in the url only if the runtimecontext contained a valid render or default template.

createResourceURL

public java.lang.String createResourceURL(java.lang.String url,
                                          boolean rewriteResource,
                                          boolean secureURL,
                                          RuntimeContext runtimeContext,
                                          PortletContext portletContext,
                                          UserContext userContext)

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.

rewriteResource - Boolean flag informing the Consumer that the resource needs to be parsed for URL rewriting.

secureURL - Boolean flag indicating whether secure communications should be used when activating the link.

runtimeContext - The RuntimeContext object from the wsrp request. Passing a null results in url's wich require consumer rewriting.

portletContext - If a portlet context is passed with a valid portlet handle then this handle is used to be inserted in the url only if the runtimecontext contained a valid resource or default template.

createNamespacedToken

public java.lang.String createNamespacedToken(java.lang.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.

Parameters:

token - Token to be namespaced.

runtimeContext - A RuntimeContext with a valid namespaceprefix or null.