org.finra.herd.tools.uploader

Class UploaderWebClient

java.lang.Object

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

org.finra.herd.tools.uploader.UploaderWebClient

@Component
public class UploaderWebClient
extends DataBridgeWebClient

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

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
UploaderWebClient()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataUploadCredential	getBusinessObjectDataUploadCredential(DataBridgeBaseManifestDto manifest, String storageName, Integer businessObjectDataVersion, Boolean createNewVersion) Gets the business object data upload credentials.
BusinessObjectDataVersions	getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey) Retrieves all versions for the specified business object data key.
protected BusinessObjectDataVersions	getBusinessObjectDataVersions(org.apache.http.client.methods.CloseableHttpResponse httpResponse) Extracts BusinessObjectDataVersions object from the registration server HTTP response.
void	updateBusinessObjectDataStatusIgnoreException(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Updates the business object data status.

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

UploaderWebClient

public UploaderWebClient()

Method Detail

getBusinessObjectDataUploadCredential

public BusinessObjectDataUploadCredential getBusinessObjectDataUploadCredential(DataBridgeBaseManifestDto manifest,
                                                                                String storageName,
                                                                                Integer businessObjectDataVersion,
                                                                                Boolean createNewVersion)
                                                                         throws URISyntaxException,
                                                                                IOException,
                                                                                JAXBException

Gets the business object data upload credentials.

Parameters:

manifest - the manifest

storageName - the storage name

businessObjectDataVersion - the version of the business object data

createNewVersion - specifies to provide credentials fof the next business object data version

Returns:

BusinessObjectDataUploadCredential

Throws:

URISyntaxException - When error occurs while URI creation

IOException - When error occurs communicating with server

JAXBException - When error occurs parsing the XML

getBusinessObjectDataVersions

public BusinessObjectDataVersions getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey)
                                                         throws URISyntaxException,
                                                                IOException,
                                                                JAXBException

Retrieves all versions for the specified business object data key.

Parameters:

businessObjectDataKey - the business object data key

Returns:

BusinessObjectDataVersions

Throws:

URISyntaxException - When error occurs while URI creation

IOException - When error occurs communicating with server

JAXBException - When error occurs parsing the XML

updateBusinessObjectDataStatusIgnoreException

public void updateBusinessObjectDataStatusIgnoreException(BusinessObjectDataKey businessObjectDataKey,
                                                          String businessObjectDataStatus)

Updates the business object data status. This method does not fail in case business object data status update is unsuccessful, but simply logs the exception information as a warning.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataStatus - the status of the business object data

getBusinessObjectDataVersions

protected BusinessObjectDataVersions getBusinessObjectDataVersions(org.apache.http.client.methods.CloseableHttpResponse httpResponse)

Extracts BusinessObjectDataVersions object from the registration server HTTP response.

Parameters:

httpResponse - the response received from the supported options.

Returns:

the BusinessObjectDataVersions object extracted from the registration server response.