com.amazonaws.services.kinesis.leases.impl

Class KinesisClientLeaseSerializer

java.lang.Object

com.amazonaws.services.kinesis.leases.impl.KinesisClientLeaseSerializer

All Implemented Interfaces:

ILeaseSerializer<KinesisClientLease>

public class KinesisClientLeaseSerializer
extends Object
implements ILeaseSerializer<KinesisClientLease>

An implementation of ILeaseSerializer for KinesisClientLease objects.

Field Summary

Fields

Modifier and Type	Field and Description
String	CHILD_SHARD_IDS_KEY
String	PARENT_SHARD_ID_KEY

Constructor Summary

Constructors

Constructor and Description
KinesisClientLeaseSerializer()

Method Summary

Modifier and Type	Method and Description
KinesisClientLease	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(KinesisClientLease lease)
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoExistentExpectation(String leaseKey)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>	getDynamoHashKey(KinesisClientLease lease)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>	getDynamoHashKey(String shardId) Special getDynamoHashKey implementation used by ILeaseManager.getLease().
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoLeaseCheckpointExpectation(KinesisClientLease lease)
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoLeaseCounterExpectation(KinesisClientLease lease)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoLeaseCounterUpdate(KinesisClientLease lease)
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoLeaseOwnerExpectation(KinesisClientLease lease)
Map<String,com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>	getDynamoNonexistantExpectation()
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoTakeLeaseUpdate(KinesisClientLease lease, String newOwner)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoUpdateLeaseUpdate(KinesisClientLease lease)
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	getDynamoUpdateLeaseUpdate(KinesisClientLease lease, UpdateField updateField)
Collection<com.amazonaws.services.dynamodbv2.model.KeySchemaElement>	getKeySchema()
Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue>	toDynamoRecord(KinesisClientLease 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

PARENT_SHARD_ID_KEY

public final String PARENT_SHARD_ID_KEY

See Also:

Constant Field Values

CHILD_SHARD_IDS_KEY

public final String CHILD_SHARD_IDS_KEY

See Also:

Constant Field Values

Constructor Detail

KinesisClientLeaseSerializer

public KinesisClientLeaseSerializer()

Method Detail

toDynamoRecord

public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> toDynamoRecord(KinesisClientLease lease)

Description copied from interface: ILeaseSerializer

Construct a DynamoDB record out of a Lease object

Specified by:

toDynamoRecord in interface ILeaseSerializer<KinesisClientLease>

Parameters:

lease - lease object to serialize

Returns:

an attribute value map representing the lease object

fromDynamoRecord

public KinesisClientLease fromDynamoRecord(Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> dynamoRecord)

Description copied from interface: ILeaseSerializer

Construct a Lease object out of a DynamoDB record.

Specified by:

fromDynamoRecord in interface ILeaseSerializer<KinesisClientLease>

Parameters:

dynamoRecord - attribute value map from DynamoDB

Returns:

a deserialized lease object representing the attribute value map

getDynamoHashKey

public Map<String,com.amazonaws.services.dynamodbv2.model.AttributeValue> getDynamoHashKey(KinesisClientLease lease)

Specified by:

getDynamoHashKey in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoHashKey

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

Description copied from interface: ILeaseSerializer

Special getDynamoHashKey implementation used by ILeaseManager.getLease().

Specified by:

getDynamoHashKey in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoLeaseCounterExpectation

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

Specified by:

getDynamoLeaseCounterExpectation in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoLeaseOwnerExpectation

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

Specified by:

getDynamoLeaseOwnerExpectation in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoLeaseCheckpointExpectation

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

Specified by:

getDynamoLeaseCheckpointExpectation in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoNonexistantExpectation

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

Specified by:

getDynamoNonexistantExpectation in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoExistentExpectation

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

Specified by:

getDynamoExistentExpectation in interface ILeaseSerializer<KinesisClientLease>

Returns:

the attribute value map asserting that a lease does exist.

getDynamoLeaseCounterUpdate

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

Specified by:

getDynamoLeaseCounterUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

the attribute value map that increments a lease counter

getDynamoTakeLeaseUpdate

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

Specified by:

getDynamoTakeLeaseUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoEvictLeaseUpdate

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

Specified by:

getDynamoEvictLeaseUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

the attribute value map that voids a lease

getDynamoUpdateLeaseUpdate

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

Specified by:

getDynamoUpdateLeaseUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoUpdateLeaseUpdate

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

Specified by:

getDynamoUpdateLeaseUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getKeySchema

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

Specified by:

getKeySchema in interface ILeaseSerializer<KinesisClientLease>

Returns:

the key schema for creating a DynamoDB table to store leases

getAttributeDefinitions

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

Specified by:

getAttributeDefinitions in interface ILeaseSerializer<KinesisClientLease>

Returns:

attribute definitions for creating a DynamoDB table to store leases