VariableEntityAuditLogManager.java

/*
 * Copyright (c) 2017 OBiBa. All rights reserved.
 *
 * This program and the accompanying materials
 * are made available under the terms of the GNU Public License v3.0.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.obiba.magma.audit;

import java.util.Map;

import org.obiba.magma.Datasource;
import org.obiba.magma.Value;
import org.obiba.magma.ValueTable;
import org.obiba.magma.VariableEntity;
import org.obiba.magma.audit.support.CopyAuditor;
import org.obiba.magma.support.DatasourceCopier;

import com.google.common.base.Function;

/**
 * Interface for interacting with audit logs. It provides the ability to obtain an instance of VariableEntityAuditLog
 * for a specific VariableEntity.
 */
public interface VariableEntityAuditLogManager {

  CopyAuditor createAuditor(DatasourceCopier.Builder builder, Datasource destination,
      Function<VariableEntity, VariableEntity> entityMapper);

  /**
   * Obtain an instance of VariableEntityAuditLog for a specific VariableEntity.
   *
   * @param entity Entity from which to obtain the VariableEntityAuditLog.
   * @return A VariableEntityAuditLog
   */
  VariableEntityAuditLog getAuditLog(VariableEntity entity);

  /**
   * Allows creating new entries (events) within a log.
   *
   * @param log The log in which the event will be created.
   * @param valueTable The ValueTable where the event stems from.
   * @param type The application-specific nature of the event. For example, an application may define "CREATE" and
   * "DELETE" types. Although Magma may define some types, this API does not define any type.
   * @param details A list of event-specific values that provide additional context.
   * @return The event created
   */
  VariableEntityAuditEvent createAuditEvent(VariableEntityAuditLog log, ValueTable valueTable, String type,
      Map<String, Value> details);

}