Package ca.uhn.fhir.interceptor.executor

Class BaseInterceptorService<POINTCUT extends IPointcut>

java.lang.Object

ca.uhn.fhir.interceptor.executor.BaseInterceptorService<POINTCUT>

All Implemented Interfaces:

IBaseInterceptorBroadcaster<POINTCUT>, IBaseInterceptorService<POINTCUT>

Direct Known Subclasses:

InterceptorService

public abstract class BaseInterceptorService<POINTCUT extends IPointcut>
extends Object
implements IBaseInterceptorService<POINTCUT>, IBaseInterceptorBroadcaster<POINTCUT>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseInterceptorService.BaseInvoker
protected static class	BaseInterceptorService.HookDescriptor

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
protected static <T extends Annotation> Optional<T>	findAnnotation(AnnotatedElement theObject, Class<T> theHookClass)
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 false)
protected void	registerAnonymousInterceptor(POINTCUT thePointcut, Object theInterceptor, BaseInterceptorService.BaseInvoker theInvoker)
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.
protected abstract Optional<BaseInterceptorService.HookDescriptor>	scanForHook(Method nextMethod)
void	setName(String theName)
void	setThreadlocalInvokersEnabled(boolean theThreadlocalInvokersEnabled)	Deprecated. ThreadLocal interceptors are deprecated as of HAPI FHIR 6.2.0 and will be removed in a future release.
void	setWarnOnInterceptorWithNoHooks(boolean theWarnOnInterceptorWithNoHooks)	Should a warning be issued if an interceptor is registered and it has no hooks
void	unregisterAllAnonymousInterceptors()	Unregisters all anonymous interceptors (i.e.
void	unregisterAllInterceptors()	Unregisters all registered interceptors.
boolean	unregisterInterceptor(Object theInterceptor)	Unregister an interceptor.
void	unregisterInterceptors(Collection<?> theInterceptors)
void	unregisterInterceptorsIf(Predicate<Object> theShouldUnregisterFunction)	Unregisters all interceptors that are indicated by the given callback function returning true
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 Details

BaseInterceptorService

public BaseInterceptorService()

Constructor which uses a default name of "default"

BaseInterceptorService

public BaseInterceptorService(String theName)

Constructor

Parameters:

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

Method Details

setWarnOnInterceptorWithNoHooks

public void setWarnOnInterceptorWithNoHooks(boolean theWarnOnInterceptorWithNoHooks)

Should a warning be issued if an interceptor is registered and it has no hooks

isThreadlocalInvokersEnabled

public boolean isThreadlocalInvokersEnabled()

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

setThreadlocalInvokersEnabled

@Deprecated
public void setThreadlocalInvokersEnabled(boolean theThreadlocalInvokersEnabled)

Deprecated.

ThreadLocal interceptors are deprecated as of HAPI FHIR 6.2.0 and will be removed in a future release.

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

setName

public void setName(String theName)

registerAnonymousInterceptor

protected void registerAnonymousInterceptor(POINTCUT thePointcut,
 Object theInterceptor,
 BaseInterceptorService.BaseInvoker theInvoker)

getAllRegisteredInterceptors

public List<Object> getAllRegisteredInterceptors()

Description copied from interface: IBaseInterceptorService

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

Specified by:

getAllRegisteredInterceptors in interface IBaseInterceptorService<POINTCUT extends IPointcut>

unregisterAllInterceptors

public void unregisterAllInterceptors()

Description copied from interface: IBaseInterceptorService

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

Specified by:

unregisterAllInterceptors in interface IBaseInterceptorService<POINTCUT extends IPointcut>

unregisterInterceptors

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

Specified by:

unregisterInterceptors in interface IBaseInterceptorService<POINTCUT extends IPointcut>

registerInterceptors

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

Specified by:

registerInterceptors in interface IBaseInterceptorService<POINTCUT extends IPointcut>

unregisterAllAnonymousInterceptors

public void unregisterAllAnonymousInterceptors()

Description copied from interface: IBaseInterceptorService

Unregisters all anonymous interceptors (i.e. all interceptors registered with registerAnonymousInterceptor)

Specified by:

unregisterAllAnonymousInterceptors in interface IBaseInterceptorService<POINTCUT extends IPointcut>

unregisterInterceptorsIf

public void unregisterInterceptorsIf(Predicate<Object> theShouldUnregisterFunction)

Description copied from interface: IBaseInterceptorService

Unregisters all interceptors that are indicated by the given callback function returning true

Specified by:

unregisterInterceptorsIf in interface IBaseInterceptorService<POINTCUT extends IPointcut>

registerThreadLocalInterceptor

public boolean registerThreadLocalInterceptor(Object theInterceptor)

Description copied from interface: IBaseInterceptorService

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 IBaseInterceptorService.getAllRegisteredInterceptors() and IBaseInterceptorService.unregisterAllInterceptors() do not affect thread local interceptors as they are kept in a separate list.

ThreadLocal interceptors are now disabled by default as of HAPI FHIR 6.2.0 and must be manually enabled by calling setThreadlocalInvokersEnabled(boolean). They are now deprecated. Registering a threadlocal interceptor without enabling this feature will result in a IllegalArgumentException.

Specified by:

registerThreadLocalInterceptor in interface IBaseInterceptorService<POINTCUT extends IPointcut>

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: IBaseInterceptorService

Unregisters a ThreadLocal interceptor

ThreadLocal interceptors are now disabled by default as of HAPI FHIR 6.2.0 and must be manually enabled by calling setThreadlocalInvokersEnabled(boolean). They are now deprecated. Registering a threadlocal interceptor without enabling this feature will result in a IllegalArgumentException.

Specified by:

unregisterThreadLocalInterceptor in interface IBaseInterceptorService<POINTCUT extends IPointcut>

Parameters:

theInterceptor - The interceptor

See Also:

• IBaseInterceptorService.registerThreadLocalInterceptor(Object)

registerInterceptor

public boolean registerInterceptor(Object theInterceptor)

Description copied from interface: IBaseInterceptorService

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

Specified by:

registerInterceptor in interface IBaseInterceptorService<POINTCUT extends IPointcut>

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: IBaseInterceptorService

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

Specified by:

unregisterInterceptor in interface IBaseInterceptorService<POINTCUT extends IPointcut>

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: IBaseInterceptorBroadcaster

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 IBaseInterceptorBroadcaster<POINTCUT extends IPointcut>

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: IBaseInterceptorBroadcaster

Does this broadcaster have any hooks for the given pointcut?

Specified by:

hasHooks in interface IBaseInterceptorBroadcaster<POINTCUT extends IPointcut>

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: IBaseInterceptorBroadcaster

Invoke registered interceptor hook methods for the given Pointcut.

Specified by:

callHooks in interface IBaseInterceptorBroadcaster<POINTCUT extends IPointcut>

Returns:

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

scanForHook

protected abstract Optional<BaseInterceptorService.HookDescriptor> scanForHook(Method nextMethod)

findAnnotation

protected static <T extends Annotation> Optional<T> findAnnotation(AnnotatedElement theObject,
 Class<T> theHookClass)