Package org.odpi.openmetadata.accessservices.datamanager.api

Interface MetadataSourceInterface

All Known Implementing Classes:
MetadataSourceClient
public interface MetadataSourceInterface
MetadataSourceInterface is the interface used to define information about the third party technologies that an integration daemon is extracting metadata from. These technologies are represented by a software server capability in open metadata.

  • Method Details

    • createAPIManager

      String createAPIManager(String userId, String externalSourceGUID, String externalSourceName, APIManagerProperties apiManagerProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create information about the component that manages APIs.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      apiManagerProperties - description of the API manager (specify qualified name at a minimum)
      Returns:
      unique identifier of the API manager'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

    • createDatabaseManager

      String createDatabaseManager(String userId, String externalSourceGUID, String externalSourceName, DatabaseManagerProperties databaseManagerProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create information about the database manager (DBMS) that is supplying database schema metadata.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      databaseManagerProperties - description of the database manager (DBMS) (specify qualified name at a minimum)
      Returns:
      unique identifier of the database manager'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

    • createEventBroker

      String createEventBroker(String userId, String externalSourceGUID, String externalSourceName, EventBrokerProperties eventBrokerProperties) 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
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      eventBrokerProperties - description of the event broker (specify qualified name at a minimum)
      Returns:
      unique identifier of the event broker'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

    • createFileSystem

      String createFileSystem(String userId, String externalSourceGUID, String externalSourceName, FileSystemProperties fileSystemProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create information about a File System that is being used to store data files.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      fileSystemProperties - description of the file system (specify qualified name at a minimum)
      Returns:
      unique identifier of the file system'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

    • createFileManager

      String createFileManager(String userId, String externalSourceGUID, String externalSourceName, FileManagerProperties fileManagerProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create information about an application that manages a collection of data files.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      fileManagerProperties - description of the file manager (specify qualified name at a minimum)
      Returns:
      unique identifier of the file manager'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

    • createApplication

      String createApplication(String userId, String externalSourceGUID, String externalSourceName, ApplicationProperties applicationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create information about an application.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      applicationProperties - description of the application (specify qualified name at a minimum)
      Returns:
      unique identifier of the application'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

    • createDataProcessingEngine

      String createDataProcessingEngine(String userId, String externalSourceGUID, String externalSourceName, DataProcessingEngineProperties engineProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create information about a data processing engine - set up typeName in the properties to create sub types such as ReportingEngine, WorkflowEngine, AnalyticsEngine, DataMovementEngine or DataVirtualizationEngine.
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      engineProperties - description of the engine (specify qualified name at a minimum)
      Returns:
      unique identifier of the engine'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

    • getMetadataSourceGUID

      String getMetadataSourceGUID(String userId, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the unique identifier of the software server capability that describes a metadata source. This could be a database manager, event broker, API Manager, filesystem or file manager.
      Parameters:
      userId - calling user
      qualifiedName - unique name of the data manager
      Returns:
      unique identifier of the data manager'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