org.odpi.openmetadata.accessservices.subjectarea.ffdc.SubjectAreaAuditCode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of subject-area-api Show documentation
Common code shared between the Subject Area Open Metadata Access Service (OMAS) client and server.
There is a newer version: 4.3
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.subjectarea.ffdc;

import org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition;
import org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet;
import org.odpi.openmetadata.repositoryservices.auditlog.OMRSAuditLogRecordSeverity;

/**
 * The SubjectAreaAuditCode is used to define the message content for the OMRS Audit Log.
 *
 * The 5 fields in the enum are:
 * 
 *     Log Message Id - 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
 * 
 */
public enum SubjectAreaAuditCode implements AuditLogMessageSet
{
    SERVICE_INITIALIZING("OMAS-SUBJECT_AREA-0001",
             OMRSAuditLogRecordSeverity.STARTUP,
             "The Subject Area Open Metadata Access Service (OMAS) is initializing a new server instance",
             "The local server has started up a new instance of the Subject Area OMAS.  " +
                                 "This service enables tools to locate assets in the catalog, retrieve information about them" +
                                 "and create open connectors to access the content of the assets.  It also sends " +
                                 "events on its out topic each time a new asset is created or updated.",
             "No action is required as long as this service is expected to be started for this server.  " +
                                 "If it is not required, then remove the configuration for this service " +
                                 "from the access service list in this server's configuration document."),

    SERVICE_INITIALIZED("OMAS-SUBJECT_AREA-0003",
             OMRSAuditLogRecordSeverity.STARTUP,
             "The Subject Area Open Metadata Access Service (OMAS) has initialized a new instance for server {0}",
             "The access service has completed initialization of a new instance.",
             "Verify that this service has initialized successfully. " +
                                "Investigate any reported errors. Also ensure that the enterprise repository " +
                                "services and the OCF metadata management services are initialized."),

    SERVICE_SHUTDOWN("OMAS-SUBJECT_AREA-0004",
             OMRSAuditLogRecordSeverity.SHUTDOWN,
             "The Subject Area Open Metadata Access Service (OMAS) is shutting down its instance for server {0}",
             "The local administrator has requested shut down of an Subject Area OMAS instance.",
             "No action is required if the server shutdown was intentional."),

    SERVICE_INSTANCE_FAILURE("OMAS-SUBJECT_AREA-0005",
             OMRSAuditLogRecordSeverity.EXCEPTION,
             "The Subject Area Open Metadata Access Service (OMAS) is unable to initialize a new instance in server {0}; the {1} exception " +
                                     "occurred with error message: {2}",
             "The access service detected an error during the start up of a specific server instance.  Its services are not available for the server.",
                             "Review the error message and any other reported failures to determine the cause of the problem.  Once this is resolved, restart the server."),

    UNEXPECTED_EXCEPTION("OMAS-SUBJECT_AREA-0006",
                         OMRSAuditLogRecordSeverity.EXCEPTION,
                         "The Open Metadata Service has generated an unexpected {0} exception during method {1}.  The message was: {2}",
                         "The request returns a SubjectAreaCheckedException.",
                         "This is probably a logic error. Review the stack trace to identify where the error " +
                                 "occurred and work to resolve the cause.")
    

    ;

    private AuditLogMessageDefinition messageDefinition;


    /**
     * The constructor for SubjectAreaAuditCode expects to be passed one of the enumeration rows defined in
     * SubjectAreaAuditCode above.   For example:
     *
     *     SubjectAreaAuditCode   auditCode = SubjectAreaAuditCode.SERVER_NOT_AVAILABLE;
     *
     * This will expand out to the 4 parameters shown below.
     *
     * @param messageId - unique Id for the message
     * @param severity - severity of the message
     * @param message - text for the message
     * @param systemAction - description of the action taken by the system when the condition happened
     * @param userAction - instructions for resolving the situation, if any
     */
    SubjectAreaAuditCode(String                     messageId,
                         OMRSAuditLogRecordSeverity severity,
                         String                     message,
                         String                     systemAction,
                         String                     userAction)
    {
        messageDefinition = new AuditLogMessageDefinition(messageId,
                                                          severity,
                                                          message,
                                                          systemAction,
                                                          userAction);
    }


    /**
     * Retrieve a message definition object for logging.  This method is used when there are no message inserts.
     *
     * @return message definition object.
     */
    public AuditLogMessageDefinition getMessageDefinition()
    {
        return messageDefinition;
    }


    /**
     * Retrieve a message definition object for logging.  This method is used when there are values to be inserted into the message.
     *
     * @param params array of parameters (all strings).  They are inserted into the message according to the numbering in the message text.
     * @return message definition object.
     */
    public AuditLogMessageDefinition getMessageDefinition(String ...params)
    {
        messageDefinition.setMessageParameters(params);
        return messageDefinition;
    }


    /**
     * JSON-style toString
     *
     * @return string of property names and values for this enum
     */
    @Override
    public String toString()
    {
        return "SubjectAreaAuditCode{" +
                "messageDefinition=" + messageDefinition +
                '}';
    }
}