Package org.odpi.openmetadata.accessservices.assetmanager.api

Interface ConnectionExchangeInterface

  • public interface ConnectionExchangeInterface
    ConnectionExchangeInterface 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 Detail

      • createConnection

        String createConnection​(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        boolean assetManagerIsHome,
                        String connectionExternalIdentifier,
                        String connectionExternalIdentifierName,
                        String connectionExternalIdentifierUsage,
                        String connectionExternalIdentifierSource,
                        KeyPattern connectionExternalIdentifierKeyPattern,
                        Map<String,​String> mappingProperties,
                        ConnectionProperties connectionProperties)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
        Create a new metadata element to represent the connection.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this element
        connectionExternalIdentifier - unique identifier of the connection in the external asset manager
        connectionExternalIdentifierName - name of property for the external identifier in the external asset manager
        connectionExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        connectionExternalIdentifierSource - component that issuing this request.
        connectionExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        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

        String createConnectionFromTemplate​(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    boolean assetManagerIsHome,
                                    String templateGUID,
                                    String connectionExternalIdentifier,
                                    String connectionExternalIdentifierName,
                                    String connectionExternalIdentifierUsage,
                                    String connectionExternalIdentifierSource,
                                    KeyPattern connectionExternalIdentifierKeyPattern,
                                    Map<String,​String> mappingProperties,
                                    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
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this element
        connectionExternalIdentifier - unique identifier of the connection in the external asset manager
        connectionExternalIdentifierName - name of property for the external identifier in the external asset manager
        connectionExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        connectionExternalIdentifierSource - component that issuing this request.
        connectionExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        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​(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String connectionGUID,
                      String connectionExternalIdentifier,
                      boolean isMergeUpdate,
                      ConnectionProperties connectionProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
        Update the metadata element representing a connection.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - 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 asset manager
        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​(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        boolean assetManagerIsHome,
                        String connectionGUID,
                        String connectorTypeGUID)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
        Create a relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - 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
        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​(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        String connectionGUID,
                        String connectorTypeGUID)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
        Remove a relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - 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
        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​(String userId,
                   String assetManagerGUID,
                   String assetManagerName,
                   boolean assetManagerIsHome,
                   String connectionGUID,
                   String endpointGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException
        Create a relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - 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
        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​(String userId,
                   String assetManagerGUID,
                   String assetManagerName,
                   String connectionGUID,
                   String endpointGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException
        Remove a relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - 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
        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​(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             boolean assetManagerIsHome,
                             String connectionGUID,
                             int position,
                             String displayName,
                             Map<String,​Object> arguments,
                             String embeddedConnectionGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Create a relationship between a virtual connection and an embedded connection.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this relationship
        connectionGUID - unique identifier of the virtual connection in the external asset 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 asset 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​(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String connectionGUID,
                             String embeddedConnectionGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Remove a relationship between a virtual connection and an embedded connection.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - 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
        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​(String userId,
                          String assetManagerGUID,
                          String assetManagerName,
                          boolean assetManagerIsHome,
                          String assetGUID,
                          String assetSummary,
                          String connectionGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
        Create a relationship between an asset and its connection.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this relationship
        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)

      • removeConnection

        void removeConnection​(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String connectionGUID,
                      String connectionExternalIdentifier)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
        Remove the metadata element representing a connection. This will delete all anchored elements such as comments.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - 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 asset 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)

      • findConnections

        List<ConnectionElement> findConnections​(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        String searchString,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        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

        List<ConnectionElement> getConnectionsByName​(String userId,
                                             String assetManagerGUID,
                                             String assetManagerName,
                                             String name,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        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)

      • createEndpoint

        String createEndpoint​(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      boolean assetManagerIsHome,
                      String endpointExternalIdentifier,
                      String endpointExternalIdentifierName,
                      String endpointExternalIdentifierUsage,
                      String endpointExternalIdentifierSource,
                      KeyPattern endpointExternalIdentifierKeyPattern,
                      Map<String,​String> mappingProperties,
                      EndpointProperties endpointProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
        Create a new metadata element to represent the endpoint.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this element
        endpointExternalIdentifier - unique identifier of the endpoint in the external asset manager
        endpointExternalIdentifierName - name of property for the external identifier in the external asset manager
        endpointExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        endpointExternalIdentifierSource - component that issuing this request.
        endpointExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        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

        String createEndpointFromTemplate​(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  boolean assetManagerIsHome,
                                  String templateGUID,
                                  String endpointExternalIdentifier,
                                  String endpointExternalIdentifierName,
                                  String endpointExternalIdentifierUsage,
                                  String endpointExternalIdentifierSource,
                                  KeyPattern endpointExternalIdentifierKeyPattern,
                                  Map<String,​String> mappingProperties,
                                  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
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this element
        endpointExternalIdentifier - unique identifier of the endpoint in the external asset manager
        endpointExternalIdentifierName - name of property for the external identifier in the external asset manager
        endpointExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        endpointExternalIdentifierSource - component that issuing this request.
        endpointExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        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

        void updateEndpoint​(String userId,
                    String assetManagerGUID,
                    String assetManagerName,
                    String endpointGUID,
                    String endpointExternalIdentifier,
                    boolean isMergeUpdate,
                    EndpointProperties endpointProperties)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException
        Update the metadata element representing a endpoint.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        endpointGUID - unique identifier of the metadata element to update
        endpointExternalIdentifier - unique identifier of the endpoint in the external asset manager
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        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​(String userId,
                    String assetManagerGUID,
                    String assetManagerName,
                    String endpointGUID,
                    String endpointExternalIdentifier)
             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
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        endpointGUID - unique identifier of the metadata element to remove
        endpointExternalIdentifier - unique identifier of the endpoint in the external asset 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)

      • findEndpoints

        List<EndpointElement> findEndpoints​(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String searchString,
                                    int startFrom,
                                    int pageSize)
                             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:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        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

        List<EndpointElement> getEndpointsByName​(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String name,
                                         int startFrom,
                                         int pageSize)
                                  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:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        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)

      • createConnectorType

        String createConnectorType​(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           boolean assetManagerIsHome,
                           String connectorTypeExternalIdentifier,
                           String connectorTypeExternalIdentifierName,
                           String connectorTypeExternalIdentifierUsage,
                           String connectorTypeExternalIdentifierSource,
                           KeyPattern connectorTypeExternalIdentifierKeyPattern,
                           Map<String,​String> mappingProperties,
                           ConnectorTypeProperties connectorTypeProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Create a new metadata element to represent the root of a connectorType.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this element
        connectorTypeExternalIdentifier - unique identifier of the connectorType in the external asset manager
        connectorTypeExternalIdentifierName - name of property for the external identifier in the external asset manager
        connectorTypeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        connectorTypeExternalIdentifierSource - component that issuing this request.
        connectorTypeExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        connectorTypeProperties - 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)

      • createConnectorTypeFromTemplate

        String createConnectorTypeFromTemplate​(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       boolean assetManagerIsHome,
                                       String templateGUID,
                                       String connectorTypeExternalIdentifier,
                                       String connectorTypeExternalIdentifierName,
                                       String connectorTypeExternalIdentifierUsage,
                                       String connectorTypeExternalIdentifierSource,
                                       KeyPattern connectorTypeExternalIdentifierKeyPattern,
                                       Map<String,​String> mappingProperties,
                                       TemplateProperties templateProperties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Create a new metadata element to represent a connectorType using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new connectorType.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this element
        connectorTypeExternalIdentifier - unique identifier of the connectorType in the external asset manager
        connectorTypeExternalIdentifierName - name of property for the external identifier in the external asset manager
        connectorTypeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        connectorTypeExternalIdentifierSource - component that issuing this request.
        connectorTypeExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        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

        void updateConnectorType​(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String connectorTypeGUID,
                         String connectorTypeExternalIdentifier,
                         boolean isMergeUpdate,
                         ConnectorTypeProperties connectorTypeProperties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
        Update the metadata element representing a connectorType.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - 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 asset manager
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        connectorTypeProperties - 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)

      • removeConnectorType

        void removeConnectorType​(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String connectorTypeGUID,
                         String connectorTypeExternalIdentifier)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
        Remove the metadata element representing a connectorType. This will delete the connectorType and all categories and terms.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - 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 asset 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)

      • findConnectorTypes

        List<ConnectorTypeElement> findConnectorTypes​(String userId,
                                              String assetManagerGUID,
                                              String assetManagerName,
                                              String searchString,
                                              int startFrom,
                                              int pageSize)
                                       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:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        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

        List<ConnectorTypeElement> getConnectorTypesByName​(String userId,
                                                   String assetManagerGUID,
                                                   String assetManagerName,
                                                   String name,
                                                   int startFrom,
                                                   int pageSize)
                                            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:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        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)