com.amazonaws.services.kinesis.leases.impl

Class LeaseSerializer

java.lang.Object

com.amazonaws.services.kinesis.leases.impl.LeaseSerializer

All Implemented Interfaces:

ILeaseSerializer<Lease>

public class LeaseSerializer
extends Object
implements ILeaseSerializer<Lease>

An implementation of ILeaseSerializer for basic Lease objects. Can also instantiate subclasses of Lease so that LeaseSerializer can be decorated by other classes if you need to add fields to leases.

Field Summary

Fields

Modifier and Type	Field and Description
Class<? extends Lease>	clazz
String	LEASE_COUNTER_KEY
String	LEASE_KEY_KEY
String	LEASE_OWNER_KEY

Constructor Summary

Constructors

Constructor and Description
LeaseSerializer()
LeaseSerializer(Class<? extends Lease> clazz)

Method Summary

Modifier and Type	Method and Description
Lease	fromDynamoRecord(Map<String,AttributeValue> dynamoRecord) Construct a Lease object out of a DynamoDB record.
Collection<AttributeDefinition>	getAttributeDefinitions()
Map<String,AttributeValueUpdate>	getDynamoEvictLeaseUpdate(Lease lease)
Map<String,AttributeValue>	getDynamoHashKey(Lease lease)
Map<String,AttributeValue>	getDynamoHashKey(String leaseKey) Special getDynamoHashKey implementation used by ILeaseManager.getLease().
Map<String,ExpectedAttributeValue>	getDynamoLeaseCounterExpectation(Lease lease)
Map<String,ExpectedAttributeValue>	getDynamoLeaseCounterExpectation(Long leaseCounter)
Map<String,AttributeValueUpdate>	getDynamoLeaseCounterUpdate(Lease lease)
Map<String,AttributeValueUpdate>	getDynamoLeaseCounterUpdate(Long leaseCounter)
Map<String,ExpectedAttributeValue>	getDynamoLeaseOwnerExpectation(Lease lease)
Map<String,ExpectedAttributeValue>	getDynamoNonexistantExpectation()
Map<String,AttributeValueUpdate>	getDynamoTakeLeaseUpdate(Lease lease, String owner)
Map<String,AttributeValueUpdate>	getDynamoUpdateLeaseUpdate(Lease lease)
Collection<KeySchemaElement>	getKeySchema()
Map<String,AttributeValue>	toDynamoRecord(Lease lease) Construct a DynamoDB record out of a Lease object

Methods inherited from class java.lang.Object

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

Field Detail

LEASE_KEY_KEY

public final String LEASE_KEY_KEY

See Also:

Constant Field Values

LEASE_OWNER_KEY

public final String LEASE_OWNER_KEY

See Also:

Constant Field Values

LEASE_COUNTER_KEY

public final String LEASE_COUNTER_KEY

See Also:

Constant Field Values

clazz

public final Class<? extends Lease> clazz

Constructor Detail

LeaseSerializer

public LeaseSerializer()

LeaseSerializer

public LeaseSerializer(Class<? extends Lease> clazz)

Method Detail

toDynamoRecord

public Map<String,AttributeValue> toDynamoRecord(Lease lease)

Description copied from interface: ILeaseSerializer

Construct a DynamoDB record out of a Lease object

Specified by:

toDynamoRecord in interface ILeaseSerializer<Lease>

Parameters:

lease - lease object to serialize

Returns:

an attribute value map representing the lease object

fromDynamoRecord

public Lease fromDynamoRecord(Map<String,AttributeValue> dynamoRecord)

Description copied from interface: ILeaseSerializer

Construct a Lease object out of a DynamoDB record.

Specified by:

fromDynamoRecord in interface ILeaseSerializer<Lease>

Parameters:

dynamoRecord - attribute value map from DynamoDB

Returns:

a deserialized lease object representing the attribute value map

getDynamoHashKey

public Map<String,AttributeValue> getDynamoHashKey(String leaseKey)

Description copied from interface: ILeaseSerializer

Special getDynamoHashKey implementation used by ILeaseManager.getLease().

Specified by:

getDynamoHashKey in interface ILeaseSerializer<Lease>

Returns:

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

getDynamoHashKey

public Map<String,AttributeValue> getDynamoHashKey(Lease lease)

Specified by:

getDynamoHashKey in interface ILeaseSerializer<Lease>

Returns:

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

getDynamoLeaseCounterExpectation

public Map<String,ExpectedAttributeValue> getDynamoLeaseCounterExpectation(Lease lease)

Specified by:

getDynamoLeaseCounterExpectation in interface ILeaseSerializer<Lease>

Returns:

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

getDynamoLeaseCounterExpectation

public Map<String,ExpectedAttributeValue> getDynamoLeaseCounterExpectation(Long leaseCounter)

getDynamoLeaseOwnerExpectation

public Map<String,ExpectedAttributeValue> getDynamoLeaseOwnerExpectation(Lease lease)

Specified by:

getDynamoLeaseOwnerExpectation in interface ILeaseSerializer<Lease>

Returns:

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

getDynamoNonexistantExpectation

public Map<String,ExpectedAttributeValue> getDynamoNonexistantExpectation()

Specified by:

getDynamoNonexistantExpectation in interface ILeaseSerializer<Lease>

Returns:

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

getDynamoLeaseCounterUpdate

public Map<String,AttributeValueUpdate> getDynamoLeaseCounterUpdate(Lease lease)

Specified by:

getDynamoLeaseCounterUpdate in interface ILeaseSerializer<Lease>

Returns:

the attribute value map that increments a lease counter

getDynamoLeaseCounterUpdate

public Map<String,AttributeValueUpdate> getDynamoLeaseCounterUpdate(Long leaseCounter)

getDynamoTakeLeaseUpdate

public Map<String,AttributeValueUpdate> getDynamoTakeLeaseUpdate(Lease lease,
                                                                 String owner)

Specified by:

getDynamoTakeLeaseUpdate in interface ILeaseSerializer<Lease>

Returns:

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

getDynamoEvictLeaseUpdate

public Map<String,AttributeValueUpdate> getDynamoEvictLeaseUpdate(Lease lease)

Specified by:

getDynamoEvictLeaseUpdate in interface ILeaseSerializer<Lease>

Returns:

the attribute value map that voids a lease

getDynamoUpdateLeaseUpdate

public Map<String,AttributeValueUpdate> getDynamoUpdateLeaseUpdate(Lease lease)

Specified by:

getDynamoUpdateLeaseUpdate in interface ILeaseSerializer<Lease>

Returns:

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

getKeySchema

public Collection<KeySchemaElement> getKeySchema()

Specified by:

getKeySchema in interface ILeaseSerializer<Lease>

Returns:

the key schema for creating a DynamoDB table to store leases

getAttributeDefinitions

public Collection<AttributeDefinition> getAttributeDefinitions()

Specified by:

getAttributeDefinitions in interface ILeaseSerializer<Lease>

Returns:

attribute definitions for creating a DynamoDB table to store leases