HttpUtils (org.openidentityplatform.commons.parent 2.2.3 Documentation)

java.lang.Object
- org.forgerock.json.resource.http.HttpUtils

public final class HttpUtils
extends Object

HTTP utility methods and constants.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTENT_DISPOSITION` the HTTP header for Content-Disposition.
`static Version`	`DEFAULT_PROTOCOL_VERSION` The default version of the named protocol.
`static String`	`PARAM_ACTION` the HTTP request parameter for an action.
`static String`	`PARAM_CREST_API` Request the CREST API Descriptor.
`static String`	`PARAM_FIELDS` the HTTP request parameter to specify which fields to return.
`static String`	`PARAM_MIME_TYPE` the HTTP request parameter to request a certain mimetype for a filed.
`static String`	`PARAM_PAGE_SIZE` the HTTP request parameter to request a certain page size.
`static String`	`PARAM_PAGED_RESULTS_COOKIE` the HTTP request parameter to specify a paged results cookie.
`static String`	`PARAM_PAGED_RESULTS_OFFSET` the HTTP request parameter to specify a paged results offset.
`static String`	`PARAM_PRETTY_PRINT` the HTTP request parameter to request pretty printing.
`static String`	`PARAM_QUERY_EXPRESSION` the HTTP request parameter to specify a query expression.
`static String`	`PARAM_QUERY_FILTER` the HTTP request parameter to specify a query filter.
`static String`	`PARAM_QUERY_ID` the HTTP request parameter to specify a query id.
`static String`	`PARAM_SORT_KEYS` the HTTP request parameter to specify the sort keys.
`static String`	`PARAM_TOTAL_PAGED_RESULTS_POLICY` The policy used for counting total paged results.
`static Version`	`PROTOCOL_VERSION_1` Protocol Version 1.
`static Version`	`PROTOCOL_VERSION_2` Protocol Version 2 - supports upsert on PUT.
`static Version`	`PROTOCOL_VERSION_2_1` Protocol Version 2.1 - supports defacto standard for create requests when the ID of the created resource is to be allocated by the server, which are represented as a POST to the collection endpoint without an `_action` query parameter.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static RequestType`	`determineRequestType(Request request)` Determines which CREST operation (CRUDPAQ) of the incoming request.

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

- Field Detail
  - CONTENT_DISPOSITION
```
public static final String CONTENT_DISPOSITION
```
    the HTTP header for Content-Disposition.
    
    See Also:
    
    Constant Field Values
  - PARAM_ACTION
```
public static final String PARAM_ACTION
```
    the HTTP request parameter for an action.
  - PARAM_FIELDS
```
public static final String PARAM_FIELDS
```
    the HTTP request parameter to specify which fields to return.
  - PARAM_MIME_TYPE
```
public static final String PARAM_MIME_TYPE
```
    the HTTP request parameter to request a certain mimetype for a filed.
  - PARAM_PAGE_SIZE
```
public static final String PARAM_PAGE_SIZE
```
    the HTTP request parameter to request a certain page size.
  - PARAM_PAGED_RESULTS_COOKIE
```
public static final String PARAM_PAGED_RESULTS_COOKIE
```
    the HTTP request parameter to specify a paged results cookie.
  - PARAM_PAGED_RESULTS_OFFSET
```
public static final String PARAM_PAGED_RESULTS_OFFSET
```
    the HTTP request parameter to specify a paged results offset.
  - PARAM_PRETTY_PRINT
```
public static final String PARAM_PRETTY_PRINT
```
    the HTTP request parameter to request pretty printing.
    
    See Also:
    
    Constant Field Values
  - PARAM_QUERY_EXPRESSION
```
public static final String PARAM_QUERY_EXPRESSION
```
    the HTTP request parameter to specify a query expression.
  - PARAM_QUERY_FILTER
```
public static final String PARAM_QUERY_FILTER
```
    the HTTP request parameter to specify a query filter.
  - PARAM_QUERY_ID
```
public static final String PARAM_QUERY_ID
```
    the HTTP request parameter to specify a query id.
  - PARAM_SORT_KEYS
```
public static final String PARAM_SORT_KEYS
```
    the HTTP request parameter to specify the sort keys.
  - PARAM_TOTAL_PAGED_RESULTS_POLICY
```
public static final String PARAM_TOTAL_PAGED_RESULTS_POLICY
```
    The policy used for counting total paged results.
  - PARAM_CREST_API
```
public static final String PARAM_CREST_API
```
    Request the CREST API Descriptor.
  - PROTOCOL_VERSION_1
```
public static final Version PROTOCOL_VERSION_1
```
    Protocol Version 1.
  - PROTOCOL_VERSION_2
```
public static final Version PROTOCOL_VERSION_2
```
    Protocol Version 2 - supports upsert on PUT.
  - PROTOCOL_VERSION_2_1
```
public static final Version PROTOCOL_VERSION_2_1
```
    Protocol Version 2.1 - supports defacto standard for create requests when the ID of the created resource is to be allocated by the server, which are represented as a POST to the collection endpoint without an _action query parameter.
  - DEFAULT_PROTOCOL_VERSION
```
public static final Version DEFAULT_PROTOCOL_VERSION
```
    The default version of the named protocol.
- Method Detail
  - determineRequestType
```
public static RequestType determineRequestType(Request request)
                                        throws ResourceException
```
    Determines which CREST operation (CRUDPAQ) of the incoming request.
    
    Parameters:
    
    request - The request.
    
    Returns:
    
    The Operation.
    
    Throws:
    
    ResourceException - If the request operation could not be determined or is not supported.

Class HttpUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTENT_DISPOSITION

PARAM_ACTION

PARAM_FIELDS

PARAM_MIME_TYPE

PARAM_PAGE_SIZE

PARAM_PAGED_RESULTS_COOKIE

PARAM_PAGED_RESULTS_OFFSET

PARAM_PRETTY_PRINT

PARAM_QUERY_EXPRESSION

PARAM_QUERY_FILTER

PARAM_QUERY_ID

PARAM_SORT_KEYS

PARAM_TOTAL_PAGED_RESULTS_POLICY

PARAM_CREST_API

PROTOCOL_VERSION_1

PROTOCOL_VERSION_2

PROTOCOL_VERSION_2_1

DEFAULT_PROTOCOL_VERSION

Method Detail

determineRequestType