Package org.hibernate.envers

Annotation Type Audited

  • @Retention(RUNTIME)
@Target({TYPE,METHOD,FIELD})
public @interface Audited
    When applied to a class, indicates that all of its properties should be audited. When applied to a field, indicates that this field should be audited.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class[] auditParents
      Deprecated.
      Use @AuditOverride(forClass=SomeEntity.class) instead.
      java.lang.String modifiedColumnName
      The column name of the modified field.
      ModificationStore modStore
      Deprecated.
      since 5.2, to be removed in 6.0 with no replacement.
      RelationTargetAuditMode targetAuditMode
      Specifies if the entity that is the target of the relation should be audited or not.
      boolean withModifiedFlag
      Should a modification flag be stored for each property in the annotated class or for the annotated property.

    • Element Detail

      • modStore

        @Deprecated
ModificationStore modStore
        Deprecated.
        since 5.2, to be removed in 6.0 with no replacement.
        Specifies modification store to use
        Default:
        org.hibernate.envers.ModificationStore.FULL

      • targetAuditMode

        RelationTargetAuditMode targetAuditMode
        Specifies if the entity that is the target of the relation should be audited or not. If not, then when reading a historic version an audited entity, the relation will always point to the "current" entity. This is useful for dictionary-like entities, which don't change and don't need to be audited.
        Default:
        org.hibernate.envers.RelationTargetAuditMode.AUDITED

      • auditParents

        @Deprecated
java.lang.Class[] auditParents
        Deprecated.
        Use @AuditOverride(forClass=SomeEntity.class) instead.
        Specifies the superclasses for which properties should be audited, even if the superclasses are not annotated with Audited. Causes all properties of the listed classes to be audited, just as if the classes had Audited annotation applied on the class level.

        The scope of this functionality is limited to the class hierarchy of the annotated entity.

        If a parent type lists any of its parent types using this attribute, all properties in the specified classes will also be audited.

        Default:
        {}

      • withModifiedFlag

        boolean withModifiedFlag
        Should a modification flag be stored for each property in the annotated class or for the annotated property. The flag stores information if a property has been changed at a given revision. This can be used for example in queries.
        Default:
        false

      • modifiedColumnName

        java.lang.String modifiedColumnName
        The column name of the modified field. Analogous to the name attribute of the @Column annotation. Ignored if withModifiedFlag is false.
        Default:
        ""