Package org.odpi.openmetadata.metadatasecurity.ffdc

Enum Class OpenMetadataSecurityAuditCode

java.lang.Object
java.lang.Enum<OpenMetadataSecurityAuditCode>
org.odpi.openmetadata.metadatasecurity.ffdc.OpenMetadataSecurityAuditCode
All Implemented Interfaces:
Serializable, Comparable<OpenMetadataSecurityAuditCode>, Constable, AuditLogMessageSet
public enum OpenMetadataSecurityAuditCode extends Enum<OpenMetadataSecurityAuditCode> implements AuditLogMessageSet
The OpenMetadataSecurityAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:
  • Log Message Identifier - to uniquely identify the message
  • Severity - is this an event, decision, action, error or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • Additional Information - further parameters and data relating to the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Enum Constant Details

    • PLATFORM_INITIALIZING

      public static final OpenMetadataSecurityAuditCode PLATFORM_INITIALIZING
      OPEN-METADATA-SECURITY-0001 - The Open Metadata Security Service {0} for OMAG Server Platform {1} is initializing

    • PLATFORM_SHUTDOWN

      public static final OpenMetadataSecurityAuditCode PLATFORM_SHUTDOWN
      OPEN-METADATA-SECURITY-0002 - The Open Metadata Security Service {0} for OMAG Server Platform {1} is shutting down

    • SERVICE_INITIALIZING

      public static final OpenMetadataSecurityAuditCode SERVICE_INITIALIZING
      OPEN-METADATA-SECURITY-0003 - The Open Metadata Security Service {0} for server {1} is initializing

    • SERVICE_SHUTDOWN

      public static final OpenMetadataSecurityAuditCode SERVICE_SHUTDOWN
      OPEN-METADATA-SECURITY-0004 - The Open Metadata Security Service {0} for server {1} is shutting down

    • UNAUTHORIZED_PLATFORM_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_PLATFORM_ACCESS
      OPEN-METADATA-SECURITY-0005 - User {0} is not authorized to issue a request to this OMAG Server Platform

    • UNAUTHORIZED_SERVER_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_SERVER_ACCESS
      OPEN-METADATA-SECURITY-0006 - User {0} is not authorized to issue a request to server {1}

    • UNAUTHORIZED_SERVICE_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_SERVICE_ACCESS
      OPEN-METADATA-SECURITY-0007 - User {0} is not authorized to issue {1} requests for service {2} on server {3}

    • UNAUTHORIZED_ASSET_FEEDBACK

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_FEEDBACK
      OPEN-METADATA-SECURITY-0008 - User {0} is not authorized to attach feedback to asset {1}

    • UNAUTHORIZED_ZONE_CHANGE

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ZONE_CHANGE
      OPEN-METADATA-SECURITY-0009 - User {0} is not authorized to change the zone membership of asset {1} from {2} to {3}

    • UNAUTHORIZED_CONNECTION_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_CONNECTION_ACCESS
      OPEN-METADATA-SECURITY-0010 - User {0} is not authorized to use connection {1}

    • UNAUTHORIZED_ASSET_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_ACCESS
      OPEN-METADATA-SECURITY-0011 - User {0} is not authorized to access asset {1}

    • UNAUTHORIZED_ASSET_CREATE

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_CREATE
      OPEN-METADATA-SECURITY-0012 - User {0} is not authorized to create an asset of type {1}

    • UNAUTHORIZED_ASSET_CHANGE

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_CHANGE
      OPEN-METADATA-SECURITY-0013 - User {0} is not authorized to change asset {1}

    • INCOMPLETE_ASSET

      public static final OpenMetadataSecurityAuditCode INCOMPLETE_ASSET
      OPEN-METADATA-SECURITY-0014 - User {0} is not authorized to change asset {1} because it has missing properties: {2}

    • UNAUTHORIZED_TYPE_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_TYPE_ACCESS
      OPEN-METADATA-SECURITY-0015 - User {0} is not authorized to access open metadata type {1} ({2}) on server {3}

    • UNAUTHORIZED_TYPE_CHANGE

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_TYPE_CHANGE
      OPEN-METADATA-SECURITY-0016 - User {0} is not authorized to change open metadata type {1} ({2}) on server {3}

    • UNAUTHORIZED_INSTANCE_CREATE

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_INSTANCE_CREATE
      OPEN-METADATA-SECURITY-0017 - User {0} is not authorized to create an open metadata instance of type {1} on server {2}

    • UNAUTHORIZED_INSTANCE_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_INSTANCE_ACCESS
      OPEN-METADATA-SECURITY-0018 - User {0} is not authorized to access open metadata instance {1} of type {2} on server {3}

    • UNAUTHORIZED_INSTANCE_CHANGE

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_INSTANCE_CHANGE
      OPEN-METADATA-SECURITY-0019 - User {0} is not authorized to change open metadata type {1} of type {2} on server {3} using method {4}

    • UNAUTHORIZED_GLOSSARY_ACCESS

      public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_GLOSSARY_ACCESS
      OPEN-METADATA-SECURITY-0020 - User {0} is not authorized to issue operation {1} on glossary {2}

    • NULL_GLOSSARY

      public static final OpenMetadataSecurityAuditCode NULL_GLOSSARY
      OPEN-METADATA-SECURITY-0021 - User {0} is not authorized to issue operation {1} because the glossary is null

    • UNKNOWN_USER

      public static final OpenMetadataSecurityAuditCode UNKNOWN_USER
      OPEN-METADATA-SECURITY-0022 - User {0} is not recognized

    • FAILED_TO_RETRIEVE_USER

      public static final OpenMetadataSecurityAuditCode FAILED_TO_RETRIEVE_USER
      OPEN-METADATA-SECURITY-0023 - Exception {0} occurred when retrieving user {1}; message was {2}

    • ASSET_ACTIVITY_READ

      public static final OpenMetadataSecurityAuditCode ASSET_ACTIVITY_READ
      OPEN-METADATA-SECURITY-0050 - User {0} retrieved {1} asset {2} during operation {3} of service {4}

    • ASSET_ACTIVITY_READ_ATTACHMENT

      public static final OpenMetadataSecurityAuditCode ASSET_ACTIVITY_READ_ATTACHMENT
      OPEN-METADATA-SECURITY-0051 - User {0} retrieved an attachment to {1} asset {2} during operation {3} of service {4}

    • ASSET_ACTIVITY_UPDATE_ATTACHMENT

      public static final OpenMetadataSecurityAuditCode ASSET_ACTIVITY_UPDATE_ATTACHMENT
      OPEN-METADATA-SECURITY-0052 - User {0} updated an attachment to {1} asset {2} during operation {3} of service {4}

    • ASSET_ACTIVITY_UPDATE_FEEDBACK

      public static final OpenMetadataSecurityAuditCode ASSET_ACTIVITY_UPDATE_FEEDBACK
      OPEN-METADATA-SECURITY-0053 - User {0} updated feedback related to {1} asset {2} during operation {3} of service {4}

    • ASSET_ACTIVITY_UPDATE

      public static final OpenMetadataSecurityAuditCode ASSET_ACTIVITY_UPDATE
      OPEN-METADATA-SECURITY-0054 - User {0} updated {1} asset {2} during operation {3} of service {4}

    • ASSET_ACTIVITY_DELETE

      public static final OpenMetadataSecurityAuditCode ASSET_ACTIVITY_DELETE
      OPEN-METADATA-SECURITY-0055 - User {0} deleted {1} asset {2} during operation {3} of service {4}

    • ASSET_ACTIVITY_SEARCH_ATTACHMENT

      public static final OpenMetadataSecurityAuditCode ASSET_ACTIVITY_SEARCH_ATTACHMENT
      OPEN-METADATA-SECURITY-0057 - User {0} retrieved an attachment to {1} asset {2} during search operation {3} of service {4}

    • UNEXPECTED_EXCEPTION

      public static final OpenMetadataSecurityAuditCode UNEXPECTED_EXCEPTION
      OPEN-METADATA-SECURITY-0099 - The security connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

  • Method Details

    • values

      public static OpenMetadataSecurityAuditCode[] 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 OpenMetadataSecurityAuditCode 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

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<OpenMetadataSecurityAuditCode>
      Returns:
      string of property names and values for this enum