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 java.lang.Object
implements ILeaseSerializer<KinesisClientLease>

An implementation of ILeaseSerializer for KinesisClientLease objects.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	PARENT_SHARD_ID_KEY

Constructor Summary

Constructors

Constructor and Description
KinesisClientLeaseSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
KinesisClientLease	fromDynamoRecord(java.util.Map<java.lang.String,AttributeValue> dynamoRecord) Construct a Lease object out of a DynamoDB record.
java.util.Collection<AttributeDefinition>	getAttributeDefinitions()
java.util.Map<java.lang.String,AttributeValueUpdate>	getDynamoEvictLeaseUpdate(KinesisClientLease lease)
java.util.Map<java.lang.String,AttributeValue>	getDynamoHashKey(KinesisClientLease lease)
java.util.Map<java.lang.String,AttributeValue>	getDynamoHashKey(java.lang.String shardId) Special getDynamoHashKey implementation used by ILeaseManager.getLease().
java.util.Map<java.lang.String,ExpectedAttributeValue>	getDynamoLeaseCounterExpectation(KinesisClientLease lease)
java.util.Map<java.lang.String,AttributeValueUpdate>	getDynamoLeaseCounterUpdate(KinesisClientLease lease)
java.util.Map<java.lang.String,ExpectedAttributeValue>	getDynamoLeaseOwnerExpectation(KinesisClientLease lease)
java.util.Map<java.lang.String,ExpectedAttributeValue>	getDynamoNonexistantExpectation()
java.util.Map<java.lang.String,AttributeValueUpdate>	getDynamoTakeLeaseUpdate(KinesisClientLease lease, java.lang.String newOwner)
java.util.Map<java.lang.String,AttributeValueUpdate>	getDynamoUpdateLeaseUpdate(KinesisClientLease lease)
java.util.Collection<KeySchemaElement>	getKeySchema()
java.util.Map<java.lang.String,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 java.lang.String PARENT_SHARD_ID_KEY

See Also:

Constant Field Values

Constructor Detail

KinesisClientLeaseSerializer

public KinesisClientLeaseSerializer()

Method Detail

toDynamoRecord

public java.util.Map<java.lang.String,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(java.util.Map<java.lang.String,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 java.util.Map<java.lang.String,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 java.util.Map<java.lang.String,AttributeValue> getDynamoHashKey(java.lang.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 java.util.Map<java.lang.String,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 java.util.Map<java.lang.String,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.

getDynamoNonexistantExpectation

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

Specified by:

getDynamoNonexistantExpectation in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoLeaseCounterUpdate

public java.util.Map<java.lang.String,AttributeValueUpdate> getDynamoLeaseCounterUpdate(KinesisClientLease lease)

Specified by:

getDynamoLeaseCounterUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

the attribute value map that increments a lease counter

getDynamoTakeLeaseUpdate

public java.util.Map<java.lang.String,AttributeValueUpdate> getDynamoTakeLeaseUpdate(KinesisClientLease lease,
                                                                            java.lang.String newOwner)

Specified by:

getDynamoTakeLeaseUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

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

getDynamoEvictLeaseUpdate

public java.util.Map<java.lang.String,AttributeValueUpdate> getDynamoEvictLeaseUpdate(KinesisClientLease lease)

Specified by:

getDynamoEvictLeaseUpdate in interface ILeaseSerializer<KinesisClientLease>

Returns:

the attribute value map that voids a lease

getDynamoUpdateLeaseUpdate

public java.util.Map<java.lang.String,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

getKeySchema

public java.util.Collection<KeySchemaElement> getKeySchema()

Specified by:

getKeySchema in interface ILeaseSerializer<KinesisClientLease>

Returns:

the key schema for creating a DynamoDB table to store leases

getAttributeDefinitions

public java.util.Collection<AttributeDefinition> getAttributeDefinitions()

Specified by:

getAttributeDefinitions in interface ILeaseSerializer<KinesisClientLease>

Returns:

attribute definitions for creating a DynamoDB table to store leases