Package org.forgerock.http.filter

Class OptionsFilter

java.lang.Object

org.forgerock.http.filter.OptionsFilter

All Implemented Interfaces:

Filter

public final class OptionsFilter
extends Object
implements Filter

Filter which handles OPTION HTTP requests to CREST resources.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD_DELETE	The HTTP DELETE method.
static final String	METHOD_GET	The HTTP GET method.
static final String	METHOD_HEAD	The HTTP HEAD method.
static final String	METHOD_OPTIONS	The HTTP OPTIONS method.
static final String	METHOD_PATCH	The HTTP PATCH method.
static final String	METHOD_POST	The HTTP POST method.
static final String	METHOD_PUT	The HTTP PUT method.
static final String	METHOD_TRACE	The HTTP TRACE method.

Method Summary

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Handles all OPTION requests to CREST resources, all other request methods are handled by the Handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

METHOD_DELETE

public static final String METHOD_DELETE

The HTTP DELETE method.

See Also:

• Constant Field Values

METHOD_GET

public static final String METHOD_GET

The HTTP GET method.

See Also:

• Constant Field Values

METHOD_HEAD

public static final String METHOD_HEAD

The HTTP HEAD method.

See Also:

• Constant Field Values

METHOD_OPTIONS

public static final String METHOD_OPTIONS

The HTTP OPTIONS method.

See Also:

• Constant Field Values

METHOD_PATCH

public static final String METHOD_PATCH

The HTTP PATCH method.

See Also:

• Constant Field Values

METHOD_POST

public static final String METHOD_POST

The HTTP POST method.

See Also:

• Constant Field Values

METHOD_PUT

public static final String METHOD_PUT

The HTTP PUT method.

See Also:

• Constant Field Values

METHOD_TRACE

public static final String METHOD_TRACE

The HTTP TRACE method.

See Also:

• Constant Field Values

Method Details

filter

public Promise<Response,NeverThrowsException> filter(Context context,
 Request request,
 Handler next)

Handles all OPTION requests to CREST resources, all other request methods are handled by the Handler.

Specified by:

filter in interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.