org.hippoecm.hst.core.container
Class HstContainerURLImpl

java.lang.Object
  org.hippoecm.hst.core.container.HstContainerURLImpl

All Implemented Interfaces:

Cloneable, HstContainerURL

public class HstContainerURLImpl
extends Object
implements HstContainerURL, Cloneable

HstContainerURLImpl

Version:

$Id: HstContainerURLImpl.java 30336 2011-09-21 09:58:41Z aschrijvers $

Field Summary

protected Map<String,String[]>	actionParameterMap
protected String	actionWindowReferenceNamespace
protected String	characterEncoding
protected String	componentRenderingReferenceNamespace
protected String	contextPath
protected String	hostName
protected Map<String,String[]>	parameterMap
protected String	pathInfo
protected int	portNumber
protected String	requestPath
protected String	resolvedMountPath
protected String	resourceId
protected String	resourceWindowReferenceNamespace

Constructor Summary

HstContainerURLImpl()

Method Summary

Object	clone()
Map<String,String[]>	getActionParameterMap() Returns the action parameter map.
String	getActionWindowReferenceNamespace() Returns the reference namespace of the current action window if it exists.
String	getCharacterEncoding() Returns the current response's character encoding.
String	getComponentRenderingWindowReferenceNamespace() Returns the reference namespace of the current rendering component if it exists.
String	getContextPath() Returns the current container's servlet context path.
String	getHostName() Returns the host name of the request: note that with reverse proxies, this can be the original host informations requested by the client or the proxies
Map<String,String[]>	getParameterMap() Returns the render parameter map.
String	getPathInfo() Returns the current request's path info (part after context path and Mount path)
int	getPortNumber() Returns the portnumber of the request: note that with reverse proxies, this can be the original port requested by the client or the proxies
String	getRequestPath() Returns the current request after the context path but before the queryString.
String	getResolvedMountPath()
String	getResourceId() Returns the resource ID if the current request is for serving resource in a component window.
String	getResourceWindowReferenceNamespace() Returns the reference namespace of the current resource serving window if it exists.
void	setActionParameter(String name, String value) Sets the action parameter for the target HstComponent.
void	setActionParameter(String name, String[] values) Sets the action parameter values for the target HstComponent.
void	setActionParameters(Map<String,String[]> parameters) Sets the action parameter map.
void	setActionWindowReferenceNamespace(String actionWindowReferenceNamespace) Sets the reference namespace of the current action window if it is necessary.
void	setCharacterEncoding(String characterEncoding)
void	setComponentRenderingWindowReferenceNamespace(String referenceNamespace) Sets the reference namespace of the current component rendering window if it is necessary.
void	setContextPath(String contextPath)
void	setHostName(String hostName)
void	setParameter(String name, String value) Sets the render parameter for a HstComponent.
void	setParameter(String name, String[] values) Sets the render parameter value array for a HstComponent.
void	setParameters(Map<String,String[]> parameters) Sets the render parameter map.
void	setPathInfo(String pathInfo)
void	setPortNumber(int portNumber)
void	setRequestPath(String requestPath)
void	setResolvedMountPath(String resolvedMountPath)
void	setResourceId(String resourceId) Sets the resource ID if the current request is for serving resource in a component window.
void	setResourceWindowReferenceNamespace(String resourceWindowReferenceNamespace) Sets the reference namespace of the current resource serving window if it is necessary.

Methods inherited from class java.lang.Object

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

Field Detail

characterEncoding

protected String characterEncoding

contextPath

protected String contextPath

hostName

protected String hostName

requestPath

protected String requestPath

resolvedMountPath

protected String resolvedMountPath

pathInfo

protected String pathInfo

portNumber

protected int portNumber

actionWindowReferenceNamespace

protected String actionWindowReferenceNamespace

resourceWindowReferenceNamespace

protected String resourceWindowReferenceNamespace

componentRenderingReferenceNamespace

protected String componentRenderingReferenceNamespace

resourceId

protected String resourceId

parameterMap

protected Map<String,String[]> parameterMap

actionParameterMap

protected Map<String,String[]> actionParameterMap

Constructor Detail

HstContainerURLImpl

public HstContainerURLImpl()

Method Detail

getHostName

public String getHostName()

Description copied from interface: HstContainerURL

Returns the host name of the request: note that with reverse proxies, this can be the original host informations requested by the client or the proxies

Specified by:

getHostName in interface HstContainerURL

Returns:

the host name of the request

setHostName

public void setHostName(String hostName)

getRequestPath

public String getRequestPath()

Description copied from interface: HstContainerURL

Returns the current request after the context path but before the queryString. This is thus the servletPath plus pathInfo.

Specified by:

getRequestPath in interface HstContainerURL

Returns:

setRequestPath

public void setRequestPath(String requestPath)

getResolvedMountPath

public String getResolvedMountPath()

Specified by:

getResolvedMountPath in interface HstContainerURL

Returns:

ResolvedMount path or null when not yet resolved

setResolvedMountPath

public void setResolvedMountPath(String resolvedMountPath)

getPortNumber

public int getPortNumber()

Description copied from interface: HstContainerURL

Returns the portnumber of the request: note that with reverse proxies, this can be the original port requested by the client or the proxies

Specified by:

getPortNumber in interface HstContainerURL

Returns:

the portnumber of the request

setPortNumber

public void setPortNumber(int portNumber)

setContextPath

public void setContextPath(String contextPath)

getContextPath

public String getContextPath()

Description copied from interface: HstContainerURL

Returns the current container's servlet context path.

Specified by:

getContextPath in interface HstContainerURL

Returns:

setPathInfo

public void setPathInfo(String pathInfo)

getPathInfo

public String getPathInfo()

Description copied from interface: HstContainerURL

Returns the current request's path info (part after context path and Mount path)

Specified by:

getPathInfo in interface HstContainerURL

Returns:

path info or null when the resolved mount path is not yet resolved

setActionWindowReferenceNamespace

public void setActionWindowReferenceNamespace(String actionWindowReferenceNamespace)

Description copied from interface: HstContainerURL

Sets the reference namespace of the current action window if it is necessary. This is invoked by the container's request processor to manage the request states.

Specified by:

setActionWindowReferenceNamespace in interface HstContainerURL

getActionWindowReferenceNamespace

public String getActionWindowReferenceNamespace()

Description copied from interface: HstContainerURL

Returns the reference namespace of the current action window if it exists. Returns null if there's no action window in the currernt request.

Specified by:

getActionWindowReferenceNamespace in interface HstContainerURL

Returns:

setResourceWindowReferenceNamespace

public void setResourceWindowReferenceNamespace(String resourceWindowReferenceNamespace)

Description copied from interface: HstContainerURL

Sets the reference namespace of the current resource serving window if it is necessary. This is invoked by the container's request processor to manage the request states.

Specified by:

setResourceWindowReferenceNamespace in interface HstContainerURL

getResourceWindowReferenceNamespace

public String getResourceWindowReferenceNamespace()

Description copied from interface: HstContainerURL

Returns the reference namespace of the current resource serving window if it exists. Returns null if there's no resource serving window in the currernt request.

Specified by:

getResourceWindowReferenceNamespace in interface HstContainerURL

Returns:

getComponentRenderingWindowReferenceNamespace

public String getComponentRenderingWindowReferenceNamespace()

Description copied from interface: HstContainerURL

Returns the reference namespace of the current rendering component if it exists. If this is not a request for component rendering (rendering a single component), then this returns null

Specified by:

getComponentRenderingWindowReferenceNamespace in interface HstContainerURL

Returns:

the componentRenderingWindowReferenceNamespace and null if the request is not a component rendering request

setComponentRenderingWindowReferenceNamespace

public void setComponentRenderingWindowReferenceNamespace(String referenceNamespace)

Description copied from interface: HstContainerURL

Sets the reference namespace of the current component rendering window if it is necessary. This is invoked by the container's request processor to manage the request states.

Specified by:

setComponentRenderingWindowReferenceNamespace in interface HstContainerURL

setResourceId

public void setResourceId(String resourceId)

Description copied from interface: HstContainerURL

Sets the resource ID if the current request is for serving resource in a component window.

Specified by:

setResourceId in interface HstContainerURL

getResourceId

public String getResourceId()

Description copied from interface: HstContainerURL

Returns the resource ID if the current request is for serving resource in a component window. Otherwise, it returns null.

Specified by:

getResourceId in interface HstContainerURL

Returns:

getParameterMap

public Map<String,String[]> getParameterMap()

Description copied from interface: HstContainerURL

Returns the render parameter map.

Specified by:

getParameterMap in interface HstContainerURL

Returns:

setParameter

public void setParameter(String name,
                         String value)

Description copied from interface: HstContainerURL

Sets the render parameter for a HstComponent. If the value is null, it will remove the parameter.

Specified by:

setParameter in interface HstContainerURL

setParameter

public void setParameter(String name,
                         String[] values)

Description copied from interface: HstContainerURL

Sets the render parameter value array for a HstComponent. If the values is null, it will remove the parameter.

Specified by:

setParameter in interface HstContainerURL

setParameters

public void setParameters(Map<String,String[]> parameters)

Description copied from interface: HstContainerURL

Sets the render parameter map.

Specified by:

setParameters in interface HstContainerURL

getActionParameterMap

public Map<String,String[]> getActionParameterMap()

Description copied from interface: HstContainerURL

Returns the action parameter map.

Specified by:

getActionParameterMap in interface HstContainerURL

Returns:

setActionParameter

public void setActionParameter(String name,
                               String value)

Description copied from interface: HstContainerURL

Sets the action parameter for the target HstComponent. If the value is null, it will remove the parameter.

Specified by:

setActionParameter in interface HstContainerURL

setActionParameter

public void setActionParameter(String name,
                               String[] values)

Description copied from interface: HstContainerURL

Sets the action parameter values for the target HstComponent. If the values is null, it will remove the parameter.

Specified by:

setActionParameter in interface HstContainerURL

setActionParameters

public void setActionParameters(Map<String,String[]> parameters)

Description copied from interface: HstContainerURL

Sets the action parameter map.

Specified by:

setActionParameters in interface HstContainerURL

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: HstContainerURL

Returns the current response's character encoding.

Specified by:

getCharacterEncoding in interface HstContainerURL

Returns:

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException