Class MetadataSourceClient

    • Constructor Summary

      Constructors 
      Constructor Description
      MetadataSourceClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      MetadataSourceClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      MetadataSourceClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      MetadataSourceClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize)
      Create a new client that is to be used within an OMAG Server.
      MetadataSourceClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String createAPIManager​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, APIManagerProperties apiManagerProperties)
      Create information about the component that manages APIs.
      java.lang.String createApplication​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, ApplicationProperties applicationProperties)
      Create information about an application.
      java.lang.String createDatabaseManager​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, DatabaseManagerProperties databaseManagerProperties)
      Create information about the integration daemon that is managing the acquisition of metadata from the data manager.
      java.lang.String createDataProcessingEngine​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, DataProcessingEngineProperties engineProperties)
      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.
      java.lang.String createEventBroker​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, EventBrokerProperties eventBrokerProperties)
      Create information about the integration daemon that is managing the acquisition of metadata from the data manager.
      java.lang.String createFileManager​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, FileManagerProperties fileManagerProperties)
      Create information about an application that manages a collection of data files.
      java.lang.String createFileSystem​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, FileSystemProperties fileSystemProperties)
      Create information about a File System that is being used to store data files.
      java.lang.String getMetadataSourceGUID​(java.lang.String userId, java.lang.String qualifiedName)
      Retrieve the unique identifier of the data manager.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MetadataSourceClient

        public MetadataSourceClient​(java.lang.String serverName,
                                    java.lang.String serverPlatformURLRoot,
                                    AuditLog auditLog)
                             throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • MetadataSourceClient

        public MetadataSourceClient​(java.lang.String serverName,
                                    java.lang.String serverPlatformURLRoot)
                             throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • MetadataSourceClient

        public MetadataSourceClient​(java.lang.String serverName,
                                    java.lang.String serverPlatformURLRoot,
                                    java.lang.String userId,
                                    java.lang.String password,
                                    AuditLog auditLog)
                             throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • MetadataSourceClient

        public MetadataSourceClient​(java.lang.String serverName,
                                    java.lang.String serverPlatformURLRoot,
                                    java.lang.String userId,
                                    java.lang.String password)
                             throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • MetadataSourceClient

        public MetadataSourceClient​(java.lang.String serverName,
                                    java.lang.String serverPlatformURLRoot,
                                    DataManagerRESTClient restClient,
                                    int maxPageSize)
                             throws InvalidParameterException
        Create a new client that is to be used within an OMAG Server.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - pre-initialized REST client
        maxPageSize - pre-initialized parameter limit
        Throws:
        InvalidParameterException - there is a problem with the information about the remote OMAS
    • Method Detail

      • createAPIManager

        public java.lang.String createAPIManager​(java.lang.String userId,
                                                 java.lang.String externalSourceGUID,
                                                 java.lang.String externalSourceName,
                                                 APIManagerProperties apiManagerProperties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Create information about the component that manages APIs.
        Specified by:
        createAPIManager in interface MetadataSourceInterface
        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

        public java.lang.String createDatabaseManager​(java.lang.String userId,
                                                      java.lang.String externalSourceGUID,
                                                      java.lang.String externalSourceName,
                                                      DatabaseManagerProperties databaseManagerProperties)
                                               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 integrator OMIS.
        Specified by:
        createDatabaseManager in interface MetadataSourceInterface
        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 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
      • createEventBroker

        public java.lang.String createEventBroker​(java.lang.String userId,
                                                  java.lang.String externalSourceGUID,
                                                  java.lang.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.
        Specified by:
        createEventBroker in interface MetadataSourceInterface
        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

        public java.lang.String createFileSystem​(java.lang.String userId,
                                                 java.lang.String externalSourceGUID,
                                                 java.lang.String externalSourceName,
                                                 FileSystemProperties fileSystemProperties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Create information about a File System that is being used to store data files.
        Specified by:
        createFileSystem in interface MetadataSourceInterface
        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
        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
      • createDataProcessingEngine

        public java.lang.String createDataProcessingEngine​(java.lang.String userId,
                                                           java.lang.String externalSourceGUID,
                                                           java.lang.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.
        Specified by:
        createDataProcessingEngine in interface MetadataSourceInterface
        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