Class ValidityAuditStrategy

  • All Implemented Interfaces:
    AuditStrategy, AuditStrategy
    Direct Known Subclasses:
    ValidityAuditStrategy

    public class ValidityAuditStrategy
    extends Object
    implements AuditStrategy
    An audit strategy implementation that persists and fetches audit information using a validity algorithm, based on the start-revision and end-revision of a row in the audit table schema.

    This algorithm works as follows:

    • For a new row, only the start-revision column is set in the row.
    • Concurrently, the end-revision of the prior audit row is set to the current revision
    • Queries using a between start and end revision predicate rather than using subqueries.

    This has a few important consequences which must be considered:

    • Persisting audit information is sightly slower due to an extra update required
    • Retreiving audit information is considerably faster
    • Constructor Detail

      • ValidityAuditStrategy

        public ValidityAuditStrategy()
    • Method Detail

      • postInitialize

        public void postInitialize​(AuditStrategyContext context)
        Description copied from interface: AuditStrategy
        Performs post initialization of the audit strategy implementation.
        Specified by:
        postInitialize in interface AuditStrategy
        Parameters:
        context - the audit strategy context, never null
      • addAdditionalColumns

        public void addAdditionalColumns​(MappingContext mappingContext)
        Description copied from interface: AuditStrategy
        Add additional columns to the audit mappings.
        Specified by:
        addAdditionalColumns in interface AuditStrategy
        Parameters:
        mappingContext - The mapping context.
      • perform

        public void perform​(Session session,
                            String entityName,
                            Configuration configuration,
                            Object id,
                            Object data,
                            Object revision)
        Description copied from interface: AuditStrategy
        Perform the persistence of audited data for regular entities.
        Specified by:
        perform in interface AuditStrategy
        Parameters:
        session - Session, which can be used to persist the data.
        entityName - Name of the entity, in which the audited change happens
        configuration - The audit entity configuration.
        id - Id of the entity.
        data - Audit data to persist.
        revision - Current revision data.
      • performCollectionChange

        public void performCollectionChange​(Session session,
                                            String entityName,
                                            String propertyName,
                                            Configuration configuration,
                                            PersistentCollectionChangeData persistentCollectionChangeData,
                                            Object revision)
        Description copied from interface: AuditStrategy
        Perform the persistence of audited data for collection ("middle") entities.
        Specified by:
        performCollectionChange in interface AuditStrategy
        Parameters:
        session - Session, which can be used to persist the data.
        entityName - Name of the entity, in which the audited change happens.
        propertyName - The name of the property holding the persistent collection
        configuration - audit configuration
        persistentCollectionChangeData - Collection change data to be persisted.
        revision - Current revision data
      • addEntityAtRevisionRestriction

        public void addEntityAtRevisionRestriction​(Configuration configuration,
                                                   QueryBuilder rootQueryBuilder,
                                                   Parameters parameters,
                                                   String revisionProperty,
                                                   String revisionEndProperty,
                                                   boolean addAlias,
                                                   MiddleIdData idData,
                                                   String revisionPropertyPath,
                                                   String originalIdPropertyName,
                                                   String alias1,
                                                   String alias2,
                                                   boolean inclusive)
        Update the rootQueryBuilder with an extra WHERE clause to restrict the revision for a two-entity relation. This WHERE clause depends on the AuditStrategy. For this implmenetation, the revision-end column is used

        e.revision <= :revision and (e.endRevision > :revision or e.endRevision is null

        Specified by:
        addEntityAtRevisionRestriction in interface AuditStrategy
        Parameters:
        configuration - the Configuration
        rootQueryBuilder - the QueryBuilder that will be updated
        parameters - root parameters to which restrictions shall be added
        revisionProperty - property of the revision column
        revisionEndProperty - property of the revisionEnd column (only used for ValidityAuditStrategy)
        addAlias - boolean indicator if a left alias is needed
        idData - id-information for the two-entity relation (only used for DefaultAuditStrategy)
        revisionPropertyPath - path of the revision property (only used for ValidityAuditStrategy)
        originalIdPropertyName - name of the id property (only used for ValidityAuditStrategy)
        alias1 - an alias used for subquery (only used for ValidityAuditStrategy)
        alias2 - an alias used for subquery (only used for ValidityAuditStrategy)
        inclusive - indicates whether revision number shall be treated as inclusive or exclusive
      • addAssociationAtRevisionRestriction

        public void addAssociationAtRevisionRestriction​(QueryBuilder rootQueryBuilder,
                                                        Parameters parameters,
                                                        String revisionProperty,
                                                        String revisionEndProperty,
                                                        boolean addAlias,
                                                        MiddleIdData referencingIdData,
                                                        String versionsMiddleEntityName,
                                                        String eeOriginalIdPropertyPath,
                                                        String revisionPropertyPath,
                                                        String originalIdPropertyName,
                                                        String alias1,
                                                        boolean inclusive,
                                                        MiddleComponentData... componentDatas)
        Update the rootQueryBuilder with an extra WHERE clause to restrict the revision for a middle-entity association. This WHERE clause depends on the AuditStrategy. For this implmenetation, the revision-end column is used

        e.revision <= :revision and (e.endRevision > :revision or e.endRevision is null

        Specified by:
        addAssociationAtRevisionRestriction in interface AuditStrategy
        Parameters:
        rootQueryBuilder - the QueryBuilder that will be updated
        parameters - root parameters to which restrictions shall be added
        revisionProperty - property of the revision column
        revisionEndProperty - property of the revisionEnd column (only used for ValidityAuditStrategy)
        addAlias - boolean indicator if a left alias is needed
        referencingIdData - id-information for the middle-entity association (only used for DefaultAuditStrategy)
        versionsMiddleEntityName - name of the middle-entity
        eeOriginalIdPropertyPath - name of the id property (only used for ValidityAuditStrategy)
        revisionPropertyPath - path of the revision property (only used for ValidityAuditStrategy)
        originalIdPropertyName - name of the id property (only used for ValidityAuditStrategy)
        alias1 - an alias used for subqueries (only used for DefaultAuditStrategy)
        inclusive - indicates whether revision number shall be treated as inclusive or exclusive
        componentDatas - information about the middle-entity relation
      • setRevisionTimestampGetter

        @Deprecated
        public void setRevisionTimestampGetter​(Getter revisionTimestampGetter)
        Deprecated.
        since 5.4 with no replacement.