org.jboss.cache.interceptors
Class InterceptorChain

java.lang.Object
  org.jboss.cache.interceptors.InterceptorChain

public class InterceptorChain
extends java.lang.Object

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

Since:

2.2 todo - if you add the same interceptor instance twice, things get really dirty. -- this should be treated as an missuse and an exception should be thrown

Author:

Mircea.Markus@jboss.com

Constructor Summary

InterceptorChain(CommandInterceptor first)
Constructs an interceptor chain having the supplied interceptor as first.

Method Summary

boolean	addAfterInterceptor(CommandInterceptor toAdd, java.lang.Class<? extends CommandInterceptor> afterInterceptor) Adds a new interceptor in list after an interceptor of a given type.
boolean	addBeforeInterceptor(CommandInterceptor toAdd, java.lang.Class<? extends CommandInterceptor> beforeInterceptor) Adds a new interceptor in list after an interceptor of a given type.
void	addInterceptor(CommandInterceptor interceptor, int position) Inserts the given interceptor at the specified position in the chain (o based indexing).
void	appendIntereceptor(CommandInterceptor ci) Appends at the end.
java.util.List<CommandInterceptor>	asList() Returns an unmofiable list with all the interceptors in sequence.
boolean	containsInstance(CommandInterceptor interceptor) Checks whether the chain contains the supplied interceptor instance.
CommandInterceptor	getFirstInChain()
java.lang.String	getInterceptorDetails()
java.lang.String	getInterceptorDetailsAsHtml()
java.util.List<CommandInterceptor>	getInterceptorsWhichExtend(java.lang.Class<? extends CommandInterceptor> interceptorClass) Returns all interceptors which extend the given command interceptor.
java.util.List<CommandInterceptor>	getInterceptorsWithClassName(java.lang.String fqName) Returns all the interceptors that have the fully qualified name of their class equal with the supplied class name.
InvocationContext	getInvocationContext()
void	initialize(InvocationContextContainer invocationContextContainer)
java.lang.Object	invoke(InvocationContext ctx, VisitableCommand command) Walks the command through the interceptor chain.
java.lang.Object	invoke(VisitableCommand cacheCommand) Similar to invoke(org.jboss.cache.InvocationContext , org.jboss.cache.commands.VisitableCommand), but constructs a invocation context on the fly, using ThreadLocal.get() and setting the origin local flag to its default value.
java.lang.Object	invokeRemote(VisitableCommand cacheCommand) Similar to invoke(org.jboss.cache.InvocationContext , org.jboss.cache.commands.VisitableCommand), but constructs a invocation context on the fly, using ThreadLocal.get()
void	removeInterceptor(java.lang.Class<? extends CommandInterceptor> clazz) Removes all the occurences of supplied interceptor type from the chain.
void	removeInterceptor(int position) Removes the interceptor at the given postion.
void	setFirstInChain(CommandInterceptor interceptor) Mainly used by unit tests to replace the interceptor chain with the starting point passed in.
int	size() Returns the number of interceptors in the chain.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InterceptorChain

public InterceptorChain(CommandInterceptor first)

Constructs an interceptor chain having the supplied interceptor as first.

Method Detail

initialize

public void initialize(InvocationContextContainer invocationContextContainer)

addInterceptor

public void addInterceptor(CommandInterceptor interceptor,
                           int position)

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

Throws:

java.lang.IllegalArgumentException - if the position is invalid (e.g. 5 and there are only 2 interceptors in the chain)

removeInterceptor

public void removeInterceptor(int position)

Removes the interceptor at the given postion.

Throws:

java.lang.IllegalArgumentException - if the position is invalid (e.g. 5 and there are only 2 interceptors in the chain)

size

public int size()

Returns the number of interceptors in the chain.

getInterceptorDetails

public java.lang.String getInterceptorDetails()

getInterceptorDetailsAsHtml

public java.lang.String getInterceptorDetailsAsHtml()

asList

public java.util.List<CommandInterceptor> asList()

Returns an unmofiable list with all the interceptors in sequence. If first in chain is null an empty list is returned.

removeInterceptor

public void removeInterceptor(java.lang.Class<? extends CommandInterceptor> clazz)

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

addAfterInterceptor

public boolean addAfterInterceptor(CommandInterceptor toAdd,
                                   java.lang.Class<? extends CommandInterceptor> afterInterceptor)

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

Returns:

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

addBeforeInterceptor

public boolean addBeforeInterceptor(CommandInterceptor toAdd,
                                    java.lang.Class<? extends CommandInterceptor> beforeInterceptor)

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

Returns:

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

appendIntereceptor

public void appendIntereceptor(CommandInterceptor ci)

Appends at the end.

invoke

public java.lang.Object invoke(InvocationContext ctx,
                               VisitableCommand command)

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

invokeRemote

public java.lang.Object invokeRemote(VisitableCommand cacheCommand)
                              throws java.lang.Throwable

Similar to invoke(org.jboss.cache.InvocationContext , org.jboss.cache.commands.VisitableCommand), but constructs a invocation context on the fly, using ThreadLocal.get()

Throws:

java.lang.Throwable

invoke

public java.lang.Object invoke(VisitableCommand cacheCommand)
                        throws java.lang.Throwable

Similar to invoke(org.jboss.cache.InvocationContext , org.jboss.cache.commands.VisitableCommand), but constructs a invocation context on the fly, using ThreadLocal.get() and setting the origin local flag to its default value.

Throws:

java.lang.Throwable

getFirstInChain

public CommandInterceptor getFirstInChain()

Returns:

the first interceptor in the chain.

setFirstInChain

public void setFirstInChain(CommandInterceptor interceptor)

Mainly used by unit tests to replace the interceptor chain with the starting point passed in.

Parameters:

interceptor - interceptor to be used as the first interceptor in the chain.

getInvocationContext

public InvocationContext getInvocationContext()

getInterceptorsWhichExtend

public java.util.List<CommandInterceptor> getInterceptorsWhichExtend(java.lang.Class<? extends CommandInterceptor> interceptorClass)

Returns all interceptors which extend the given command interceptor.

getInterceptorsWithClassName

public java.util.List<CommandInterceptor> getInterceptorsWithClassName(java.lang.String fqName)

Returns all the interceptors that have the fully qualified name of their class equal with the supplied class name.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

containsInstance

public boolean containsInstance(CommandInterceptor interceptor)

Checks whether the chain contains the supplied interceptor instance.