RestUtils (Apache Juneau 8.1.3)

java.lang.Object
- org.apache.juneau.rest.util.RestUtils

public final class RestUtils
extends Object

Various reusable utility methods.

Constructor Summary

Constructors
Constructor and Description

RestUtils()

Constructors
Constructor and Description
`RestUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`fixMethodPath(String path)` Normalizes the `RestMethod.path()` value.
`static String`	`getHttpResponseText(int rc)` Returns readable text for an HTTP response code.
`static String`	`getPathInfoUndecoded(HttpServletRequest req)` Identical to `HttpServletRequest.getPathInfo()` but doesn't decode encoded characters.
`static boolean`	`isValidContextPath(String value)` Returns true if the specified value is a valid context path.
`static boolean`	`isValidPathInfo(String value)` Returns true if the specified value is a valid path-info path.
`static boolean`	`isValidServletPath(String value)` Returns true if the specified value is a valid servlet path.
`static Object[]`	`merge(Object[] fromParent, Object[] fromChild)` Merges the specified parent and child arrays.
`static Object`	`parseAnything(String s)` Parses a string that can consist of a simple string or JSON object/array.
`static String[]`	`parseHeader(String s)` Parses HTTP header.
`static String[]`	`parseKeyValuePair(String s)` Parses key/value pairs separated by either : or =
`static Map<String,String[]>`	`parseQuery(Object qs)` Parses a URL query string or form-data body.
`static Map<String,String[]>`	`parseQuery(Object qs, Map<String,String[]> map)` Same as `parseQuery(Object)` but allows you to specify the map to insert values into.
`static String`	`trimContextPath(String contextPath, String path)` If the specified path-info starts with the specified context path, trims the context path from the path info.
`static StringBuffer`	`trimPathInfo(StringBuffer requestURI, String contextPath, String servletPath)` Efficiently trims the path info part from a request URI.
`static void`	`validateContextPath(String value)` Throws a `RuntimeException` if the method `isValidContextPath(String)` returns false for the specified value.
`static void`	`validatePathInfo(String value)` Throws a `RuntimeException` if the method `isValidPathInfo(String)` returns false for the specified value.
`static void`	`validateServletPath(String value)` Throws a `RuntimeException` if the method `isValidServletPath(String)` returns false for the specified value.

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

- Constructor Detail
  - RestUtils
```
public RestUtils()
```
- Method Detail
  - getHttpResponseText
```
public static String getHttpResponseText(int rc)
```
    Returns readable text for an HTTP response code.
    
    Parameters:
    
    rc - The HTTP response code.
    
    Returns:
    
    Readable text for an HTTP response code, or null if it's an invalid code.
  - getPathInfoUndecoded
```
public static String getPathInfoUndecoded(HttpServletRequest req)
```
    Identical to HttpServletRequest.getPathInfo() but doesn't decode encoded characters.
    
    Parameters:
    
    req - The HTTP request
    
    Returns:
    
    The un-decoded path info.
  - trimPathInfo
```
public static StringBuffer trimPathInfo(StringBuffer requestURI,
                                        String contextPath,
                                        String servletPath)
```
    Efficiently trims the path info part from a request URI.
    The result is the URI of the servlet itself.
    
    Parameters:
    
    requestURI - The value returned by HttpServletRequest.getRequestURL()
    
    contextPath - The value returned by HttpServletRequest.getContextPath()
    
    servletPath - The value returned by HttpServletRequest.getServletPath()
    
    Returns:
    
    The same StringBuilder with remainder trimmed.
  - parseHeader
```
public static String[] parseHeader(String s)
```
    Parses HTTP header.
    
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The parsed string.
  - parseKeyValuePair
```
public static String[] parseKeyValuePair(String s)
```
    Parses key/value pairs separated by either : or =
    
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The parsed string.
  - parseQuery
```
public static Map<String,String[]> parseQuery(Object qs)
```
    Parses a URL query string or form-data body.
    
    Parameters:
    
    qs - A reader or string containing the query string to parse.
    
    Returns:
    
    A new map containing the parsed query.
  - parseQuery
```
public static Map<String,String[]> parseQuery(Object qs,
                                              Map<String,String[]> map)
```
    Same as parseQuery(Object) but allows you to specify the map to insert values into.
    
    Parameters:
    
    qs - A reader containing the query string to parse.
    
    map - The map to pass the values into.
    
    Returns:
    
    The same map passed in, or a new map if it was null.
  - parseAnything
```
public static Object parseAnything(String s)
                            throws ParseException
```
    Parses a string that can consist of a simple string or JSON object/array.
    
    Parameters:
    
    s - The string to parse.
    
    Returns:
    
    The parsed value, or null if the input is null.
    
    Throws:
    
    ParseException - Invalid JSON in string.
  - merge
```
public static Object[] merge(Object[] fromParent,
                             Object[] fromChild)
```
    Merges the specified parent and child arrays.
    The general concept is to allow child values to override parent values.
    The rules are:
    - If the child array is not empty, then the child array is returned.
    - If the child array is empty, then the parent array is returned.
    - If the child array contains None, then an empty array is always returned.
    - If the child array contains Inherit, then the contents of the parent array are inserted into the position of the Inherit entry.
    Parameters:
    
    fromParent - The parent array.
    
    fromChild - The child array.
    
    Returns:
    
    A new merged array.
  - trimContextPath
```
public static String trimContextPath(String contextPath,
                                     String path)
```
    If the specified path-info starts with the specified context path, trims the context path from the path info.
    
    Parameters:
    
    contextPath - The context path.
    
    path - The URL path.
    
    Returns:
    
    The path following the context path, or the original path.
  - fixMethodPath
```
public static String fixMethodPath(String path)
```
    Normalizes the RestMethod.path() value.
    
    Parameters:
    
    path - The path to normalize.
    
    Returns:
    
    The normalized path.
  - isValidContextPath
```
public static boolean isValidContextPath(String value)
```
    Returns true if the specified value is a valid context path. The path must start with a "/" character but not end with a "/" character. For servlets in the default (root) context, the value should be "".
    
    Parameters:
    
    value - The value to test.
    
    Returns:
    
    true if the specified value is a valid context path.
  - validateContextPath
```
public static void validateContextPath(String value)
```
    Throws a RuntimeException if the method isValidContextPath(String) returns false for the specified value.
    
    Parameters:
    
    value - The value to test.
  - isValidServletPath
```
public static boolean isValidServletPath(String value)
```
    Returns true if the specified value is a valid servlet path. This path must with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Should be an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
    
    Parameters:
    
    value - The value to test.
    
    Returns:
    
    true if the specified value is a valid servlet path.
  - validateServletPath
```
public static void validateServletPath(String value)
```
    Throws a RuntimeException if the method isValidServletPath(String) returns false for the specified value.
    
    Parameters:
    
    value - The value to test.
  - isValidPathInfo
```
public static boolean isValidPathInfo(String value)
```
    Returns true if the specified value is a valid path-info path. The extra path information follows the servlet path but precedes the query string and will start with a "/" character. The value should be null if there was no extra path information.
    
    Parameters:
    
    value - The value to test.
    
    Returns:
    
    true if the specified value is a valid path-info path.
  - validatePathInfo
```
public static void validatePathInfo(String value)
```
    Throws a RuntimeException if the method isValidPathInfo(String) returns false for the specified value.
    
    Parameters:
    
    value - The value to test.

Class RestUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestUtils

Method Detail

getHttpResponseText

getPathInfoUndecoded

trimPathInfo

parseHeader

parseKeyValuePair

parseQuery

parseQuery

parseAnything

merge

trimContextPath

fixMethodPath

isValidContextPath

validateContextPath

isValidServletPath

validateServletPath

isValidPathInfo

validatePathInfo