org.finra.herd.service.helper

Class StorageHelper

java.lang.Object

org.finra.herd.service.helper.StorageHelper

@Component
public class StorageHelper
extends Object

A helper class for Storage related code.

Field Summary

Fields

Modifier and Type	Field and Description
protected StsDao	stsDao

Constructor Summary

Constructors

Constructor and Description
StorageHelper()

Method Summary

Modifier and Type	Method and Description
boolean	getBooleanStorageAttributeValueByName(String attributeName, StorageEntity storageEntity, boolean attributeRequired, boolean attributeValueRequiredIfExists) Gets attribute value by name from the storage entity and returns it as a boolean.
S3FileTransferRequestParamsDto	getS3BucketAccessParams(StorageEntity storageEntity) Returns a new instance of S3FileTransferRequestParamsDto populated with all parameters, required to access an S3 bucket.
S3FileCopyRequestParamsDto	getS3FileCopyRequestParamsDto() Returns a new org.finra.herd.model.dto.S3FileCopyRequestParamsDto with proxy host and port populated from the configuration.
S3FileTransferRequestParamsDto	getS3FileTransferRequestParamsDto() Returns a new S3FileTransferRequestParamsDto with proxy host and port populated from the configuration.
S3FileTransferRequestParamsDto	getS3FileTransferRequestParamsDtoByRole(String roleArn, String sessionName) Returns a new S3FileTransferRequestParamsDto with temporary credentials as per specified AWS role and session name.
Integer	getStorageAttributeIntegerValueByName(String attributeName, StorageEntity storageEntity, boolean attributeRequired, boolean attributeValueRequiredIfExists) Gets a storage attribute value by name.
Integer	getStorageAttributeIntegerValueByName(String attributeName, StorageEntity storageEntity, Integer defaultValue) Gets a storage attribute value by name.
String	getStorageAttributeValueByName(String attributeName, Storage storage, Boolean required) Gets attribute value by name from the storage object instance.
String	getStorageAttributeValueByName(String attributeName, StorageEntity storageEntity, boolean attributeValueRequired) Gets attribute value by name from the storage entity while specifying whether the attribute value is required (i.e.
String	getStorageAttributeValueByName(String attributeName, StorageEntity storageEntity, boolean attributeRequired, boolean attributeValueRequiredIfExists) Gets attribute value by name from the storage entity while specifying whether the attribute is required and whether the attribute value is required.
String	getStorageBucketName(StorageEntity storageEntity) Gets the storage's bucket name.
String	getStorageKmsKeyId(StorageEntity storageEntity) Gets the storage's KMS key ID.

Methods inherited from class java.lang.Object

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

Field Detail

stsDao

@Autowired
protected StsDao stsDao

Constructor Detail

StorageHelper

public StorageHelper()

Method Detail

getBooleanStorageAttributeValueByName

public boolean getBooleanStorageAttributeValueByName(String attributeName,
                                                     StorageEntity storageEntity,
                                                     boolean attributeRequired,
                                                     boolean attributeValueRequiredIfExists)
                                              throws IllegalStateException

Gets attribute value by name from the storage entity and returns it as a boolean. Most types of boolean strings are supported (e.g. true/false, on/off, yes/no, etc.).

Parameters:

attributeName - the attribute name (case insensitive)

storageEntity - the storage entity

attributeRequired - specifies whether the attribute is mandatory (i.e. whether it has a value or not).

attributeValueRequiredIfExists - specifies whether the attribute value is mandatory (i.e. the attribute must exist and its value must also contain a value).

Returns:

the attribute value from the attribute with the attribute name as a boolean. If no value is configured and the attribute isn't required, then false is returned.

Throws:

IllegalStateException - if an invalid storage attribute boolean value was configured.

getS3BucketAccessParams

public S3FileTransferRequestParamsDto getS3BucketAccessParams(StorageEntity storageEntity)

Returns a new instance of S3FileTransferRequestParamsDto populated with all parameters, required to access an S3 bucket.

Parameters:

storageEntity - the storage entity that contains attributes to access an S3 bucket

Returns:

the S3FileTransferRequestParamsDto instance that can be used to access S3 bucket

getS3FileCopyRequestParamsDto

public S3FileCopyRequestParamsDto getS3FileCopyRequestParamsDto()

Returns a new org.finra.herd.model.dto.S3FileCopyRequestParamsDto with proxy host and port populated from the configuration.

Returns:

org.finra.herd.model.dto.S3FileCopyRequestParamsDto with proxy host and port.

getS3FileTransferRequestParamsDto

public S3FileTransferRequestParamsDto getS3FileTransferRequestParamsDto()

Returns a new S3FileTransferRequestParamsDto with proxy host and port populated from the configuration.

Returns:

the S3FileTransferRequestParamsDto object

getS3FileTransferRequestParamsDtoByRole

public S3FileTransferRequestParamsDto getS3FileTransferRequestParamsDtoByRole(String roleArn,
                                                                              String sessionName)

Returns a new S3FileTransferRequestParamsDto with temporary credentials as per specified AWS role and session name.

Parameters:

roleArn - the ARN of the role

sessionName - the session name

Returns:

the S3FileTransferRequestParamsDto object

getStorageAttributeIntegerValueByName

public Integer getStorageAttributeIntegerValueByName(String attributeName,
                                                     StorageEntity storageEntity,
                                                     Integer defaultValue)

Gets a storage attribute value by name. If the attribute does not exist, returns the default value. If the attribute exists, and is defined, the value MUST be an integer, otherwise a exception is thrown.

Parameters:

attributeName - The name of attribute

storageEntity - The storage entity

defaultValue - The default value

Returns:

The integer value

getStorageAttributeIntegerValueByName

public Integer getStorageAttributeIntegerValueByName(String attributeName,
                                                     StorageEntity storageEntity,
                                                     boolean attributeRequired,
                                                     boolean attributeValueRequiredIfExists)
                                              throws IllegalStateException

Gets a storage attribute value by name. The value must be a valid integer, otherwise a validation error is thrown.

Parameters:

attributeName - the attribute name (case insensitive)

storageEntity - the storage entity

attributeRequired - specifies whether the attribute is mandatory (i.e. whether it has a value or not).

attributeValueRequiredIfExists - specifies whether the attribute value is mandatory (i.e. the attribute must exist and its value must also contain a value).

Returns:

the attribute value from the attribute with the attribute name.

Throws:

IllegalStateException - if the attribute is mandatory and this storage contains no attribute with this attribute name or the value is blank. This will produce a 500 HTTP status code error. If storage attributes are able to be updated by a REST invocation in the future, we might want to consider making this a 400 instead since the user has the ability to fix the issue on their own. Also throws when the value exists, but is not a valid integer.

getStorageAttributeValueByName

public String getStorageAttributeValueByName(String attributeName,
                                             Storage storage,
                                             Boolean required)

Gets attribute value by name from the storage object instance.

Parameters:

attributeName - the attribute name (case insensitive)

storage - the storage

required - specifies whether the attribute value is mandatory

Returns:

the attribute value from the attribute with the attribute name, or null if this list contains no attribute with this attribute name

getStorageAttributeValueByName

public String getStorageAttributeValueByName(String attributeName,
                                             StorageEntity storageEntity,
                                             boolean attributeValueRequired)
                                      throws IllegalArgumentException

Gets attribute value by name from the storage entity while specifying whether the attribute value is required (i.e. it must exist and must have a value configured). This is a convenience method when a value must be returned (i.e. the attribute must be configured and have a value present) or is totally optional (i.e. the attribute can not exist or it can exist and have a blank value).

Parameters:

attributeName - the attribute name (case insensitive)

storageEntity - the storage entity

attributeValueRequired - specifies whether the attribute value is mandatory

Returns:

the attribute value from the attribute with the attribute name.

Throws:

IllegalArgumentException - if the attribute is mandatory and this storage contains no attribute with this attribute name

getStorageAttributeValueByName

public String getStorageAttributeValueByName(String attributeName,
                                             StorageEntity storageEntity,
                                             boolean attributeRequired,
                                             boolean attributeValueRequiredIfExists)
                                      throws IllegalStateException

Gets attribute value by name from the storage entity while specifying whether the attribute is required and whether the attribute value is required.

Parameters:

attributeName - the attribute name (case insensitive)

storageEntity - the storage entity

attributeRequired - specifies whether the attribute is mandatory (i.e. whether it has a value or not).

attributeValueRequiredIfExists - specifies whether the attribute value is mandatory (i.e. the attribute must exist and its value must also contain a value).

Returns:

the attribute value from the attribute with the attribute name.

Throws:

IllegalStateException - if the attribute is mandatory and this storage contains no attribute with this attribute name or the value is blank.This will produce a 500 HTTP status code error. If storage attributes are able to be updated by a REST invocation in the future, we might want to consider making this a 400 instead since the user has the ability to fix the issue on their own.

getStorageBucketName

public String getStorageBucketName(StorageEntity storageEntity)

Gets the storage's bucket name. Throws if not defined.

Parameters:

storageEntity - the storage entity

Returns:

the S3 bucket name

getStorageKmsKeyId

public String getStorageKmsKeyId(StorageEntity storageEntity)

Gets the storage's KMS key ID. Throws if not defined.

Parameters:

storageEntity - the storage entity

Returns:

the KMS key ID