Package org.springframework.data.auditing

Class AuditingHandler

java.lang.Object

org.springframework.data.auditing.AuditingHandlerSupport

org.springframework.data.auditing.AuditingHandler

All Implemented Interfaces:

InitializingBean

Direct Known Subclasses:

IsNewAwareAuditingHandler

public class AuditingHandler
extends AuditingHandlerSupport
implements InitializingBean

Auditing handler to mark entity objects created and modified.

Since:

1.5

Author:

Oliver Gierke, Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
AuditingHandler(PersistentEntities entities)	Creates a new AuditableBeanWrapper using the given PersistentEntities when looking up auditing metadata via reflection.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
static AuditingHandler	from(MappingContext<?,?> mappingContext)	Factory method that creates a new AuditingHandler for the given MappingContext.
<T> T	markCreated(T source)	Marks the given object as created.
<T> T	markModified(T source)	Marks the given object as modified.
void	setAuditorAware(@Nullable AuditorAware<?> auditorAware)	Setter to inject a AuditorAware component to retrieve the current auditor.

Methods inherited from class org.springframework.data.auditing.AuditingHandlerSupport

isAuditable, setDateTimeForNow, setDateTimeProvider, setModifyOnCreation

Methods inherited from class java.lang.Object

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

Constructor Details

AuditingHandler

public AuditingHandler(PersistentEntities entities)

Creates a new AuditableBeanWrapper using the given PersistentEntities when looking up auditing metadata via reflection.

Parameters:

entities - must not be null.

Since:

1.10

Method Details

from

public static AuditingHandler from(MappingContext<?,?> mappingContext)

Factory method that creates a new AuditingHandler for the given MappingContext.

Parameters:

mappingContext - must not be null.

Since:

3.0

setAuditorAware

public void setAuditorAware(@Nullable AuditorAware<?> auditorAware)

Setter to inject a AuditorAware component to retrieve the current auditor.

Parameters:

auditorAware - can be null if no auditor-aware is available.

markCreated

public <T> T markCreated(T source)

Marks the given object as created.

Parameters:

source -

markModified

public <T> T markModified(T source)

Marks the given object as modified.

Parameters:

source -

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean