org.infinispan.interceptors.impl

Class AsyncInterceptorChainImpl

java.lang.Object

org.infinispan.interceptors.impl.AsyncInterceptorChainImpl

All Implemented Interfaces:

AsyncInterceptorChain

public class AsyncInterceptorChainImpl
extends Object
implements AsyncInterceptorChain

Knows how to build and manage a chain of interceptors. Also in charge with invoking methods on the chain.

Since:

9.0

Author:

Dan Berindei

Constructor Summary

Constructors

Constructor and Description
AsyncInterceptorChainImpl(ComponentRegistry componentRegistry)

Method Summary

Modifier and Type	Method and Description
void	addInterceptor(AsyncInterceptor interceptor, int position) Inserts the given interceptor at the specified position in the chain (0 based indexing).
boolean	addInterceptorAfter(AsyncInterceptor toAdd, Class<? extends AsyncInterceptor> afterInterceptor) Adds a new interceptor in list after an interceptor of a given type.
boolean	addInterceptorBefore(AsyncInterceptor toAdd, Class<? extends AsyncInterceptor> beforeInterceptor) Adds a new interceptor in list before an interceptor of a given type.
boolean	addInterceptorBefore(AsyncInterceptor toAdd, Class<? extends AsyncInterceptor> beforeInterceptor, boolean isCustom) Deprecated.
void	appendInterceptor(AsyncInterceptor ci, boolean isCustom) Appends at the end.
boolean	containsInstance(AsyncInterceptor interceptor) Checks whether the chain contains the supplied interceptor instance.
boolean	containsInterceptorType(Class<? extends AsyncInterceptor> interceptorType) Checks whether the chain contains an interceptor with the given class.
boolean	containsInterceptorType(Class<? extends AsyncInterceptor> interceptorType, boolean alsoMatchSubClasses) Checks whether the chain contains an interceptor with the given class, or a subclass.
<T extends AsyncInterceptor> T	findInterceptorExtending(Class<T> interceptorClass) Returns the first interceptor extending the given class, or null if there is none.
<T extends AsyncInterceptor> T	findInterceptorWithClass(Class<T> interceptorClass) Returns the first interceptor with the given class, or null if there is none.
List<AsyncInterceptor>	getInterceptors()
Object	invoke(InvocationContext ctx, VisitableCommand command) Walks the command through the interceptor chain.
CompletableFuture<Object>	invokeAsync(InvocationContext ctx, VisitableCommand command) Walks the command through the interceptor chain.
void	removeInterceptor(Class<? extends AsyncInterceptor> clazz) Removes all the occurrences of supplied interceptor type from the chain.
void	removeInterceptor(int position) Removes the interceptor at the given position.
boolean	replaceInterceptor(AsyncInterceptor replacingInterceptor, Class<? extends AsyncInterceptor> existingInterceptorType) Replaces an existing interceptor of the given type in the interceptor chain with a new interceptor instance passed as parameter.
int	size() Returns the number of interceptors in the chain.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncInterceptorChainImpl

public AsyncInterceptorChainImpl(ComponentRegistry componentRegistry)

Method Detail

addInterceptor

public void addInterceptor(AsyncInterceptor interceptor,
                           int position)

Description copied from interface: AsyncInterceptorChain

Inserts the given interceptor at the specified position in the chain (0 based indexing).

Specified by:

addInterceptor in interface AsyncInterceptorChain

removeInterceptor

public void removeInterceptor(int position)

Description copied from interface: AsyncInterceptorChain

Removes the interceptor at the given position.

Specified by:

removeInterceptor in interface AsyncInterceptorChain

size

public int size()

Description copied from interface: AsyncInterceptorChain

Returns the number of interceptors in the chain.

Specified by:

size in interface AsyncInterceptorChain

removeInterceptor

public void removeInterceptor(Class<? extends AsyncInterceptor> clazz)

Description copied from interface: AsyncInterceptorChain

Removes all the occurrences of supplied interceptor type from the chain.

Specified by:

removeInterceptor in interface AsyncInterceptorChain

addInterceptorAfter

public boolean addInterceptorAfter(AsyncInterceptor toAdd,
                                   Class<? extends AsyncInterceptor> afterInterceptor)

Description copied from interface: AsyncInterceptorChain

Adds a new interceptor in list after an interceptor of a given type.

Specified by:

addInterceptorAfter in interface AsyncInterceptorChain

Returns:

true if the interceptor was added; i.e. the afterInterceptor exists

addInterceptorBefore

@Deprecated
public boolean addInterceptorBefore(AsyncInterceptor toAdd,
                                                Class<? extends AsyncInterceptor> beforeInterceptor,
                                                boolean isCustom)

Deprecated.

addInterceptorBefore

public boolean addInterceptorBefore(AsyncInterceptor toAdd,
                                    Class<? extends AsyncInterceptor> beforeInterceptor)

Description copied from interface: AsyncInterceptorChain

Adds a new interceptor in list before an interceptor of a given type.

Specified by:

addInterceptorBefore in interface AsyncInterceptorChain

Returns:

true if the interceptor was added; i.e. the beforeInterceptor exists

replaceInterceptor

public boolean replaceInterceptor(AsyncInterceptor replacingInterceptor,
                                  Class<? extends AsyncInterceptor> existingInterceptorType)

Description copied from interface: AsyncInterceptorChain

Replaces an existing interceptor of the given type in the interceptor chain with a new interceptor instance passed as parameter.

Specified by:

replaceInterceptor in interface AsyncInterceptorChain

Parameters:

replacingInterceptor - the interceptor to add to the interceptor chain

existingInterceptorType - the type of interceptor that should be swapped with the new one

Returns:

true if the interceptor was replaced

appendInterceptor

public void appendInterceptor(AsyncInterceptor ci,
                              boolean isCustom)

Description copied from interface: AsyncInterceptorChain

Appends at the end.

Specified by:

appendInterceptor in interface AsyncInterceptorChain

invokeAsync

public CompletableFuture<Object> invokeAsync(InvocationContext ctx,
                                             VisitableCommand command)

Description copied from interface: AsyncInterceptorChain

Walks the command through the interceptor chain. The received ctx is being passed in.

Specified by:

invokeAsync in interface AsyncInterceptorChain

invoke

public Object invoke(InvocationContext ctx,
                     VisitableCommand command)

Description copied from interface: AsyncInterceptorChain

Walks the command through the interceptor chain. The received ctx is being passed in.

Note: Reusing the context for multiple invocations is allowed, however most context implementations are not thread-safe.

Specified by:

invoke in interface AsyncInterceptorChain

findInterceptorExtending

public <T extends AsyncInterceptor> T findInterceptorExtending(Class<T> interceptorClass)

Description copied from interface: AsyncInterceptorChain

Returns the first interceptor extending the given class, or null if there is none.

Specified by:

findInterceptorExtending in interface AsyncInterceptorChain

findInterceptorWithClass

public <T extends AsyncInterceptor> T findInterceptorWithClass(Class<T> interceptorClass)

Description copied from interface: AsyncInterceptorChain

Returns the first interceptor with the given class, or null if there is none.

Specified by:

findInterceptorWithClass in interface AsyncInterceptorChain

toString

public String toString()

Overrides:

toString in class Object

containsInstance

public boolean containsInstance(AsyncInterceptor interceptor)

Description copied from interface: AsyncInterceptorChain

Checks whether the chain contains the supplied interceptor instance.

Specified by:

containsInstance in interface AsyncInterceptorChain

containsInterceptorType

public boolean containsInterceptorType(Class<? extends AsyncInterceptor> interceptorType)

Description copied from interface: AsyncInterceptorChain

Checks whether the chain contains an interceptor with the given class.

Specified by:

containsInterceptorType in interface AsyncInterceptorChain

containsInterceptorType

public boolean containsInterceptorType(Class<? extends AsyncInterceptor> interceptorType,
                                       boolean alsoMatchSubClasses)

Description copied from interface: AsyncInterceptorChain

Checks whether the chain contains an interceptor with the given class, or a subclass.

Specified by:

containsInterceptorType in interface AsyncInterceptorChain

getInterceptors

public List<AsyncInterceptor> getInterceptors()

Specified by:

getInterceptors in interface AsyncInterceptorChain

Returns:

An immutable list of the current interceptors.