org.finra.herd.service.helper

Class S3KeyPrefixHelper

java.lang.Object

org.finra.herd.service.helper.S3KeyPrefixHelper

@Component
public class S3KeyPrefixHelper
extends Object

A helper class for S3 key prefix related code.

Constructor Summary

Constructors

Constructor and Description
S3KeyPrefixHelper()

Method Summary

Modifier and Type	Method and Description
String	buildS3KeyPrefix(StorageEntity storageEntity, BusinessObjectDefinitionKey businessObjectDefinitionKey) Build S3 key prefix for business object definition key
String	buildS3KeyPrefix(StorageEntity storageEntity, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataKey businessObjectDataKey) Returns the S3 object key prefix based on the given storage, business object format and business object data key.
String	buildS3KeyPrefix(String s3KeyPrefixVelocityTemplate, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataKey businessObjectDataKey, String storageName) Returns the S3 object key prefix based on the given velocity template, business object format and business object data key.
String	buildS3KeyPrefix(String s3KeyPrefixVelocityTemplate, String dataProviderName, BusinessObjectFormat businessObjectFormat, BusinessObjectDataKey businessObjectDataKey, String storageName) Returns S3 key prefix constructed per specified velocity template.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3KeyPrefixHelper

public S3KeyPrefixHelper()

Method Detail

buildS3KeyPrefix

public String buildS3KeyPrefix(StorageEntity storageEntity,
                               BusinessObjectFormatEntity businessObjectFormatEntity,
                               BusinessObjectDataKey businessObjectDataKey)

Returns the S3 object key prefix based on the given storage, business object format and business object data key.

Parameters:

storageEntity - the storage entity

businessObjectFormatEntity - the business object format entity

businessObjectDataKey - the business object data key

Returns:

the S3 key prefix

buildS3KeyPrefix

public String buildS3KeyPrefix(String s3KeyPrefixVelocityTemplate,
                               BusinessObjectFormatEntity businessObjectFormatEntity,
                               BusinessObjectDataKey businessObjectDataKey,
                               String storageName)

Returns the S3 object key prefix based on the given velocity template, business object format and business object data key.

Parameters:

s3KeyPrefixVelocityTemplate - the S3 key prefix velocity template, not null

businessObjectFormatEntity - the business object format entity

businessObjectDataKey - the business object data key

storageName - the storage name

Returns:

the S3 key prefix

buildS3KeyPrefix

public String buildS3KeyPrefix(String s3KeyPrefixVelocityTemplate,
                               String dataProviderName,
                               BusinessObjectFormat businessObjectFormat,
                               BusinessObjectDataKey businessObjectDataKey,
                               String storageName)

Returns S3 key prefix constructed per specified velocity template.

Parameters:

s3KeyPrefixVelocityTemplate - the S3 key prefix velocity template,

dataProviderName - the data provider name

businessObjectFormat - the business object format

businessObjectDataKey - the business object data key

storageName - the storage name

Returns:

the S3 key prefix

buildS3KeyPrefix

public String buildS3KeyPrefix(StorageEntity storageEntity,
                               BusinessObjectDefinitionKey businessObjectDefinitionKey)

Build S3 key prefix for business object definition key

Parameters:

storageEntity - storage entity

businessObjectDefinitionKey - business object definition key

Returns:

S3KeyPrefix