org.xipki.audit.AuditEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of audit Show documentation
The newest version!
// Copyright (c) 2013-2023 xipki. All rights reserved.
// License Apache License 2.0

package org.xipki.audit;

import org.slf4j.Logger;
import org.xipki.util.Args;

import java.time.Duration;
import java.time.Instant;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;

/**
 * Audit event.
 *
 * @author Lijun Liao (xipki)
 * @since 2.0.0
 */

public class AuditEvent {

  /**
   * The name of the application the event belongs to.
   */
  private String applicationName;

  /**
   * The AuditLevel this Event belongs to.
   */
  private AuditLevel level;

  /**
   * Time-stamp when the event was saved.
   */
  private final Instant timestamp;

  private AuditStatus status;

  /**
   * Duration.
   */
  private Duration duration;

  /**
   * The data array belonging to the event.
   */
  private final List eventDatas = new LinkedList<>();

  public AuditEvent() {
    this(null);
  }

  public AuditEvent(Instant timestamp) {
    this.timestamp = (timestamp == null) ? Instant.now() : timestamp;
    this.level = AuditLevel.INFO;
    this.duration = null;
  }

  public AuditLevel getLevel() {
    if (status == AuditStatus.FAILED && AuditLevel.INFO == level) {
      return AuditLevel.WARN;
    } else {
      return level;
    }
  }

  public void setLevel(AuditLevel level) {
    this.level = level;
  }

  public void update(AuditLevel level, AuditStatus status) {
    this.level = level;
    this.status = status;
  }

  public String getApplicationName() {
    return applicationName;
  }

  public void setApplicationName(String applicationName) {
    this.applicationName = Args.notNull(applicationName, "applicationName");
  }

  public Instant getTimestamp() {
    return timestamp;
  }

  public List getEventDatas() {
    return Collections.unmodifiableList(eventDatas);
  }

  public void setEventType(String type) {
    setEventData("event_type", type);
  }

  public AuditEventData addEventType(String type) {
    return addEventData("event_type", type);
  }

  public void setEventData(String name, Object value) {
    Args.notNull(name, "name");
    Args.notNull(value, "value");

    int idx = -1;
    for (int i = 0; i < eventDatas.size(); i++) {
      final AuditEventData ed = eventDatas.get(i);
      if (ed.getName().equals(name)) {
        idx = i;
        break;
      }
    }

    if (idx != -1) {
      eventDatas.remove(idx);
    }
    eventDatas.add(new AuditEventData(name, value));
  }

  public AuditEventData addEventData(String name, Object value) {
    return addEventData(new AuditEventData(name, value));
  }

  public AuditEventData addEventData(AuditEventData eventData) {
    Args.notNull(eventData, "eventData");

    int idx = -1;
    for (int i = 0; i < eventDatas.size(); i++) {
      final AuditEventData ed = eventDatas.get(i);
      if (ed.getName().equals(eventData.getName())) {
        idx = i;
        break;
      }
    }

    if (idx == -1) {
      eventDatas.add(eventData);
      return eventData;
    } else {
      final AuditEventData existing = eventDatas.get(idx);
      existing.addValue(eventData.getValue());
      return existing;
    }
  } // method addEventData

  public boolean removeEventData(String eventDataName) {
    Args.notNull(eventDataName, "eventDataName");

    boolean removed = false;
    for (final AuditEventData ed : eventDatas) {
      if (ed.getName().equals(eventDataName)) {
        eventDatas.remove(ed);
        removed = true;
        break;
      }
    }

    return removed;
  } // method removeEventData

  public AuditStatus getStatus() {
    return status;
  }

  public void setStatus(AuditStatus status) {
    Args.notNull(status, "status");
    if (this.status != status && this.status != AuditStatus.FAILED) {
      this.status = status;
    }
  }

  public void finish() {
    this.duration = Duration.between(timestamp, Instant.now());
  }

  public Duration getDuration() {
    return duration;
  }

  public String toTextMessage() {
    String applicationName = getApplicationName();
    if (applicationName == null) {
      applicationName = "undefined";
    }

    StringBuilder sb = new StringBuilder(150);

    sb.append(applicationName);

    AuditStatus status = getStatus();
    if (status == null) {
      status = AuditStatus.UNDEFINED;
    }
    sb.append(";\tstatus: ").append(status.name());
    List eventDataArray = getEventDatas();

    Duration duration = getDuration();
    if (duration != null) {
      sb.append("\tduration: ").append(duration.toMillis());
    }

    if ((eventDataArray != null) && (eventDataArray.size() > 0)) {
      for (AuditEventData m : eventDataArray) {
        if ("duration".equalsIgnoreCase(m.getName())) {
          continue;
        }

        sb.append("\t").append(m.getName()).append(": ").append(m.getValue());
      }
    }

    return sb.toString();
  } // method toTextMessage

  public void log(Logger log) {
    AuditLevel level = getLevel();
    if (level == AuditLevel.ERROR) {
      log.error(toTextMessage());
    } else if (level == AuditLevel.WARN) {
      log.warn(toTextMessage());
    } else {
      log.info(toTextMessage());
    }
  }

}