[15x] Remove Read Auditing feature

ebean-api/src/main/java/io/ebean/ExpressionList.java

@@ -670,16 +670,6 @@ public interface ExpressionList<T> {
    */
   Query<T> setDisableLazyLoading(boolean disableLazyLoading);
 
-  /**
-   * Disable read auditing for this query.
-   * <p>
-   * This is intended to be used when the query is not a user initiated query and instead
-   * part of the internal processing in an application to load a cache or document store etc.
-   * In these cases we don't want the query to be part of read auditing.
-   * </p>
-   */
-  Query<T> setDisableReadAuditing();
-
   /**
    * Set a label on the query (to help identify query execution statistics).
    */

ebean-api/src/main/java/io/ebean/Query.java

@@ -424,16 +424,6 @@ public interface Query<T> extends CancelableQuery {
    */
   Query<T> setIncludeSoftDeletes();
 
-  /**
-   * Disable read auditing for this query.
-   * <p>
-   * This is intended to be used when the query is not a user initiated query and instead
-   * part of the internal processing in an application to load a cache or document store etc.
-   * In these cases we don't want the query to be part of read auditing.
-   * </p>
-   */
-  Query<T> setDisableReadAuditing();
-
   /**
    * Specify the properties to fetch on the root level entity bean in comma delimited format.
    * <p>

ebean-api/src/main/java/io/ebean/config/DatabaseConfig.java

@@ -14,8 +14,6 @@ import io.ebean.event.*;
 import io.ebean.event.changelog.ChangeLogListener;
 import io.ebean.event.changelog.ChangeLogPrepare;
 import io.ebean.event.changelog.ChangeLogRegister;
-import io.ebean.event.readaudit.ReadAuditLogger;
-import io.ebean.event.readaudit.ReadAuditPrepare;
 import io.ebean.meta.MetricNamingMatch;
 import io.ebean.util.StringHelper;
 
@@ -416,8 +414,6 @@ public class DatabaseConfig {
   private ChangeLogListener changeLogListener;
   private ChangeLogRegister changeLogRegister;
   private boolean changeLogAsync = true;
-  private ReadAuditLogger readAuditLogger;
-  private ReadAuditPrepare readAuditPrepare;
   private EncryptKeyManager encryptKeyManager;
   private EncryptDeployManager encryptDeployManager;
   private Encryptor encryptor;
@@ -1197,40 +1193,6 @@ public class DatabaseConfig {
     this.changeLogAsync = changeLogAsync;
   }
 
-  /**
-   * Return the ReadAuditLogger to use.
-   */
-  public ReadAuditLogger getReadAuditLogger() {
-    return readAuditLogger;
-  }
-
-  /**
-   * Set the ReadAuditLogger to use. If not set the default implementation is used
-   * which logs the read events in JSON format to a standard named SLF4J logger
-   * (which can be configured in say logback to log to a separate log file).
-   */
-  public void setReadAuditLogger(ReadAuditLogger readAuditLogger) {
-    this.readAuditLogger = readAuditLogger;
-  }
-
-  /**
-   * Return the ReadAuditPrepare to use.
-   */
-  public ReadAuditPrepare getReadAuditPrepare() {
-    return readAuditPrepare;
-  }
-
-  /**
-   * Set the ReadAuditPrepare to use.
-   * <p>
-   * It is expected that an implementation is used that read user context information
-   * (user id, user ip address etc) and sets it on the ReadEvent bean before it is sent
-   * to the ReadAuditLogger.
-   */
-  public void setReadAuditPrepare(ReadAuditPrepare readAuditPrepare) {
-    this.readAuditPrepare = readAuditPrepare;
-  }
-
   /**
    * Return the configuration for profiling.
    */

ebean-api/src/main/java/io/ebean/event/readaudit/ReadAuditLogger.java

@@ -1,37 +0,0 @@
-package io.ebean.event.readaudit;
-
-/**
- * Log that the query was executed
- */
-public interface ReadAuditLogger {
-
-  /**
-   * Called when a new query plan is created.
-   * <p>
-   * The query plan has the full sql and logging the query plan separately means that each of
-   * the bean and many read events can log the query plan key and not the full sql (reducing the
-   * bulk size of the read audit logs).
-   * </p>
-   */
-  void queryPlan(ReadAuditQueryPlan queryPlan);
-
-  /**
-   * Audit a find bean query that returned a bean.
-   * <p>
-   * Finds that did not return a bean are excluded.
-   * </p>
-   */
-  void auditBean(ReadEvent readBean);
-
-  /**
-   * Audit a find many query that returned some beans.
-   * <p>
-   * Finds that did not return any beans are excluded.
-   * </p>
-   * <p>
-   * For large queries executed via findEach() etc the ids are collected in batches
-   * and logged. Hence the ids list has a maximum size of the batch size.
-   * </p>
-   */
-  void auditMany(ReadEvent readMany);
-}

ebean-api/src/main/java/io/ebean/event/readaudit/ReadAuditPrepare.java

@@ -1,23 +0,0 @@
-package io.ebean.event.readaudit;
-
-/**
- * Set user context information into the read event prior to it being logged.
- */
-public interface ReadAuditPrepare {
-
-  /**
-   * Prepare the read event by setting any user context information into the read event such as the
-   * application user id and ip address.
-   * <p>
-   * This method is called prior to the read event being sent to the ReadAuditLogger.
-   * </p>
-   * <p>
-   * Note that for findFutureList() queries prepare() is called early in the foreground thread
-   * prior to the query executing and at that point the ReadEvent bean only has the bean type
-   * and no other details (which are populated later when the query is executed in the background
-   * thread).
-   * </p>
-   */
-  void prepare(ReadEvent readEvent);
-
-}

ebean-api/src/main/java/io/ebean/event/readaudit/ReadAuditQueryPlan.java

@@ -1,97 +0,0 @@
-package io.ebean.event.readaudit;
-
-/**
- * A SQL query and associated keys.
- * <p>
- * This is logged as a separate event so that the
- * </p>
- */
-public class ReadAuditQueryPlan {
-
-  String beanType;
-
-  String queryKey;
-
-  String sql;
-
-  /**
-   * Construct given the beanType, queryKey and sql.
-   */
-  public ReadAuditQueryPlan(String beanType, String queryKey, String sql) {
-    this.beanType = beanType;
-    this.queryKey = queryKey;
-    this.sql = sql;
-  }
-
-  /**
-   * Construct for JSON tools.
-   */
-  public ReadAuditQueryPlan() {
-  }
-
-  @Override
-  public String toString() {
-    return "beanType:" + beanType + " queryKey:" + queryKey + " sql:" + sql;
-  }
-
-  /**
-   * Return the bean type.
-   */
-  public String getBeanType() {
-    return beanType;
-  }
-
-  /**
-   * Set the bean type.
-   */
-  public void setBeanType(String beanType) {
-    this.beanType = beanType;
-  }
-
-  /**
-   * Return the query key (relative to the bean type).
-   */
-  public String getQueryKey() {
-    return queryKey;
-  }
-
-  /**
-   * Set the query key.
-   */
-  public void setQueryKey(String queryKey) {
-    this.queryKey = queryKey;
-  }
-
-  /**
-   * Return the sql statement.
-   */
-  public String getSql() {
-    return sql;
-  }
-
-  /**
-   * Set the sql statement.
-   */
-  public void setSql(String sql) {
-    this.sql = sql;
-  }
-
-  @Override
-  public boolean equals(Object o) {
-    if (this == o) return true;
-    if (o == null || getClass() != o.getClass()) return false;
-
-    ReadAuditQueryPlan that = (ReadAuditQueryPlan) o;
-    if (!beanType.equals(that.beanType)) return false;
-    if (!queryKey.equals(that.queryKey)) return false;
-    return sql.equals(that.sql);
-  }
-
-  @Override
-  public int hashCode() {
-    int result = beanType.hashCode();
-    result = 92821 * result + queryKey.hashCode();
-    result = 92821 * result + sql.hashCode();
-    return result;
-  }
-}

ebean-api/src/main/java/io/ebean/event/readaudit/ReadEvent.java

@@ -1,261 +0,0 @@
-package io.ebean.event.readaudit;
-
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-
-/**
- * Read event sent to the ReadEventLogger.
- * <p>
- * This is a flattened in that it contains either a read bean or list of beans. It is flattened
- * in this way to simplify logging and processing and simply means that it either contains an
- * id or a list of ids.
- * </p>
- */
-public class ReadEvent {
-
-  /**
-   * User defined 'source' such as the application name.
-   */
-  protected String source;
-
-  /**
-   * Application user id expected to be optionally populated by ChangeLogPrepare.
-   */
-  protected String userId;
-
-  /**
-   * Application user ip address expected to be optionally populated by ChangeLogPrepare.
-   */
-  protected String userIpAddress;
-
-  /**
-   * Arbitrary user context information expected to be optionally populated by ChangeLogPrepare.
-   */
-  protected Map<String, String> userContext;
-
-  /**
-   * The time the bean change was created.
-   */
-  protected long eventTime;
-
-  /**
-   * The type of the bean(s) read.
-   */
-  protected String beanType;
-
-  /**
-   * The query key (relative to the bean type).
-   */
-  protected String queryKey;
-
-  /**
-   * The bind log when the query was executed.
-   */
-  protected String bindLog;
-
-  /**
-   * The id of the bean read.
-   */
-  protected Object id;
-
-  /**
-   * The ids of the beans read.
-   */
-  protected List<Object> ids;
-
-  /**
-   * Common constructor for single bean and multi-bean read events.
-   */
-  protected ReadEvent(String beanType, String queryKey, String bindLog) {
-    this.beanType = beanType;
-    this.queryKey = queryKey;
-    this.bindLog = bindLog;
-    this.eventTime = System.currentTimeMillis();
-  }
-
-  /**
-   * Construct for a single bean read.
-   */
-  public ReadEvent(String beanType, String queryKey, String bindLog, Object id) {
-    this(beanType, queryKey, bindLog);
-    this.id = id;
-  }
-
-  /**
-   * Construct for many beans read.
-   */
-  public ReadEvent(String beanType, String queryKey, String bindLog, List<Object> ids) {
-    this(beanType, queryKey, bindLog);
-    this.ids = ids;
-  }
-
-  /**
-   * Construct for many future list query.
-   */
-  public ReadEvent(String beanType) {
-    this.beanType = beanType;
-    this.eventTime = System.currentTimeMillis();
-  }
-
-  /**
-   * Constructor for JSON tools.
-   */
-  public ReadEvent() {
-  }
-
-  /**
-   * Return a code that identifies the source of the change (like the name of the application).
-   */
-  public String getSource() {
-    return source;
-  }
-
-  /**
-   * Set the source of the change (like the name of the application).
-   */
-  public void setSource(String source) {
-    this.source = source;
-  }
-
-  /**
-   * Return the application user Id.
-   */
-  public String getUserId() {
-    return userId;
-  }
-
-  /**
-   * Set the application user Id.
-   * <p>
-   * This can be set by the ChangeLogListener in the prepare() method which is called
-   * in the foreground thread.
-   * </p>
-   */
-  public void setUserId(String userId) {
-    this.userId = userId;
-  }
-
-  /**
-   * Return the application users ip address.
-   */
-  public String getUserIpAddress() {
-    return userIpAddress;
-  }
-
-  /**
-   * Set the application users ip address.
-   * <p>
-   * This can be set by the ChangeLogListener in the prepare() method which is called
-   * in the foreground thread.
-   * </p>
-   */
-  public void setUserIpAddress(String userIpAddress) {
-    this.userIpAddress = userIpAddress;
-  }
-
-  /**
-   * Return a user context value - anything you set yourself in ChangeLogListener prepare().
-   */
-  public Map<String, String> getUserContext() {
-    if (userContext == null) {
-      userContext = new LinkedHashMap<>();
-    }
-    return userContext;
-  }
-
-  /**
-   * Set a user context value (anything you like).
-   * <p>
-   * This can be set by the ChangeLogListener in the prepare() method which is called
-   * in the foreground thread.
-   * </p>
-   */
-  public void setUserContext(Map<String, String> userContext) {
-    this.userContext = userContext;
-  }
-
-  /**
-   * Return the type of bean read.
-   */
-  public String getBeanType() {
-    return beanType;
-  }
-
-  /**
-   * Set the type of bean read.
-   */
-  public void setBeanType(String beanType) {
-    this.beanType = beanType;
-  }
-
-  /**
-   * Return the query key (relative to the bean type).
-   */
-  public String getQueryKey() {
-    return queryKey;
-  }
-
-  /**
-   * Set the query key (relative to the bean type).
-   */
-  public void setQueryKey(String queryKey) {
-    this.queryKey = queryKey;
-  }
-
-  /**
-   * Return the bind log used when executing the query.
-   */
-  public String getBindLog() {
-    return bindLog;
-  }
-
-  /**
-   * Set the bind log used when executing the query.
-   */
-  public void setBindLog(String bindLog) {
-    this.bindLog = bindLog;
-  }
-
-  /**
-   * Return the event date time.
-   */
-  public long getEventTime() {
-    return eventTime;
-  }
-
-  /**
-   * Set the event date time.
-   */
-  public void setEventTime(long eventTime) {
-    this.eventTime = eventTime;
-  }
-
-  /**
-   * Return the id of the bean read.
-   */
-  public Object getId() {
-    return id;
-  }
-
-  /**
-   * Set the id of the bean read.
-   */
-  public void setId(Object id) {
-    this.id = id;
-  }
-
-  /**
-   * Return the ids of the beans read.
-   */
-  public List<Object> getIds() {
-    return ids;
-  }
-
-  /**
-   * Set the ids of the beans read.
-   */
-  public void setIds(List<Object> ids) {
-    this.ids = ids;
-  }
-}

ebean-api/src/main/java/io/ebean/event/readaudit/package-info.java

@@ -1,8 +0,0 @@
-/**
- * Provides Auditing of read events including queries and L2 cache.
- * <p>
- * Provides a built support for supplied an audit of all the 'read events' for beans annotated
- * with <code>@ReadAudit</code>
- * </p>
- */
-package io.ebean.event.readaudit;