org.odpi.openmetadata.accessservices.datamanager.api

Interface DataManagerIntegratorInterface

public interface DataManagerIntegratorInterface

DataManagerIntegratorInterface is the interface used to define information about the integration daemon that is extracting metadata from a data manager and maintaining it in open metadata. The integration daemon is represented by a software server capability in open metadata. It has a classification to indicate that it is data manager integrator.

Method Summary

Modifier and Type	Method and Description
String	createDataManagerIntegrator(String userId, SoftwareServerCapabilitiesProperties integratorCapabilities) Create information about the integration daemon that is managing the acquisition of metadata from the data manager.
String	getDataManagerIntegratorGUID(String userId, String qualifiedName) Retrieve the unique identifier of the integration daemon.

Method Detail

createDataManagerIntegrator

String createDataManagerIntegrator(String userId,
                                   SoftwareServerCapabilitiesProperties integratorCapabilities)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create information about the integration daemon that is managing the acquisition of metadata from the data manager. Typically this is Egeria's data manager proxy.

Parameters:

userId - calling user

integratorCapabilities - description of the integration daemon (specify qualified name at a minimum)

Returns:

unique identifier of the integration daemon's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getDataManagerIntegratorGUID

String getDataManagerIntegratorGUID(String userId,
                                    String qualifiedName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the unique identifier of the integration daemon.

Parameters:

userId - calling user

qualifiedName - unique name of the integration daemon

Returns:

unique identifier of the integration daemon's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server