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, DataManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)
      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 dataManagerGUID, java.lang.String dataManagerName, java.lang.String assetGUID, java.lang.String connectionGUID)
      Remove a relationship between an asset and its connection.
      void clearConnectorType​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Remove a relationship between a connection and a connector type.
      void clearEmbeddedConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String embeddedConnectionGUID)
      Remove a relationship between a virtual connection and an embedded connection.
      void clearEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String endpointGUID)
      Remove a relationship between a connection and an endpoint.
      java.lang.String createConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, ConnectionProperties connectionProperties)
      Create a new metadata element to represent a connection.
      java.lang.String createConnectionFromTemplate​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a connection using an existing metadata element as a template.
      java.lang.String createEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, EndpointProperties endpointProperties)
      Create a new metadata element to represent an endpoint
      java.lang.String createEndpointFromTemplate​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String networkAddress, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a endpoint using an existing metadata element as a template.
      java.util.List<ConnectionElement> findConnections​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of metadata elements that contain the search string.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements that contain the search string.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string.
      ConnectionElement getConnectionByGUID​(java.lang.String userId, java.lang.String connectionGUID)
      Retrieve the 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.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId, java.lang.String connectorTypeGUID)
      Retrieve the connector type metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements with a matching qualified name, display name or connector provider class name.
      EndpointElement getEndpointByGUID​(java.lang.String userId, java.lang.String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name.
      void removeConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID)
      Remove the metadata element representing a connection.
      void removeEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String endpointGUID)
      Remove the metadata element representing a endpoint.
      void setupAssetConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String assetGUID, java.lang.String assetSummary, java.lang.String connectionGUID)
      Create a relationship between an asset and its connection.
      void setupConnectorType​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Create a relationship between a connection and a connector type.
      void setupEmbeddedConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, int position, java.lang.String displayName, java.util.Map<java.lang.String,​java.lang.Object> arguments, java.lang.String embeddedConnectionGUID)
      Create a relationship between a virtual connection and an embedded connection.
      void setupEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, java.lang.String endpointGUID)
      Create a relationship between a connection and an endpoint.
      void updateConnection​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, java.lang.String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)
      Update the metadata element representing a connection.
      void updateEndpoint​(java.lang.String userId, java.lang.String dataManagerGUID, java.lang.String dataManagerName, boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing a endpoint.
      • 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,
                                       DataManagerRESTClient restClient,
                                       int maxPageSize,
                                       AuditLog auditLog)
                                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
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.