URLComposerImpl (WSRP4J 0.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.wsrp4j.producer.provider.driver
Class URLComposerImpl

java.lang.Object
  org.apache.wsrp4j.producer.provider.driver.URLComposerImpl

All Implemented Interfaces:: URLComposer

public class URLComposerImpl
extends java.lang.Object
implements URLComposer

This class implements the URLComposer interface providing methods to generate URLs or namespace tokens.

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.

Version:: $Id: URLComposerImpl.java,v 1.5 2005/08/12 12:56:53 cziegeler Exp $
Author:: Stefan Behl

Field Summary
`private Logger`	`logger`

Constructor Summary
`private`	`URLComposerImpl()`

Method Summary
`private java.lang.String`	`appendNameValuePair(java.lang.String name, java.lang.String value)`
`java.lang.String`	`createBlockingActionURL(java.lang.String portletMode, java.lang.String navigationalState, java.lang.String interactionState, java.lang.String windowState, boolean secureURL, oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext, oasis.names.tc.wsrp.v1.types.PortletContext portletContext, oasis.names.tc.wsrp.v1.types.UserContext userContext)` creates a rewrite blocking-action-url
`private java.lang.String`	`createBlockingActionURLByTemplate(java.lang.String blockingActionTemplate, java.lang.String portletMode, java.lang.String navigationalState, java.lang.String interactionState, java.lang.String windowState, java.lang.String portletHandle, java.lang.String userContextKey, java.lang.String portletInstanceKey, java.lang.String sessionID)`
`java.lang.String`	`createNamespacedToken(java.lang.String token, oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext)` creates a namespaced token
`private java.lang.String`	`createNameValuePair(java.lang.String name, java.lang.String value)`
`java.lang.String`	`createRenderURL(java.lang.String portletMode, java.lang.String navigationalState, java.lang.String windowState, boolean secureURL, oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext, oasis.names.tc.wsrp.v1.types.PortletContext portletContext, oasis.names.tc.wsrp.v1.types.UserContext userContext)` creates a rewrite render-url
`private java.lang.String`	`createRenderURLByTemplate(java.lang.String renderTemplate, java.lang.String portletMode, java.lang.String navigationalState, java.lang.String windowState, java.lang.String portletHandle, java.lang.String userContextKey, java.lang.String portletInstanceKey, java.lang.String sessionID)`
`java.lang.String`	`createResourceURL(java.lang.String url, boolean rewriteResource, boolean secureURL, oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext, oasis.names.tc.wsrp.v1.types.PortletContext portletContext, oasis.names.tc.wsrp.v1.types.UserContext userContext)` creates a rewrite resource-url
`private java.lang.String`	`createResourceURLByTemplate(java.lang.String resourceTemplate, java.lang.String url, boolean rewriteResource, java.lang.String portletHandle, java.lang.String userContextKey, java.lang.String portletInstanceKey, java.lang.String sessionID)`
`private java.lang.String`	`createRewriteURL(java.lang.String urlType, java.lang.String portletMode, java.lang.String navigationalState, java.lang.String interactionState, java.lang.String windowState, java.lang.String url, java.lang.String rewriteResource, java.lang.String token, java.lang.String secureURL)`
`static URLComposerImpl`	`getInstance(Provider provider)`
`private java.lang.String`	`processTemplate(java.lang.String template, java.lang.String urlType, java.lang.String portletMode, java.lang.String navigationalState, java.lang.String interactionState, java.lang.String windowState, java.lang.String url, java.lang.String rewriteResource, java.lang.String portletHandle, java.lang.String userContextKey, java.lang.String portletInstanceKey, java.lang.String sessionID)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private Logger logger

Constructor Detail

URLComposerImpl

private URLComposerImpl()

Method Detail

getInstance

public static URLComposerImpl getInstance(Provider provider)

createBlockingActionURL

public java.lang.String createBlockingActionURL(java.lang.String portletMode,
                                                java.lang.String navigationalState,
                                                java.lang.String interactionState,
                                                java.lang.String windowState,
                                                boolean secureURL,
                                                oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext,
                                                oasis.names.tc.wsrp.v1.types.PortletContext portletContext,
                                                oasis.names.tc.wsrp.v1.types.UserContext userContext)

creates a rewrite blocking-action-url

Specified by:: createBlockingActionURL in interface URLComposer

Parameters:: portletMode -; navigationalState -; interactionState -; windowState -; secureURL -; runtimeContext -; portletContext -; userContext -
Returns:: URL as String

createRenderURL

public java.lang.String createRenderURL(java.lang.String portletMode,
                                        java.lang.String navigationalState,
                                        java.lang.String windowState,
                                        boolean secureURL,
                                        oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext,
                                        oasis.names.tc.wsrp.v1.types.PortletContext portletContext,
                                        oasis.names.tc.wsrp.v1.types.UserContext userContext)

creates a rewrite render-url

Specified by:: createRenderURL in interface URLComposer

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,
                                          oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext,
                                          oasis.names.tc.wsrp.v1.types.PortletContext portletContext,
                                          oasis.names.tc.wsrp.v1.types.UserContext userContext)

creates a rewrite resource-url

Specified by:: createResourceURL in interface URLComposer

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,
                                              oasis.names.tc.wsrp.v1.types.RuntimeContext runtimeContext)

creates a namespaced token

Specified by:: createNamespacedToken in interface URLComposer

Parameters:: token - Token to be namespaced.; runtimeContext - A RuntimeContext with a valid namespaceprefix or null.

createRewriteURL

private java.lang.String createRewriteURL(java.lang.String urlType,
                                          java.lang.String portletMode,
                                          java.lang.String navigationalState,
                                          java.lang.String interactionState,
                                          java.lang.String windowState,
                                          java.lang.String url,
                                          java.lang.String rewriteResource,
                                          java.lang.String token,
                                          java.lang.String secureURL)

createNameValuePair

private java.lang.String createNameValuePair(java.lang.String name,
                                             java.lang.String value)

appendNameValuePair

private java.lang.String appendNameValuePair(java.lang.String name,
                                             java.lang.String value)

createBlockingActionURLByTemplate

private java.lang.String createBlockingActionURLByTemplate(java.lang.String blockingActionTemplate,
                                                           java.lang.String portletMode,
                                                           java.lang.String navigationalState,
                                                           java.lang.String interactionState,
                                                           java.lang.String windowState,
                                                           java.lang.String portletHandle,
                                                           java.lang.String userContextKey,
                                                           java.lang.String portletInstanceKey,
                                                           java.lang.String sessionID)
                                                    throws WSRPException

Throws:: WSRPException

createRenderURLByTemplate

private java.lang.String createRenderURLByTemplate(java.lang.String renderTemplate,
                                                   java.lang.String portletMode,
                                                   java.lang.String navigationalState,
                                                   java.lang.String windowState,
                                                   java.lang.String portletHandle,
                                                   java.lang.String userContextKey,
                                                   java.lang.String portletInstanceKey,
                                                   java.lang.String sessionID)
                                            throws WSRPException

Throws:: WSRPException

createResourceURLByTemplate

private java.lang.String createResourceURLByTemplate(java.lang.String resourceTemplate,
                                                     java.lang.String url,
                                                     boolean rewriteResource,
                                                     java.lang.String portletHandle,
                                                     java.lang.String userContextKey,
                                                     java.lang.String portletInstanceKey,
                                                     java.lang.String sessionID)
                                              throws WSRPException

Throws:: WSRPException

processTemplate

private java.lang.String processTemplate(java.lang.String template,
                                         java.lang.String urlType,
                                         java.lang.String portletMode,
                                         java.lang.String navigationalState,
                                         java.lang.String interactionState,
                                         java.lang.String windowState,
                                         java.lang.String url,
                                         java.lang.String rewriteResource,
                                         java.lang.String portletHandle,
                                         java.lang.String userContextKey,
                                         java.lang.String portletInstanceKey,
                                         java.lang.String sessionID)
                                  throws WSRPException

Throws:: WSRPException