Package org.odpi.openmetadata.reports.messages

package org.odpi.openmetadata.reports.messages

Generates the markdown documentation for every message that Egeria can produce.

Egeria's messages are defined in message sets - java enums that implement one of the interfaces in the audit log framework's org.odpi.openmetadata.frameworks.auditlog.messagesets package. The utility in this package scans the Egeria source tree for those enums, reads the message definitions out of them, and writes a page for each message set into the messages-and-codes directory at the root of the repository, along with the README pages that index them.

The generated pages are checked in so that they can be read and searched from GitHub. The utility only rewrites a page whose content has changed, so running it on an unchanged repository leaves the working tree clean.

Related Packages

Package	Description
org.odpi.openmetadata.reports	Provides the EgeriaReport utility that allows a report to print to the screen and create a markdown file at the same time.
org.odpi.openmetadata.reports.componentid	Provides the ComponentIdReport that outputs a list of component identifiers used by popular Egeria services and connectors.
org.odpi.openmetadata.reports.duplicates	Compares two versions of an open metadata archive and reports the elements that keep their qualified name but change their unique identifier - the ones that become duplicates in a repository that loads both.

Class	Description
AuditLogSeverityDescription	AuditLogSeverityDescription holds the details of one of the audit log severities.
MessageDescription	MessageDescription captures the content of a single message definition found in a message set.
MessagesAndCodesReport	MessagesAndCodesReport generates the markdown documentation for every message that Egeria can produce.
MessageSetCategory	MessageSetCategory organises the message sets into the directories of the documentation.
MessageSetDescription	MessageSetDescription captures the content of a single message set - that is, one enum that implements one of the message set interfaces from the audit log framework.
MessageSetParsingException	MessageSetParsingException is thrown when a source file declares a message set that the parser cannot read.
MessageSetScanner	MessageSetScanner walks the Egeria source tree looking for the enums that implement one of the message set interfaces.
MessageSetType	MessageSetType describes the three flavours of message set defined in the audit log framework's org.odpi.openmetadata.frameworks.auditlog.messagesets package.