ca.uhn.fhir.interceptor.executor

Class InterceptorService

java.lang.Object

ca.uhn.fhir.interceptor.executor.InterceptorService

All Implemented Interfaces:

IInterceptorBroadcaster, IInterceptorService

public class InterceptorService
extends Object
implements IInterceptorService, IInterceptorBroadcaster

Constructor Summary

Constructors

Constructor and Description
InterceptorService() Constructor which uses a default name of "default"
InterceptorService(String theName) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	callHooks(Pointcut thePointcut, HookParams theParams) Invoke registered interceptor hook methods for the given Pointcut.
Object	callHooksAndReturnObject(Pointcut thePointcut, HookParams theParams) Invoke registered interceptor hook methods for the given Pointcut.
List<Object>	getAllRegisteredInterceptors() Returns all currently registered interceptors (excluding any thread local interceptors).
boolean	hasHooks(Pointcut thePointcut) Does this broadcaster have any hooks for the given pointcut?
boolean	isThreadlocalInvokersEnabled() Are threadlocal interceptors enabled on this registry (defaults to true)
void	registerAnonymousInterceptor(Pointcut thePointcut, IAnonymousInterceptor theInterceptor)
void	registerAnonymousInterceptor(Pointcut thePointcut, int theOrder, IAnonymousInterceptor theInterceptor)
boolean	registerInterceptor(Object theInterceptor) Register an interceptor.
void	registerInterceptors(Collection<?> theInterceptors)
boolean	registerThreadLocalInterceptor(Object theInterceptor) Register an interceptor that will be used in a ThreadLocal context.
void	setName(String theName)
void	setThreadlocalInvokersEnabled(boolean theThreadlocalInvokersEnabled) Are threadlocal interceptors enabled on this registry (defaults to true)
void	unregisterAllInterceptors() Unregisters all registered interceptors.
boolean	unregisterInterceptor(Object theInterceptor) Unregister an interceptor.
void	unregisterInterceptors(Collection<?> theInterceptors)
void	unregisterThreadLocalInterceptor(Object theInterceptor) Unregisters a ThreadLocal interceptor

Methods inherited from class java.lang.Object

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

Constructor Detail

InterceptorService

public InterceptorService()

Constructor which uses a default name of "default"

InterceptorService

public InterceptorService(String theName)

Constructor

Parameters:

theName - The name for this registry (useful for troubleshooting)

Method Detail

isThreadlocalInvokersEnabled

public boolean isThreadlocalInvokersEnabled()

Are threadlocal interceptors enabled on this registry (defaults to true)

setThreadlocalInvokersEnabled

public void setThreadlocalInvokersEnabled(boolean theThreadlocalInvokersEnabled)

Are threadlocal interceptors enabled on this registry (defaults to true)

registerAnonymousInterceptor

public void registerAnonymousInterceptor(Pointcut thePointcut,
                                         IAnonymousInterceptor theInterceptor)

Specified by:

registerAnonymousInterceptor in interface IInterceptorService

setName

public void setName(String theName)

registerAnonymousInterceptor

public void registerAnonymousInterceptor(Pointcut thePointcut,
                                         int theOrder,
                                         IAnonymousInterceptor theInterceptor)

Specified by:

registerAnonymousInterceptor in interface IInterceptorService

getAllRegisteredInterceptors

public List<Object> getAllRegisteredInterceptors()

Description copied from interface: IInterceptorService

Returns all currently registered interceptors (excluding any thread local interceptors).

Specified by:

getAllRegisteredInterceptors in interface IInterceptorService

unregisterAllInterceptors

public void unregisterAllInterceptors()

Description copied from interface: IInterceptorService

Unregisters all registered interceptors. Note that this method does not unregister any thread local interceptors.

Specified by:

unregisterAllInterceptors in interface IInterceptorService

unregisterInterceptors

public void unregisterInterceptors(@Nullable
                                   Collection<?> theInterceptors)

Specified by:

unregisterInterceptors in interface IInterceptorService

registerInterceptors

public void registerInterceptors(@Nullable
                                 Collection<?> theInterceptors)

Specified by:

registerInterceptors in interface IInterceptorService

registerThreadLocalInterceptor

public boolean registerThreadLocalInterceptor(Object theInterceptor)

Description copied from interface: IInterceptorService

Register an interceptor that will be used in a ThreadLocal context. This means that events will only be broadcast to the given interceptor if they were fired from the current thread.

Note that it is almost always desirable to call this method with a try-finally statement that removes the interceptor afterwards, since this can lead to memory leakage, poor performance due to ever-increasing numbers of interceptors, etc.

Note that most methods such as IInterceptorService.getAllRegisteredInterceptors() and IInterceptorService.unregisterAllInterceptors() do not affect thread local interceptors as they are kept in a separate list.

Specified by:

registerThreadLocalInterceptor in interface IInterceptorService

Parameters:

theInterceptor - The interceptor

Returns:

Returns true if at least one valid hook method was found on this interceptor

unregisterThreadLocalInterceptor

public void unregisterThreadLocalInterceptor(Object theInterceptor)

Description copied from interface: IInterceptorService

Unregisters a ThreadLocal interceptor

Specified by:

unregisterThreadLocalInterceptor in interface IInterceptorService

Parameters:

theInterceptor - The interceptor

See Also:

IInterceptorService.registerThreadLocalInterceptor(Object)

registerInterceptor

public boolean registerInterceptor(Object theInterceptor)

Description copied from interface: IInterceptorService

Register an interceptor. This method has no effect if the given interceptor is already registered.

Specified by:

registerInterceptor in interface IInterceptorService

Parameters:

theInterceptor - The interceptor to register

Returns:

Returns true if at least one valid hook method was found on this interceptor

unregisterInterceptor

public boolean unregisterInterceptor(Object theInterceptor)

Description copied from interface: IInterceptorService

Unregister an interceptor. This method has no effect if the given interceptor is not already registered.

Specified by:

unregisterInterceptor in interface IInterceptorService

Parameters:

theInterceptor - The interceptor to unregister

Returns:

Returns true if the interceptor was found and removed

callHooksAndReturnObject

public Object callHooksAndReturnObject(Pointcut thePointcut,
                                       HookParams theParams)

Description copied from interface: IInterceptorBroadcaster

Invoke registered interceptor hook methods for the given Pointcut. This method should only be called for pointcuts that return a type other than void or boolean

Specified by:

callHooksAndReturnObject in interface IInterceptorBroadcaster

Returns:

Returns the object returned by the first hook method that did not return null

hasHooks

public boolean hasHooks(Pointcut thePointcut)

Description copied from interface: IInterceptorBroadcaster

Does this broadcaster have any hooks for the given pointcut?

Specified by:

hasHooks in interface IInterceptorBroadcaster

Parameters:

thePointcut - The poointcut

Returns:

Does this broadcaster have any hooks for the given pointcut?

callHooks

public boolean callHooks(Pointcut thePointcut,
                         HookParams theParams)

Description copied from interface: IInterceptorBroadcaster

Invoke registered interceptor hook methods for the given Pointcut.

Specified by:

callHooks in interface IInterceptorBroadcaster

Returns:

Returns false if any of the invoked hook methods returned false, and returns true otherwise.