Interface ConnectionManagerInterface

  • All Known Implementing Classes:
    ConnectionManagerClient

    public interface ConnectionManagerInterface
    ManageConnections provides methods to define connections and their supporting objects The interface supports the following types of objects
    • Connections - the connections used to create connector instances that can access the connection.
    • ConnectorTypes - description of a specific that can be used to access the connection.
    • ConnectorCategories - the network information needed to access the connection.
    • Endpoints - the network information needed to access the connection.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearAssetConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String assetGUID, java.lang.String connectionGUID)
      Remove a relationship between an asset and its connection.
      void clearConnectorType​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Remove a relationship between a connection and a connector type.
      void clearEmbeddedConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String embeddedConnectionGUID)
      Remove a relationship between a virtual connection and an embedded connection.
      void clearEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String endpointGUID)
      Remove a relationship between a connection and an endpoint.
      java.lang.String createConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, ConnectionProperties connectionProperties)
      Create a new metadata element to represent the connection.
      java.lang.String createConnectionFromTemplate​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a connection using an existing metadata element as a template.
      java.lang.String createEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, EndpointProperties endpointProperties)
      Create a new metadata element to represent the endpoint.
      java.lang.String createEndpointFromTemplate​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String networkAddress, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a endpoint using an existing metadata element as a template.
      java.util.List<ConnectionElement> findConnections​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of asset metadata elements that contain the search string.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements that contain the search string.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string.
      ConnectionElement getConnectionByGUID​(java.lang.String userId, java.lang.String connectionGUID)
      Retrieve the connection metadata element with the supplied unique identifier.
      java.util.List<ConnectionElement> getConnectionsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of asset metadata elements with a matching qualified or display name.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId, java.lang.String connectorTypeGUID)
      Retrieve the connectorType metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements with a matching qualified or display name.
      EndpointElement getEndpointByGUID​(java.lang.String userId, java.lang.String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name.
      void removeConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID)
      Remove the metadata element representing a connection.
      void removeEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String endpointGUID)
      Remove the metadata element representing a endpoint.
      void setupAssetConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String assetGUID, java.lang.String assetSummary, java.lang.String connectionGUID)
      Create a relationship between an asset and its connection.
      void setupConnectorType​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Create a relationship between a connection and a connector type.
      void setupEmbeddedConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, int position, java.lang.String displayName, java.util.Map<java.lang.String,​java.lang.Object> arguments, java.lang.String embeddedConnectionGUID)
      Create a relationship between a virtual connection and an embedded connection.
      void setupEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String endpointGUID)
      Create a relationship between a connection and an endpoint.
      void updateConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)
      Update the metadata element representing a connection.
      void updateEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing a endpoint.
    • Method Detail

      • createConnection

        java.lang.String createConnection​(java.lang.String userId,
                                          java.lang.String dataManagerGUID,
                                          java.lang.String dataManagerName,
                                          ConnectionProperties connectionProperties)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Create a new metadata element to represent the connection.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionProperties - properties to store
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createConnectionFromTemplate

        java.lang.String createConnectionFromTemplate​(java.lang.String userId,
                                                      java.lang.String dataManagerGUID,
                                                      java.lang.String dataManagerName,
                                                      java.lang.String templateGUID,
                                                      TemplateProperties templateProperties)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
        Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new asset.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateConnection

        void updateConnection​(java.lang.String userId,
                              java.lang.String dataManagerGUID,
                              java.lang.String dataManagerName,
                              java.lang.String connectionGUID,
                              boolean isMergeUpdate,
                              ConnectionProperties connectionProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Update the metadata element representing a connection.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the metadata element to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        connectionProperties - new properties for this element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupConnectorType

        void setupConnectorType​(java.lang.String userId,
                                java.lang.String dataManagerGUID,
                                java.lang.String dataManagerName,
                                java.lang.String connectionGUID,
                                java.lang.String connectorTypeGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Create a relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the connection in the external data manager
        connectorTypeGUID - unique identifier of the connector type in the external data manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearConnectorType

        void clearConnectorType​(java.lang.String userId,
                                java.lang.String dataManagerGUID,
                                java.lang.String dataManagerName,
                                java.lang.String connectionGUID,
                                java.lang.String connectorTypeGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Remove a relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the connection in the external data manager
        connectorTypeGUID - unique identifier of the connector type in the external data manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupEndpoint

        void setupEndpoint​(java.lang.String userId,
                           java.lang.String dataManagerGUID,
                           java.lang.String dataManagerName,
                           java.lang.String connectionGUID,
                           java.lang.String endpointGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Create a relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the connection in the external data manager
        endpointGUID - unique identifier of the endpoint in the external data manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearEndpoint

        void clearEndpoint​(java.lang.String userId,
                           java.lang.String dataManagerGUID,
                           java.lang.String dataManagerName,
                           java.lang.String connectionGUID,
                           java.lang.String endpointGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Remove a relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the connection in the external data manager
        endpointGUID - unique identifier of the endpoint in the external data manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupEmbeddedConnection

        void setupEmbeddedConnection​(java.lang.String userId,
                                     java.lang.String dataManagerGUID,
                                     java.lang.String dataManagerName,
                                     java.lang.String connectionGUID,
                                     int position,
                                     java.lang.String displayName,
                                     java.util.Map<java.lang.String,​java.lang.Object> arguments,
                                     java.lang.String embeddedConnectionGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Create a relationship between a virtual connection and an embedded connection.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the virtual connection in the external data manager
        position - which order should this connection be processed
        arguments - What additional properties should be passed to the embedded connector via the configuration properties
        displayName - what does this connector signify?
        embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearEmbeddedConnection

        void clearEmbeddedConnection​(java.lang.String userId,
                                     java.lang.String dataManagerGUID,
                                     java.lang.String dataManagerName,
                                     java.lang.String connectionGUID,
                                     java.lang.String embeddedConnectionGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Remove a relationship between a virtual connection and an embedded connection.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the virtual connection in the external data manager
        embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupAssetConnection

        void setupAssetConnection​(java.lang.String userId,
                                  java.lang.String dataManagerGUID,
                                  java.lang.String dataManagerName,
                                  java.lang.String assetGUID,
                                  java.lang.String assetSummary,
                                  java.lang.String connectionGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Create a relationship between an asset and its connection.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the asset
        assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
        connectionGUID - unique identifier of the connection
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearAssetConnection

        void clearAssetConnection​(java.lang.String userId,
                                  java.lang.String dataManagerGUID,
                                  java.lang.String dataManagerName,
                                  java.lang.String assetGUID,
                                  java.lang.String connectionGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove a relationship between an asset and its connection.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the asset
        connectionGUID - unique identifier of the connection
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeConnection

        void removeConnection​(java.lang.String userId,
                              java.lang.String dataManagerGUID,
                              java.lang.String dataManagerName,
                              java.lang.String connectionGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the metadata element representing a connection. This will delete all anchored elements such as comments.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the metadata element to remove
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createEndpoint

        java.lang.String createEndpoint​(java.lang.String userId,
                                        java.lang.String dataManagerGUID,
                                        java.lang.String dataManagerName,
                                        EndpointProperties endpointProperties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Create a new metadata element to represent the endpoint.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        endpointProperties - properties to store
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createEndpointFromTemplate

        java.lang.String createEndpointFromTemplate​(java.lang.String userId,
                                                    java.lang.String dataManagerGUID,
                                                    java.lang.String dataManagerName,
                                                    java.lang.String networkAddress,
                                                    java.lang.String templateGUID,
                                                    TemplateProperties templateProperties)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Create a new metadata element to represent a endpoint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new endpoint.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        networkAddress - location of the endpoint
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - descriptive properties that override the template
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateEndpoint

        void updateEndpoint​(java.lang.String userId,
                            java.lang.String dataManagerGUID,
                            java.lang.String dataManagerName,
                            boolean isMergeUpdate,
                            java.lang.String endpointGUID,
                            EndpointProperties endpointProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
        Update the metadata element representing a endpoint.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        endpointGUID - unique identifier of the metadata element to update
        endpointProperties - new properties for this element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeEndpoint

        void removeEndpoint​(java.lang.String userId,
                            java.lang.String dataManagerGUID,
                            java.lang.String dataManagerName,
                            java.lang.String endpointGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
        Remove the metadata element representing a endpoint. This will delete the endpoint and all categories and terms.
        Parameters:
        userId - calling user
        dataManagerGUID - unique identifier of software server capability representing the caller
        dataManagerName - unique name of software server capability representing the caller
        endpointGUID - unique identifier of the metadata element to remove
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)