Class AuditingEntityCallback

java.lang.Object

org.springframework.data.elasticsearch.core.event.AuditingEntityCallback

All Implemented Interfaces:

Ordered, BeforeConvertCallback<Object>, EntityCallback<Object>

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

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

Since:

4.0

Author:

Peter-Josef Meisch, Roman Puchkovskiy

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 IsNewAwareAuditingHandler provided by the given ObjectFactory.

Method Summary

Modifier and Type	Method	Description
int	getOrder()
Object	onBeforeConvert(Object entity, IndexCoordinates index)	Callback method that will be invoked before an entity is persisted.

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 IsNewAwareAuditingHandler provided by the given ObjectFactory.

Parameters:

auditingHandlerFactory - must not be null.

Method Details

onBeforeConvert

public Object onBeforeConvert(Object entity,
 IndexCoordinates index)

Description copied from interface: BeforeConvertCallback

Callback method that will be invoked before an entity is persisted. Can return the same or a different instance of the domain entity class.

Specified by:

onBeforeConvert in interface BeforeConvertCallback<Object>

Parameters:

entity - the entity being converted

index - must not be null.

Returns:

the entity to be converted

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered