ca.uhn.fhir.interceptor.api

Interface IInterceptorService

All Superinterfaces:

IInterceptorBroadcaster

All Known Implementing Classes:

InterceptorService

public interface IInterceptorService
extends IInterceptorBroadcaster

Method Summary

Modifier and Type	Method and Description
List<Object>	getAllRegisteredInterceptors() Returns all currently registered interceptors (excluding any thread local interceptors).
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	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 interface ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster

callHooks, callHooksAndReturnObject, hasHooks

Method Detail

registerThreadLocalInterceptor

boolean registerThreadLocalInterceptor(Object theInterceptor)

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

Parameters:

theInterceptor - The interceptor

Returns:

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

unregisterThreadLocalInterceptor

void unregisterThreadLocalInterceptor(Object theInterceptor)

Unregisters a ThreadLocal interceptor

Parameters:

theInterceptor - The interceptor

See Also:

registerThreadLocalInterceptor(Object)

registerInterceptor

boolean registerInterceptor(Object theInterceptor)

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

Parameters:

theInterceptor - The interceptor to register

Returns:

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

unregisterInterceptor

boolean unregisterInterceptor(Object theInterceptor)

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

Parameters:

theInterceptor - The interceptor to unregister

Returns:

Returns true if the interceptor was found and removed

registerAnonymousInterceptor

void registerAnonymousInterceptor(Pointcut thePointcut,
                                  IAnonymousInterceptor theInterceptor)

registerAnonymousInterceptor

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

getAllRegisteredInterceptors

List<Object> getAllRegisteredInterceptors()

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

unregisterAllInterceptors

void unregisterAllInterceptors()

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

unregisterInterceptors

void unregisterInterceptors(@Nullable
                            Collection<?> theInterceptors)

registerInterceptors

void registerInterceptors(@Nullable
                          Collection<?> theInterceptors)