org.odpi.openmetadata.repositoryservices.auditlog

Class OMRSAuditLog

java.lang.Object

org.odpi.openmetadata.repositoryservices.auditlog.OMRSAuditLog

public class OMRSAuditLog
extends Object

OMRSAuditLog is a class for managing the audit logging of activity for the OMRS components. Each auditing component will have their own instance of an OMRSAuditLog. OMRSAuditLog will ensure audit log records are written to disk in the common OMRSAuditLog for this local server. There are different levels of log record to cover all of the activity of the OMRS. This audit log is critical to validate the behavior of the OMRS, particularly in the initial interaction of a new metadata repository to the OMRS Cohort.

Constructor Summary

Constructors

Constructor and Description
OMRSAuditLog(int componentId, String componentName, String componentDescription, String componentWikiURL) Typical constructor: each component using the Audit log will create their own OMRSAuditLog instance and will push log records to it.
OMRSAuditLog(OMRSAuditingComponent reportingComponent) External constructor is used to create an audit log for a component outside of OMRS

Method Summary

Modifier and Type	Method and Description
static void	initialize(String localServerName, String localServerType, String localOrganizationName, List<OMRSAuditLogStore> auditLogStores) Initialize the static values used in all log records.
void	logException(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 OMRS.
void	logRecord(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 OMRS.
static 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

OMRSAuditLog

public OMRSAuditLog(int componentId,
                    String componentName,
                    String componentDescription,
                    String componentWikiURL)

Typical constructor: each component using the Audit log will create their own OMRSAuditLog instance and will push log records to it.

Parameters:

componentId - numerical identifier for the component.

componentName - display name for the component.

componentDescription - description of the component.

componentWikiURL - link to more information.

OMRSAuditLog

public OMRSAuditLog(OMRSAuditingComponent reportingComponent)

External constructor is used to create an audit log for a component outside of OMRS

Parameters:

reportingComponent - information about the component that will use this instance of the audit log.

Method Detail

initialize

public static void initialize(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

setLocalMetadataCollectionId

public static 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(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 OMRS.

Parameters:

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(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 OMRS. These exceptions typically mean that the local server is not configured correctly, or there is a logic error in the code. When exceptions are logged, it is important that they are investigated and the cause corrected since the local repository is not able to operate as a proper peer in the metadata repository cluster whilst these conditions persist.

Parameters:

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.