egeria 5.4-SNAPSHOT API
Packages
Package
Description
The encrypted file configuration store allows the storage of the entirety of configuration files as encrypted
files.
Controls for working with Apache Atlas
The Apache Atlas integration connector publishes glossary terms to Apache Atlas.
FFDC stands for First Failure Data Capture.
The Apache Atlas REST connector provides a java interface to the Apache Atlas server.
FFDC stands for First Failure Data Capture.
These are the beans used on the Apache Atlas REST API calls.
Information used with the connector.
The Kafka Topic integration connector catalogues topics from an Apache Kafka Server.
FFDC stands for First Failure Data Capture.
The ApacheKafkaAdminConnector provides the resource connector for an Apache Kafka Server.
FFDC stands for First Failure Data Capture.
Implementation of the file resource connector for accessing the content of a file.
Error messages for the file resource connector.
Exceptions for the file resource connector.
Implementation of the CSV file resource connector for accessing the content of a CSV formatted file.
Error messages for the CSV file resource connector.
Implementation of the data folder resource connector for accessing a collection of files stored in a folder (directory).
Error messages for the data folder resource connector.
FFDC stands for First Failure Data Capture.
Glossary dynamic archiving service.
Information used with the connectors and associated templates.
The extractor extracts information from the running Egeria infrastructure.
FFDC stands for First Failure Data Capture.
FFDC stands for First Failure Data Capture.
Provisioning Governance Action Services that provision new resources into the digital landscape and optionally produce lineage.
Remediation Governance Action Services that correct errors and enhance metadata elements, relationships and classifications.
Verification Governance Action Services that verify that the metadata elements and relationships are set up correctly.
Watchdog Governance Action Services that monitor changes to open metadata.
The basic file integration connectors monitor changes in a file directory (folder) and updates the open metadata
repository/repositories to reflect the changes to both the files and folders underneath it.
FFDC stands for First Failure Data Capture.
The exceptions in this package are thrown by the basic file integration connectors.
The CSV Lineage Importer loads lineage data from a CSV file
FFDC stands for First Failure Data Capture.
The Open API Specification Monitor integration connector monitors a REST Endpoint and is it supports the retrieval of the
OpenAPI specification for its API, this connector builds an open metadata representation of the API and its operations.
FFDC stands for First Failure Data Capture.
The open lineage integration connectors work with open lineage events and either process or distribute them.
FFDC stands for First Failure Data Capture.
FFDC stands for First Failure Data Capture.
FFDC stands for First Failure Data Capture.
Enum definitions of the database schema used to represent the harvest open metadata structure.
FFDC stands for First Failure Data Capture.
FFDC stands for First Failure Data Capture.
Enum definitions of the database schema used to represent the harvest surveys structure.
Information used with the connector.
FFDC stands for First Failure Data Capture.
Create schema and table definitions for a PostgreSQL database.
FFDC stands for First Failure Data Capture.
The Environment Variable Secrets Store Connector retrieves secrets from environment variables.
The YAML Secrets Store Connector retrieves secrets from a structured YAML file.
Beans to help the developers of secret store connectors.
The controls are used to build the reference data for these services.
First Failure Data Capture (FFDC) definitions.
CSV Survey Action Service Connector.
File Survey Action Service Connector.
Folder (directory) Survey Action Service Connector.
Information used with the connector.
FFDC stands for First Failure Data Capture.
Beans to use in the connector APIs.
The resource connector acts as a client around the unity catalog API.
Additional beans to support the Unity Catalog REST API.
FFDC stands for First Failure Data Capture.
Enum definitions of the database schema used to represent the audit log structure.
Defines and implements the PostgreSQL repository connector as an Open Connector Framework (OCF) connector, implementing
the repository connector (MetadataCollection) interface.
Defines the audit and error logging messages used by the Postgres repository connector.
Map between OMRS objects and the database tables
Enum definitions of the database schema used to represent the repository structure.
The admin services packages provide support for the registration, configuration and operational management of
services that run within the Open Metadata and Governance software server process.
The properties package provides the configuration properties for the different subsystems that run inside
the Open Metadata and Governance (OMAG) Platform.
The registration package provides the definitions and interfaces to describe each of the Open Metadata
and Governance services that support the different subsystems within the OMAG Server.
Properties are the Java Beans that appear exclusively on the API
The registration package provides the definitions and interfaces to describe each of the Open Metadata
Access Services and View Services and enable them to register with the admin services.
These are the beans that wrap request bodies and responses on the REST API.
The store package provides the interface definition for the data store used to store configuration documents.
Utility classes for writing out the open metadata definitions for the big glossaries.
The archive builder for each of the big glossaries.
Archive builder describing the connectors supplied by the Egeria project.
Builds a content pack to support templates, connectors and services specific for working with Apache Atlas.
Builds a content pack to support templates, connectors and services specific for governing and cataloguing
Apache Kafka.
Builds a content pack to support templates, connectors and services specific for working with REST APIs.
Provides the base class for the archive writers.
Provides the base reference data, templates, connectors and services for a simple deployment of Egeria that is
able to catalog and govern files.
Builds a content pack to support templates, connectors and services specific for working with Egeria's observability
capability (aka "the Nanny").
Builds a content pack to support templates, connectors and services specific for working with PostgreSQL.
Builds a content pack to support templates, connectors and services specific for working with Unity Catalog.
Utility classes for writing out the open metadata definitions for the simple catalogs.
The archive builders for each of the simple catalogs.
The FFDC Services provide common exceptions and error handling for service running in OMAG Servers.
Beans used in providing FFDC context and support to open metadata and governance.
This package defines the beans used to build the REST request and response payloads.
The generic handlers provide services to translate Open Metadata Store requests
built around that service's private beans into calls to the repository
services (through the repository handler).
The RepositoryHandler provides object-like interfaces over the Open Metadata Repository Services (OMRS) repository connector.
Provides Java interfaces for working with connectors.
The beans used in the connector provider to define the behaviour of the connector.
This package provides the first failure data capture support for the OCF module.
Specific values for setting up the services around the Open Connector Framework (OCF).
Beans for the security connector.
The interfaces of the Governance Action Framework (GAF)
The governance action framework defines interfaces for governance action services.
Provides the interface used by connectors to access Open Metadata.
Provides common names and structures for describing request parameters, action target names and types, and guards.
This package provides the first failure data capture
support for the Governance Action Framework (GAF) module.
The Mermaid Services provide common routines for building Mermaid Markdown visualizations.
The context manager is a specialized class that sets up access to the OMAS client that it is
These iterators help an integration connector to step through the Egeria elements that they are responsible
for.
Interfaces for integrating with open lineage events
Java interface definitions for the Open Metadata Framework.
Converts open metadata beans into element properties (the opposite of a converter).
Defines the standard interface for the open metadata services.
Provides base classes for connector context objects.
The beans used to define the behaviour of a component.
Definitions of the EnumDefs that appear in the open metadata type system.
Definitions of the different types of events that the OMF Services can publish.
File classifier utility.
Provides specialised handlers that use the Open Metadata Store Services client.
Specific values used in the set up of open metadata services.
The Mermaid Services provide common routines for building Mermaid Markdown visualizations.
The metadata elements describe the way that metadata is returned from the repository.
These beans describe the core properties that are passed to the server to create and update metadata.
These beans cover todos/meetings (actions for people), engine actions
and incident reporting.
Beans that represent different types of assets.
Beans to describe APIs.
Beans to describe relational databases.
Beans to describe assets that display data, such as forms and reports.
Beans to describe files and folders.
Beans to describe servers, platforms and host assets.
Beans to describe processes.
Beans about assets that manage events.
Beans for managing collections.
Beans to describe communities and their members.
Beans for Connections, VirtualConnections, Endpoints and ConnectorTypes.
Properties used to design/describe data requirements.
Beans to describe both permitted purposes and actions along with actual processing actions on data targets.
Beans for representing digital services, digital products and business capabilities.
External identifiers capture header details of metadata stored in remote locations.
Beans for external references and related media.
Beans that represent feedback elements.
Beans for managing glossaries and their contents.
Beans for managing governance information.
These are the implementation relationship properties used to link the design/requirements work to
concrete implementations.
InformationSupplyChainProperties identifies a flow of data between systems in a digital landscape
that are of importance to the organization.
Beans describing lineage relationships
Beans to describe locations and their relationships to other things.
Beans for describing the structure of data.
Beans for representing the structure of parameter lists, headers and results in an API.
Beans for representing the structure of data in a database.
Beans describing the structure of displayed data.
Beans to describe the structure of data in an event.
Beans for representing the structure of simple tabular data.
Beans for describing the required security.
Beans for solution blueprints, and solution components.
Beans for managing and representing template classifications
Beans for valid values
Enums that describe the default reference data for the open connectors supplied with Egeria.
Connectors and interfaces of the Survey Action Framework (SAF).
Classes that describe the properties that control the behaviour of an executing
survey action service and its role in a governance action process.
Details of the messages for the Audit Log and Exceptions.
These beans describe the typical measurements to capture for different types of technologies.
Property beans used on the Survey Action Framework interfaces.
This package contains the clients for configuring and managing governance engines, managing the governance actions, governance action
processes and incident reports as well as supporting the metadata needs of the governance action services when they are running
in the Engine Host OMAG Server.
This package contains the internal class for issuing REST calls.
This package provides the first failure data capture support for the Metadata Store Service module.
This package defines the beans used to build the REST request and response payloads.
This package provides the first failure data capture support for the OCF Metadata Management module.
This package contains the client that supports the Open Integration Service.
This package contains the internal class for issuing REST calls.
This package provides the first failure data capture support for the Open Integration Service module.
This package defines the beans used to build the REST request and response payloads.
This package contains the clients for the open metadata interfaces:
one for events and one for REST services.
This package contains the internal class for issuing REST calls.
The OMF topic connectors are the interfaces of the
connectors supported by the Open Metadata Store services.
This package provides the first failure data capture support for the Metadata Store Service module.
Supports the processing of events from the repository services that notify this module of changes to the metadata
in the repository services.
Produces events on the Open Metadata Store's out topic.
These beans come from AssetManager OMAS and are there temporarily.
This package defines the beans used to build the REST request and response payloads.
Provides the implementation of the client-side Governance Engine OMAS out topic listener
Provides the implementation of the client-side Governance Server OMAS out topic listener
Connector that implements the interfaces of both the Platform and Server Metadata Security Access Connectors.
Defines the controls for the Open Metadata Access Security Connector.
This package contains the open metadata types definition.
This package contains a utility for writing open metadata types.
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search
The accumulators are thread-safe caches of types and instances from the open metadata repositories that
are building a list of unique results.
The federation control classes manage the process of interacting with a collection of metadata repositories.
The executors issue a request to one or more metadata repositories.
This package provides the first failure data capture support for the repository services module.
The helper classes build metadata instances of specific types.
The business systems package contains the utility methods for creating the metadata
that represents the business systems and the data movement between them for Coco
Pharmaceuticals Human Resources, Finance, Procurement, Sales and Distribution as well
as the transfer of this data to the data lake.
The Clinical Trials Templates package contains the utility methods for creating the definitions for the templates used
when onboarding data sources as part of the clinical trials.
Utility to build an open metadata archive containing governance engine definitions for Coco Pharmaceuticals
Utility to build an open metadata archive containing governance program definitions for Coco Pharmaceuticals.
Utility to build an open metadata archive containing specialist types for Coco Pharmaceuticals
Coco Pharmaceuticals governance actions for clinical trials - they run in the ClinicalTrials@CocoPharmaceuticals
governance engine.
FFDC stands for First Failure Data Capture.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Action Author OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Actor Manager OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Asset Catalog OMVS.
This package defines the beans used to build the REST request and response payloads.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Automated Curation OMVS.
Creates extensions to the handlers that are needed by the REST APIs.
Properties extracted from the open metadata ecosystem and consolidated into specific views for the curator.
This package defines the beans used to build the REST request and response payloads.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Classification Explorer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Classification Manager OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Collection Manager OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Community Matters OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Connection Maker OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Data Designer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Data Discovery OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Data Officer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Devops Pipeline OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Feedback Manager OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Glossary Browser OMVS.
This package defines the beans used to build the REST request and response payloads.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Glossary Manager OMVS.
This package defines the beans used to build the REST request and response payloads.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Governance Officer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Metadata Explorer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the My Profile OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Notification Manager OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the People Organizer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Privacy Officer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Project Manager OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Reference Data OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Runtime Manager OMVS.
This package defines the beans used to build the REST request and response payloads.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Schema Maker OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Security Officer OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Solution Architect OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Subject Area OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Template Manager OMVS.
This package defines the beans used to build the REST request and response payloads.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Time Keeper OMVS.
The admin package controls the start-up and shutdown of the view service.
This package provides the definition of the error handling for the Valid Metadata OMVS.