Interface DataHubOutboundClient

All Known Implementing Classes:
DefaultDataHubOutboundClient

public interface DataHubOutboundClient
A REST client to communicate to the Data Hub. Sends CSV Raw Item content to Data Hub
  • Method Details

    • exportData

      ResultData exportData(String[] csvContent, String dataFeed, String rawItemType) throws DataHubOutboundException
      Parameters:
      csvContent - the CSV content
      dataFeed - the name of the data feed
      rawItemType - the raw item type
      Returns:
      the result of the export
      Throws:
      DataHubCommunicationException - if communication with the Data Hub server failed
      DataHubOutboundException - if the Data Hub server was unable to successfully complete the export operation
    • deleteItem

      ResultData deleteItem(String poolName, String canonicalItemType, Map<String,String> keyFields) throws DataHubOutboundException
      Deletes item with an integration key comprised of the specified primary keys, of the type specified, in the pool specified on the Data Hub server
      Parameters:
      poolName - name of the data pool the item to be deleted resides in
      canonicalItemType - type code for the canonical item to delete
      keyFields - map of primary key attribute names and values to uniquely identify the item to be deleted
      Returns:
      the result of the deletion
      Throws:
      IllegalStateException - if exception communicating with the Data Hub occurs
      DataHubCommunicationException - if communication with the Data Hub server failed
      DataHubOutboundException - if the Data Hub server was unable to successfully complete the delete operation
    • deleteByFeed

      ResultData deleteByFeed(String feedName, String rawItemType) throws DataHubOutboundException
      Deletes all items originating from the data feed and raw item type specified
      Parameters:
      feedName - Name of the data feed the items originated from
      rawItemType - Name of the raw item type the items originated from
      Returns:
      the result of the deletion
      Throws:
      IllegalStateException - if exception communicating with the Data Hub occurs
      DataHubCommunicationException - if communication with the Data Hub server failed
      DataHubOutboundException - if the Data Hub server was unable to successfully complete the export operation
    • deleteByFeed

      ResultData deleteByFeed(String feedName, String rawItemType, Map<String,Object> keyFields) throws DataHubOutboundException
      Deletes item with an integration key comprised of the specified primary keys, originating from the data feed and raw item type specified
      Parameters:
      feedName - Name of the data feed the items originated from
      rawItemType - Name of the raw item type the items originated from
      keyFields - Map of primary key attribute names and values to uniquely identify the item to be deleted
      Returns:
      the result of the deletion
      Throws:
      IllegalStateException - if exception communicating with the Data Hub occurs
      DataHubCommunicationException - if communication with the Data Hub server failed
      DataHubOutboundException - if the Data Hub server was unable to successfully complete the export operation