org.apache.cayenne.commitlog

Class CommitLogModuleExtender

java.lang.Object

org.apache.cayenne.commitlog.CommitLogModuleExtender

public class CommitLogModuleExtender
extends Object

A builder of a custom extensions module for CommitLogModule that customizes its services and installs application-specific commit log listeners.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
CommitLogModuleExtender	addListener(Class<? extends CommitLogListener> type)
CommitLogModuleExtender	addListener(CommitLogListener instance)
CommitLogModuleExtender	commitLogAnnotationEntitiesOnly() Installs entity filter that would only include entities annotated with CommitLog on the callbacks.
CommitLogModuleExtender	entityFactory(Class<? extends CommitLogEntityFactory> entityFactoryType) Installs a custom factory for CommitLogEntity objects that allows implementors to use their own annotations, etc.
CommitLogModuleExtender	excludeFromTransaction() If called, events will be dispatched outside of the main commit transaction.
org.apache.cayenne.di.Module	module() Creates a DI module that would install CommitLogFilter and its listeners in Cayenne.

Methods inherited from class java.lang.Object

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

Method Detail

addListener

public CommitLogModuleExtender addListener(Class<? extends CommitLogListener> type)

addListener

public CommitLogModuleExtender addListener(CommitLogListener instance)

excludeFromTransaction

public CommitLogModuleExtender excludeFromTransaction()

If called, events will be dispatched outside of the main commit transaction. By default events are dispatched within the transaction, so listeners can commit their code together with the main commit.

commitLogAnnotationEntitiesOnly

public CommitLogModuleExtender commitLogAnnotationEntitiesOnly()

Installs entity filter that would only include entities annotated with CommitLog on the callbacks. Also CommitLog.confidential() properties will be obfuscated and CommitLog.ignoredProperties() - excluded from the change collection.

entityFactory

public CommitLogModuleExtender entityFactory(Class<? extends CommitLogEntityFactory> entityFactoryType)

Installs a custom factory for CommitLogEntity objects that allows implementors to use their own annotations, etc.

module

public org.apache.cayenne.di.Module module()

Creates a DI module that would install CommitLogFilter and its listeners in Cayenne.