HstContainerURL (Hippo Site Toolkit API 5.0.2 API)

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

Version:

$Id$

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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
`String`	`getParameter(String name)` Returns the value of a render parameter as a `String`, or `null` if the render parameter does not exist.
`Map<String,String[]>`	`getParameterMap()` Returns the render parameter map.
`String[]`	`getParameterValues(String name)` Returns an array of `String` objects containing all of the values the given render parameter has, or `null` if the render parameter does not exist.
`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.
`String`	`getURIEncoding()` Returns the current response's URI encoding.
`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:
    
    the current response's character encoding.
  - getURIEncoding
```
String getURIEncoding()
```
    Returns the current response's URI encoding.
    
    Returns:
    
    the current response's URI encoding.
  - 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:
    
    the current container's servlet context path.
  - getRequestPath
```
String getRequestPath()
```
    Returns the current request after the context path but before the queryString. This is thus the servletPath plus pathInfo.
  - 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:
    
    the reference namespace of the current action window if it exists; null if there's no action window in the currernt request.
  - 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:
    
    the reference namespace of the current resource serving window if it exists; null if there's no resource serving window in the currernt request.
  - 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:
    
    the resource ID if the current request is for serving resource in a component window. Otherwise, it returns null.
  - 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:
    
    the render parameter map.
  - getParameter
```
String getParameter(String name)
```
    Returns the value of a render parameter as a String, or null if the render parameter does not exist.
    You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParameterValues(java.lang.String).
    If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.
    
    Parameters:
    
    name -
  - getParameterValues
```
String[] getParameterValues(String name)
```
    Returns an array of String objects containing all of the values the given render parameter has, or null if the render parameter does not exist.
    
    Parameters:
    
    name -
  - 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:
    
    the action parameter map.

Interface HstContainerURL

Method Summary

Method Detail

getCharacterEncoding

getURIEncoding

getHostName

getContextPath

getRequestPath

getPortNumber

getResolvedMountPath

getPathInfo

getActionWindowReferenceNamespace

setActionWindowReferenceNamespace

getResourceWindowReferenceNamespace

setResourceWindowReferenceNamespace

getComponentRenderingWindowReferenceNamespace

setComponentRenderingWindowReferenceNamespace

getResourceId

setResourceId

setParameter

setParameter

setParameters

getParameterMap

getParameter

getParameterValues

setActionParameter

setActionParameter

setActionParameters

getActionParameterMap