Class ConnectionExchangeService


  • public class ConnectionExchangeService
    extends java.lang.Object
    ConnectionExchangeService is the context for managing connections and associated elements such as connector types and endpoints.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearAssetConnection​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String assetGUID, java.lang.String connectionGUID, java.util.Date effectiveTime)
      Remove a relationship between an asset and its connection.
      void clearConnectorType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectionGUID, java.lang.String connectorTypeGUID, java.util.Date effectiveTime)
      Remove a relationship between a connection and a connector type.
      void clearEmbeddedConnection​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectionGUID, java.lang.String embeddedConnectionGUID, java.util.Date effectiveTime)
      Remove a relationship between a virtual connection and an embedded connection.
      void clearEndpoint​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectionGUID, java.lang.String endpointGUID, java.util.Date effectiveTime)
      Remove a relationship between a connection and an endpoint.
      java.lang.String createConnection​(boolean externalSourceIsHome, ExternalIdentifierProperties externalIdentifierProperties, ConnectionProperties connectionProperties)
      Create a new metadata element to represent the root of a connection.
      java.lang.String createConnectionFromTemplate​(boolean externalSourceIsHome, java.lang.String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)
      Create a new metadata element to represent a connection using an existing metadata element as a template.
      java.lang.String createConnectorType​(boolean externalSourceIsHome, ExternalIdentifierProperties externalIdentifierProperties, ConnectorTypeProperties connectorTypeProperties)
      Create a new metadata element to represent the root of a connector type.
      java.lang.String createConnectorTypeFromTemplate​(boolean externalSourceIsHome, java.lang.String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)
      Create a new metadata element to represent a connector type using an existing metadata element as a template.
      java.lang.String createEndpoint​(boolean externalSourceIsHome, ExternalIdentifierProperties externalIdentifierProperties, EndpointProperties endpointProperties)
      Create a new metadata element to represent the root of an endpoint.
      java.lang.String createEndpointFromTemplate​(boolean externalSourceIsHome, java.lang.String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)
      Create a new metadata element to represent an endpoint using an existing metadata element as a template.
      java.util.List<ConnectionElement> findConnections​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of connection metadata elements that contain the search string.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of connectorType metadata elements that contain the search string.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of endpoint metadata elements that contain the search string.
      ConnectionElement getConnectionByGUID​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectionGUID, java.util.Date effectiveTime)
      Retrieve the connection metadata element with the supplied unique identifier.
      java.util.List<ConnectionElement> getConnectionsByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of connection metadata elements with a matching qualified or display name.
      java.util.List<ConnectionElement> getConnectionsForAssetManager​(int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of connections created on behalf of the named external source.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String dataAssetGUID, java.util.Date effectiveTime)
      Retrieve the connectorType metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of connectorType metadata elements with a matching qualified or display name.
      java.util.List<ConnectorTypeElement> getConnectorTypesForAssetManager​(int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of connectorTypes created on behalf of the named connectorType manager.
      EndpointElement getEndpointByGUID​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String endpointGUID, java.util.Date effectiveTime)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name.
      java.util.List<EndpointElement> getEndpointsForAssetManager​(int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the list of endpoints created on behalf of the named external source.
      boolean isForLineage()
      Return whether retrieval requests from this service are to include elements with the Memento classification attached or not.
      void removeConnection​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectionGUID, java.lang.String connectionExternalIdentifier, java.util.Date effectiveTime)
      Remove the metadata element representing a connection.
      void removeConnectorType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectorTypeGUID, java.lang.String connectorTypeExternalIdentifier, java.util.Date effectiveTime)
      Remove the metadata element representing a connector type.
      void removeEndpoint​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectorTypeGUID, java.lang.String endpointExternalIdentifier, java.util.Date effectiveTime)
      Remove the metadata element representing a connector type.
      void setForLineage​(boolean forLineage)
      Set up whether retrieval requests from this service are to include elements with the Memento classification attached or not.
      void setupAssetConnection​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, boolean externalSourceIsHome, java.lang.String assetGUID, java.lang.String connectionGUID, AssetConnectionProperties properties, java.util.Date effectiveTime)
      Create a relationship between an asset and its connection.
      void setupConnectorType​(java.lang.String userId, boolean externalSourceIsHome, java.lang.String connectionGUID, java.lang.String connectorTypeGUID, java.util.Date effectiveFrom, java.util.Date effectiveTo, java.util.Date effectiveTime)
      Create a relationship between a connection and a connector type.
      void setupEmbeddedConnection​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, boolean externalSourceIsHome, java.lang.String connectionGUID, java.lang.String embeddedConnectionGUID, EmbeddedConnectionProperties properties, java.util.Date effectiveTime)
      Create a relationship between a virtual connection and an embedded connection.
      void setupEndpoint​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, boolean externalSourceIsHome, java.lang.String connectionGUID, java.lang.String endpointGUID, java.util.Date effectiveFrom, java.util.Date effectiveTo, java.util.Date effectiveTime)
      Create a relationship between a connection and an endpoint.
      void updateConnection​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectionGUID, java.lang.String connectionExternalIdentifier, boolean isMergeUpdate, ConnectionProperties connectionProperties, java.util.Date effectiveTime)
      Update the metadata element representing an connection.
      void updateConnectorType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectorTypeGUID, java.lang.String connectorTypeExternalIdentifier, boolean isMergeUpdate, ConnectorTypeProperties connectorTypeProperties, java.util.Date effectiveTime)
      Update the metadata element representing a connector type.
      void updateEndpoint​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String connectorTypeGUID, java.lang.String endpointExternalIdentifier, boolean isMergeUpdate, EndpointProperties endpointProperties, java.util.Date effectiveTime)
      Update the metadata element representing an endpoint.
      • Methods inherited from class java.lang.Object

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

      • isForLineage

        public boolean isForLineage()
        Return whether retrieval requests from this service are to include elements with the Memento classification attached or not.
        Returns:
        boolean flag
      • setForLineage

        public void setForLineage​(boolean forLineage)
        Set up whether retrieval requests from this service are to include elements with the Memento classification attached or not.
        Parameters:
        forLineage - boolean flag
      • createConnectionFromTemplate

        public java.lang.String createConnectionFromTemplate​(boolean externalSourceIsHome,
                                                             java.lang.String templateGUID,
                                                             ExternalIdentifierProperties externalIdentifierProperties,
                                                             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 connection.
        Parameters:
        externalSourceIsHome - ensure that only the external source can update this process
        externalIdentifierProperties - optional properties used to define an external identifier
        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

        public void updateConnection​(java.lang.String userId,
                                     java.lang.String externalSourceGUID,
                                     java.lang.String externalSourceName,
                                     java.lang.String connectionGUID,
                                     java.lang.String connectionExternalIdentifier,
                                     boolean isMergeUpdate,
                                     ConnectionProperties connectionProperties,
                                     java.util.Date effectiveTime)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update the metadata element representing an connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the metadata element to update
        connectionExternalIdentifier - unique identifier of the connection in the external source
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        connectionProperties - new properties for this element
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void setupConnectorType​(java.lang.String userId,
                                       boolean externalSourceIsHome,
                                       java.lang.String connectionGUID,
                                       java.lang.String connectorTypeGUID,
                                       java.util.Date effectiveFrom,
                                       java.util.Date effectiveTo,
                                       java.util.Date effectiveTime)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Create a relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        externalSourceIsHome - ensure that only the asset manager can update this relationship
        connectionGUID - unique identifier of the connection in the external asset manager
        connectorTypeGUID - unique identifier of the connector type in the external asset manager
        effectiveFrom - the date when this element is active - null for active now
        effectiveTo - the date when this element becomes inactive - null for active until deleted
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void clearConnectorType​(java.lang.String userId,
                                       java.lang.String externalSourceGUID,
                                       java.lang.String externalSourceName,
                                       java.lang.String connectionGUID,
                                       java.lang.String connectorTypeGUID,
                                       java.util.Date effectiveTime)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Remove a relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the connection in the external asset manager
        connectorTypeGUID - unique identifier of the connector type in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void setupEndpoint​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  boolean externalSourceIsHome,
                                  java.lang.String connectionGUID,
                                  java.lang.String endpointGUID,
                                  java.util.Date effectiveFrom,
                                  java.util.Date effectiveTo,
                                  java.util.Date effectiveTime)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Create a relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        externalSourceIsHome - ensure that only the asset manager can update this relationship
        connectionGUID - unique identifier of the connection in the external asset manager
        endpointGUID - unique identifier of the endpoint in the external asset manager
        effectiveFrom - the date when this element is active - null for active now
        effectiveTo - the date when this element becomes inactive - null for active until deleted
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void clearEndpoint​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String connectionGUID,
                                  java.lang.String endpointGUID,
                                  java.util.Date effectiveTime)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove a relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the connection in the external asset manager
        endpointGUID - unique identifier of the endpoint in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void setupEmbeddedConnection​(java.lang.String userId,
                                            java.lang.String externalSourceGUID,
                                            java.lang.String externalSourceName,
                                            boolean externalSourceIsHome,
                                            java.lang.String connectionGUID,
                                            java.lang.String embeddedConnectionGUID,
                                            EmbeddedConnectionProperties properties,
                                            java.util.Date effectiveTime)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Create a relationship between a virtual connection and an embedded connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        externalSourceIsHome - ensure that only the asset manager can update this relationship
        connectionGUID - unique identifier of the virtual connection in the external asset manager
        embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
        properties - properties describing how to use the embedded connection such as: Which order should this connection be processed; What additional properties should be passed to the embedded connector via the configuration properties; What does this connector signify?
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void clearEmbeddedConnection​(java.lang.String userId,
                                            java.lang.String externalSourceGUID,
                                            java.lang.String externalSourceName,
                                            java.lang.String connectionGUID,
                                            java.lang.String embeddedConnectionGUID,
                                            java.util.Date effectiveTime)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Remove a relationship between a virtual connection and an embedded connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the virtual connection in the external asset manager
        embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void setupAssetConnection​(java.lang.String userId,
                                         java.lang.String externalSourceGUID,
                                         java.lang.String externalSourceName,
                                         boolean externalSourceIsHome,
                                         java.lang.String assetGUID,
                                         java.lang.String connectionGUID,
                                         AssetConnectionProperties properties,
                                         java.util.Date effectiveTime)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Create a relationship between an asset and its connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        externalSourceIsHome - ensure that only the asset manager can update this relationship
        assetGUID - unique identifier of the asset
        properties - summary of the asset that is stored in the relationship between the asset and the connection.
        connectionGUID - unique identifier of the connection
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void clearAssetConnection​(java.lang.String userId,
                                         java.lang.String externalSourceGUID,
                                         java.lang.String externalSourceName,
                                         java.lang.String assetGUID,
                                         java.lang.String connectionGUID,
                                         java.util.Date effectiveTime)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Remove a relationship between an asset and its connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the asset
        connectionGUID - unique identifier of the connection
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void removeConnection​(java.lang.String userId,
                                     java.lang.String externalSourceGUID,
                                     java.lang.String externalSourceName,
                                     java.lang.String connectionGUID,
                                     java.lang.String connectionExternalIdentifier,
                                     java.util.Date effectiveTime)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Remove the metadata element representing a connection. This will delete the connection and all anchored elements such as schema and comments.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the metadata element to remove
        connectionExternalIdentifier - unique identifier of the connection in the external source
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • findConnections

        public java.util.List<ConnectionElement> findConnections​(java.lang.String searchString,
                                                                 int startFrom,
                                                                 int pageSize,
                                                                 java.util.Date effectiveTime)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException
        Retrieve the list of connection metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        list of matching metadata elements
        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)
      • getConnectionsByName

        public java.util.List<ConnectionElement> getConnectionsByName​(java.lang.String name,
                                                                      int startFrom,
                                                                      int pageSize,
                                                                      java.util.Date effectiveTime)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException
        Retrieve the list of connection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        list of matching metadata elements
        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)
      • getConnectionByGUID

        public ConnectionElement getConnectionByGUID​(java.lang.String userId,
                                                     java.lang.String externalSourceGUID,
                                                     java.lang.String externalSourceName,
                                                     java.lang.String connectionGUID,
                                                     java.util.Date effectiveTime)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
        Retrieve the connection metadata element with the supplied unique identifier.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the requested metadata element
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        matching 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

        public java.lang.String createEndpointFromTemplate​(boolean externalSourceIsHome,
                                                           java.lang.String templateGUID,
                                                           ExternalIdentifierProperties externalIdentifierProperties,
                                                           TemplateProperties templateProperties)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Create a new metadata element to represent an 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:
        externalSourceIsHome - ensure that only the external source can update this process
        externalIdentifierProperties - optional properties used to define an external identifier
        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)
      • updateEndpoint

        public void updateEndpoint​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String connectorTypeGUID,
                                   java.lang.String endpointExternalIdentifier,
                                   boolean isMergeUpdate,
                                   EndpointProperties endpointProperties,
                                   java.util.Date effectiveTime)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Update the metadata element representing an endpoint.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectorTypeGUID - unique identifier of the metadata element to update
        endpointExternalIdentifier - unique identifier of the endpoint in the external source
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        endpointProperties - new properties for this element
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        public void removeEndpoint​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String connectorTypeGUID,
                                   java.lang.String endpointExternalIdentifier,
                                   java.util.Date effectiveTime)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Remove the metadata element representing a connector type. This will delete the endpoint and all anchored elements such as schema and comments.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectorTypeGUID - unique identifier of the metadata element to remove
        endpointExternalIdentifier - unique identifier of the endpoint in the external source
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • findEndpoints

        public java.util.List<EndpointElement> findEndpoints​(java.lang.String searchString,
                                                             int startFrom,
                                                             int pageSize,
                                                             java.util.Date effectiveTime)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        list of matching metadata elements
        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)
      • getEndpointsByName

        public java.util.List<EndpointElement> getEndpointsByName​(java.lang.String name,
                                                                  int startFrom,
                                                                  int pageSize,
                                                                  java.util.Date effectiveTime)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException
        Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        list of matching metadata elements
        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)
      • getEndpointByGUID

        public EndpointElement getEndpointByGUID​(java.lang.String userId,
                                                 java.lang.String externalSourceGUID,
                                                 java.lang.String externalSourceName,
                                                 java.lang.String endpointGUID,
                                                 java.util.Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Retrieve the endpoint metadata element with the supplied unique identifier.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        endpointGUID - unique identifier of the requested metadata element
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        matching 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)
      • createConnectorTypeFromTemplate

        public java.lang.String createConnectorTypeFromTemplate​(boolean externalSourceIsHome,
                                                                java.lang.String templateGUID,
                                                                ExternalIdentifierProperties externalIdentifierProperties,
                                                                TemplateProperties templateProperties)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException
        Create a new metadata element to represent a connector type using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new connectorType.
        Parameters:
        externalSourceIsHome - ensure that only the connectorType manager can update this process
        externalIdentifierProperties - optional properties used to define an external identifier
        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)
      • updateConnectorType

        public void updateConnectorType​(java.lang.String userId,
                                        java.lang.String externalSourceGUID,
                                        java.lang.String externalSourceName,
                                        java.lang.String connectorTypeGUID,
                                        java.lang.String connectorTypeExternalIdentifier,
                                        boolean isMergeUpdate,
                                        ConnectorTypeProperties connectorTypeProperties,
                                        java.util.Date effectiveTime)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Update the metadata element representing a connector type.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectorTypeGUID - unique identifier of the metadata element to update
        connectorTypeExternalIdentifier - unique identifier of the connectorType in the external connectorType manager
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        connectorTypeProperties - new properties for this element
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • removeConnectorType

        public void removeConnectorType​(java.lang.String userId,
                                        java.lang.String externalSourceGUID,
                                        java.lang.String externalSourceName,
                                        java.lang.String connectorTypeGUID,
                                        java.lang.String connectorTypeExternalIdentifier,
                                        java.util.Date effectiveTime)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Remove the metadata element representing a connector type. This will delete the connectorType and all anchored elements such as schema and comments.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectorTypeGUID - unique identifier of the metadata element to remove
        connectorTypeExternalIdentifier - unique identifier of the connectorType in the external connectorType manager
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • findConnectorTypes

        public java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String searchString,
                                                                       int startFrom,
                                                                       int pageSize,
                                                                       java.util.Date effectiveTime)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException
        Retrieve the list of connectorType metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        list of matching metadata elements
        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)
      • getConnectorTypesByName

        public java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String name,
                                                                            int startFrom,
                                                                            int pageSize,
                                                                            java.util.Date effectiveTime)
                                                                     throws InvalidParameterException,
                                                                            UserNotAuthorizedException,
                                                                            PropertyServerException
        Retrieve the list of connectorType metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        list of matching metadata elements
        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)
      • getConnectorTypeByGUID

        public ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId,
                                                           java.lang.String externalSourceGUID,
                                                           java.lang.String externalSourceName,
                                                           java.lang.String dataAssetGUID,
                                                           java.util.Date effectiveTime)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Retrieve the connectorType metadata element with the supplied unique identifier.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        dataAssetGUID - unique identifier of the requested metadata element
        effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
        Returns:
        matching 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)