com.github.ambry.cloud

Class CloudBlobMetadata

java.lang.Object

com.github.ambry.cloud.CloudBlobMetadata

public class CloudBlobMetadata
extends java.lang.Object

Blob metadata document POJO class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudBlobMetadata.EncryptionOrigin Possible values of encryption origin for cloud stored blobs.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_ACCOUNT_ID
static java.lang.String	FIELD_CLOUD_BLOB_NAME
static java.lang.String	FIELD_CONTAINER_ID
static java.lang.String	FIELD_CREATION_TIME
static java.lang.String	FIELD_CRYPTO_AGENT_FACTORY
static java.lang.String	FIELD_DELETION_TIME
static java.lang.String	FIELD_ENCRYPTION_ORIGIN
static java.lang.String	FIELD_EXPIRATION_TIME
static java.lang.String	FIELD_UPLOAD_TIME
static java.lang.String	FIELD_VCR_KMS_CONTEXT

Constructor Summary

Constructors

Constructor and Description
CloudBlobMetadata() Default constructor (for JSONSerializer).
CloudBlobMetadata(com.github.ambry.commons.BlobId blobId, long creationTime, long expirationTime, long size, CloudBlobMetadata.EncryptionOrigin encryptionOrigin) Constructor from BlobId.
CloudBlobMetadata(com.github.ambry.commons.BlobId blobId, long creationTime, long expirationTime, long size, CloudBlobMetadata.EncryptionOrigin encryptionOrigin, java.lang.String vcrKmsContext, java.lang.String cryptoAgentFactory, long encryptedSize) Constructor from BlobId.

Method Summary

Modifier and Type	Method and Description
static java.util.List<CloudBlobMetadata>	capMetadataListBySize(java.util.List<CloudBlobMetadata> originalList, long size) Utility to cap specified CloudBlobMetadata list by specified size of its blobs.
boolean	equals(java.lang.Object o)
int	getAccountId()
java.lang.String	getCloudBlobName()
int	getContainerId()
long	getCreationTime()
java.lang.String	getCryptoAgentFactory()
long	getDeletionTime()
long	getEncryptedSize()
CloudBlobMetadata.EncryptionOrigin	getEncryptionOrigin()
long	getExpirationTime()
java.lang.String	getId()
long	getLastUpdateTime()
java.lang.String	getPartitionId()
long	getSize()
long	getUploadTime()
java.lang.String	getVcrKmsContext()
CloudBlobMetadata	setAccountId(int accountId) Set the account Id.
CloudBlobMetadata	setCloudBlobName(java.lang.String cloudBlobName) Sets blob's name in cloud.
CloudBlobMetadata	setContainerId(int containerId) Set the container Id.
CloudBlobMetadata	setCreationTime(long creationTime) Set the creation time.
CloudBlobMetadata	setCryptoAgentFactory(java.lang.String cryptoAgentFactory) Sets the VCR crypto agent factory class name.
CloudBlobMetadata	setDeletionTime(long deletionTime) Set the blob deletion time.
CloudBlobMetadata	setEncryptedSize(long encryptedSize) Sets the encrypted size of the blob
CloudBlobMetadata	setEncryptionOrigin(CloudBlobMetadata.EncryptionOrigin encryptionOrigin) Sets the encryption origin.
CloudBlobMetadata	setExpirationTime(long expirationTime) Set the blob expiration time.
CloudBlobMetadata	setId(java.lang.String id)
void	setLastUpdateTime(long lastUpdateTime) Sets the last update time of the blob.
CloudBlobMetadata	setPartitionId(java.lang.String partitionId) Set the partition Id.
CloudBlobMetadata	setSize(long size) Set the size.
CloudBlobMetadata	setUploadTime(long uploadTime) Set the upload time.
CloudBlobMetadata	setVcrKmsContext(java.lang.String vcrKmsContext) Sets the VCR KMS context.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_CREATION_TIME

public static final java.lang.String FIELD_CREATION_TIME

See Also:

Constant Field Values

FIELD_UPLOAD_TIME

public static final java.lang.String FIELD_UPLOAD_TIME

See Also:

Constant Field Values

FIELD_DELETION_TIME

public static final java.lang.String FIELD_DELETION_TIME

See Also:

Constant Field Values

FIELD_EXPIRATION_TIME

public static final java.lang.String FIELD_EXPIRATION_TIME

See Also:

Constant Field Values

FIELD_ACCOUNT_ID

public static final java.lang.String FIELD_ACCOUNT_ID

See Also:

Constant Field Values

FIELD_CONTAINER_ID

public static final java.lang.String FIELD_CONTAINER_ID

See Also:

Constant Field Values

FIELD_ENCRYPTION_ORIGIN

public static final java.lang.String FIELD_ENCRYPTION_ORIGIN

See Also:

Constant Field Values

FIELD_VCR_KMS_CONTEXT

public static final java.lang.String FIELD_VCR_KMS_CONTEXT

See Also:

Constant Field Values

FIELD_CRYPTO_AGENT_FACTORY

public static final java.lang.String FIELD_CRYPTO_AGENT_FACTORY

See Also:

Constant Field Values

FIELD_CLOUD_BLOB_NAME

public static final java.lang.String FIELD_CLOUD_BLOB_NAME

See Also:

Constant Field Values

Constructor Detail

CloudBlobMetadata

public CloudBlobMetadata()

Default constructor (for JSONSerializer).

CloudBlobMetadata

public CloudBlobMetadata(com.github.ambry.commons.BlobId blobId,
                         long creationTime,
                         long expirationTime,
                         long size,
                         CloudBlobMetadata.EncryptionOrigin encryptionOrigin)

Constructor from BlobId.

Parameters:

blobId - The BlobId for metadata record.

creationTime - The blob creation time.

expirationTime - The blob expiration time.

size - The blob size.

encryptionOrigin - The blob's encryption origin.

CloudBlobMetadata

public CloudBlobMetadata(com.github.ambry.commons.BlobId blobId,
                         long creationTime,
                         long expirationTime,
                         long size,
                         CloudBlobMetadata.EncryptionOrigin encryptionOrigin,
                         java.lang.String vcrKmsContext,
                         java.lang.String cryptoAgentFactory,
                         long encryptedSize)

Constructor from BlobId.

Parameters:

blobId - The BlobId for metadata record.

creationTime - The blob creation time.

expirationTime - The blob expiration time.

size - The blob size.

encryptionOrigin - The blob's encryption origin.

vcrKmsContext - The KMS context used to encrypt the blob. Only used when encryptionOrigin = VCR.

cryptoAgentFactory - The class name of the CloudBlobCryptoAgentFactory used to encrypt the blob. Only used when encryptionOrigin = VCR.

encryptedSize - The size of the uploaded blob if it was encrypted and then uploaded. Only used when encryptionOrigin = VCR.

Method Detail

getId

public java.lang.String getId()

Returns:

the blob Id.

setId

public CloudBlobMetadata setId(java.lang.String id)

getPartitionId

public java.lang.String getPartitionId()

Returns:

the partition Id.

setPartitionId

public CloudBlobMetadata setPartitionId(java.lang.String partitionId)

Set the partition Id.

Parameters:

partitionId - the partition Id of the blob.

Returns:

this instance.

getCreationTime

public long getCreationTime()

Returns:

the blob creation time.

setCreationTime

public CloudBlobMetadata setCreationTime(long creationTime)

Set the creation time.

Parameters:

creationTime - the creation time of the blob.

Returns:

this instance.

getUploadTime

public long getUploadTime()

Returns:

the blob upload time.

setUploadTime

public CloudBlobMetadata setUploadTime(long uploadTime)

Set the upload time.

Parameters:

uploadTime - the upload time of the blob.

Returns:

this instance.

getExpirationTime

public long getExpirationTime()

Returns:

the blob expiration time.

setExpirationTime

public CloudBlobMetadata setExpirationTime(long expirationTime)

Set the blob expiration time.

Parameters:

expirationTime - the expiration time of the blob.

Returns:

this instance.

getDeletionTime

public long getDeletionTime()

Returns:

the blob deletion time.

setDeletionTime

public CloudBlobMetadata setDeletionTime(long deletionTime)

Set the blob deletion time.

Parameters:

deletionTime - the deletion time of the blob.

Returns:

this instance.

getSize

public long getSize()

Returns:

the blob size.

setSize

public CloudBlobMetadata setSize(long size)

Set the size.

Parameters:

size - the size of the blob in bytes.

Returns:

this instance.

getAccountId

public int getAccountId()

Returns:

the account Id.

setAccountId

public CloudBlobMetadata setAccountId(int accountId)

Set the account Id.

Parameters:

accountId - the account Id of the blob.

Returns:

this instance.

getContainerId

public int getContainerId()

Returns:

the container Id.

setContainerId

public CloudBlobMetadata setContainerId(int containerId)

Set the container Id.

Parameters:

containerId - the container Id of the blob.

Returns:

this instance.

getEncryptionOrigin

public CloudBlobMetadata.EncryptionOrigin getEncryptionOrigin()

Returns:

the CloudBlobMetadata.EncryptionOrigin.

setEncryptionOrigin

public CloudBlobMetadata setEncryptionOrigin(CloudBlobMetadata.EncryptionOrigin encryptionOrigin)

Sets the encryption origin.

Parameters:

encryptionOrigin - the CloudBlobMetadata.EncryptionOrigin.

Returns:

this instance.

getVcrKmsContext

public java.lang.String getVcrKmsContext()

Returns:

the VCR KMS context.

setVcrKmsContext

public CloudBlobMetadata setVcrKmsContext(java.lang.String vcrKmsContext)

Sets the VCR KMS context.

Parameters:

vcrKmsContext - the KMS context used for encryption.

Returns:

this instance.

getCloudBlobName

public java.lang.String getCloudBlobName()

Returns:

the blob's name in cloud.

setCloudBlobName

public CloudBlobMetadata setCloudBlobName(java.lang.String cloudBlobName)

Sets blob's name in cloud.

Parameters:

cloudBlobName - the blob's name in cloud.

Returns:

this instance.

getCryptoAgentFactory

public java.lang.String getCryptoAgentFactory()

Returns:

the VCR crypto agent factory class name.

setCryptoAgentFactory

public CloudBlobMetadata setCryptoAgentFactory(java.lang.String cryptoAgentFactory)

Sets the VCR crypto agent factory class name.

Parameters:

cryptoAgentFactory - the class name of the CloudBlobCryptoAgentFactory used for encryption.

Returns:

this instance.

getEncryptedSize

public long getEncryptedSize()

Returns:

the encrypted size of the blob if the blob was encrypted and uploaded to cloud, -1 otherwise

setEncryptedSize

public CloudBlobMetadata setEncryptedSize(long encryptedSize)

Sets the encrypted size of the blob

Parameters:

encryptedSize -

getLastUpdateTime

public long getLastUpdateTime()

Returns:

the last update time of the blob.

setLastUpdateTime

public void setLastUpdateTime(long lastUpdateTime)

Sets the last update time of the blob.

Parameters:

lastUpdateTime - last update time.

capMetadataListBySize

public static java.util.List<CloudBlobMetadata> capMetadataListBySize(java.util.List<CloudBlobMetadata> originalList,
                                                                      long size)

Utility to cap specified CloudBlobMetadata list by specified size of its blobs. Always returns at least one metadata object irrespective of size.

Parameters:

originalList - List of CloudBlobMetadata.

size - total size of metadata's blobs.

Returns:

List of CloudBlobMetadata capped by size.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object