org.mule.runtime.api.interception

Interface InterceptionAction

@NoImplement
public interface InterceptionAction

Allows the implementations of around and around to control the execution of the interception chain.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
CompletableFuture<InterceptionEvent>	fail(ErrorType errorType) Interrupts the current interception chain, not running the next interceptors in the chain and the intercepted component.
CompletableFuture<InterceptionEvent>	fail(ErrorType errorType, String msg) Interrupts the current interception chain, not running the next interceptors in the chain and the intercepted component.
CompletableFuture<InterceptionEvent>	fail(Throwable cause) Interrupts the current interception chain, not running the next interceptors in the chain and the intercepted component.
CompletableFuture<InterceptionEvent>	proceed() Indicates that the current interception chain must continue, proceeding with the next handlers in the chain (if any) and the intercepted component or flow.
CompletableFuture<InterceptionEvent>	skip() Interrupts the current interception chain, skipping the next interceptors in the chain and the intercepted component.

Method Detail

proceed

CompletableFuture<InterceptionEvent> proceed()

Indicates that the current interception chain must continue, proceeding with the next handlers in the chain (if any) and the intercepted component or flow.

Returns:

a CompletableFuture using the event that results of the remaining handlers of the chain and the intercepted processor.

skip

CompletableFuture<InterceptionEvent> skip()

Interrupts the current interception chain, skipping the next interceptors in the chain and the intercepted component.

If called for a router component or a flow, the whole route or flow (and all the components contained in it) will be skipped.

If called for an intercepting component (i.e. a splitter), the listener components (i.e. what follows the splitter up to an aggregator) are skipped as well.

Returns:

a CompletableFuture using the same event passed to the around() or around() method.

fail

CompletableFuture<InterceptionEvent> fail(Throwable cause)

Interrupts the current interception chain, not running the next interceptors in the chain and the intercepted component.

A future is returned which in turn it will fail with an exception wrapping the provided cause

If called for a router component or a flow, the whole route or flow (and all the components contained in it) will be skipped.

If called for an intercepting component (i.e. a splitter), the listener components (i.e. what follows the splitter up to an aggregator) are skipped as well.

Returns:

a CompletableFuture using the same event passed to the around() or around() method.

fail

CompletableFuture<InterceptionEvent> fail(ErrorType errorType)

Interrupts the current interception chain, not running the next interceptors in the chain and the intercepted component.

A future is returned which in turn it will fail with an exception that maps the provided error type.

If called for a router component or a flow, the whole route or flow (and all the components contained in it) will be skipped.

If called for an intercepting component (i.e. a splitter), the listener components (i.e. what follows the splitter up to an aggregator) are skipped as well.

Returns:

a CompletableFuture using the same event passed to the around() or around() method.

fail

CompletableFuture<InterceptionEvent> fail(ErrorType errorType,
                                          String msg)

Interrupts the current interception chain, not running the next interceptors in the chain and the intercepted component.

A future is returned which in turn it will fail with an exception that maps the provided error type, with the error message provided.

If called for a router component or a flow, the whole route or flow (and all the components contained in it) will be skipped.

If called for an intercepting component (i.e. a splitter), the listener components (i.e. what follows the splitter up to an aggregator) are skipped as well.

Returns:

a CompletableFuture using the same event passed to the around() or around() method.

Since:

1.2