Package org.javers.spring.auditable

Interface CommitPropertiesProvider

All Known Subinterfaces:

AdvancedCommitPropertiesProvider

All Known Implementing Classes:

AdvancedCommitPropertiesProvider.EmptyAdvancedCommitPropertiesProvider, EmptyPropertiesProvider

public interface CommitPropertiesProvider

This interface gives possibility to provide commit properties for Javers.commit(String, Object, Map) and Javers.commitShallowDelete(String, Object, Map) when called by the JaversSpringDataAuditable auto-audit aspect.

Implementation has to be thread-safe.

Usage
Create a bean in your Spring context, for example:

 
     @Bean
     @ConditionalOnMissingBean
     public CommitPropertiesProvider commitPropertiesProvider() {
         return new MyCommitPropertiesProvider();
     }
 
 

See the extended version of this interface — AdvancedCommitPropertiesProvider, which works similarly, but additionally gives you access to an audited method execution context.

Method Summary

Modifier and Type	Method	Description
default Map<String,String>	provide()	Deprecated.
default Map<String,String>	provideForCommittedObject(Object savedDomainObject)	Provides object-specific Javers commit properties when a given object is committed (saved or updated) to JaversRepository.
default Map<String,String>	provideForDeleteById(Class<?> deletedDomainObjectClass, Object deletedDomainObjectId)	Provides object-specific commit properties when a given object is deleted from JaversRepository by its Id.
default Map<String,String>	provideForDeletedObject(Object deletedDomainObject)	Provides object-specific Javers commit properties when a given object is deleted from JaversRepository.

Method Details

provideForCommittedObject

default Map<String,String> provideForCommittedObject(Object savedDomainObject)

Provides object-specific Javers commit properties when a given object is committed (saved or updated) to JaversRepository.

This method is called by the JaversSpringDataAuditable aspect to get properties for Javers commit created when CrudRepository.save(Object) and CrudRepository.saveAll(Iterable) methods are called.

Default implementation returns empty Map.

Returns:

a map of commit properties

See Also:

• AdvancedCommitPropertiesProvider.provideForCommittedObject(Object, AuditedMethodExecutionContext)

provideForDeletedObject

default Map<String,String> provideForDeletedObject(Object deletedDomainObject)

Provides object-specific Javers commit properties when a given object is deleted from JaversRepository.

This method is called by JaversSpringDataAuditable aspect to get properties for Javers commit created when CrudRepository.delete(Object) and CrudRepository.deleteAll(Iterable) methods are called.

Default implementation delegates to provideForCommittedObject(Object).

Returns:

a map of commit properties

See Also:

• AdvancedCommitPropertiesProvider.provideForDeletedObject(Object, AuditedMethodExecutionContext)

provideForDeleteById

default Map<String,String> provideForDeleteById(Class<?> deletedDomainObjectClass,
 Object deletedDomainObjectId)

Provides object-specific commit properties when a given object is deleted from JaversRepository by its Id.

This method is called by JaversSpringDataAuditable aspect to get properties for Javers commit created when CrudRepository.deleteById(Object) is called.

Default implementation returns empty Map.

Returns:

a map of commit properties

See Also:

• AdvancedCommitPropertiesProvider.provideForDeleteById(Class, Object, AuditedMethodExecutionContext)

provide

@Deprecated
default Map<String,String> provide()

Deprecated.

This method is deprecated and replaced with provideForCommittedObject(Object)