Package org.odpi.openmetadata.adapters.connectors.mssql.ffdc

Enum Class MSSQLAuditCode

java.lang.Object
java.lang.Enum<MSSQLAuditCode>
org.odpi.openmetadata.adapters.connectors.mssql.ffdc.MSSQLAuditCode
All Implemented Interfaces:
Serializable, Comparable<MSSQLAuditCode>, Constable, AuditLogMessageSet
public enum MSSQLAuditCode extends Enum<MSSQLAuditCode> implements AuditLogMessageSet
The MSSQLAuditCode 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

  • 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
    CATALOGED_DATABASE
    MSSQL-CONNECTOR-0003 - The {0} integration connector has catalogued Microsoft SQL Server Database {1} ({2})
    DATABASE_NOT_SURVEYED
    MSSQL-CONNECTOR-0011 - The {0} survey action service is unable to survey database {1} because of a {2} exception with message: {3}
    FRIENDSHIP_GUID
    MSSQL-CONNECTOR-0007 - The {0} Microsoft SQL Server Connector has been supplied with a friendship connector with GUID {1}
    NEW_CATALOG_TARGET
    MSSQL-CONNECTOR-0009 - The {0} Connector has added a catalog target relationship {1} from friendship connector {2} to Microsoft SQL Server Database Asset {3} for Database {4}
    NO_DATABASE_ACCESS
    MSSQL-CONNECTOR-0010 - The {0} connector is skipping database {1} on Microsoft SQL Server {2} because its userId {3} does not have access to it
    NO_DATABASES
    MSSQL-CONNECTOR-0002 - The {0} survey action service cannot retrieve details of any databases for Microsoft SQL Server {1}
    SKIPPING_DATABASE
    MSSQL-CONNECTOR-0004 - The {0} integration connector is skipping Microsoft SQL Server Database {1} ({2}) because it is already catalogued
    SURVEY_QUERY_FAILED
    MSSQL-CONNECTOR-0012 - The {0} survey action service is unable to retrieve the {1} for {2} because of a {3} exception with message: {4}
    UNEXPECTED_EXCEPTION
    MSSQL-CONNECTOR-0001 - The Microsoft SQL Server connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

  • Method Summary

    Modifier and Type
    Method
    Description
    AuditLogMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for logging.
    AuditLogMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for logging.
    String
    toString()
    JSON-style toString
    static MSSQLAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MSSQLAuditCode[]
    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

    • UNEXPECTED_EXCEPTION

      public static final MSSQLAuditCode UNEXPECTED_EXCEPTION
      MSSQL-CONNECTOR-0001 - The Microsoft SQL Server connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

    • NO_DATABASES

      public static final MSSQLAuditCode NO_DATABASES
      MSSQL-CONNECTOR-0002 - The {0} survey action service cannot retrieve details of any databases for Microsoft SQL Server {1}

    • CATALOGED_DATABASE

      public static final MSSQLAuditCode CATALOGED_DATABASE
      MSSQL-CONNECTOR-0003 - The {0} integration connector has catalogued Microsoft SQL Server Database {1} ({2})

    • SKIPPING_DATABASE

      public static final MSSQLAuditCode SKIPPING_DATABASE
      MSSQL-CONNECTOR-0004 - The {0} integration connector is skipping Microsoft SQL Server Database {1} ({2}) because it is already catalogued

    • FRIENDSHIP_GUID

      public static final MSSQLAuditCode FRIENDSHIP_GUID
      MSSQL-CONNECTOR-0007 - The {0} Microsoft SQL Server Connector has been supplied with a friendship connector with GUID {1}

    • NEW_CATALOG_TARGET

      public static final MSSQLAuditCode NEW_CATALOG_TARGET
      MSSQL-CONNECTOR-0009 - The {0} Connector has added a catalog target relationship {1} from friendship connector {2} to Microsoft SQL Server Database Asset {3} for Database {4}

    • NO_DATABASE_ACCESS

      public static final MSSQLAuditCode NO_DATABASE_ACCESS
      MSSQL-CONNECTOR-0010 - The {0} connector is skipping database {1} on Microsoft SQL Server {2} because its userId {3} does not have access to it

    • DATABASE_NOT_SURVEYED

      public static final MSSQLAuditCode DATABASE_NOT_SURVEYED
      MSSQL-CONNECTOR-0011 - The {0} survey action service is unable to survey database {1} because of a {2} exception with message: {3}

    • SURVEY_QUERY_FAILED

      public static final MSSQLAuditCode SURVEY_QUERY_FAILED
      MSSQL-CONNECTOR-0012 - The {0} survey action service is unable to retrieve the {1} for {2} because of a {3} exception with message: {4}

  • Method Details

    • values

      public static MSSQLAuditCode[] 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 MSSQLAuditCode 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<MSSQLAuditCode>
      Returns:
      string of property names and values for this enum