ServletUtil (Magnolia Main Project (Parent) 5.5 API)

java.lang.Object
- info.magnolia.cms.util.ServletUtil

```
public abstract class ServletUtil
extends Object
```
Utility methods for operations related to Servlet API.

See Also:

RequestHeaderUtil

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ERROR_REQUEST_STATUS_CODE_ATTRIBUTE`
`static String`	`FORWARD_QUERY_STRING_ATTRIBUTE`
`static String`	`FORWARD_REQUEST_URI_ATTRIBUTE`
`static String`	`INCLUDE_CONTEXT_PATH_ATTRIBUTE`
`static String`	`INCLUDE_REQUEST_URI_ATTRIBUTE`

Constructor Summary

Constructors
Constructor and Description

ServletUtil()

Constructors
Constructor and Description
`ServletUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getContextPath(javax.servlet.http.HttpServletRequest request)`
`static String`	`getContextRelativePath(javax.servlet.http.HttpServletRequest request)` Returns the current path relative to the context path, the current path is the path used in the latest forward or include dispatch.
`static DispatcherType`	`getDispatcherType(javax.servlet.http.HttpServletRequest request)` Returns the dispatcher type of the request, the dispatcher type is defined to be identical to the semantics of filter mappings in web.xml.
`static String`	`getOriginalRequestURI(javax.servlet.http.HttpServletRequest request)` Returns the original request uri.
`static String`	`getOriginalRequestURLIncludingQueryString(javax.servlet.http.HttpServletRequest request)` Returns the original request url.
`static String`	`getRequestUri(javax.servlet.http.HttpServletRequest request)` Returns the request uri for the request.
`static <T extends javax.servlet.ServletRequest> T`	`getWrappedRequest(javax.servlet.ServletRequest request, Class<T> clazz)` Finds a request wrapper object inside the chain of request wrappers.
`static LinkedHashMap<String,String>`	`initParametersToMap(javax.servlet.FilterConfig config)` Returns the init parameters for a `FilterConfig` object as a Map, preserving the order in which they are exposed by the `FilterConfig` object.
`static LinkedHashMap<String,String>`	`initParametersToMap(javax.servlet.ServletConfig config)` Returns the init parameters for a `ServletConfig` object as a Map, preserving the order in which they are exposed by the `ServletConfig` object.
`static boolean`	`isError(javax.servlet.http.HttpServletRequest request)` Returns true if the request is rendering an error page, either due to a call to sendError() or an exception being thrown in a filter or a servlet that reached the container.
`static boolean`	`isForward(javax.servlet.http.HttpServletRequest request)` Returns true if the request is currently processing a forward operation.
`static boolean`	`isInclude(javax.servlet.http.HttpServletRequest request)` Returns true if the request is currently processing an include operation.
`static boolean`	`isMultipart(javax.servlet.http.HttpServletRequest request)` Returns true if the request has a content type that indicates that is a multipart request.
`static String`	`stripPathParameters(String uri)` Strips path parameters from a URI.

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

- Field Detail
  - FORWARD_REQUEST_URI_ATTRIBUTE
```
public static final String FORWARD_REQUEST_URI_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - FORWARD_QUERY_STRING_ATTRIBUTE
```
public static final String FORWARD_QUERY_STRING_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - INCLUDE_REQUEST_URI_ATTRIBUTE
```
public static final String INCLUDE_REQUEST_URI_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - INCLUDE_CONTEXT_PATH_ATTRIBUTE
```
public static final String INCLUDE_CONTEXT_PATH_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - ERROR_REQUEST_STATUS_CODE_ATTRIBUTE
```
public static final String ERROR_REQUEST_STATUS_CODE_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ServletUtil
```
public ServletUtil()
```
- Method Detail
  - initParametersToMap
```
public static LinkedHashMap<String,String> initParametersToMap(javax.servlet.ServletConfig config)
```
    Returns the init parameters for a ServletConfig object as a Map, preserving the order in which they are exposed by the ServletConfig object.
  - initParametersToMap
```
public static LinkedHashMap<String,String> initParametersToMap(javax.servlet.FilterConfig config)
```
    Returns the init parameters for a FilterConfig object as a Map, preserving the order in which they are exposed by the FilterConfig object.
  - getWrappedRequest
```
public static <T extends javax.servlet.ServletRequest> T getWrappedRequest(javax.servlet.ServletRequest request,
                                                                           Class<T> clazz)
```
    Finds a request wrapper object inside the chain of request wrappers.
  - isMultipart
```
public static boolean isMultipart(javax.servlet.http.HttpServletRequest request)
```
    Returns true if the request has a content type that indicates that is a multipart request.
  - isForward
```
public static boolean isForward(javax.servlet.http.HttpServletRequest request)
```
    Returns true if the request is currently processing a forward operation. This method will return false after an include operation has begun and will return true after that include operations has completed.
  - isInclude
```
public static boolean isInclude(javax.servlet.http.HttpServletRequest request)
```
    Returns true if the request is currently processing an include operation.
  - isError
```
public static boolean isError(javax.servlet.http.HttpServletRequest request)
```
    Returns true if the request is rendering an error page, either due to a call to sendError() or an exception being thrown in a filter or a servlet that reached the container. Will return true also after an include() or forward() while rendering the error page.
  - getDispatcherType
```
public static DispatcherType getDispatcherType(javax.servlet.http.HttpServletRequest request)
```
    Returns the dispatcher type of the request, the dispatcher type is defined to be identical to the semantics of filter mappings in web.xml.
  - getOriginalRequestURI
```
public static String getOriginalRequestURI(javax.servlet.http.HttpServletRequest request)
```
    Returns the original request uri. The If the request has been forwarded it finds the original request uri from request attributes. The returned uri is not decoded.
  - getOriginalRequestURLIncludingQueryString
```
public static String getOriginalRequestURLIncludingQueryString(javax.servlet.http.HttpServletRequest request)
```
    Returns the original request url. If the request has been forwarded it reconstructs the url from request attributes. The returned url is not decoded.
  - getRequestUri
```
public static String getRequestUri(javax.servlet.http.HttpServletRequest request)
```
    Returns the request uri for the request. If the request is an include it will return the uri being included. The returned uri is not decoded.
  - stripPathParameters
```
public static String stripPathParameters(String uri)
```
    Strips path parameters from a URI. Path parameters are mentioned in RFC-3986 section 3.3 but not clearly defined. The most common case for Java web applications is the JSESSIONID path parameter.
  - getContextRelativePath
```
public static String getContextRelativePath(javax.servlet.http.HttpServletRequest request)
```
    Returns the current path relative to the context path, the current path is the path used in the latest forward or include dispatch. The returned path is not decoded.
  - getContextPath
```
public static String getContextPath(javax.servlet.http.HttpServletRequest request)
```

Class ServletUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORWARD_REQUEST_URI_ATTRIBUTE

FORWARD_QUERY_STRING_ATTRIBUTE

INCLUDE_REQUEST_URI_ATTRIBUTE

INCLUDE_CONTEXT_PATH_ATTRIBUTE

ERROR_REQUEST_STATUS_CODE_ATTRIBUTE

Constructor Detail

ServletUtil

Method Detail

initParametersToMap

initParametersToMap

getWrappedRequest

isMultipart

isForward

isInclude

isError

getDispatcherType

getOriginalRequestURI

getOriginalRequestURLIncludingQueryString

getRequestUri

stripPathParameters

getContextRelativePath

getContextPath