Class AuditingEntityCallback

java.lang.Object

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

All Implemented Interfaces:

Ordered, EntityCallback<Object>, BeforeConvertCallback<Object>

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

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

Since:

2.2

Author:

Mark Paluch, HeeChul Yang

Field Summary

Fields inherited from interface 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	onBeforeConvert(Object entity, String collection)	Entity callback method invoked before a domain object is converted to be persisted.
void	setOrder(int order)	Specify the order value for this BeforeConvertCallback.

Methods inherited from class 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

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setOrder

public void setOrder(int order)

Specify the order value for this BeforeConvertCallback.

The default value is 100.

Since:

5.0

See Also:

• Ordered.getOrder()

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.