Index (Audit Log Framework (ALF) 3.12 API)

A C D E G H I L M O S T V
All Classes All Packages

A

addLogRecord(AuditLogRecord) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogDestination: Log an audit log record for an event, decision, error, or exception detected by the open metadata services.
AuditLog - Class in org.odpi.openmetadata.frameworks.auditlog: AuditLog is the superclass of audit log implementations.
AuditLog(AuditLogDestination, int, ComponentDevelopmentStatus, String, String, String) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Typical constructor: each component using the audit log will create their own AuditLog instance and will push log records to it.
AuditLog(AuditLogDestination, ComponentDescription) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Constructor used to create the root audit log for a process/server
AuditLog.AuditLogActivity - Class in org.odpi.openmetadata.frameworks.auditlog: Count up the number of records of each severity logged by a component.
auditLogActivity - Variable in class org.odpi.openmetadata.frameworks.auditlog.AuditLog
AuditLogActivity() - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLog.AuditLogActivity
AuditLogDestination - Class in org.odpi.openmetadata.frameworks.auditlog: AuditLogDestination provides the support to push audit log records to the desired locations for either storage or processing.
AuditLogDestination() - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogDestination: Default constructor for subclasses to give them an opportunity to build the originator properties.
AuditLogDestination(Map<String, String>) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogDestination: The normal constructor takes the description of the process/server that is using the audit log.
AuditLoggingComponent - Interface in org.odpi.openmetadata.frameworks.auditlog: AuditLoggingComponent is an interface that components can implement to indicate that they can make use of an audit log.
AuditLogMessageDefinition - Class in org.odpi.openmetadata.frameworks.auditlog.messagesets: AuditLogMessageDefinition extends MessageDefinition to provide a container that describes a single instance of a message for an audit log record.
AuditLogMessageDefinition(String, AuditLogRecordSeverity, String, String, String) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition: Constructor to save all the fixed values of a message.
AuditLogMessageSet - Interface in org.odpi.openmetadata.frameworks.auditlog.messagesets: AuditLogMessageSet is the interface implemented by an enum that contains the collection of message definitions for a component.
AuditLogRecord - Class in org.odpi.openmetadata.frameworks.auditlog: AuditLogRecord provides a carrier for details about a single log record in the audit log.
AuditLogRecord() - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Default constructor
AuditLogRecord(AuditLogRecord) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Copy/clone constructor
AuditLogRecordSeverity - Interface in org.odpi.openmetadata.frameworks.auditlog.messagesets: AuditLogRecordSeverity defines the different levels of severity for log records stored in an AuditLogRecord.
AuditLogReport - Class in org.odpi.openmetadata.frameworks.auditlog: AuditLogReport is a container for returning information about a hierarchy of audit logs.
AuditLogReport() - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Default constructor
AuditLogReport(AuditLogReport) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Copy/clone constructor
AuditLogReportingComponent - Class in org.odpi.openmetadata.frameworks.auditlog: AuditLogReportingComponent describes the component issuing the audit log record.
AuditLogReportingComponent() - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Default constructor for Jackson
AuditLogReportingComponent(int, ComponentDevelopmentStatus, String, String, String) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Construct the description of the reporting component.
AuditLogReportingComponent(ComponentDescription) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Copy/clone constructor

C

childAuditLogs - Variable in class org.odpi.openmetadata.frameworks.auditlog.AuditLog
ComponentDescription - Interface in org.odpi.openmetadata.frameworks.auditlog: ComponentDescription is an interface implemented by a enum that describes the components using the audit log
ComponentDevelopmentStatus - Enum in org.odpi.openmetadata.frameworks.auditlog: ComponentDevelopmentStatus describes the development status of a component.
countRecord(int, String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog.AuditLogActivity: Update the maps with information about another log record.
createNewAuditLog(int, ComponentDevelopmentStatus, String, String, String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Clone request is used to create an audit log for a component outside the OMRS.
createNewAuditLog(ComponentDescription) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Constructor used to create the root audit log for OMRS

D

DEPRECATED - org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus

E

equals(Object) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Validate that an object is equal depending on their stored values.
equals(Object) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Validate that an object is equal depending on their stored values.
equals(Object) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Validate that an object is equal depending on their stored values.
ExceptionMessageDefinition - Class in org.odpi.openmetadata.frameworks.auditlog.messagesets: ExceptionMessageDefinition extends MessageDefinition to provide a container that describes a single instance of a message for an exception.
ExceptionMessageDefinition(int, String, String, String, String) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition: Constructor to save all the fixed values of a message.
ExceptionMessageSet - Interface in org.odpi.openmetadata.frameworks.auditlog.messagesets: ExceptionMessageSet is the interface implemented by an enum that contains the collection of message definitions for a component's exceptions.

G

getActionDescription() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the description of the activity that this log record relates.
getAdditionalInformation() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return any additional information in the audit log record.
getChildAuditLogReports() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Return the reports for the hierarchy of audit logs nested in this audit log.
getComponentDevelopmentStatus() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Return the development status of the component.
getComponentDevelopmentStatus() - Method in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription: Return the development status of the component.
getComponentId() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Return the numerical code for this component.
getComponentId() - Method in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription: Return the numerical code for this component.
getComponentName() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Return the name of the component.
getComponentName() - Method in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription: Return the name of the component.
getComponentType() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Return the short description of the component.
getComponentType() - Method in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription: Return the short description of the component.
getComponentWikiURL() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Return the URL link to the wiki page that describes this component.
getComponentWikiURL() - Method in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription: URL link to the wiki page that describes this component.
getConnectorComponentDescription() - Method in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent: Return the component description that is used by this connector in the audit log.
getDescription() - Method in enum org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus: Return the default description for this enum.
getDescription() - Method in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogRecordSeverity: Return the default description of this enum.
getExceptionClassName() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the name of any exception linked to the audit log record.
getExceptionMessage() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the name of the message associated with any exception linked to the audit log record.
getExceptionStackTrace() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the stack trace associated with any exception linked to the audit log record.
getFormattedMessage(MessageDefinition) - Method in class org.odpi.openmetadata.frameworks.auditlog.MessageFormatter: Create a formatted message from a message definition instance.
getGUID() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the unique Id of the audit log record.
getHttpErrorCode() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition: Return the HTTP code that describes the nature of the exception.
getMessageDefinition() - Method in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet: Retrieve a message definition object for logging.
getMessageDefinition() - Method in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet: Retrieve a message definition object for an exception.
getMessageDefinition(String...) - Method in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet: Retrieve a message definition object for logging.
getMessageDefinition(String...) - Method in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet: Retrieve a message definition object for an exception.
getMessageId() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the identifier of the message within the log record.
getMessageId() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: Return the unique identifier for the message.
getMessageParameters() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the array of values that were inserted in the message text.
getMessageParams() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: Return the array of values that apply to this message instance.
getMessageTemplate() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: Return the template of the message.
getMessageText() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the text of the message within the log record.
getName() - Method in enum org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus: Return the default name for this enum type.
getName() - Method in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogRecordSeverity: Return the name of this enum.
getOrdinal() - Method in enum org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus: Return the code for this enum used for indexing based on the enum value.
getOrdinal() - Method in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogRecordSeverity: Return the code for this enum.
getOriginatorComponent() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the name of the component that reported the situation recorded in the log record.
getOriginatorProperties() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Return the map of properties used to describe the originator process/server.
getOriginatorProperties() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogDestination: Return the map of properties used to describe the originator process/server.
getOriginatorProperties() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return details of the originator of the log record.
getReport() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Return a report describing the audit log's properties and activity.
getReportingComponent() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Return the description of the component that is using this audit log.
getSeverity() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the severity of the situation recorded in the log record.
getSeverity() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition: Return the severity of the audit log record.
getSeverityCode() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the severity of the situation recorded in the log record.
getSeverityCount() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Return the count of log records for each severity code.
getSeverityIdentification() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Return the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1.
getSystemAction() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the description of the actions taken by the local server as a result of the reported situation.
getSystemAction() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: Returns a description of the action taken by the system when the condition that caused this exception was detected.
getThreadId() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the identifier of the thread where the situation occurred.
getThreadName() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the name of the thread where the situation occurred.
getTimeStamp() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return the time stamp for when the audit log record was created.
getUserAction() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return details of the actions (if any) that a user can take in response to the reported situation.
getUserAction() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: Returns instructions on what to do next given that this situation has occurred.

H

hashCode() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Return a hash code based on the values of this object.
hashCode() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Return a hash code based on the values of this object.
hashCode() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Return a hash code based on the values of this object.

I

IN_DEVELOPMENT - org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus

L

logException(String, AuditLogMessageDefinition, String, Throwable) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Log an audit log message associated with a caught exception.
logException(String, AuditLogMessageDefinition, Throwable) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Log an audit log message associated with a caught exception.
logException(String, AuditLogMessageDefinition, List<String>, Throwable) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Log an audit log message associated with a caught exception.
logMessage(String, AuditLogMessageDefinition) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Log an audit log message.
logMessage(String, AuditLogMessageDefinition, String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Log an audit log message.
logMessage(String, AuditLogMessageDefinition, List<String>) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLog: Log an audit log message.

M

MessageDefinition - Class in org.odpi.openmetadata.frameworks.auditlog.messagesets: MessageDefinition is a container that describes a single instance of a message.
MessageDefinition(String, String, String, String) - Constructor for class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: Constructor to save all the fixed values of a message.
MessageFormatter - Class in org.odpi.openmetadata.frameworks.auditlog: MessageFormatter is the superclass of audit log implementations.
MessageFormatter() - Constructor for class org.odpi.openmetadata.frameworks.auditlog.MessageFormatter: Default Constructor

O

org.odpi.openmetadata.frameworks.auditlog - package org.odpi.openmetadata.frameworks.auditlog
org.odpi.openmetadata.frameworks.auditlog.messagesets - package org.odpi.openmetadata.frameworks.auditlog.messagesets
originatorProperties - Variable in class org.odpi.openmetadata.frameworks.auditlog.AuditLogDestination

S

SAMPLE - org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus
setActionDescription(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the description of the activity that this log record relates.
setAdditionalInformation(List<String>) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up any additional information in the audit log record.
setAuditLog(AuditLog) - Method in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent: Receive an audit log object that can be used to record audit log messages.
setChildAuditLogReports(List<AuditLogReport>) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Set up the reports for the hierarchy of audit logs nested in this audit log.
setComponentDescription(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Set up the short description of the component.
setComponentDevelopmentStatus(ComponentDevelopmentStatus) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Set up the development status of the component.
setComponentId(int) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Set up the numerical code for this component.
setComponentName(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Set up the name of the component.
setComponentWikiURL(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Set up the URL link to the wiki page that describes this component.
setExceptionClassName(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the name of any exception linked to the audit log record.
setExceptionMessage(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the name of the message associated with any exception linked to the audit log record.
setExceptionStackTrace(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the stack trace associated with any exception linked to the audit log record.
setGUID(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the unique Id of the audit log record.
setMessageId(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the identifier of the message within the log record.
setMessageParameters(String[]) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the array of values that were inserted in the message text.
setMessageParameters(String...) - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: Set up the specific values that apply to this message instance.
setMessageText(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the text of the message within the log record.
setOriginatorComponent(AuditLogReportingComponent) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the name of the component that reported the situation recorded in the log record.
setOriginatorProperties(Map<String, String>) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up details of the originator of the log record.
setReportingComponent(AuditLogReportingComponent) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Set up the description of the component that is using this audit log.
setSeverity(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the severity of the situation recorded in the log record.
setSeverityCode(int) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the severity of the situation recorded in the log record.
setSeverityCount(Map<Integer, Integer>) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Set up the count of log records for each severity code.
setSeverityIdentification(Map<Integer, List<String>>) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Set up the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1.
setSystemAction(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the description of the actions taken by the local server as a result of the reported situation.
setThreadId(long) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the identifier of the thread where the situation occurred.
setThreadName(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up he name of the thread where the situation occurred.
setTimeStamp(Date) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up the time stamp for when the audit log record was created.
setUserAction(String) - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Set up details of the actions (if any) that a user can take in response to the reported situation.
STABLE - org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus

T

TECHNICAL_PREVIEW - org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus
toString() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord: Standard toString method.
toString() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReport: Standard toString method.
toString() - Method in class org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent: Standard toString method.
toString() - Method in enum org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus: Standard toString method.
toString() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition: JSON-style toString.
toString() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition: JSON-style toString.
toString() - Method in class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition: JSON-style toString.

V

valueOf(String) - Static method in enum org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I L M O S T V
All Classes All Packages