com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption

Class EncryptionContext

java.lang.Object

com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionContext

public final class EncryptionContext
extends java.lang.Object

This class serves to provide additional useful data to EncryptionMaterialsProviders so they can more intelligently select the proper EncryptionMaterials or DecryptionMaterials for use. Any of the methods are permitted to return null.

For the simplest cases, all a developer needs to provide in the context are:

• TableName
• HashKeyName
• RangeKeyName (if present)

This class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncryptionContext.Builder Builder class for EncryptionContext.

Method Summary

Modifier and Type	Method and Description
static EncryptionContext.Builder	builder() Return a new builder that can be used to construct an EncryptionContext
java.util.Map<java.lang.String,software.amazon.awssdk.services.dynamodb.model.AttributeValue>	getAttributeValues() Returns the DynamoDB record about to be encrypted/decrypted.
java.lang.Object	getDeveloperContext() This object has no meaning (and will not be set or examined) by any core libraries.
java.lang.String	getHashKeyName() Returns the name of the HashKey attribute for the record to be encrypted/decrypted.
java.util.Map<java.lang.String,java.lang.String>	getMaterialDescription()
java.lang.String	getRangeKeyName() Returns the name of the RangeKey attribute for the record to be encrypted/decrypted.
java.lang.String	getTableName() Returns the name of the DynamoDB Table this record is associated with.
EncryptionContext.Builder	toBuilder() Converts an existing EncryptionContext into a builder that can be used to mutate and make a new version.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static EncryptionContext.Builder builder()

Return a new builder that can be used to construct an EncryptionContext

Returns:

A newly initialized EncryptionContext.Builder.

getTableName

public java.lang.String getTableName()

Returns the name of the DynamoDB Table this record is associated with.

getAttributeValues

public java.util.Map<java.lang.String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> getAttributeValues()

Returns the DynamoDB record about to be encrypted/decrypted.

getDeveloperContext

public java.lang.Object getDeveloperContext()

This object has no meaning (and will not be set or examined) by any core libraries. It exists to allow custom object mappers and data access layers to pass data to EncryptionMaterialsProviders through the DynamoDBEncryptor.

getHashKeyName

public java.lang.String getHashKeyName()

Returns the name of the HashKey attribute for the record to be encrypted/decrypted.

getRangeKeyName

public java.lang.String getRangeKeyName()

Returns the name of the RangeKey attribute for the record to be encrypted/decrypted.

getMaterialDescription

public java.util.Map<java.lang.String,java.lang.String> getMaterialDescription()

toBuilder

public EncryptionContext.Builder toBuilder()

Converts an existing EncryptionContext into a builder that can be used to mutate and make a new version.

Returns:

A new EncryptionContext.Builder with all the fields filled out to match the current object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object