OMRS-131: Detailed Audit Logging

openmrs · Jun 26, 2024 · 697629e · 697629e
1 parent 23c3c3c
commit 697629e
Show file tree

Hide file tree

Showing 88 changed files with 214 additions and 4 deletions.
diff --git a/api/pom.xml b/api/pom.xml
@@ -141,6 +141,10 @@
          <groupId>org.hibernate</groupId>
          <artifactId>hibernate-search-orm</artifactId>
       </dependency>
+      <dependency>
+         <groupId>org.hibernate</groupId>
+         <artifactId>hibernate-envers</artifactId>
+      </dependency>
       <dependency>
          <groupId>org.apache.lucene</groupId>
          <artifactId>lucene-queryparser</artifactId>

diff --git a/api/src/main/java/org/openmrs/Allergen.java b/api/src/main/java/org/openmrs/Allergen.java
@@ -10,6 +10,7 @@
 package org.openmrs;
 
 import org.apache.commons.lang3.StringUtils;
+import org.hibernate.envers.Audited;
 import org.openmrs.Concept;
 import org.openmrs.util.OpenmrsConstants;
 import org.openmrs.api.context.Context;

diff --git a/api/src/main/java/org/openmrs/Allergy.java b/api/src/main/java/org/openmrs/Allergy.java
@@ -16,6 +16,7 @@
 import java.util.UUID;
 
 import org.apache.commons.lang3.StringUtils;
+import org.hibernate.envers.Audited;
 import org.openmrs.BaseOpenmrsData;
 import org.openmrs.Concept;
 import org.openmrs.Patient;
@@ -24,6 +25,7 @@
 /**
  * Represent allergy
  */
+@Audited
 public class Allergy extends BaseOpenmrsData implements java.io.Serializable {
 
 	public static final long serialVersionUID = 1;

diff --git a/api/src/main/java/org/openmrs/AllergyReaction.java b/api/src/main/java/org/openmrs/AllergyReaction.java
@@ -10,13 +10,15 @@
 package org.openmrs;
 
 import org.apache.commons.lang3.StringUtils;
+import org.hibernate.envers.Audited;
 import org.openmrs.BaseOpenmrsObject;
 import org.openmrs.Concept;
 import org.openmrs.util.OpenmrsUtil;
 
 /**
  * Represent allergy reactions
  */
+@Audited
 public class AllergyReaction extends BaseOpenmrsObject implements java.io.Serializable{
 
 	public static final long serialVersionUID = 1;

diff --git a/api/src/main/java/org/openmrs/CareSetting.java b/api/src/main/java/org/openmrs/CareSetting.java
@@ -9,6 +9,8 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
+
 /**
  * Care Setting defines the scope of care for any piece of data within the medical record. Clinical
  * data (treatments, notes, etc.) apply within their associated care setting. Implementations
@@ -24,6 +26,7 @@
  * 
  * @since 1.10
  */
+@Audited
 public class CareSetting extends BaseOpenmrsMetadata implements java.io.Serializable {
 
 	public enum CareSettingType {

diff --git a/api/src/main/java/org/openmrs/Cohort.java b/api/src/main/java/org/openmrs/Cohort.java
@@ -19,10 +19,12 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.hibernate.envers.Audited;
 
 /**
  * This class represents a list of patientIds.
  */
+@Audited
 public class Cohort extends BaseOpenmrsData implements Serializable {
 
 	public static final long serialVersionUID = 0L;

diff --git a/api/src/main/java/org/openmrs/Concept.java b/api/src/main/java/org/openmrs/Concept.java
@@ -29,6 +29,7 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.codehaus.jackson.annotate.JsonIgnore;
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.ContainedIn;
 import org.hibernate.search.annotations.DocumentId;
 import org.hibernate.search.annotations.Field;
@@ -70,6 +71,7 @@
  * @see ConceptService
  */
 @FullTextFilterDefs( { @FullTextFilterDef(name = "termsFilterFactory", impl = TermsFilterFactory.class) })
+@Audited
 public class Concept extends BaseOpenmrsObject implements Auditable, Retireable, Serializable, Attributable<Concept>,Customizable<ConceptAttribute> {
 
 	public static final long serialVersionUID = 57332L;

diff --git a/api/src/main/java/org/openmrs/ConceptAnswer.java b/api/src/main/java/org/openmrs/ConceptAnswer.java
@@ -9,6 +9,8 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
+
 import java.util.Date;
 
 /**
@@ -18,6 +20,7 @@
  *
  * @see Concept#getAnswers()
  */
+@Audited
 public class ConceptAnswer extends BaseOpenmrsObject implements Auditable, java.io.Serializable, Comparable<ConceptAnswer> {
 
 	public static final long serialVersionUID = 3744L;

diff --git a/api/src/main/java/org/openmrs/ConceptAttribute.java b/api/src/main/java/org/openmrs/ConceptAttribute.java
@@ -9,9 +9,11 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
 import org.openmrs.attribute.Attribute;
 import org.openmrs.attribute.BaseAttribute;
 
+@Audited
 public class ConceptAttribute extends BaseAttribute<ConceptAttributeType, Concept> implements Attribute<ConceptAttributeType, Concept> {
 
 	private Integer conceptAttributeId;

diff --git a/api/src/main/java/org/openmrs/ConceptAttributeType.java b/api/src/main/java/org/openmrs/ConceptAttributeType.java
@@ -9,9 +9,11 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
 import org.openmrs.attribute.AttributeType;
 import org.openmrs.attribute.BaseAttributeType;
 
+@Audited
 public class ConceptAttributeType extends BaseAttributeType<Concept> implements AttributeType<Concept> {
 
 	private Integer conceptAttributeTypeId;

diff --git a/api/src/main/java/org/openmrs/ConceptClass.java b/api/src/main/java/org/openmrs/ConceptClass.java
@@ -9,11 +9,13 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.DocumentId;
 
 /**
  * ConceptClass
  */
+@Audited
 public class ConceptClass extends BaseOpenmrsMetadata implements java.io.Serializable {
 
 	public static final long serialVersionUID = 33473L;

diff --git a/api/src/main/java/org/openmrs/ConceptComplex.java b/api/src/main/java/org/openmrs/ConceptComplex.java
@@ -11,6 +11,7 @@
 
 import java.io.Serializable;
 
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.Indexed;
 import org.openmrs.obs.ComplexObsHandler;
 
@@ -20,6 +21,7 @@
  * @since 1.5
  */
 @Indexed
+@Audited
 public class ConceptComplex extends Concept implements Serializable {
 
 	public static final long serialVersionUID = 473231233L;

diff --git a/api/src/main/java/org/openmrs/ConceptDatatype.java b/api/src/main/java/org/openmrs/ConceptDatatype.java
@@ -9,12 +9,14 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.DocumentId;
 import org.hibernate.search.annotations.Indexed;
 
 /**
  * ConceptDatatype
  */
+@Audited
 public class ConceptDatatype extends BaseOpenmrsMetadata implements java.io.Serializable {
 
 	public static final long serialVersionUID = 473L;

diff --git a/api/src/main/java/org/openmrs/ConceptDescription.java b/api/src/main/java/org/openmrs/ConceptDescription.java
@@ -9,12 +9,15 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
+
 import java.util.Date;
 import java.util.Locale;
 
 /**
  * ConceptDescription is the localized description of a concept.
  */
+@Audited
 public class ConceptDescription extends BaseOpenmrsObject implements Auditable, java.io.Serializable {
 
 	private static final long serialVersionUID = -7223075113369136584L;

diff --git a/api/src/main/java/org/openmrs/ConceptMap.java b/api/src/main/java/org/openmrs/ConceptMap.java
@@ -9,6 +9,7 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.ContainedIn;
 import org.hibernate.search.annotations.DocumentId;
 import org.hibernate.search.annotations.IndexedEmbedded;
@@ -17,6 +18,7 @@
  * The concept map object represents a mapping of Concept to ConceptSource. A concept can have 0 to
  * N mappings to any and all concept sources in the database.
  */
+@Audited
 public class ConceptMap extends BaseConceptMap implements java.io.Serializable {
 
 	public static final long serialVersionUID = 754677L;

diff --git a/api/src/main/java/org/openmrs/ConceptMapType.java b/api/src/main/java/org/openmrs/ConceptMapType.java
@@ -10,13 +10,15 @@
 package org.openmrs;
 
 import org.codehaus.jackson.annotate.JsonIgnore;
+import org.hibernate.envers.Audited;
 
 /**
  * ConceptMapType are used to define relationships between concepts and concept reference terms e.g
  * IS_A or SAME_AS, BROADER_THAN
  *
  * @since 1.9
  */
+@Audited
 public class ConceptMapType extends BaseOpenmrsMetadata implements java.io.Serializable {
 
 	private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/org/openmrs/ConceptName.java b/api/src/main/java/org/openmrs/ConceptName.java
@@ -19,6 +19,7 @@
 import org.apache.lucene.analysis.standard.StandardFilterFactory;
 import org.apache.lucene.analysis.standard.StandardTokenizerFactory;
 import org.codehaus.jackson.annotate.JsonIgnore;
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.Analyze;
 import org.hibernate.search.annotations.Analyzer;
 import org.hibernate.search.annotations.AnalyzerDef;
@@ -41,6 +42,7 @@
 @AnalyzerDef(name = "ConceptNameAnalyzer", tokenizer = @TokenizerDef(factory = StandardTokenizerFactory.class), filters = {
         @TokenFilterDef(factory = StandardFilterFactory.class), @TokenFilterDef(factory = LowerCaseFilterFactory.class) })
 @Analyzer(definition = "ConceptNameAnalyzer")
+@Audited
 public class ConceptName extends BaseOpenmrsObject implements Auditable, Voidable, java.io.Serializable {
 
 	public static final long serialVersionUID = 2L;

diff --git a/api/src/main/java/org/openmrs/ConceptNameTag.java b/api/src/main/java/org/openmrs/ConceptNameTag.java
@@ -12,10 +12,12 @@
 import java.util.Date;
 
 import org.codehaus.jackson.annotate.JsonIgnore;
+import org.hibernate.envers.Audited;
 
 /**
  * ConceptNameTag is a textual tag which can be applied to a ConceptName.
  */
+@Audited
 public class ConceptNameTag extends BaseOpenmrsObject implements Auditable, Voidable, java.io.Serializable {
 
 	public static final long serialVersionUID = 33226787L;

diff --git a/api/src/main/java/org/openmrs/ConceptNumeric.java b/api/src/main/java/org/openmrs/ConceptNumeric.java
@@ -13,6 +13,7 @@
 import java.util.TreeSet;
 
 import org.codehaus.jackson.annotate.JsonIgnore;
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.Indexed;
 
 /**
@@ -21,6 +22,7 @@
  * @see Concept
  */
 @Indexed
+@Audited
 public class ConceptNumeric extends Concept implements java.io.Serializable {
 
 	public static final long serialVersionUID = 47323L;

diff --git a/api/src/main/java/org/openmrs/ConceptProposal.java b/api/src/main/java/org/openmrs/ConceptProposal.java
@@ -13,6 +13,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.hibernate.envers.Audited;
 import org.openmrs.util.OpenmrsConstants;
 
 /**
@@ -22,6 +23,7 @@
  * encounter that prompted this proposal is updated with a new observation pointing at the new (or
  * edited) concept.
  */
+@Audited
 public class ConceptProposal extends BaseOpenmrsObject implements java.io.Serializable {
 
 	public static final long serialVersionUID = 57344L;

diff --git a/api/src/main/java/org/openmrs/ConceptReferenceTerm.java b/api/src/main/java/org/openmrs/ConceptReferenceTerm.java
@@ -12,6 +12,7 @@
 import java.util.LinkedHashSet;
 import java.util.Set;
 
+import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.Analyze;
 import org.hibernate.search.annotations.DocumentId;
 import org.hibernate.search.annotations.Field;
@@ -23,6 +24,7 @@
  *
  * @since 1.9
  */
+@Audited
 public class ConceptReferenceTerm extends BaseOpenmrsMetadata implements java.io.Serializable {
 
 	private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/org/openmrs/ConceptReferenceTermMap.java b/api/src/main/java/org/openmrs/ConceptReferenceTermMap.java
@@ -9,6 +9,8 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
+
 import java.io.Serializable;
 
 /**
@@ -18,6 +20,7 @@
  *
  * @since 1.9
  */
+@Audited
 public class ConceptReferenceTermMap extends BaseConceptMap implements Serializable {
 
 	private static final long serialVersionUID = 1L;

diff --git a/api/src/main/java/org/openmrs/ConceptSet.java b/api/src/main/java/org/openmrs/ConceptSet.java
@@ -11,11 +11,13 @@
 
 import java.util.Date;
 
+import org.hibernate.envers.Audited;
 import org.openmrs.util.OpenmrsUtil;
 
 /**
  * This represents a single concept within a concept set.
  */
+@Audited
 public class ConceptSet extends BaseOpenmrsObject implements Auditable, java.io.Serializable, Comparable<ConceptSet> {
 
 	public static final long serialVersionUID = 3787L;

diff --git a/api/src/main/java/org/openmrs/ConceptSource.java b/api/src/main/java/org/openmrs/ConceptSource.java
@@ -9,12 +9,15 @@
  */
 package org.openmrs;
 
+import org.hibernate.envers.Audited;
+
 import java.util.Date;
 
 /**
  * A concept source is defined as any institution that keeps a concept dictionary. Examples are
  * ICD9, ICD10, SNOMED, or any other OpenMRS implementation
  */
+@Audited
 public class ConceptSource extends BaseOpenmrsMetadata implements java.io.Serializable {
 
 	public static final long serialVersionUID = 375L;

diff --git a/api/src/main/java/org/openmrs/ConceptStateConversion.java b/api/src/main/java/org/openmrs/ConceptStateConversion.java
@@ -11,10 +11,12 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.hibernate.envers.Audited;
 
 /**
  * ConceptStateConversion
  */
+@Audited
 public class ConceptStateConversion extends BaseOpenmrsObject implements java.io.Serializable {
 
 	public static final long serialVersionUID = 3214511L;