org.hippoecm.hst.core.container
Interface HstContainerURL

All Known Implementing Classes:

HstContainerURLImpl

public interface HstContainerURL

The HstComponent container URL. This is responsible for managing the request URL states of all the HstComponents.

Version:

$Id: HstContainerURL.java 30326 2011-09-20 15:08:12Z aschrijvers $

Method Summary

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	setComponentRenderingWindowReferenceNamespace(String componentRenderingWindowReferenceNamespace) Sets the reference namespace of the current component rendering window if it is necessary.
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	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.

Method Detail

getCharacterEncoding

String getCharacterEncoding()

Returns the current response's character encoding.

Returns:

getHostName

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

Returns:

the host name of the request

getContextPath

String getContextPath()

Returns the current container's servlet context path.

Returns:

getRequestPath

String getRequestPath()

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

Returns:

getPortNumber

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

Returns:

the portnumber of the request

getResolvedMountPath

String getResolvedMountPath()

Returns:

ResolvedMount path or null when not yet resolved

getPathInfo

String getPathInfo()

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

Returns:

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

getActionWindowReferenceNamespace

String getActionWindowReferenceNamespace()

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

Returns:

setActionWindowReferenceNamespace

void setActionWindowReferenceNamespace(String actionWindowReferenceNamespace)

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.

Parameters:

actionWindowReferenceNamespace -

getResourceWindowReferenceNamespace

String getResourceWindowReferenceNamespace()

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.

Returns:

setResourceWindowReferenceNamespace

void setResourceWindowReferenceNamespace(String resourceWindowReferenceNamespace)

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.

Parameters:

resourceWindowReferenceNamespace -

getComponentRenderingWindowReferenceNamespace

String getComponentRenderingWindowReferenceNamespace()

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

Returns:

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

setComponentRenderingWindowReferenceNamespace

void setComponentRenderingWindowReferenceNamespace(String componentRenderingWindowReferenceNamespace)

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.

Parameters:

componentRenderingWindowReferenceNamespace -

getResourceId

String getResourceId()

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

Returns:

setResourceId

void setResourceId(String resourceId)

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

Parameters:

resourceId -

setParameter

void setParameter(String name,
                  String value)

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

Parameters:

name -

value -

setParameter

void setParameter(String name,
                  String[] values)

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

Parameters:

name -

values -

setParameters

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

Sets the render parameter map.

Parameters:

parameters -

getParameterMap

Map<String,String[]> getParameterMap()

Returns the render parameter map.

Returns:

setActionParameter

void setActionParameter(String name,
                        String value)

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

Parameters:

name -

value -

setActionParameter

void setActionParameter(String name,
                        String[] values)

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

Parameters:

name -

values -

setActionParameters

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

Sets the action parameter map.

Parameters:

parameters -

getActionParameterMap

Map<String,String[]> getActionParameterMap()

Returns the action parameter map.

Returns: