Package org.javers.spring.auditable

Interface CommitPropertiesProvider

  • All Known Implementing Classes:
    EmptyPropertiesProvider
    public interface CommitPropertiesProvider
    Provides commit properties for Javers.commit(String, Object, Map) called by Javers auto-audit aspect — JaversSpringDataAuditable.

    Implementation has to be thread-safe.

    • Method Summary

      All Methods Instance Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      default java.util.Map<java.lang.String,​java.lang.String> provide()
      Deprecated.
      default java.util.Map<java.lang.String,​java.lang.String> provideForCommittedObject​(java.lang.Object domainObject)
      Provides object-specific Javers commit properties when a given object is committed (saved or updated) to JaversRepository.
      default java.util.Map<java.lang.String,​java.lang.String> provideForDeleteById​(java.lang.Class<?> domainObjectClass, java.lang.Object domainObjectId)
      Provides object-specific commit properties when a given object is deleted from JaversRepository by its Id.
      default java.util.Map<java.lang.String,​java.lang.String> provideForDeletedObject​(java.lang.Object domainObject)
      Provides object-specific commit properties when a given object is deleted from JaversRepository.

    • Method Detail

      • provideForCommittedObject

        default java.util.Map<java.lang.String,​java.lang.String> provideForCommittedObject​(java.lang.Object domainObject)
        Provides object-specific Javers commit properties when a given object is committed (saved or updated) to JaversRepository.

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

        Default implementation returns empty Map
        Parameters:
        domainObject - saved object

      • provideForDeletedObject

        default java.util.Map<java.lang.String,​java.lang.String> provideForDeletedObject​(java.lang.Object domainObject)
        Provides object-specific commit properties when a given object is deleted from JaversRepository.

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

        Default implementation delegates to provideForCommittedObject(Object)
        Parameters:
        domainObject - affected object

      • provideForDeleteById

        default java.util.Map<java.lang.String,​java.lang.String> provideForDeleteById​(java.lang.Class<?> domainObjectClass,
                                                                                    java.lang.Object domainObjectId)
        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 commit created when CrudRepository.deleteById(Object) methods are called.

        Default implementation returns empty Map

      • provide

        @Deprecated
default java.util.Map<java.lang.String,​java.lang.String> provide()
        Deprecated.
        This method is deprecated and replaced with provideForCommittedObject(Object)