org.odpi.openmetadata.repositoryservices.auditlog

Class OMRSAuditLogDestination

java.lang.Object

org.odpi.openmetadata.repositoryservices.auditlog.OMRSAuditLogDestination

public class OMRSAuditLogDestination
extends Object

OMRSAuditLogDestination provides information needed to log records to the configured audit log destinations for a specific server instance.

Constructor Summary

Constructors

Constructor and Description
OMRSAuditLogDestination(List<OMRSAuditLogStore> auditLogStores)
OMRSAuditLogDestination(String localServerName, String localServerType, String localOrganizationName, List<OMRSAuditLogStore> auditLogStores) Initialize the static values used in all log records.

Method Summary

Modifier and Type	Method and Description
void	logException(OMRSAuditLogReportingComponent reportingComponent, String actionDescription, String logMessageId, OMRSAuditLogRecordSeverity severity, String logMessage, String additionalInformation, String systemAction, String userAction, Throwable caughtException) Log details of an unexpected exception detected by the open metadata modules.
void	logRecord(OMRSAuditLogReportingComponent reportingComponent, String actionDescription, String logMessageId, OMRSAuditLogRecordSeverity severity, String logMessage, String additionalInformation, String systemAction, String userAction) Log an audit log record for an event, decision, error, or exception detected by the open metadata services.
void	setLocalMetadataCollectionId(String localMetadataCollectionId) Set up the local metadata collection Id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMRSAuditLogDestination

public OMRSAuditLogDestination(List<OMRSAuditLogStore> auditLogStores)

OMRSAuditLogDestination

public OMRSAuditLogDestination(String localServerName,
                               String localServerType,
                               String localOrganizationName,
                               List<OMRSAuditLogStore> auditLogStores)

Initialize the static values used in all log records. These values help to pin-point the source of messages when audit log records from many servers are consolidated into centralized operational tooling.

Parameters:

localServerName - name of the local server

localServerType - type of the local server

localOrganizationName - name of the organization that owns the local server

auditLogStores - list of destinations for the audit log records

Method Detail

setLocalMetadataCollectionId

public void setLocalMetadataCollectionId(String localMetadataCollectionId)

Set up the local metadata collection Id. This is null if there is no local repository.

Parameters:

localMetadataCollectionId - String unique identifier for the metadata collection

logRecord

public void logRecord(OMRSAuditLogReportingComponent reportingComponent,
                      String actionDescription,
                      String logMessageId,
                      OMRSAuditLogRecordSeverity severity,
                      String logMessage,
                      String additionalInformation,
                      String systemAction,
                      String userAction)

Log an audit log record for an event, decision, error, or exception detected by the open metadata services.

Parameters:

reportingComponent - component that sent the log record

actionDescription - description of the activity creating the audit log record

logMessageId - id for the audit log record

severity - is this an event, decision, error or exception?

logMessage - description of the audit log record including specific resources involved

additionalInformation - additional data to help resolve issues of verify behavior

systemAction - the related action taken by the OMRS.

userAction - details of any action that an administrator needs to take.

logException

public void logException(OMRSAuditLogReportingComponent reportingComponent,
                         String actionDescription,
                         String logMessageId,
                         OMRSAuditLogRecordSeverity severity,
                         String logMessage,
                         String additionalInformation,
                         String systemAction,
                         String userAction,
                         Throwable caughtException)

Log details of an unexpected exception detected by the open metadata modules.

Parameters:

reportingComponent - component that sent the log record

actionDescription - description of the activity in progress when the error occurred

logMessageId - id for the type of exception caught

severity - severity of the error

logMessage - description of the exception including specific resources involved

additionalInformation - additional data to help resolve issues of verify behavior

systemAction - the action taken by the OMRS in response to the error.

userAction - details of any action that an administrator needs to take.

caughtException - the original exception.