org.hippoecm.hst.core.component
Class HstURLFactoryImpl

java.lang.Object
  org.hippoecm.hst.core.component.HstURLFactoryImpl

All Implemented Interfaces:

HstURLFactory

public class HstURLFactoryImpl
extends Object
implements HstURLFactory

HstURLFactoryImpl

Version:

$Id: HstURLFactoryImpl.java 31568 2011-11-29 20:49:46Z wko $

Field Summary

protected HstContainerURLProvider	containerURLProvider
protected HstNavigationalStateCodec	navigationalStateCodec
protected String	parameterNameComponentSeparator
protected boolean	portletResourceURLEnabled
protected boolean	referenceNamespaceIgnored
protected String	urlNamespacePrefix

Constructor Summary

HstURLFactoryImpl()

Method Summary

HstURL	createURL(String type, String referenceNamespace, HstContainerURL containerURL, HstRequestContext requestContext) Returns HstURL for the HstURL type with reference namespace based on the base container URL
HstURL	createURL(String type, String referenceNamespace, HstContainerURL containerURL, HstRequestContext requestContext, String contextPath) Returns HstURL for the HstURL type with reference namespace based on the base container URL and an explicit contextPath, for example needed when the Mount to create a link for has a different contextpath than the ResolvedMount belonging to the HstRequestContext
HstContainerURLProvider	getContainerURLProvider() Returns the HstContainerURLProvider.
boolean	isReferenceNamespaceIgnored() Returns the flag if parameter namespacing is ignored or not.
void	setNavigationalStateCodec(HstNavigationalStateCodec navigationalStateCodec)
void	setParameterNameComponentSeparator(String parameterNameComponentSeparator)
void	setPortletResourceURLEnabled(boolean portletResourceURLEnabled)
void	setReferenceNamespaceIgnored(boolean referenceNamespaceIgnored)
void	setUrlNamespacePrefix(String urlNamespacePrefix)

Methods inherited from class java.lang.Object

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

Field Detail

referenceNamespaceIgnored

protected boolean referenceNamespaceIgnored

urlNamespacePrefix

protected String urlNamespacePrefix

parameterNameComponentSeparator

protected String parameterNameComponentSeparator

navigationalStateCodec

protected HstNavigationalStateCodec navigationalStateCodec

portletResourceURLEnabled

protected boolean portletResourceURLEnabled

containerURLProvider

protected HstContainerURLProvider containerURLProvider

Constructor Detail

HstURLFactoryImpl

public HstURLFactoryImpl()

Method Detail

setUrlNamespacePrefix

public void setUrlNamespacePrefix(String urlNamespacePrefix)

setParameterNameComponentSeparator

public void setParameterNameComponentSeparator(String parameterNameComponentSeparator)

setNavigationalStateCodec

public void setNavigationalStateCodec(HstNavigationalStateCodec navigationalStateCodec)

setPortletResourceURLEnabled

public void setPortletResourceURLEnabled(boolean portletResourceURLEnabled)

setReferenceNamespaceIgnored

public void setReferenceNamespaceIgnored(boolean referenceNamespaceIgnored)

isReferenceNamespaceIgnored

public boolean isReferenceNamespaceIgnored()

Description copied from interface: HstURLFactory

Returns the flag if parameter namespacing is ignored or not. It returns false by default.

Specified by:

isReferenceNamespaceIgnored in interface HstURLFactory

Returns:

getContainerURLProvider

public HstContainerURLProvider getContainerURLProvider()

Description copied from interface: HstURLFactory

Returns the HstContainerURLProvider.

Specified by:

getContainerURLProvider in interface HstURLFactory

Returns:

HstContainerURLProvider

createURL

public HstURL createURL(String type,
                        String referenceNamespace,
                        HstContainerURL containerURL,
                        HstRequestContext requestContext)

Description copied from interface: HstURLFactory

Returns HstURL for the HstURL type with reference namespace based on the base container URL

Specified by:

createURL in interface HstURLFactory

Parameters:

type - the HstURL type. It should one of HstURL.ACTION_TYPE, HstURL.RENDER_TYPE or HstURL.RESOURCE_TYPE.

referenceNamespace - the reference namespace of the HstComponent's window.

containerURL - the base HstContainer URL

requestContext - the current HstRequestContext

Returns:

HstContainerURLProvider

createURL

public HstURL createURL(String type,
                        String referenceNamespace,
                        HstContainerURL containerURL,
                        HstRequestContext requestContext,
                        String contextPath)

Description copied from interface: HstURLFactory

Returns HstURL for the HstURL type with reference namespace based on the base container URL and an explicit contextPath, for example needed when the Mount to create a link for has a different contextpath than the ResolvedMount belonging to the HstRequestContext

Specified by:

createURL in interface HstURLFactory

Parameters:

type - the HstURL type. It should one of HstURL.ACTION_TYPE, HstURL.RENDER_TYPE or HstURL.RESOURCE_TYPE.

referenceNamespace - the reference namespace of the HstComponent's window.

containerURL - the base HstContainer URL

requestContext - the current HstRequestContext

contextPath - the context path for the URL to create. If it is null the contextPath from the ResolvedMount will be used. If is is EMPTY string, the contextPath will be set to empty ""

Returns:

HstContainerURLProvider