Interface ManageConnections

  • All Known Implementing Classes:
    ConnectionManager

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearAssetConnection​(java.lang.String userId, java.lang.String assetGUID, java.lang.String connectionGUID)
      Remove a relationship between an asset and its connection.
      void clearConnectorType​(java.lang.String userId, 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 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 connectionGUID, java.lang.String endpointGUID)
      Remove a relationship between a connection and an endpoint.
      java.lang.String createConnection​(java.lang.String userId, ConnectionProperties connectionProperties)
      Create a new metadata element to represent the connection.
      java.lang.String createConnectionFromTemplate​(java.lang.String userId, 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 createConnectorType​(java.lang.String userId, ConnectorTypeProperties connectorTypeProperties)
      Create a new metadata element to represent the root of a connectorType.
      java.lang.String createConnectorTypeFromTemplate​(java.lang.String userId, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a connectorType using an existing metadata element as a template.
      java.lang.String createEndpoint​(java.lang.String userId, EndpointProperties endpointProperties)
      Create a new metadata element to represent the endpoint.
      java.lang.String createEndpointFromTemplate​(java.lang.String userId, java.lang.String networkAddress, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a endpoint using an existing metadata element as a template.
      java.util.List<ConnectionElement> findConnections​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of asset metadata elements that contain the search string.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements that contain the search string.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string.
      ConnectionElement getConnectionByGUID​(java.lang.String userId, java.lang.String connectionGUID)
      Retrieve the connection metadata element with the supplied unique identifier.
      java.util.List<ConnectionElement> getConnectionsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of asset metadata elements with a matching qualified or display name.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId, java.lang.String connectorTypeGUID)
      Retrieve the connectorType metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements with a matching qualified or display name.
      EndpointElement getEndpointByGUID​(java.lang.String userId, java.lang.String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name.
      void removeConnection​(java.lang.String userId, java.lang.String connectionGUID)
      Remove the metadata element representing a connection.
      void removeConnectorType​(java.lang.String userId, java.lang.String connectorTypeGUID)
      Remove the metadata element representing a connectorType.
      void removeEndpoint​(java.lang.String userId, java.lang.String endpointGUID)
      Remove the metadata element representing a endpoint.
      void setupAssetConnection​(java.lang.String userId, 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 connectionGUID, java.lang.String connectorTypeGUID)
      Create a relationship between a connection and a connector type.
      void setupEmbeddedConnection​(java.lang.String userId, 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 connectionGUID, java.lang.String endpointGUID)
      Create a relationship between a connection and an endpoint.
      void updateConnection​(java.lang.String userId, java.lang.String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)
      Update the metadata element representing a connection.
      void updateConnectorType​(java.lang.String userId, boolean isMergeUpdate, java.lang.String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties)
      Update the metadata element representing a connectorType.
      void updateEndpoint​(java.lang.String userId, boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing a endpoint.