HstRequestUtils (Hippo Site Toolkit 4.1.0 API)

java.lang.Object
- org.hippoecm.hst.util.HstRequestUtils

public class HstRequestUtils
extends Object

HST Request Utils

Field Summary

Fields
Modifier and Type Field and Description

static String HTTP_METHOD_POST

static Pattern MATRIX_PARAMS_PATTERN

Fields
Modifier and Type	Field and Description
`static String`	`HTTP_METHOD_POST`
`static Pattern`	`MATRIX_PARAMS_PATTERN`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`createURLWithExplicitSchemeForRequest(String scheme, Mount mount, javax.servlet.http.HttpServletRequest request)` Creates the same fully qualified URL as the client used to make the request, only force the scheme of the URL to be equal to the `scheme` parameter instead of the scheme of the `request`.
`static String`	`escapeXml(String str)` Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.
`static String`	`getCharacterEncoding(javax.servlet.http.HttpServletRequest request)` Returns the name of the character encoding used in the body of the servlet request.
`static String`	`getCharacterEncoding(javax.servlet.http.HttpServletRequest request, String defaultEncoding)` Returns the name of the character encoding used in the body of the servlet request.
`static String`	`getExternalRequestUrl(javax.servlet.http.HttpServletRequest request, boolean includeQueryString)` Returns the request URL as seen by, for example, a browser.
`static String`	`getFarthestRemoteAddr(javax.servlet.http.HttpServletRequest request)` Returns the remote client address.
`static String`	`getFarthestRequestHost(javax.servlet.http.HttpServletRequest request)` Returns the original host information requested by the client.
`static String`	`getFarthestRequestHost(javax.servlet.http.HttpServletRequest request, boolean checkRenderHost)` Returns the original host information requested by the client and do check optional injected render host information only when `checkRenderHost` is `true`
`static String`	`getFarthestRequestScheme(javax.servlet.http.HttpServletRequest request)`
`static String`	`getFullyQualifiedHstURL(HstRequestContext requestContext, HstURL hstUrl, boolean escapeXml)` Returns a fully qualified String url for the `HstURL` `hstUrl`.
`static HstRequest`	`getHstRequest(javax.servlet.http.HttpServletRequest servletRequest)` Returns `HstRequest` object found in the servletRequest.
`static HstRequestContext`	`getHstRequestContext(javax.servlet.http.HttpServletRequest servletRequest)` Returns `HstRequestContext` object found in the servletRequest.
`static HstResponse`	`getHstResponse(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)` Returns `HstResponse` object found in the servletRequest or servletResponse.
`static String`	`getPathInfo(ResolvedMount mount, javax.servlet.http.HttpServletRequest request)` Deprecated. since CMS 7.9.1 (2.28.05) use `HttpServletRequest.getPathInfo()` instead
`static String`	`getPathInfo(ResolvedMount mount, javax.servlet.http.HttpServletRequest request, String characterEncoding)` Deprecated. since CMS 7.9.1 (2.28.05) use `HttpServletRequest.getPathInfo()` instead
`static String[]`	`getRemoteAddrs(javax.servlet.http.HttpServletRequest request)` Returns the remote host addresses related to this request.
`static String`	`getRenderingHost(javax.servlet.http.HttpServletRequest request)` Returns the rendering host of the current request, i.e.
`static String[]`	`getRequestHosts(javax.servlet.http.HttpServletRequest request)` Returns the original host informations requested by the client or the proxies in the Host HTTP request headers.
`static String[]`	`getRequestHosts(javax.servlet.http.HttpServletRequest request, boolean checkRenderHost)` Returns HTTP/1.1 compatible 'Host' header value.
`static String`	`getRequestPath(javax.servlet.http.HttpServletRequest request)`
`static String`	`getRequestPath(javax.servlet.http.HttpServletRequest request, String characterEncoding)`
`static String`	`getRequestServerName(javax.servlet.http.HttpServletRequest request)` Returns the original host's server name requested by the client.
`static int`	`getRequestServerPort(javax.servlet.http.HttpServletRequest request)` Returns the original host' port number requested by the client.
`static String`	`getRequestURI(javax.servlet.http.HttpServletRequest request, boolean excludeMatrixParameters)`
`static boolean`	`isComponentRenderingPreviewRequest(HstRequestContext requestContext)`
`static Map<String,String[]>`	`parseQueryString(javax.servlet.http.HttpServletRequest request)`
`static Map<String,String[]>`	`parseQueryString(URI uri, String encoding)`
`static String`	`removeAllMatrixParams(String uri)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MATRIX_PARAMS_PATTERN
```
public static final Pattern MATRIX_PARAMS_PATTERN
```
  - HTTP_METHOD_POST
```
public static final String HTTP_METHOD_POST
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getHstRequest
```
public static HstRequest getHstRequest(javax.servlet.http.HttpServletRequest servletRequest)
```
    Returns HstRequest object found in the servletRequest.
    
    Parameters:
    
    servletRequest -
    
    Returns:
  - getHstResponse
```
public static HstResponse getHstResponse(javax.servlet.http.HttpServletRequest servletRequest,
                                         javax.servlet.http.HttpServletResponse servletResponse)
```
    Returns HstResponse object found in the servletRequest or servletResponse.
    
    Parameters:
    
    servletRequest -
    
    servletResponse -
    
    Returns:
  - getHstRequestContext
```
public static HstRequestContext getHstRequestContext(javax.servlet.http.HttpServletRequest servletRequest)
```
    Returns HstRequestContext object found in the servletRequest.
    
    Parameters:
    
    servletRequest -
    
    Returns:
  - getRequestURI
```
public static String getRequestURI(javax.servlet.http.HttpServletRequest request,
                                   boolean excludeMatrixParameters)
```
    Parameters:
    
    request -
    
    excludeMatrixParameters -
    
    Returns:
  - getRequestPath
```
public static String getRequestPath(javax.servlet.http.HttpServletRequest request)
```
    Parameters:
    
    request -
    
    Returns:
    
    the decoded getRequestURI after the context path but before the matrix parameters or the query string in the request URL
  - getRequestPath
```
public static String getRequestPath(javax.servlet.http.HttpServletRequest request,
                                    String characterEncoding)
```
    Parameters:
    
    request -
    
    characterEncoding -
    
    Returns:
    
    the decoded getRequestURI after the context path but before the matrix parameters or the query string in the request URL
  - getPathInfo
```
@Deprecated
public static String getPathInfo(ResolvedMount mount,
                                             javax.servlet.http.HttpServletRequest request)
```
    Deprecated. since CMS 7.9.1 (2.28.05) use HttpServletRequest.getPathInfo() instead
  - getPathInfo
```
@Deprecated
public static String getPathInfo(ResolvedMount mount,
                                             javax.servlet.http.HttpServletRequest request,
                                             String characterEncoding)
```
    Deprecated. since CMS 7.9.1 (2.28.05) use HttpServletRequest.getPathInfo() instead
  - getRequestHosts
```
public static String[] getRequestHosts(javax.servlet.http.HttpServletRequest request,
                                       boolean checkRenderHost)
```
    Returns HTTP/1.1 compatible 'Host' header value.
    
    Parameters:
    
    request -
    
    checkRenderHost -
    
    Returns:
  - getRenderingHost
```
public static String getRenderingHost(javax.servlet.http.HttpServletRequest request)
```
    Returns the rendering host of the current request, i.e. the host at which the request output is rendered. The rendering host can be set as a request parameter, or be present in the HTTP session. The request parameter value has precedence over the value in the HTTP session.
    
    Parameters:
    
    request - the servlet request
    
    Returns:
    
    the rendering host for the current request
  - getRequestHosts
```
public static String[] getRequestHosts(javax.servlet.http.HttpServletRequest request)
```
    Returns the original host informations requested by the client or the proxies in the Host HTTP request headers.
    
    Parameters:
    
    request -
    
    Returns:
  - getFarthestRequestHost
```
public static String getFarthestRequestHost(javax.servlet.http.HttpServletRequest request)
```
    Returns the original host information requested by the client.
    
    Parameters:
    
    request -
    
    Returns:
  - getFarthestRequestHost
```
public static String getFarthestRequestHost(javax.servlet.http.HttpServletRequest request,
                                            boolean checkRenderHost)
```
    Returns the original host information requested by the client and do check optional injected render host information only when checkRenderHost is true
    
    Parameters:
    
    request -
    
    checkRenderHost - when true the optional render host is used when present.
    
    Returns:
    
    the farthest request host or option render host when checkRenderHost is true
  - getFarthestRequestScheme
```
public static String getFarthestRequestScheme(javax.servlet.http.HttpServletRequest request)
```
  - getRequestServerName
```
public static String getRequestServerName(javax.servlet.http.HttpServletRequest request)
```
    Returns the original host's server name requested by the client.
    
    Parameters:
    
    request -
    
    Returns:
  - getRequestServerPort
```
public static int getRequestServerPort(javax.servlet.http.HttpServletRequest request)
```
    Returns the original host' port number requested by the client.
    
    Parameters:
    
    request -
    
    Returns:
  - getRemoteAddrs
```
public static String[] getRemoteAddrs(javax.servlet.http.HttpServletRequest request)
```
    Returns the remote host addresses related to this request. If there's any proxy server between the client and the server, then the proxy addresses are contained in the returned array. The lowest indexed element is the farthest downstream client and each successive proxy addresses are the next elements.
    
    Parameters:
    
    request -
    
    Returns:
  - getFarthestRemoteAddr
```
public static String getFarthestRemoteAddr(javax.servlet.http.HttpServletRequest request)
```
    Returns the remote client address.
    
    Parameters:
    
    request -
    
    Returns:
  - getCharacterEncoding
```
public static String getCharacterEncoding(javax.servlet.http.HttpServletRequest request)
```
    Returns the name of the character encoding used in the body of the servlet request. This method returns ISO-8859-1 instead of null if the request does not specify a character encoding because the Servlet specification requires that an encoding of ISO-8859-1 is used if a character encoding is not specified.
    
    Parameters:
    
    request -
    
    Returns:
  - getCharacterEncoding
```
public static String getCharacterEncoding(javax.servlet.http.HttpServletRequest request,
                                          String defaultEncoding)
```
    Returns the name of the character encoding used in the body of the servlet request. This method returns defaultEncoding instead of null if the request does not specify a character encoding.
    
    Parameters:
    
    request -
    
    defaultEncoding -
    
    Returns:
  - parseQueryString
```
public static Map<String,String[]> parseQueryString(javax.servlet.http.HttpServletRequest request)
```
  - parseQueryString
```
public static Map<String,String[]> parseQueryString(URI uri,
                                                    String encoding)
                                             throws UnsupportedEncodingException
```
    Throws:
    
    UnsupportedEncodingException
  - removeAllMatrixParams
```
public static String removeAllMatrixParams(String uri)
```
  - createURLWithExplicitSchemeForRequest
```
public static String createURLWithExplicitSchemeForRequest(String scheme,
                                                           Mount mount,
                                                           javax.servlet.http.HttpServletRequest request)
```
    Creates the same fully qualified URL as the client used to make the request, only force the scheme of the URL to be equal to the scheme parameter instead of the scheme of the request.
  - getFullyQualifiedHstURL
```
public static String getFullyQualifiedHstURL(HstRequestContext requestContext,
                                             HstURL hstUrl,
                                             boolean escapeXml)
```
    Returns a fully qualified String url for the HstURL hstUrl. As scheme for the created url, always the scheme of the current (farthest) request is taken, as a hstUrl can never have a different scheme than the request that was used to create the hstUrl
  - escapeXml
```
public static String escapeXml(String str)
```
    Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.
    
    Parameters:
    
    str - - the String where to replace
    
    Returns:
    
    String
  - isComponentRenderingPreviewRequest
```
public static boolean isComponentRenderingPreviewRequest(HstRequestContext requestContext)
```
    Returns:
    
    true if the request is a preview component rendering request from channel manager in cms
  - getExternalRequestUrl
```
public static String getExternalRequestUrl(javax.servlet.http.HttpServletRequest request,
                                           boolean includeQueryString)
```
    Returns the request URL as seen by, for example, a browser. The returned URL consists of:
    1. the base URL as returned by VirtualHost.getBaseURL(javax.servlet.http.HttpServletRequest)
    2. the context path, if that is configured in the HST to be visible (as determined by VirtualHost.isContextPathInUrl())
    3. the path of the URL
    4. optionally based on flag includeQueryString, the queryString is added
    Parameters:
    
    request - the HTTP servlet request
    
    includeQueryString - whether to include the queryString as seen by the browser
    
    Returns:
    
    the external request URL as seen by the browser (without encoding)

Class HstRequestUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MATRIX_PARAMS_PATTERN

HTTP_METHOD_POST

Method Detail

getHstRequest

getHstResponse

getHstRequestContext

getRequestURI

getRequestPath

getRequestPath

getPathInfo

getPathInfo

getRequestHosts

getRenderingHost

getRequestHosts

getFarthestRequestHost

getFarthestRequestHost

getFarthestRequestScheme

getRequestServerName

getRequestServerPort

getRemoteAddrs

getFarthestRemoteAddr

getCharacterEncoding

getCharacterEncoding

parseQueryString

parseQueryString

removeAllMatrixParams

createURLWithExplicitSchemeForRequest

getFullyQualifiedHstURL

escapeXml

isComponentRenderingPreviewRequest

getExternalRequestUrl