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 Summary
Modifier and TypeMethodDescriptiondeleteByFeed(String feedName, String rawItemType) Deletes all items originating from the data feed and raw item type specifiedDeletes item with an integration key comprised of the specified primary keys, originating from the data feed and raw item type specifiedDeletes item with an integration key comprised of the specified primary keys, of the type specified, in the pool specified on the Data Hub serverexportData(String[] csvContent, String dataFeed, String rawItemType)
-
Method Details
-
exportData
ResultData exportData(String[] csvContent, String dataFeed, String rawItemType) throws DataHubOutboundException - Parameters:
csvContent- the CSV contentdataFeed- the name of the data feedrawItemType- the raw item type- Returns:
- the result of the export
- Throws:
DataHubCommunicationException- if communication with the Data Hub server failedDataHubOutboundException- 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 DataHubOutboundExceptionDeletes 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 incanonicalItemType- type code for the canonical item to deletekeyFields- 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 occursDataHubCommunicationException- if communication with the Data Hub server failedDataHubOutboundException- if the Data Hub server was unable to successfully complete the delete operation
-
deleteByFeed
Deletes all items originating from the data feed and raw item type specified- Parameters:
feedName- Name of the data feed the items originated fromrawItemType- 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 occursDataHubCommunicationException- if communication with the Data Hub server failedDataHubOutboundException- 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 DataHubOutboundExceptionDeletes 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 fromrawItemType- Name of the raw item type the items originated fromkeyFields- 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 occursDataHubCommunicationException- if communication with the Data Hub server failedDataHubOutboundException- if the Data Hub server was unable to successfully complete the export operation
-