org.hippoecm.hst.core.component
Interface HstURLFactory

All Known Implementing Classes:

HstURLFactoryImpl

public interface HstURLFactory

HstURL Factory interface. It is mainly responsible to generate HstURL.

Version:

$Id: HstURLFactory.java 31509 2011-11-29 11:38:43Z aschrijvers $

Method Summary

HstURL	createURL(String type, String referenceNamespace, HstContainerURL base, HstRequestContext requestContext) Returns HstURL for the HstURL type with reference namespace based on the base container URL
HstURL	createURL(String type, String referenceNamespace, HstContainerURL base, 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.

Method Detail

getContainerURLProvider

HstContainerURLProvider getContainerURLProvider()

Returns the HstContainerURLProvider.

Returns:

HstContainerURLProvider

createURL

HstURL createURL(String type,
                 String referenceNamespace,
                 HstContainerURL base,
                 HstRequestContext requestContext)

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

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.

base - the base HstContainer URL

requestContext - the current HstRequestContext

Returns:

HstContainerURLProvider

createURL

HstURL createURL(String type,
                 String referenceNamespace,
                 HstContainerURL base,
                 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

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.

base - 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

isReferenceNamespaceIgnored

boolean isReferenceNamespaceIgnored()

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

Returns: