Package org.springframework.data.couchbase.core.mapping.event

Class AuditingEntityCallback

java.lang.Object

org.springframework.data.couchbase.core.mapping.event.AuditingEntityCallback

All Implemented Interfaces:

Ordered, AfterConvertCallback<Object>, BeforeConvertCallback<Object>, EntityCallback<Object>

public class AuditingEntityCallback
extends Object
implements BeforeConvertCallback<Object>, AfterConvertCallback<Object>, Ordered

EntityCallback to populate auditing related fields on an entity about to be saved.

Since:

4.2

Author:

Jorge Rodríguez Martín

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AuditingEntityCallback(ObjectFactory<IsNewAwareAuditingHandler> auditingHandlerFactory)	Creates a new AuditingEntityCallback using the given MappingContext and AuditingHandler provided by the given ObjectFactory.

Method Summary

Modifier and Type	Method	Description
int	getOrder()
Object	onAfterConvert(Object entity, CouchbaseDocument document, String collection)	Entity callback method invoked after a domain object is materialized from a CouchbaseDocument.
Object	onBeforeConvert(Object entity, String collection)	Entity callback method invoked before a domain object is converted to be persisted.

Methods inherited from class java.lang.Object

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

Constructor Details

AuditingEntityCallback

public AuditingEntityCallback(ObjectFactory<IsNewAwareAuditingHandler> auditingHandlerFactory)

Creates a new AuditingEntityCallback using the given MappingContext and AuditingHandler provided by the given ObjectFactory.

Parameters:

auditingHandlerFactory - must not be null.

Method Details

onBeforeConvert

public Object onBeforeConvert(Object entity,
 String collection)

Description copied from interface: BeforeConvertCallback

Entity callback method invoked before a domain object is converted to be persisted. Can return either the same or a modified instance of the domain object.

Specified by:

onBeforeConvert in interface BeforeConvertCallback<Object>

Parameters:

entity - the domain object to save.

collection - name of the collection.

Returns:

the domain object to be persisted.

onAfterConvert

public Object onAfterConvert(Object entity,
 CouchbaseDocument document,
 String collection)

Description copied from interface: AfterConvertCallback

Entity callback method invoked after a domain object is materialized from a CouchbaseDocument. Can return either the same or a modified instance of the domain object.

Specified by:

onAfterConvert in interface AfterConvertCallback<Object>

Parameters:

entity - the domain object (the result of the conversion).

document - must not be null.

collection - name of the collection.

Returns:

the domain object that is the result of reading it from the CouchbaseDocument.

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered