Writing Repository Governance Services¶
Interface¶
The interface that all repository governance services must implement is defined by RepositoryGovernanceService
:
Figure 1: Methods implemented by an archive service
initialize
is a standard method for all connectors that is called by the connector broker when the connector is created. The connector is passed the connection object from the configuration and a unique identifier for this instance of the connector.setAuditLog
provides a logging destination (see Audit Log Framework (ALF)).setContext
sets up the archive context. This provides an interface to the repository services (OMRS) that provide access to the open metadata.- The ability to register a listener to receive events from the Enterprise OMRS Topic.
- The ability to retrieve metadata instances from any connected open metadata repository.
start
indicates that the archive service is completely configured and can begin processing. This call can be used to register a listener with the Enterprise OMRS Topic through the context and to update the archive store with the current state of the metadata in the repositories.disconnect
is called when the server is shutting down. The archive service should free up any resources that it holds since it is not needed any more.
Further information
- Metadata Archiving to understand the different mechanisms that use open metadata archives.
- Open Metadata Archives to understand structure of an open metadata archive.
- Configuring an engine host to understand how to set up an archive service.
- Defining a governance engine in a content pack to add
- Writing a Open Metadata Archive Store Connector.
- Loading an Open Metadata Archive at server statup
- Loading an Open Metadata Archive in a running server
Raise an issue or comment below