Skip to content

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

Open Integration Framework (OIF)

The Open Integration Framework (OIF) provides the interfaces for running integration connectors.

Integration connector interfaces

The OIF is built on the Open Connector Framework (OCF). As such, it offers interfaces for the integration connector and the associated connector provider that extend the Connector and ConnectorProvider OCF interfaces respectively.

Specifically it offers:

  • IntegrationConnector is the interface that is specific to an integration connector.
  • IntegrationConnectorBase is the base class for an integration connector. It provides implementations of the initialize(), start() and disconnect() methods as well as useful functions needed by many integration connectors.
  • IntegrationConnectorProvider is the base class for the integration connector's connector provider.

Integration context

The IntegrationContext class provides the base class for the context object that provides open metadata services to the integration connector. The integration context is passed to the integration connector between initialize() and start() method calls.

Catalog target

A catalog target is an open metadata element that the integration connector should use as a root element for its work.

Permitted synchronization

The PermittedSynchronization enumeration can be used to limit the activities of a particular integration connector. It is set in the integration connector's configuration and enforced by the context.

Integration context manager

The context manager is responsible for setting up the integration context for the integration connector.

Framework implementation

Egeria provides a full implementation of the OIF. It provides an integration daemon server where the integration connectors run. There are specialist integration services that provide specialist integration contexts along with their integration context manager. There are also implementations of integration connectors in the integration-connectors module.

Raise an issue or comment below