Package org.odpi.openmetadata.accessservices.datamanager.server

Class DataManagerRESTServices

  • public class DataManagerRESTServices
extends Object
    The DataManagerRESTServices provides the server-side implementation of the services that are generic for all types of data managers.

    • Constructor Detail

      • DataManagerRESTServices

        public DataManagerRESTServices()
        Default constructor

    • Method Detail

      • getOutTopicConnection

        public ConnectionResponse getOutTopicConnection​(String serverName,
                                                String userId,
                                                String callerId)
        Return the connection object for the Data Manager OMAS's out topic.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        callerId - unique identifier of the caller
        Returns:
        connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

      • createFileSystemInCatalog

        public GUIDResponse createFileSystemInCatalog​(String serverName,
                                              String userId,
                                              FileSystemRequestBody requestBody)
        Files live on a file system. This method creates a top level capability for a file system.
        Parameters:
        serverName - name of calling server
        userId - calling user
        requestBody - properties of the file system
        Returns:
        unique identifier for the file system or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

      • createFileManagerInCatalog

        public GUIDResponse createFileManagerInCatalog​(String serverName,
                                               String userId,
                                               FileManagerRequestBody requestBody)
        Files live on a file system. This method creates a top level capability for a file system.
        Parameters:
        serverName - name of calling server
        userId - calling user
        requestBody - properties of the file system
        Returns:
        unique identifier for the file system or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

      • createDatabaseManagerInCatalog

        public GUIDResponse createDatabaseManagerInCatalog​(String serverName,
                                                   String userId,
                                                   DatabaseManagerRequestBody requestBody)
        Create the software server capability for the database manager (DBMS).
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        requestBody - description of the database manager
        Returns:
        unique identifier of the software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

      • createAPIManagerInCatalog

        public GUIDResponse createAPIManagerInCatalog​(String serverName,
                                              String userId,
                                              APIManagerRequestBody requestBody)
        Create the Software server capability for the API Manager.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        requestBody - description of the API manager
        Returns:
        unique identifier of the software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

      • createEventBrokerInCatalog

        public GUIDResponse createEventBrokerInCatalog​(String serverName,
                                               String userId,
                                               EventBrokerRequestBody requestBody)
        Create the Software server capability for the Event Broker.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        requestBody - description of the Event Broker
        Returns:
        unique identifier of the software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

      • createApplicationInCatalog

        public GUIDResponse createApplicationInCatalog​(String serverName,
                                               String userId,
                                               ApplicationRequestBody requestBody)
        Create the Software server capability for an Application.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        requestBody - description of the Application
        Returns:
        unique identifier of the software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

      • createDataProcessingEngineInCatalog

        public GUIDResponse createDataProcessingEngineInCatalog​(String serverName,
                                                        String userId,
                                                        DataProcessingEngineRequestBody requestBody)
        Create the Software server capability for a data processing engine such as a reporting engine.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        requestBody - description of the data processing engine
        Returns:
        unique identifier of the software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

      • getMetadataSourceGUID

        public GUIDResponse getMetadataSourceGUID​(String serverName,
                                          String userId,
                                          String qualifiedName)
        Retrieve the unique identifier of the integration daemon service.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        qualifiedName - unique name of the integration daemon
        Returns:
        unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server