org.finra.herd.tools.common.databridge

Class DataBridgeWebClient

java.lang.Object

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

Direct Known Subclasses:

DownloaderWebClient, RetentionExpirationDestroyerWebClient, UploaderWebClient

public abstract class DataBridgeWebClient
extends Object

A base class for the uploader and downloader web client.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_ACCEPT
protected static String	DEFAULT_CONTENT_TYPE
protected static String	HERD_APP_REST_URI_PREFIX
protected HerdStringHelper	herdStringHelper
protected HttpClientHelper	httpClientHelper
protected HttpClientOperations	httpClientOperations
protected RegServerAccessParamsDto	regServerAccessParamsDto The DTO for the parameters required to communicate with the registration server.

Constructor Summary

Constructors

Constructor and Description
DataBridgeWebClient()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataStorageFilesCreateResponse	addStorageFiles(BusinessObjectDataKey businessObjectDataKey, UploaderInputManifestDto manifest, S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto, String storageName) Calls the registration server to add storage files to the business object data.
protected org.apache.http.message.BasicHeader	getAuthorizationHeader() Returns an authorization header required for HTTPS client authentication with the registration server.
protected BusinessObjectData	getBusinessObjectData(org.apache.http.client.methods.CloseableHttpResponse httpResponse, String actionDescription) Extracts BusinessObjectData object from the registration server HTTP response.
protected BusinessObjectDataStorageFilesCreateResponse	getBusinessObjectDataStorageFilesCreateResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse) Extracts BusinessObjectDataStorageFilesCreateResponse object from the registration server HTTP response.
RegServerAccessParamsDto	getRegServerAccessParamsDto() Returns the Registration Server Access Parameters DTO.
protected S3KeyPrefixInformation	getS3KeyPrefix(DataBridgeBaseManifestDto manifest, Integer businessObjectDataVersion, Boolean createNewVersion) Retrieves S3 key prefix from the registration server.
Storage	getStorage(String storageName) Gets storage information from the registration server.
protected String	getUriScheme() Returns an URI scheme.
BusinessObjectData	preRegisterBusinessObjectData(UploaderInputManifestDto manifest, String storageName, Boolean createNewVersion) Pre-registers business object data with the registration server.
protected Object	processXmlHttpResponse(org.apache.http.client.methods.CloseableHttpResponse response, String actionDescription, Class<?>... responseClass) Extracts an instance of the specified object class from the registration server response.
void	setRegServerAccessParamsDto(RegServerAccessParamsDto regServerAccessParamsDto) Sets the Registration Server Access Parameters DTO.
BusinessObjectDataStatusUpdateResponse	updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Updates the business object data status.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACCEPT

protected static final String DEFAULT_ACCEPT

DEFAULT_CONTENT_TYPE

protected static final String DEFAULT_CONTENT_TYPE

HERD_APP_REST_URI_PREFIX

protected static final String HERD_APP_REST_URI_PREFIX

See Also:

Constant Field Values

herdStringHelper

@Autowired
protected HerdStringHelper herdStringHelper

httpClientHelper

@Autowired
protected HttpClientHelper httpClientHelper

httpClientOperations

@Autowired
protected HttpClientOperations httpClientOperations

regServerAccessParamsDto

protected RegServerAccessParamsDto regServerAccessParamsDto

The DTO for the parameters required to communicate with the registration server.

Constructor Detail

DataBridgeWebClient

public DataBridgeWebClient()

Method Detail

addStorageFiles

public BusinessObjectDataStorageFilesCreateResponse addStorageFiles(BusinessObjectDataKey businessObjectDataKey,
                                                                    UploaderInputManifestDto manifest,
                                                                    S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto,
                                                                    String storageName)
                                                             throws IOException,
                                                                    JAXBException,
                                                                    URISyntaxException,
                                                                    NoSuchAlgorithmException,
                                                                    KeyStoreException,
                                                                    KeyManagementException

Calls the registration server to add storage files to the business object data.

Parameters:

businessObjectDataKey - the business object data key

manifest - the uploader input manifest file

s3FileTransferRequestParamsDto - the S3 file transfer request parameters to be used to retrieve local path and S3 key prefix values

storageName - the storage name

Returns:

the business object data create storage files response turned by the registration server.

Throws:

IOException - if an I/O error was encountered

JAXBException - if a JAXB error was encountered

URISyntaxException - if a URI syntax error was encountered

KeyStoreException - if a key store exception occurs

NoSuchAlgorithmException - if a no such algorithm exception occurs

KeyManagementException - if key management exception

getRegServerAccessParamsDto

public RegServerAccessParamsDto getRegServerAccessParamsDto()

Returns the Registration Server Access Parameters DTO.

Returns:

the DTO for the parameters required to communicate with the registration server

setRegServerAccessParamsDto

public void setRegServerAccessParamsDto(RegServerAccessParamsDto regServerAccessParamsDto)

Sets the Registration Server Access Parameters DTO.

Parameters:

regServerAccessParamsDto - the DTO for the parameters required to communicate with the registration server

getStorage

public Storage getStorage(String storageName)
                   throws IOException,
                          JAXBException,
                          URISyntaxException,
                          NoSuchAlgorithmException,
                          KeyStoreException,
                          KeyManagementException

Gets storage information from the registration server.

Parameters:

storageName - the storage name

Returns:

the storage information

Throws:

IOException - if an I/O error was encountered

JAXBException - if a JAXB error was encountered

URISyntaxException - if a URI syntax error was encountered

KeyStoreException - if a key store exception occurs

NoSuchAlgorithmException - if a no such algorithm exception occurs

KeyManagementException - if key management exception

preRegisterBusinessObjectData

public BusinessObjectData preRegisterBusinessObjectData(UploaderInputManifestDto manifest,
                                                        String storageName,
                                                        Boolean createNewVersion)
                                                 throws IOException,
                                                        JAXBException,
                                                        URISyntaxException,
                                                        NoSuchAlgorithmException,
                                                        KeyStoreException,
                                                        KeyManagementException

Pre-registers business object data with the registration server.

Parameters:

manifest - the uploader input manifest file

storageName - the storage name

createNewVersion - if not set, only initial version of the business object data is allowed to be created

Returns:

the business object data returned by the registration server.

Throws:

IOException - if an I/O error was encountered

JAXBException - if a JAXB error was encountered

URISyntaxException - if a URI syntax error was encountered

KeyStoreException - if a key store exception occurs

NoSuchAlgorithmException - if a no such algorithm exception occurs

KeyManagementException - if key management exception

updateBusinessObjectDataStatus

public BusinessObjectDataStatusUpdateResponse updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey,
                                                                             String businessObjectDataStatus)
                                                                      throws URISyntaxException,
                                                                             IOException,
                                                                             JAXBException,
                                                                             NoSuchAlgorithmException,
                                                                             KeyStoreException,
                                                                             KeyManagementException

Updates the business object data status.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataStatus - the status of the business object data

Returns:

BusinessObjectDataStatusUpdateResponse

Throws:

URISyntaxException - if error occurs while URI creation

IOException - if error occurs communicating with server

JAXBException - if error occurs parsing the XML

KeyStoreException - if a key store exception occurs

NoSuchAlgorithmException - if a no such algorithm exception occurs

KeyManagementException - if key management exception

getAuthorizationHeader

protected org.apache.http.message.BasicHeader getAuthorizationHeader()

Returns an authorization header required for HTTPS client authentication with the registration server.

Returns:

the authorization header

getBusinessObjectData

protected BusinessObjectData getBusinessObjectData(org.apache.http.client.methods.CloseableHttpResponse httpResponse,
                                                   String actionDescription)

Extracts BusinessObjectData object from the registration server HTTP response.

Parameters:

httpResponse - the response received from the supported options.

actionDescription - the description of the action being performed with the registration server (to be used in an error message).

Returns:

the BusinessObjectData object extracted from the registration server response.

getBusinessObjectDataStorageFilesCreateResponse

protected BusinessObjectDataStorageFilesCreateResponse getBusinessObjectDataStorageFilesCreateResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse)

Extracts BusinessObjectDataStorageFilesCreateResponse object from the registration server HTTP response.

Parameters:

httpResponse - the response received from the supported options.

Returns:

the BusinessObjectData object extracted from the registration server response.

getS3KeyPrefix

protected S3KeyPrefixInformation getS3KeyPrefix(DataBridgeBaseManifestDto manifest,
                                                Integer businessObjectDataVersion,
                                                Boolean createNewVersion)
                                         throws IOException,
                                                JAXBException,
                                                URISyntaxException,
                                                NoSuchAlgorithmException,
                                                KeyStoreException,
                                                KeyManagementException

Retrieves S3 key prefix from the registration server.

Parameters:

manifest - the manifest file information

businessObjectDataVersion - the business object data version (optional)

createNewVersion - if not set, only initial version of the business object data is allowed to be created. This parameter is ignored, when the business object data version is specified.

Returns:

the S3 key prefix

Throws:

IOException - if an I/O error was encountered

JAXBException - if a JAXB error was encountered

URISyntaxException - if a URI syntax error was encountered

KeyStoreException - if a key store exception occurs

NoSuchAlgorithmException - if a no such algorithm exception occurs

KeyManagementException - if key management exception

getUriScheme

protected String getUriScheme()

Returns an URI scheme.

processXmlHttpResponse

protected Object processXmlHttpResponse(org.apache.http.client.methods.CloseableHttpResponse response,
                                        String actionDescription,
                                        Class<?>... responseClass)

Extracts an instance of the specified object class from the registration server response.

Parameters:

response - the HTTP response received from the registration server.

actionDescription - the description of the action being performed with the registration server (to be used in an error message).

responseClass - the class of the object expected to be returned by the registration server.

Returns:

the BusinessObjectData object extracted from the registration server response.