Package org.odpi.openmetadata.serveroperations.ffdc

Enum Class ServerOpsAuditCode

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

    • MAX_PAGE_SIZE

      public static final ServerOpsAuditCode MAX_PAGE_SIZE
      SERVER-OPS-0001 - The {0} server is configured with a max page size of {1}

    • UNLIMITED_MAX_PAGE_SIZE

      public static final ServerOpsAuditCode UNLIMITED_MAX_PAGE_SIZE
      SERVER-OPS-0002 - The {0} server is configured with an unlimited maximum page size

    • INVALID_MAX_PAGE_SIZE

      public static final ServerOpsAuditCode INVALID_MAX_PAGE_SIZE
      SERVER-OPS-0003 - The {0} server is configured with an invalid max page size of {1}

    • SERVER_STARTUP_SUCCESS

      public static final ServerOpsAuditCode SERVER_STARTUP_SUCCESS
      SERVER-OPS-0004 - The {0} server has successfully completed start up. The following services are running: {1}

    • SERVER_SHUTDOWN_STARTED

      public static final ServerOpsAuditCode SERVER_SHUTDOWN_STARTED
      SERVER-OPS-0005 - The {0} server has begun the shutdown process

    • SERVER_SHUTDOWN_SUCCESS

      public static final ServerOpsAuditCode SERVER_SHUTDOWN_SUCCESS
      SERVER-OPS-0006 - The {0} server has completed shutdown

    • SERVER_SHUTDOWN_ERROR

      public static final ServerOpsAuditCode SERVER_SHUTDOWN_ERROR
      SERVER-OPS-0007 - The {0} server has detected an {1} exception during server shutdown. The error message was {2}

    • STARTING_ACCESS_SERVICES

      public static final ServerOpsAuditCode STARTING_ACCESS_SERVICES
      SERVER-OPS-0010 - The Open Metadata Access Services (OMASs) are starting

    • SKIPPING_ACCESS_SERVICE

      public static final ServerOpsAuditCode SKIPPING_ACCESS_SERVICE
      SERVER-OPS-0011 - The {0} is marked as DISABLED and so will not be started in the {1} server

    • ALL_ACCESS_SERVICES_STARTED

      public static final ServerOpsAuditCode ALL_ACCESS_SERVICES_STARTED
      SERVER-OPS-0012 - {0} out of {1} configured Open Metadata Access Services (OMASs) have started

    • STOPPING_ACCESS_SERVICES

      public static final ServerOpsAuditCode STOPPING_ACCESS_SERVICES
      SERVER-OPS-0013 - The Open Metadata Access Services (OMASs) in server {0} are shutting down

    • ALL_ACCESS_SERVICES_STOPPED

      public static final ServerOpsAuditCode ALL_ACCESS_SERVICES_STOPPED
      SERVER-OPS-0014 - The Open Metadata Access Services (OMASs) in server {0} have shutdown

    • ACCESS_SERVICE_INSTANCE_FAILURE

      public static final ServerOpsAuditCode ACCESS_SERVICE_INSTANCE_FAILURE
      SERVER-OPS-0015 - The {0} access service is unable to initialize a new instance; error message is {1}

    • BAD_ACCESS_SERVICE_ADMIN_CLASS

      public static final ServerOpsAuditCode BAD_ACCESS_SERVICE_ADMIN_CLASS
      SERVER-OPS-0016 - The admin services are not able to start the {0} access service because the admin service class {1} is invalid; error message is {2}

    • ACCESS_SERVICE_FAILURE

      public static final ServerOpsAuditCode ACCESS_SERVICE_FAILURE
      SERVER-OPS-0017 - The admin services caught an unexpected {0} exception whilst initializing the {1} service. The error message is {2}

    • NULL_ACCESS_SERVICE_ADMIN_CLASS

      public static final ServerOpsAuditCode NULL_ACCESS_SERVICE_ADMIN_CLASS
      SERVER-OPS-0018 - The OMAG server {0} has been passed a null admin services class name for access service {1}

    • STARTING_VIEW_SERVICES

      public static final ServerOpsAuditCode STARTING_VIEW_SERVICES
      SERVER-OPS-0020 - The Open Metadata View Services (OMVSs) are starting

    • SKIPPING_VIEW_SERVICE

      public static final ServerOpsAuditCode SKIPPING_VIEW_SERVICE
      SERVER-OPS-0021 - The {0} is marked as DISABLED and so will not be started in the {1} view server

    • ALL_VIEW_SERVICES_STARTED

      public static final ServerOpsAuditCode ALL_VIEW_SERVICES_STARTED
      SERVER-OPS-0022 - {0} out of {1} configured Open Metadata View Services (OMVSs) have started

    • STOPPING_VIEW_SERVICES

      public static final ServerOpsAuditCode STOPPING_VIEW_SERVICES
      SERVER-OPS-0023 - The Open Metadata View Services (OMVSs) in server {0} are shutting down

    • ALL_VIEW_SERVICES_STOPPED

      public static final ServerOpsAuditCode ALL_VIEW_SERVICES_STOPPED
      SERVER-OPS-0024 - The Open Metadata View Services (OMVSs) in server {0} have shutdown

    • VIEW_SERVICE_INSTANCE_FAILURE

      public static final ServerOpsAuditCode VIEW_SERVICE_INSTANCE_FAILURE
      SERVER-OPS-0025 - The {0} view service is unable to initialize a new instance; error message is {1}

    • BAD_VIEW_SERVICE_ADMIN_CLASS

      public static final ServerOpsAuditCode BAD_VIEW_SERVICE_ADMIN_CLASS
      SERVER-OPS-0026 - The admin services are not able to start the {0} view service because the admin service class {1} is invalid; error message is {2}

    • VIEW_SERVICE_FAILURE

      public static final ServerOpsAuditCode VIEW_SERVICE_FAILURE
      SERVER-OPS-0027 - The admin services caught an unexpected {0} exception whilst initializing the {1} service for a view server. The error message is {2}

    • NULL_VIEW_SERVICE_ADMIN_CLASS

      public static final ServerOpsAuditCode NULL_VIEW_SERVICE_ADMIN_CLASS
      SERVER-OPS-0028 - The OMAG server {0} has been passed a null admin services class name for view service {1}

    • STARTING_ENGINE_SERVICES

      public static final ServerOpsAuditCode STARTING_ENGINE_SERVICES
      SERVER-OPS-0040 - The Open Metadata Engine Services (OMESs) are starting

    • SKIPPING_ENGINE_SERVICE

      public static final ServerOpsAuditCode SKIPPING_ENGINE_SERVICE
      SERVER-OPS-0041- The {0} engine service is marked as DISABLED and so will not be started in the {1} engine host server

    • ALL_ENGINE_SERVICES_STARTED

      public static final ServerOpsAuditCode ALL_ENGINE_SERVICES_STARTED
      SERVER-OPS-0042 - {0} out of {1} configured Open Metadata Engine Services (OMESs) have started

    • STOPPING_ENGINE_SERVICES

      public static final ServerOpsAuditCode STOPPING_ENGINE_SERVICES
      SERVER-OPS-0043 - The Open Metadata Engine Services (OMESs) in server {0} are shutting down

    • ALL_ENGINE_SERVICES_STOPPED

      public static final ServerOpsAuditCode ALL_ENGINE_SERVICES_STOPPED
      SERVER-OPS-0044 - The Open Metadata Engine Services (OMESs) in server {0} have shutdown

    • ENGINE_SERVICE_INSTANCE_FAILURE

      public static final ServerOpsAuditCode ENGINE_SERVICE_INSTANCE_FAILURE
      SERVER-OPS-0045 - The {0} engine service is unable to initialize a new instance; error message is {1}

    • BAD_ENGINE_SERVICE_ADMIN_CLASS

      public static final ServerOpsAuditCode BAD_ENGINE_SERVICE_ADMIN_CLASS
      SERVER-OPS-0046 - The admin services are not able to start the {0} engine service because the admin service class {1} is invalid; error message is {2}

    • ENGINE_SERVICE_FAILURE

      public static final ServerOpsAuditCode ENGINE_SERVICE_FAILURE
      SERVER-OPS-0047 - The admin services caught an unexpected {0} exception whilst initializing the {1} service for an engine host server. The error message is {2}

    • NULL_ENGINE_SERVICE_ADMIN_CLASS

      public static final ServerOpsAuditCode NULL_ENGINE_SERVICE_ADMIN_CLASS
      SERVER-OPS-0048 - The OMAG server {0} has been passed a null admin services class name for engine service {1}

    • STARTING_GOVERNANCE_SERVICES

      public static final ServerOpsAuditCode STARTING_GOVERNANCE_SERVICES
      SERVER-OPS-0100 - The governance services subsystem for the {0} called {1} is about to start

    • GOVERNANCE_SERVICES_STARTED

      public static final ServerOpsAuditCode GOVERNANCE_SERVICES_STARTED
      SERVER-OPS-0101 - The governance services subsystem for the {0} called {1} has completed start up

    • GOVERNANCE_SERVICE_FAILURE

      public static final ServerOpsAuditCode GOVERNANCE_SERVICE_FAILURE
      SERVER-OPS-0102 - The admin services caught an {0} exception whilst initializing the governance services subsystem for the {1} called {2}; error message is {3}

  • Method Details

    • values

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