Class ConnectionManagerClient

    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectionManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      ConnectionManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      ConnectionManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      ConnectionManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)
      Create a new client that is going to be used in an OMAG Server.
      ConnectionManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

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

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

      • ConnectionManagerClient

        public ConnectionManagerClient​(java.lang.String serverName,
                                       java.lang.String serverPlatformURLRoot,
                                       AuditLog auditLog)
                                throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectionManagerClient

        public ConnectionManagerClient​(java.lang.String serverName,
                                       java.lang.String serverPlatformURLRoot)
                                throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectionManagerClient

        public ConnectionManagerClient​(java.lang.String serverName,
                                       java.lang.String serverPlatformURLRoot,
                                       java.lang.String userId,
                                       java.lang.String password)
                                throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectionManagerClient

        public ConnectionManagerClient​(java.lang.String serverName,
                                       java.lang.String serverPlatformURLRoot,
                                       java.lang.String userId,
                                       java.lang.String password,
                                       AuditLog auditLog)
                                throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectionManagerClient

        public ConnectionManagerClient​(java.lang.String serverName,
                                       java.lang.String serverPlatformURLRoot,
                                       ITInfrastructureRESTClient restClient,
                                       int maxPageSize)
                                throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • createConnectionFromTemplate

        public java.lang.String createConnectionFromTemplate​(java.lang.String userId,
                                                             java.lang.String infrastructureManagerGUID,
                                                             java.lang.String infrastructureManagerName,
                                                             java.lang.String templateGUID,
                                                             TemplateProperties templateProperties)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Create a new metadata element to represent a connection using an existing metadata element as a template.
        Specified by:
        createConnectionFromTemplate in interface ConnectionsManagerInterface
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new 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)
      • updateConnection

        public void updateConnection​(java.lang.String userId,
                                     java.lang.String infrastructureManagerGUID,
                                     java.lang.String infrastructureManagerName,
                                     java.lang.String connectionGUID,
                                     boolean isMergeUpdate,
                                     ConnectionProperties connectionProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update the metadata element representing a connection. It is possible to use the subtype property classes or set up specialized properties in extended properties.
        Specified by:
        updateConnection in interface ConnectionsManagerInterface
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the metadata element to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        connectionProperties - new properties for the 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)
      • setupConnectorType

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

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

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

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

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

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

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

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