Package ca.uhn.fhir.jpa.cache

Class ResourceChangeListenerRegistryImpl

java.lang.Object

ca.uhn.fhir.jpa.cache.ResourceChangeListenerRegistryImpl

All Implemented Interfaces:

IResourceChangeListenerRegistry

@Component
public class ResourceChangeListenerRegistryImpl
extends Object
implements IResourceChangeListenerRegistry

This component holds an in-memory list of all registered IResourceChangeListener instances along with their caches and other details needed to maintain those caches. Register an IResourceChangeListener instance with this service to be notified when resources you care about are changed. This service quickly notifies listeners of changes that happened on the local process and also eventually notifies listeners of changes that were made by remote processes.

Constructor Summary

Constructors

Constructor	Description
ResourceChangeListenerRegistryImpl(ca.uhn.fhir.context.FhirContext theFhirContext, ResourceChangeListenerCacheFactory theResourceChangeListenerCacheFactory, InMemoryResourceMatcher theInMemoryResourceMatcher)

Method Summary

Modifier and Type	Method	Description
void	clearCachesForUnitTest()
void	clearListenersForUnitTest()
boolean	contains(IResourceChangeListenerCache theCache)
int	getResourceVersionCacheSizeForUnitTest()
Set<String>	getWatchedResourceNames()
Iterator<ResourceChangeListenerCache>	iterator()
IResourceChangeListenerCache	registerResourceResourceChangeListener(String theResourceName, SearchParameterMap theSearchParameterMap, IResourceChangeListener theResourceChangeListener, long theRemoteRefreshIntervalMs)	Register a listener in order to be notified whenever a resource matching the provided SearchParameterMap changes in any way.
void	requestRefreshIfWatching(org.hl7.fhir.instance.model.api.IBaseResource theResource)	Called by the ResourceChangeListenerRegistryInterceptor when a resource is changed to invalidate matching caches so their listeners are notified the next time the caches are refreshed.
int	size()
void	unregisterResourceResourceChangeListener(IResourceChangeListener theResourceChangeListener)	Unregister a listener from this service
void	unregisterResourceResourceChangeListener(IResourceChangeListenerCache theResourceChangeListenerCache)	Unregister a listener from this service using its cache handle

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceChangeListenerRegistryImpl

public ResourceChangeListenerRegistryImpl(ca.uhn.fhir.context.FhirContext theFhirContext,
 ResourceChangeListenerCacheFactory theResourceChangeListenerCacheFactory,
 InMemoryResourceMatcher theInMemoryResourceMatcher)

Method Details

registerResourceResourceChangeListener

public IResourceChangeListenerCache registerResourceResourceChangeListener(String theResourceName,
 SearchParameterMap theSearchParameterMap,
 IResourceChangeListener theResourceChangeListener,
 long theRemoteRefreshIntervalMs)

Register a listener in order to be notified whenever a resource matching the provided SearchParameterMap changes in any way. If the change happened on the same jvm process where this registry resides, then the listener will be called within ResourceChangeListenerCacheRefresherImpl.LOCAL_REFRESH_INTERVAL_MS of the change happening. If the change happened on a different jvm process, then the listener will be called within theRemoteRefreshIntervalMs.

Specified by:

registerResourceResourceChangeListener in interface IResourceChangeListenerRegistry

Parameters:

theResourceName - the type of the resource the listener should be notified about (e.g. "Subscription" or "SearchParameter")

theSearchParameterMap - the listener will only be notified of changes to resources that match this map

theResourceChangeListener - the listener that will be called whenever resource changes are detected

theRemoteRefreshIntervalMs - the number of milliseconds between checking the database for changed resources that match the search parameter map

Returns:

RegisteredResourceChangeListener that stores the resource id cache, and the next refresh time

Throws:

DataFormatException - if theResourceName is not a valid resource type in our FhirContext

IllegalArgumentException - if theSearchParamMap cannot be evaluated in-memory

unregisterResourceResourceChangeListener

public void unregisterResourceResourceChangeListener(IResourceChangeListener theResourceChangeListener)

Unregister a listener from this service

Specified by:

unregisterResourceResourceChangeListener in interface IResourceChangeListenerRegistry

Parameters:

theResourceChangeListener -

unregisterResourceResourceChangeListener

public void unregisterResourceResourceChangeListener(IResourceChangeListenerCache theResourceChangeListenerCache)

Description copied from interface: IResourceChangeListenerRegistry

Unregister a listener from this service using its cache handle

Specified by:

unregisterResourceResourceChangeListener in interface IResourceChangeListenerRegistry

Parameters:

theResourceChangeListenerCache -

iterator

@Nonnull
public Iterator<ResourceChangeListenerCache> iterator()

size

public int size()

clearCachesForUnitTest

public void clearCachesForUnitTest()

contains

public boolean contains(IResourceChangeListenerCache theCache)

Specified by:

contains in interface IResourceChangeListenerRegistry

Parameters:

theCache -

Returns:

true if theCache is registered

getResourceVersionCacheSizeForUnitTest

public int getResourceVersionCacheSizeForUnitTest()

requestRefreshIfWatching

public void requestRefreshIfWatching(org.hl7.fhir.instance.model.api.IBaseResource theResource)

Description copied from interface: IResourceChangeListenerRegistry

Called by the ResourceChangeListenerRegistryInterceptor when a resource is changed to invalidate matching caches so their listeners are notified the next time the caches are refreshed.

Specified by:

requestRefreshIfWatching in interface IResourceChangeListenerRegistry

Parameters:

theResource - the resource that changed that might trigger a refresh

getWatchedResourceNames

public Set<String> getWatchedResourceNames()

Specified by:

getWatchedResourceNames in interface IResourceChangeListenerRegistry

Returns:

a set of resource names watched by the registered listeners

clearListenersForUnitTest

public void clearListenersForUnitTest()

Specified by:

clearListenersForUnitTest in interface IResourceChangeListenerRegistry