io.apiman.gateway.engine.policy

Interface IPolicyChain<T>

Type Parameters:

T - Service object type

All Known Implementing Classes:

Chain, RequestChain, ResponseChain

public interface IPolicyChain<T>

The interface given to policies that allows them to asynchronously signal when events occur.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	doApply(T serviceObject) Called by a policy when it has successfully completed applying itself.
void	doFailure(io.apiman.gateway.engine.beans.PolicyFailure failure) Called by a policy when it has detected a violation or failure in the policy.
void	doSkip(T serviceObject) Immediately trigger a successful response, rather than waiting for the entire policy chain to complete.
void	throwError(Throwable error) Called by a policy when an unexpected and unrecoverable error is encountered.

Method Detail

doApply

void doApply(T serviceObject)

Called by a policy when it has successfully completed applying itself. This triggers the next policy in the chain.

Parameters:

serviceObject - the service object

doSkip

void doSkip(T serviceObject)

Immediately trigger a successful response, rather than waiting for the entire policy chain to complete. This is useful for special cases where subsequent policies might block a response that should always succeed (e.g. CORS). Use extremely judiciously.

Parameters:

serviceObject - the service object

doFailure

void doFailure(io.apiman.gateway.engine.beans.PolicyFailure failure)

Called by a policy when it has detected a violation or failure in the policy. This will stop the processing of policies and immediately return an failure response to the originating client.

Parameters:

failure - the policy failure

throwError

void throwError(Throwable error)

Called by a policy when an unexpected and unrecoverable error is encountered.

Parameters:

error - the error thrown