Package org.odpi.openmetadata.accessservices.discoveryengine.server

Class DiscoveryConfigurationServices

  • public class DiscoveryConfigurationServices
extends Object
    The DiscoveryConfigurationServices provides the server-side implementation of the configuration services from the Open Discovery Framework (ODF). These services configure discovery engines and discovery services.

    • Constructor Detail

      • DiscoveryConfigurationServices

        public DiscoveryConfigurationServices()
        Default constructor

    • Method Detail

      • getOutTopicConnection

        public ConnectionResponse getOutTopicConnection​(String serverName,
                                                String userId,
                                                String callerId)
        Return the connection object for the Discovery Engine 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.

      • createDiscoveryEngine

        public GUIDResponse createDiscoveryEngine​(String serverName,
                                          String userId,
                                          NewDiscoveryEngineRequestBody requestBody)
        Create a new discovery engine definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        requestBody - containing: qualifiedName - unique name for the discovery engine; displayName - display name for messages and user interfaces; description - description of the types of discovery services that wil be associated with this discovery engine.
        Returns:
        unique identifier (guid) of the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryEngineByGUID

        public DiscoveryEnginePropertiesResponse getDiscoveryEngineByGUID​(String serverName,
                                                                  String userId,
                                                                  String guid)
        Return the properties from a discovery engine definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier (guid) of the discovery engine definition.
        Returns:
        properties from the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryEngineByName

        public DiscoveryEnginePropertiesResponse getDiscoveryEngineByName​(String serverName,
                                                                  String userId,
                                                                  String name)
        Return the properties from a discovery engine definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        name - qualified name or display name (if unique).
        Returns:
        properties from the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getAllDiscoveryEngines

        public DiscoveryEngineListResponse getAllDiscoveryEngines​(String serverName,
                                                          String userId,
                                                          int startingFrom,
                                                          int maximumResults)
        Return the list of discovery engine definitions that are stored.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        startingFrom - initial position in the stored list.
        maximumResults - maximum number of definitions to return on this call.
        Returns:
        list of discovery engine definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • updateDiscoveryEngine

        public VoidResponse updateDiscoveryEngine​(String serverName,
                                          String userId,
                                          String guid,
                                          UpdateDiscoveryEngineRequestBody requestBody)
        Update the properties of an existing discovery engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier of the discovery engine - used to locate the definition.
        requestBody - containing the new properties of the discovery engine.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • deleteDiscoveryEngine

        public VoidResponse deleteDiscoveryEngine​(String serverName,
                                          String userId,
                                          String guid,
                                          DeleteRequestBody requestBody)
        Remove the properties of the discovery engine. Both the guid and the qualified name is supplied to validate that the correct discovery engine is being deleted.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier of the discovery engine - used to locate the definition.
        requestBody - containing the unique name for the discovery engine.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • createDiscoveryService

        public GUIDResponse createDiscoveryService​(String serverName,
                                           String userId,
                                           NewDiscoveryServiceRequestBody requestBody)
        Create a discovery service definition. The same discovery service can be associated with multiple discovery engines.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        requestBody - containing: qualifiedName - unique name for the discovery service; displayName - display name for the discovery service; description - description of the analysis provided by the discovery service; connection - connection to instantiate the discovery service implementation.
        Returns:
        unique identifier of the discovery service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryServiceByGUID

        public DiscoveryServicePropertiesResponse getDiscoveryServiceByGUID​(String serverName,
                                                                    String userId,
                                                                    String guid)
        Return the properties from a discovery service definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier (guid) of the discovery service definition.
        Returns:
        properties of the discovery service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryServiceByName

        public DiscoveryServicePropertiesResponse getDiscoveryServiceByName​(String serverName,
                                                                    String userId,
                                                                    String name)
        Return the properties from a discovery service definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        name - qualified name or display name (if unique).
        Returns:
        properties from the discovery engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getAllDiscoveryServices

        public DiscoveryServiceListResponse getAllDiscoveryServices​(String serverName,
                                                            String userId,
                                                            int startingFrom,
                                                            int maximumResults)
        Return the list of discovery services definitions that are stored.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        startingFrom - initial position in the stored list.
        maximumResults - maximum number of definitions to return on this call.
        Returns:
        list of discovery service definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getDiscoveryServiceRegistrations

        public GUIDListResponse getDiscoveryServiceRegistrations​(String serverName,
                                                         String userId,
                                                         String discoveryServiceGUID)
        Return the list of discovery engines that a specific discovery service is registered with.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        discoveryServiceGUID - discovery service to search for.
        Returns:
        list of discovery engine unique identifiers (guids) or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • updateDiscoveryService

        public VoidResponse updateDiscoveryService​(String serverName,
                                           String userId,
                                           String guid,
                                           UpdateDiscoveryServiceRequestBody requestBody)
        Update the properties of an existing discovery service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier of the discovery service - used to locate the definition.
        requestBody - containing the new parameters for the discovery service.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • deleteDiscoveryService

        public VoidResponse deleteDiscoveryService​(String serverName,
                                           String userId,
                                           String guid,
                                           DeleteRequestBody requestBody)
        Remove the properties of the discovery service. Both the guid and the qualified name is supplied to validate that the correct discovery service is being deleted. The discovery service is also unregistered from its discovery engines.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        guid - unique identifier of the discovery service - used to locate the definition.
        requestBody - containing the unique name for the discovery service.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • registerDiscoveryServiceWithEngine

        public VoidResponse registerDiscoveryServiceWithEngine​(String serverName,
                                                       String userId,
                                                       String discoveryEngineGUID,
                                                       DiscoveryServiceRegistrationRequestBody requestBody)
        Register a discovery service with a specific discovery engine.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        discoveryEngineGUID - unique identifier of the discovery engine.
        requestBody - containing: discoveryServiceGUID - unique identifier of the discovery service; discoveryRequestTypes - list of asset types that this discovery service is able to process.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getRegisteredDiscoveryService

        public RegisteredDiscoveryServiceResponse getRegisteredDiscoveryService​(String serverName,
                                                                        String userId,
                                                                        String discoveryEngineGUID,
                                                                        String discoveryServiceGUID)
        Retrieve a specific discovery service registered with a discovery engine.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        discoveryEngineGUID - unique identifier of the discovery engine.
        discoveryServiceGUID - unique identifier of the discovery service.
        Returns:
        details of the discovery service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • getRegisteredDiscoveryServices

        public GUIDListResponse getRegisteredDiscoveryServices​(String serverName,
                                                       String userId,
                                                       String discoveryEngineGUID,
                                                       int startingFrom,
                                                       int maximumResults)
        Retrieve the identifiers of the discovery services registered with a discovery engine.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        discoveryEngineGUID - unique identifier of the discovery engine.
        startingFrom - initial position in the stored list.
        maximumResults - maximum number of definitions to return on this call.
        Returns:
        list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.

      • unregisterDiscoveryServiceFromEngine

        public VoidResponse unregisterDiscoveryServiceFromEngine​(String serverName,
                                                         String userId,
                                                         String discoveryEngineGUID,
                                                         String discoveryServiceGUID,
                                                         NullRequestBody requestBody)
        Unregister a discovery service from the discovery engine.
        Parameters:
        serverName - name of the service to route the request to.
        userId - identifier of calling user.
        discoveryEngineGUID - unique identifier of the discovery engine.
        discoveryServiceGUID - unique identifier of the discovery service.
        requestBody - null request body.
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the discovery engine definition.