software.amazon.kinesis.leases

Interface LeaseSerializer

All Known Implementing Classes:

DynamoDBLeaseSerializer

public interface LeaseSerializer

Utility class that manages the mapping of Lease objects/operations to records in DynamoDB.

Method Summary

Modifier and Type	Method and Description
Lease	fromDynamoRecord(Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> dynamoRecord) Construct a Lease object out of a DynamoDB record.
Collection<software.amazon.awssdk.services.dynamodb.model.AttributeDefinition>	getAttributeDefinitions()
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate>	getDynamoEvictLeaseUpdate(Lease lease)
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue>	getDynamoHashKey(Lease lease)
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue>	getDynamoHashKey(String leaseKey) Special getDynamoHashKey implementation used by LeaseRefresher.getLease(String).
Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue>	getDynamoLeaseCounterExpectation(Lease lease)
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate>	getDynamoLeaseCounterUpdate(Lease lease)
Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue>	getDynamoLeaseOwnerExpectation(Lease lease)
Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue>	getDynamoNonexistantExpectation()
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate>	getDynamoTakeLeaseUpdate(Lease lease, String newOwner)
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate>	getDynamoUpdateLeaseUpdate(Lease lease)
Collection<software.amazon.awssdk.services.dynamodb.model.KeySchemaElement>	getKeySchema()
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue>	toDynamoRecord(Lease lease) Construct a DynamoDB record out of a Lease object

Method Detail

toDynamoRecord

Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> toDynamoRecord(Lease lease)

Construct a DynamoDB record out of a Lease object

Parameters:

lease - lease object to serialize

Returns:

an attribute value map representing the lease object

fromDynamoRecord

Lease fromDynamoRecord(Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> dynamoRecord)

Construct a Lease object out of a DynamoDB record.

Parameters:

dynamoRecord - attribute value map from DynamoDB

Returns:

a deserialized lease object representing the attribute value map

getDynamoHashKey

Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> getDynamoHashKey(Lease lease)

Parameters:

lease -

Returns:

the attribute value map representing a Lease's hash key given a Lease object.

getDynamoHashKey

Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> getDynamoHashKey(String leaseKey)

Special getDynamoHashKey implementation used by LeaseRefresher.getLease(String).

Parameters:

leaseKey -

Returns:

the attribute value map representing a Lease's hash key given a string.

getDynamoLeaseCounterExpectation

Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue> getDynamoLeaseCounterExpectation(Lease lease)

Parameters:

lease -

Returns:

the attribute value map asserting that a lease counter is what we expect.

getDynamoLeaseOwnerExpectation

Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue> getDynamoLeaseOwnerExpectation(Lease lease)

Parameters:

lease -

Returns:

the attribute value map asserting that the lease owner is what we expect.

getDynamoNonexistantExpectation

Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue> getDynamoNonexistantExpectation()

Returns:

the attribute value map asserting that a lease does not exist.

getDynamoLeaseCounterUpdate

Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate> getDynamoLeaseCounterUpdate(Lease lease)

Parameters:

lease -

Returns:

the attribute value map that increments a lease counter

getDynamoTakeLeaseUpdate

Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate> getDynamoTakeLeaseUpdate(Lease lease,
                                                                                                         String newOwner)

Parameters:

lease -

newOwner -

Returns:

the attribute value map that takes a lease for a new owner

getDynamoEvictLeaseUpdate

Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate> getDynamoEvictLeaseUpdate(Lease lease)

Parameters:

lease -

Returns:

the attribute value map that voids a lease

getDynamoUpdateLeaseUpdate

Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate> getDynamoUpdateLeaseUpdate(Lease lease)

Parameters:

lease -

Returns:

the attribute value map that updates application-specific data for a lease and increments the lease counter

getKeySchema

Collection<software.amazon.awssdk.services.dynamodb.model.KeySchemaElement> getKeySchema()

Returns:

the key schema for creating a DynamoDB table to store leases

getAttributeDefinitions

Collection<software.amazon.awssdk.services.dynamodb.model.AttributeDefinition> getAttributeDefinitions()

Returns:

attribute definitions for creating a DynamoDB table to store leases