Package ca.uhn.fhir.interceptor.executor

Class BaseInterceptorService<POINTCUT extends Enum<POINTCUT> & 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 Enum<POINTCUT> & IPointcut>
extends Object
implements IBaseInterceptorService<POINTCUT>, IBaseInterceptorBroadcaster<POINTCUT>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface ca.uhn.fhir.interceptor.api.IBaseInterceptorBroadcaster

IBaseInterceptorBroadcaster.IInterceptorFilterHook, IBaseInterceptorBroadcaster.IInvoker

Constructor Summary

Constructors

Constructor	Description
BaseInterceptorService(Class<POINTCUT> thePointcutType)	Constructor which uses a default name of "default"
BaseInterceptorService(Class<POINTCUT> thePointcutType, String theName)	Deprecated, for removal: This API element is subject to removal in a future version. The name parameter is not used for anything

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.
static Object	callInvokers(IPointcut thePointcut, HookParams theParams, List<IBaseInterceptorBroadcaster.IInvoker> invokers)
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).
protected Class<?>	getBooleanReturnType()
List<IBaseInterceptorBroadcaster.IInvoker>	getInvokersForPointcut(POINTCUT thePointcut)	Returns a list of all invokers registered for the given pointcut.
boolean	hasHooks(POINTCUT thePointcut)	Does this broadcaster have any hooks for the given pointcut?
static boolean	haveAppropriateParams(IPointcut thePointcut, HookParams theParams)	Only call this when assertions are enabled, it's expensive
protected void	registerAnonymousInterceptor(POINTCUT thePointcut, Object theInterceptor, BaseInterceptorService.BaseInvoker theInvoker)
boolean	registerInterceptor(Object theInterceptor)	Register an interceptor.
void	registerInterceptors(Collection<?> theInterceptors)
protected abstract Optional<BaseInterceptorService<POINTCUT>.HookDescriptor>	scanForHook(Method nextMethod)
void	setName(String theName)	Deprecated, for removal: This API element is subject to removal in a future version. This value is not used anywhere
void	setWarnOnInterceptorWithNoHooks(boolean theWarnOnInterceptorWithNoHooks)	Should a warning be issued if an interceptor is registered and it has no hooks
static List<IBaseInterceptorBroadcaster.IInvoker>	union(List<List<IBaseInterceptorBroadcaster.IInvoker>> theInvokersLists)	First argument must be the global invoker list!!
void	unregisterAllAnonymousInterceptors()	Unregisters all anonymous interceptors (i.e. all interceptors registered with registerAnonymousInterceptor)
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

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.interceptor.api.IBaseInterceptorBroadcaster

ifHasCallHooks, ifHasCallHooksAndReturnObject, runWithFilterHooks, runWithFilterHooks

Methods inherited from interface ca.uhn.fhir.interceptor.api.IBaseInterceptorService

hasRegisteredInterceptor

Constructor Details

BaseInterceptorService

public BaseInterceptorService(Class<POINTCUT> thePointcutType)

Constructor which uses a default name of "default"

BaseInterceptorService

@Deprecated(since="8.0.0",
            forRemoval=true)
public BaseInterceptorService(Class<POINTCUT> thePointcutType,
 String theName)

Deprecated, for removal: This API element is subject to removal in a future version.

The name parameter is not used for anything

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

setName

@Deprecated(since="8.0.0",
            forRemoval=true)
public void setName(String theName)

Deprecated, for removal: This API element is subject to removal in a future version.

This value is not used anywhere

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 Enum<POINTCUT> & IPointcut>

unregisterAllInterceptors

public void unregisterAllInterceptors()

Description copied from interface: IBaseInterceptorService

Unregisters all registered interceptors.

Specified by:

unregisterAllInterceptors in interface IBaseInterceptorService<POINTCUT extends Enum<POINTCUT> & IPointcut>

unregisterInterceptors

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

Specified by:

unregisterInterceptors in interface IBaseInterceptorService<POINTCUT extends Enum<POINTCUT> & IPointcut>

registerInterceptors

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

Specified by:

registerInterceptors in interface IBaseInterceptorService<POINTCUT extends Enum<POINTCUT> & 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 Enum<POINTCUT> & 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 Enum<POINTCUT> & IPointcut>

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 Enum<POINTCUT> & 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 Enum<POINTCUT> & 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 Enum<POINTCUT> & 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 Enum<POINTCUT> & IPointcut>

Parameters:

thePointcut - The poointcut

Returns:

Does this broadcaster have any hooks for the given pointcut?

getBooleanReturnType

protected Class<?> getBooleanReturnType()

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 Enum<POINTCUT> & IPointcut>

Returns:

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

getInvokersForPointcut

public List<IBaseInterceptorBroadcaster.IInvoker> getInvokersForPointcut(POINTCUT thePointcut)

Returns a list of all invokers registered for the given pointcut. The list is ordered by the invoker order (specified on the Interceptor.order() and Hook.order() values.

Specified by:

getInvokersForPointcut in interface IBaseInterceptorBroadcaster<POINTCUT extends Enum<POINTCUT> & IPointcut>

Returns:

The list returned by this method will always be a newly created list, so it will be stable and can be modified.

haveAppropriateParams

public static boolean haveAppropriateParams(IPointcut thePointcut,
 HookParams theParams)

Only call this when assertions are enabled, it's expensive

scanForHook

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

callInvokers

public static Object callInvokers(IPointcut thePointcut,
 HookParams theParams,
 List<IBaseInterceptorBroadcaster.IInvoker> invokers)

union

public static List<IBaseInterceptorBroadcaster.IInvoker> union(List<List<IBaseInterceptorBroadcaster.IInvoker>> theInvokersLists)

First argument must be the global invoker list!!

findAnnotation

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