Package org.odpi.openmetadata.frameworks.auditlog

Enum Class AuditLogRecordSeverityLevel

java.lang.Object
java.lang.Enum<AuditLogRecordSeverityLevel>
org.odpi.openmetadata.frameworks.auditlog.AuditLogRecordSeverityLevel
All Implemented Interfaces:
Serializable, Comparable<AuditLogRecordSeverityLevel>, Constable, AuditLogRecordSeverity
public enum AuditLogRecordSeverityLevel extends Enum<AuditLogRecordSeverityLevel> implements AuditLogRecordSeverity
AuditLogRecordSeverityLevel defines the different levels of severity for log records stored in the AuditLogRecord.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ACTION
    Action - Action is required by the administrator.
    ACTIVITY
    Activity - This log record contains user activity information such as the requests being made and the metadata being accessed.
    ASSET
    Asset - An auditable action relating to an asset has been taken.
    COHORT
    Cohort - The server is exchanging registration information about an open metadata repository cohort that it is connecting to.
    DECISION
    Decision - A decision has been made related to the operation of the system.
    ERROR
    Error - An error occurred.
    EVENT
    Event - An event was sent to or received from another participant in the server's ecosystem.
    EXCEPTION
    Exception - An unexpected exception occurred.
    INFO
    Information - The server is providing information about its normal operation.
    PERFMON
    PerfMon - This log record contains performance monitoring timing information for specific types of processing.
    SECURITY
    Security - Unauthorized access to a service or metadata instance has been attempted.
    SHUTDOWN
    Shutdown - An existing component is shutting down.
    STARTUP
    Startup - A new component is starting up.
    TRACE
    Trace - This is additional information on the operation of the server that may be of assistance in debugging a problem.
    TYPES
    Types - Activity is occurring that relates to the open metadata types in use by this server.
    UNKNOWN
    Unknown - Uninitialized Severity.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Return the default description of this enum.
    String
    getName()
    Return the name of this enum.
    int
    getOrdinal()
    Return the code for this enum.
    static List<AuditLogRecordSeverity>
    getSeverityList()
    Return the list of severities defined for the audit log records in this server.
    String
    toString()
    toString() JSON-style
    static AuditLogRecordSeverityLevel
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static AuditLogRecordSeverityLevel[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final AuditLogRecordSeverityLevel UNKNOWN
      Unknown - Uninitialized Severity.

    • INFO

      public static final AuditLogRecordSeverityLevel INFO
      Information - The server is providing information about its normal operation.

    • EVENT

      public static final AuditLogRecordSeverityLevel EVENT
      Event - An event was sent to or received from another participant in the server's ecosystem.

    • DECISION

      public static final AuditLogRecordSeverityLevel DECISION
      Decision - A decision has been made related to the operation of the system.

    • ACTION

      public static final AuditLogRecordSeverityLevel ACTION
      Action - Action is required by the administrator. At a minimum, the situation needs to be investigated and if necessary, corrective action taken.

    • ERROR

      public static final AuditLogRecordSeverityLevel ERROR
      Error - An error occurred. This may restrict some of the server's operations.

    • EXCEPTION

      public static final AuditLogRecordSeverityLevel EXCEPTION
      Exception - An unexpected exception occurred. Details of the exception and stack trace are included in the log record.

    • SECURITY

      public static final AuditLogRecordSeverityLevel SECURITY
      Security - Unauthorized access to a service or metadata instance has been attempted.

    • STARTUP

      public static final AuditLogRecordSeverityLevel STARTUP
      Startup - A new component is starting up.

    • SHUTDOWN

      public static final AuditLogRecordSeverityLevel SHUTDOWN
      Shutdown - An existing component is shutting down.

    • ASSET

      public static final AuditLogRecordSeverityLevel ASSET
      Asset - An auditable action relating to an asset has been taken.

    • TYPES

      public static final AuditLogRecordSeverityLevel TYPES
      Types - Activity is occurring that relates to the open metadata types in use by this server.

    • COHORT

      public static final AuditLogRecordSeverityLevel COHORT
      Cohort - The server is exchanging registration information about an open metadata repository cohort that it is connecting to.

    • TRACE

      public static final AuditLogRecordSeverityLevel TRACE
      Trace - This is additional information on the operation of the server that may be of assistance in debugging a problem. It is not normally logged to any destination, but can be added when needed.

    • PERFMON

      public static final AuditLogRecordSeverityLevel PERFMON
      PerfMon - This log record contains performance monitoring timing information for specific types of processing. It is not normally logged to any destination but can be added when needed.

    • ACTIVITY

      public static final AuditLogRecordSeverityLevel ACTIVITY
      Activity - This log record contains user activity information such as the requests being made and the metadata being accessed.

  • Method Details

    • values

      public static AuditLogRecordSeverityLevel[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AuditLogRecordSeverityLevel valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getOrdinal

      public int getOrdinal()
      Return the code for this enum.
      Specified by:
      getOrdinal in interface AuditLogRecordSeverity
      Returns:
      int numeric for this enum

    • getName

      public String getName()
      Return the name of this enum.
      Specified by:
      getName in interface AuditLogRecordSeverity
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the default description of this enum. This description is in English. Natural language translations can be created using a Resource Bundle indexed by the severity code. This description is a fall back when the resource bundle is not available.
      Specified by:
      getDescription in interface AuditLogRecordSeverity
      Returns:
      String default description

    • toString

      public String toString()
      toString() JSON-style
      Overrides:
      toString in class Enum<AuditLogRecordSeverityLevel>
      Returns:
      string description

    • getSeverityList

      public static List<AuditLogRecordSeverity> getSeverityList()
      Return the list of severities defined for the audit log records in this server. The Enum needs to be turned into a bean.
      Returns:
      list of severity values