com.amazonaws.services.kinesis.leases.interfaces

Interface ILeaseSerializer<T extends Lease>

Type Parameters:

T - Lease subclass, possibly Lease itself

All Known Implementing Classes:

KinesisClientLeaseSerializer, LeaseSerializer

public interface ILeaseSerializer<T extends Lease>

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

Method Summary

Modifier and Type	Method and Description
T	fromDynamoRecord(Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> dynamoRecord) Construct a Lease object out of a DynamoDB record.
Collection<com.amazonaws.services.dynamodbv2.model.AttributeDefinition>	getAttributeDefinitions()
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoEvictLeaseUpdate(T lease)
default Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoExistentExpectation(String leaseKey)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>	getDynamoHashKey(String leaseKey) Special getDynamoHashKey implementation used by ILeaseManager.getLease().
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>	getDynamoHashKey(T lease)
default Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoLeaseCheckpointExpectation(T lease)
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoLeaseCounterExpectation(T lease)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoLeaseCounterUpdate(T lease)
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoLeaseOwnerExpectation(T lease)
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoNonexistantExpectation()
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoTakeLeaseUpdate(T lease, String newOwner)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoUpdateLeaseUpdate(T lease)
default Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoUpdateLeaseUpdate(T lease, UpdateField updateField)
Collection<com.amazonaws.services.dynamodbv2.model.KeySchemaElement>	getKeySchema()
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>	toDynamoRecord(T lease) Construct a DynamoDB record out of a Lease object

Method Detail

toDynamoRecord

Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> toDynamoRecord(T 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

T fromDynamoRecord(Map<String,com.amazonaws.services.dynamodbv2.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,com.amazonaws.services.dynamodbv2.model.AttributeValue> getDynamoHashKey(T lease)

Parameters:

lease -

Returns:

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

getDynamoHashKey

Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> getDynamoHashKey(String leaseKey)

Special getDynamoHashKey implementation used by ILeaseManager.getLease().

Parameters:

leaseKey -

Returns:

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

getDynamoLeaseCounterExpectation

Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoLeaseCounterExpectation(T lease)

Parameters:

lease -

Returns:

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

getDynamoLeaseOwnerExpectation

Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoLeaseOwnerExpectation(T lease)

Parameters:

lease -

Returns:

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

getDynamoLeaseCheckpointExpectation

default Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoLeaseCheckpointExpectation(T lease)

Parameters:

lease -

Returns:

the attribute value map asserting that the checkpoint state is as expected.

getDynamoNonexistantExpectation

Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoNonexistantExpectation()

Returns:

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

getDynamoExistentExpectation

default Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue> getDynamoExistentExpectation(String leaseKey)

Returns:

the attribute value map asserting that a lease does exist.

getDynamoLeaseCounterUpdate

Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoLeaseCounterUpdate(T lease)

Parameters:

lease -

Returns:

the attribute value map that increments a lease counter

getDynamoTakeLeaseUpdate

Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoTakeLeaseUpdate(T lease,
                                                                                                  String newOwner)

Parameters:

lease -

newOwner -

Returns:

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

getDynamoEvictLeaseUpdate

Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoEvictLeaseUpdate(T lease)

Parameters:

lease -

Returns:

the attribute value map that voids a lease

getDynamoUpdateLeaseUpdate

Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoUpdateLeaseUpdate(T lease)

Parameters:

lease -

Returns:

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

getDynamoUpdateLeaseUpdate

default Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> getDynamoUpdateLeaseUpdate(T lease,
                                                                                                            UpdateField updateField)

Parameters:

lease -

updateField -

Returns:

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

getKeySchema

Collection<com.amazonaws.services.dynamodbv2.model.KeySchemaElement> getKeySchema()

Returns:

the key schema for creating a DynamoDB table to store leases

getAttributeDefinitions

Collection<com.amazonaws.services.dynamodbv2.model.AttributeDefinition> getAttributeDefinitions()

Returns:

attribute definitions for creating a DynamoDB table to store leases