software.amazon.lambda.powertools.idempotency.persistence

Class BasePersistenceStore

java.lang.Object

software.amazon.lambda.powertools.idempotency.persistence.BasePersistenceStore

All Implemented Interfaces:

PersistenceStore

Direct Known Subclasses:

DynamoDBPersistenceStore

public abstract class BasePersistenceStore
extends java.lang.Object
implements PersistenceStore

Persistence layer that will store the idempotency result. Base implementation. See DynamoDBPersistenceStore for an implementation (default one) Extends this class to use your own implementation (DocumentDB, Elasticache, ...)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	payloadValidationEnabled

Constructor Summary

Constructors

Constructor and Description
BasePersistenceStore()

Method Summary

Modifier and Type	Method and Description
void	configure(IdempotencyConfig config, java.lang.String functionName) Initialize the base persistence layer from the configuration settings
void	deleteRecord(com.fasterxml.jackson.databind.JsonNode data, java.lang.Throwable throwable) Delete record from the persistence store
DataRecord	getRecord(com.fasterxml.jackson.databind.JsonNode data, java.time.Instant now) Retrieve idempotency key for data provided, fetch from persistence store, and convert to DataRecord.
void	saveInProgress(com.fasterxml.jackson.databind.JsonNode data, java.time.Instant now, java.util.OptionalInt remainingTimeInMs) Save record of function's execution being in progress
void	saveSuccess(com.fasterxml.jackson.databind.JsonNode data, java.lang.Object result, java.time.Instant now) Save record of function's execution completing successfully

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.lambda.powertools.idempotency.persistence.PersistenceStore

deleteRecord, getRecord, putRecord, updateRecord

Field Detail

payloadValidationEnabled

protected boolean payloadValidationEnabled

Constructor Detail

BasePersistenceStore

public BasePersistenceStore()

Method Detail

configure

public void configure(IdempotencyConfig config,
                      java.lang.String functionName)

Initialize the base persistence layer from the configuration settings

Parameters:

config - Idempotency configuration settings

functionName - The name of the function being decorated

saveSuccess

public void saveSuccess(com.fasterxml.jackson.databind.JsonNode data,
                        java.lang.Object result,
                        java.time.Instant now)

Save record of function's execution completing successfully

Parameters:

data - Payload

result - the response from the function

saveInProgress

public void saveInProgress(com.fasterxml.jackson.databind.JsonNode data,
                           java.time.Instant now,
                           java.util.OptionalInt remainingTimeInMs)
                    throws IdempotencyItemAlreadyExistsException

Save record of function's execution being in progress

Parameters:

data - Payload

now -

Throws:

IdempotencyItemAlreadyExistsException

deleteRecord

public void deleteRecord(com.fasterxml.jackson.databind.JsonNode data,
                         java.lang.Throwable throwable)

Delete record from the persistence store

Parameters:

data - Payload

throwable - The throwable thrown by the function

getRecord

public DataRecord getRecord(com.fasterxml.jackson.databind.JsonNode data,
                            java.time.Instant now)
                     throws IdempotencyValidationException,
                            IdempotencyItemNotFoundException

Retrieve idempotency key for data provided, fetch from persistence store, and convert to DataRecord.

Parameters:

data - Payload

Returns:

DataRecord representation of existing record found in persistence store

Throws:

IdempotencyValidationException - Payload doesn't match the stored record for the given idempotency key

IdempotencyItemNotFoundException - Exception thrown if no record exists in persistence store with the idempotency key