org.finra.herd.tools.downloader

Class DownloaderWebClient

java.lang.Object

org.finra.herd.tools.common.databridge.DataBridgeWebClient

org.finra.herd.tools.downloader.DownloaderWebClient

@Component
public class DownloaderWebClient
extends DataBridgeWebClient

This class encapsulates web client functionality required to communicate with the herd registration service.

Field Summary

Fields inherited from class org.finra.herd.tools.common.databridge.DataBridgeWebClient

DEFAULT_ACCEPT, DEFAULT_CONTENT_TYPE, HERD_APP_REST_URI_PREFIX, herdStringHelper, httpClientOperations, regServerAccessParamsDto

Constructor Summary

Constructors

Constructor and Description
DownloaderWebClient()

Method Summary

Modifier and Type	Method and Description
BusinessObjectData	getBusinessObjectData(DownloaderInputManifestDto manifest) Retrieves business object data from the herd registration server.
S3KeyPrefixInformation	getS3KeyPrefix(BusinessObjectData businessObjectData) Retrieves S3 key prefix from the herd registration server.
StorageUnitDownloadCredential	getStorageUnitDownloadCredential(DownloaderInputManifestDto manifest, String storageName) Gets the storage unit download credentials.

Methods inherited from class org.finra.herd.tools.common.databridge.DataBridgeWebClient

addStorageFiles, getAuthorizationHeader, getBusinessObjectData, getBusinessObjectDataStorageFilesCreateResponse, getRegServerAccessParamsDto, getS3KeyPrefix, getStorage, getUriScheme, preRegisterBusinessObjectData, processXmlHttpResponse, setRegServerAccessParamsDto, updateBusinessObjectDataStatus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DownloaderWebClient

public DownloaderWebClient()

Method Detail

getS3KeyPrefix

public S3KeyPrefixInformation getS3KeyPrefix(BusinessObjectData businessObjectData)
                                      throws IOException,
                                             JAXBException,
                                             URISyntaxException

Retrieves S3 key prefix from the herd registration server.

Parameters:

businessObjectData - the business object data

Returns:

the S3 key prefix

Throws:

JAXBException - if a JAXB error was encountered.

IOException - if an I/O error was encountered.

URISyntaxException - if a URI syntax error was encountered.

getBusinessObjectData

public BusinessObjectData getBusinessObjectData(DownloaderInputManifestDto manifest)
                                         throws IOException,
                                                JAXBException,
                                                URISyntaxException

Retrieves business object data from the herd registration server.

Parameters:

manifest - the downloader input manifest file information

Returns:

the business object data information

Throws:

JAXBException - if a JAXB error was encountered.

IOException - if an I/O error was encountered.

URISyntaxException - if a URI syntax error was encountered.

getStorageUnitDownloadCredential

public StorageUnitDownloadCredential getStorageUnitDownloadCredential(DownloaderInputManifestDto manifest,
                                                                      String storageName)
                                                               throws URISyntaxException,
                                                                      IOException,
                                                                      JAXBException

Gets the storage unit download credentials.

Parameters:

manifest - The manifest

storageName - The storage name

Returns:

StorageUnitDownloadCredential

Throws:

URISyntaxException - When error occurs while URI creation

IOException - When error occurs communicating with server

JAXBException - When error occurs parsing XML