Package org.restheart.plugins

Enum Class InterceptPoint

java.lang.Object

java.lang.Enum<InterceptPoint>

org.restheart.plugins.InterceptPoint

All Implemented Interfaces:

Serializable, Comparable<InterceptPoint>, Constable

public enum InterceptPoint
extends Enum<InterceptPoint>

Defines the intercept point of an Interceptor

Author:

Andrea Di Cesare <andrea@softinstigate.com>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	ANY can be used exclusively in the dontIntercept attribute of the
REQUEST_AFTER_AUTH	intercept the request after authentication occurs
REQUEST_BEFORE_AUTH	intercept the request before authentication occurs
REQUEST_BEFORE_EXCHANGE_INIT	Intercepts the request before the exchange is initialized.
RESPONSE	intercept the response and executes blocking the response
RESPONSE_ASYNC	intercept the response and executes asynchronously with the response

Method Summary

Modifier and Type	Method	Description
static InterceptPoint	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InterceptPoint[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUEST_BEFORE_EXCHANGE_INIT

public static final InterceptPoint REQUEST_BEFORE_EXCHANGE_INIT

Intercepts the request before the exchange is initialized.

Interceptors on InterceptPoint.REQUEST_BEFORE_EXCHANGE_INIT must implement the interface WildcardInterceptor; in this case, Interceptor.handle(request, response) receives the request as UninitializedRequest and the response as UninitializedResponse.

Interceptors can provide a custom initializer with PluginUtils.attachCustomRequestInitializer() or can modify the raw request content using Request.setRawContent().

REQUEST_BEFORE_AUTH

public static final InterceptPoint REQUEST_BEFORE_AUTH

intercept the request before authentication occurs

REQUEST_AFTER_AUTH

public static final InterceptPoint REQUEST_AFTER_AUTH

intercept the request after authentication occurs

RESPONSE

public static final InterceptPoint RESPONSE

intercept the response and executes blocking the response

RESPONSE_ASYNC

public static final InterceptPoint RESPONSE_ASYNC

intercept the response and executes asynchronously with the response

ANY

public static final InterceptPoint ANY

ANY can be used exclusively in the dontIntercept attribute of the

Method Details

values

public static InterceptPoint[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static InterceptPoint valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null