com.amazon.ask.attributes.persistence

Interface PersistenceAdapter

All Known Implementing Classes:

DynamoDbPersistenceAdapter

public interface PersistenceAdapter

Persistence adapters allow an AttributesManager to store skill attributes to a persistence layer. The adapter encapsulates all initialization, get, and save logic specific to the persistence implementation.

Method Summary

Modifier and Type	Method and Description
void	deleteAttributes(RequestEnvelope envelope) Deletes attributes from persistence.
Optional<Map<String,Object>>	getAttributes(RequestEnvelope envelope) Retrieves attributes from persistence.
void	saveAttributes(RequestEnvelope envelope, Map<String,Object> attributes) Saves attributes to persistence.

Method Detail

getAttributes

Optional<Map<String,Object>> getAttributes(RequestEnvelope envelope)
                                    throws PersistenceException

Retrieves attributes from persistence. A RequestEnvelope is passed to the adapter so current request parameters can be used as an attribute key.

Parameters:

envelope - the current request envelope

Returns:

Optional containing existing attributes if they exist, or empty if not

Throws:

PersistenceException - if attributes could not be retrieved due to an error

saveAttributes

void saveAttributes(RequestEnvelope envelope,
                    Map<String,Object> attributes)
             throws PersistenceException

Saves attributes to persistence. A RequestEnvelope is passed to the adapter so current request parameters can be used as an attribute key.

Parameters:

envelope - the current request envelope

attributes - attributes to persist

Throws:

PersistenceException - if attributes could not be saved due to an error

deleteAttributes

void deleteAttributes(RequestEnvelope envelope)
               throws PersistenceException

Deletes attributes from persistence. A RequestEnvelope is passed to the adapter so current request parameters can be used as an attribute key.

Parameters:

envelope - the current request envelope.

Throws:

PersistenceException - if attributes could not be deleted due to an error.