Package org.apache.cayenne.cache.invalidation

Class CacheInvalidationFilter

java.lang.Object

org.apache.cayenne.cache.invalidation.CacheInvalidationFilter

All Implemented Interfaces:

DataChannelSyncFilter

public class CacheInvalidationFilter
extends Object
implements DataChannelSyncFilter

A DataChannelSyncFilter that invalidates cache groups. Use custom rules for invalidation provided via DI.

Default rule is based on entities' CacheGroups annotation.

To add default filter:

         ServerRuntime.builder("cayenne-project.xml")
              .addModule(CacheInvalidationModuleBuilder.builder().build());
     

Since:

4.0 enhanced to support custom handlers.

See Also:

• CacheInvalidationModuleExtender
• InvalidationHandler

Constructor Summary

Constructors

Constructor	Description
CacheInvalidationFilter(org.apache.cayenne.di.Provider<QueryCache> cacheProvider, List<InvalidationHandler> handlers)

Method Summary

Modifier and Type	Method	Description
protected Set<CacheGroupDescriptor>	getOrCreateTxGroups()
GraphDiff	onSync(ObjectContext originatingContext, GraphDiff changes, int syncType, DataChannelSyncFilterChain filterChain)
protected void	preCommit(Object object)	A callback method that records cache group to flush at the end of the commit.

Methods inherited from class java.lang.Object

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

Constructor Details

CacheInvalidationFilter

public CacheInvalidationFilter(org.apache.cayenne.di.Provider<QueryCache> cacheProvider,
 List<InvalidationHandler> handlers)

Method Details

onSync

public GraphDiff onSync(ObjectContext originatingContext,
 GraphDiff changes,
 int syncType,
 DataChannelSyncFilterChain filterChain)

Specified by:

onSync in interface DataChannelSyncFilter

preCommit

@PrePersist
@PreRemove
@PreUpdate
protected void preCommit(Object object)

A callback method that records cache group to flush at the end of the commit.

getOrCreateTxGroups

protected Set<CacheGroupDescriptor> getOrCreateTxGroups()