Package org.javers.spring.auditable

Interface AdvancedCommitPropertiesProvider

All Superinterfaces:

CommitPropertiesProvider

All Known Implementing Classes:

AdvancedCommitPropertiesProvider.EmptyAdvancedCommitPropertiesProvider

public interface AdvancedCommitPropertiesProvider
extends CommitPropertiesProvider

This is an extended version of CommitPropertiesProvider.
Both interfaces exist because of backward compatibility reasons.

Choose this extended version of the interface to generate commit properties that might depend on a current method being executed. See AuditedMethodExecutionContext.

It's not recommended to implement both interfaces in your class, if so, Javers merges the results.

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

 
     @Bean
     @ConditionalOnMissingBean
     public AdvancedCommitPropertiesProvider advancedCommitPropertiesProvider() {
         return new MyAdvancedCommitPropertiesProvider();
     }
 
 

Since:

7.5

See Also:

• CommitPropertiesProvider
• AuditedMethodExecutionContext

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AdvancedCommitPropertiesProvider.EmptyAdvancedCommitPropertiesProvider

Method Summary

Modifier and Type	Method	Description
static AdvancedCommitPropertiesProvider	empty()	Default implementation returning empty maps.
default Map<String,String>	provideForCommittedObject(Object savedDomainObject, AuditedMethodExecutionContext ctx)	Extended version of CommitPropertiesProvider.provideForCommittedObject(Object), which gives access to an audited method execution context.
default Map<String,String>	provideForDeleteById(Class<?> deletedDomainObjectClass, Object deletedDomainObjectId, AuditedMethodExecutionContext ctx)	Extended version of CommitPropertiesProvider.provideForDeleteById(Class, Object), which gives access to an audited method execution context.
default Map<String,String>	provideForDeletedObject(Object deletedDomainObject, AuditedMethodExecutionContext ctx)	Extended version of CommitPropertiesProvider.provideForDeletedObject(Object), which gives access to an audited method execution context.

Methods inherited from interface org.javers.spring.auditable.CommitPropertiesProvider

provide, provideForCommittedObject, provideForDeleteById, provideForDeletedObject

Method Details

provideForCommittedObject

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

Extended version of CommitPropertiesProvider.provideForCommittedObject(Object), which gives access to an audited method execution context.

These two method variants exist because of backward compatibility reasons. Pick one you want to override. If you override both of them (which is not recommended) — Javers merges the results.
Both method variants returns empty Map by default.

Returns:

a map of commit properties

See Also:

• CommitPropertiesProvider.provideForCommittedObject(Object)

provideForDeletedObject

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

Extended version of CommitPropertiesProvider.provideForDeletedObject(Object), which gives access to an audited method execution context.

These two method variants exist because of backward compatibility reasons. Pick one you want to override. If you override both of them (which is not recommended) — Javers merges the results.
Default impl delegates to provideForCommittedObject(Object, AuditedMethodExecutionContext).

Returns:

a map of commit properties

See Also:

• CommitPropertiesProvider.provideForDeletedObject(Object)

provideForDeleteById

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

Extended version of CommitPropertiesProvider.provideForDeleteById(Class, Object), which gives access to an audited method execution context.

These two method variants exist because of backward compatibility reasons. Pick one you want to override. If you override both of them (which is not recommended) — Javers merges the results.
Both method variants returns empty Map by default.

Returns:

a map of commit properties

See Also:

• CommitPropertiesProvider.provideForDeleteById(Class, Object)

empty

static AdvancedCommitPropertiesProvider empty()

Default implementation returning empty maps.