se.swedenconnect.signservice.audit.AuditEventIds Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022-2024 Sweden Connect
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package se.swedenconnect.signservice.audit;

/**
 * Defines audit logger events identifiers.
 */
public class AuditEventIds {

  /** SignService system was started. */
  public final static String EVENT_SYSTEM_STARTED = "audit.system.started";

  /** A request was made to the application that could not be serviced. */
  public final static String EVENT_SYSTEM_NOTFOUND = "audit.system.not-found";

  /** An unrecoverable processing error was caught and reported by the system. */
  public final static String EVENT_SYSTEM_PROCESSING_ERROR = "audit.system.processing-error";

  /** A SignService engine instance (servicing a client) was started. */
  public final static String EVENT_ENGINE_STARTED = "audit.engine.started";

  /**
   * A "session reset" may occur when a SignRequest is received when the expected message is
   * an authentication response message. This is not treated as an error. Instead we assume
   * that the previous session was abandoned by the user. However, we audit log this, since
   * it may be useful in interactions with users (support).
   */
  public final static String EVENT_ENGINE_SESSION_RESET = "audit.engine.user.session-reset";

  /** A user was successfully authenticated. */
  public final static String EVENT_ENGINE_USER_AUTHENTICATED = "audit.engine.user.authn";

  /** The user authentication failed. */
  public final static String EVENT_ENGINE_USER_AUTHN_FAILED = "audit.engine.user.authn-failure";

  /** The signature operation failed and an error message is sent back to the user. */
  public final static String EVENT_ENGINE_SIGNATURE_OPERATION_FAILURE = "audit.engine.user.operation-failure";

  /** The signature operation was successful. */
  public final static String EVENT_ENGINE_SIGNATURE_OPERATION_SUCCESS = "audit.engine.user.operation-success";

  // Hidden constructor
  private AuditEventIds() {
  }

}