Skip to content

Using connectors

A connector is created from a connection. The connection, along with its connector type and endpoint, can be stored as open metadata and linked to the asset that describes the digital resource that the connector accesses. These elements are maintained through the Connection Maker view service.

An asset with a connection

There are two ways to create a connector in Java:

  • Create a Connection object and pass it to the getConnector() method of the OCF's ConnectorBroker . The connector broker uses the connector provider class name in the connection's connector type to create the connector provider, which in turn creates and initializes the connector. If the connection is a virtual connection, the broker also creates the connectors for its embedded connections.
  • Ask a metadata access server to create the connector from a connection stored in open metadata, using the Connected Asset Services. The Java client for these services is EgeriaConnectedAssetClient . Its getConnectorForAsset() method returns a connector for the digital resource described by an asset. There are also getConnectorByGUID() and getConnectorByName() methods that work from the unique identifier or name of a stored connection, and getConnectorByConnection() that works from a supplied connection object.

In both cases, the connector is returned initialized but not started. The caller calls start() on the connector before using it, and disconnect() when it has finished with it.

Connecting to assets with different levels of security

It is possible that an asset can have multiple connections, each with different levels of security access encoded. When a connection is requested for an asset, Egeria determines which one to use by calling the selectConnection() method of the Server Security Metadata Connector.

Multiple connections for an asset

Open metadata is a connected network (graph) of information. The connector type and endpoint that a connection object links to are typically shared with many connections. This creates some interesting insight.

For example, there is typically one connector type for each connector implementation. By retrieving the relationships from the connector type to the connections, it is possible to see the extent to which the connector is used.

Connector types

Uses of a connector implementation

The connector types for Egeria's connectors are supplied in the Core Content Pack, which can be loaded into the server. This approach can be used for all of your connector implementations to create the connector type objects in your metadata repository. See the core-content-pack module for more detail.

Further information

The connector catalog lists the connectors provided by the Egeria community.