AWSS3StateHandler (Alexa Skills Kit States SDK for Java 1.1.0 API)

java.lang.Object
- io.klerch.alexa.state.handler.AlexaSessionStateHandler
- - io.klerch.alexa.state.handler.AWSS3StateHandler

All Implemented Interfaces:

AlexaStateHandler
```
public class AWSS3StateHandler
extends AlexaSessionStateHandler
```
As this handler works in the user and application scope it persists all models to an S3 bucket. This handler reads and writes state for AlexaStateModels and considers all its fields annotated with AlexaSaveState-tags. This handler derives from the AlexaSessionStateHandler thus it reads and writes state out of S3 files also to your Alexa session. For each individual scope (which is described by the Alexa User Id there will be a directory in your bucket which then contains files - one for each instance of a saved model. Be aware that S3 does not support bulk uploads thus writeModels and writeValues upload files one by one without batch processing.

Constructor Summary

Constructors
Constructor and Description
`AWSS3StateHandler(com.amazon.speech.speechlet.Session session, com.amazonaws.services.s3.AmazonS3 awsClient, String bucketName)` Takes the Alexa session and an AWS client set up for the AWS region the given bucket is in.
`AWSS3StateHandler(com.amazon.speech.speechlet.Session session, String bucketName)` Takes the Alexa session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`exists(String id, AlexaScope scope)` Looks for a state object with the given id in the given scope.
`com.amazonaws.services.s3.AmazonS3`	`getAwsClient()` Returns the AWS connection client used to write to and read from files in S3 bucket.
`String`	`getBucketName()` Returns the name of the S3 bucket which is used by this handler to store JSON files with model states.
`<TModel extends AlexaStateModel> Map<String,TModel>`	`readModels(Class<TModel> modelClass, Collection<String> ids)` Reads out models from the persistence store of this handler.
`Map<String,AlexaStateObject>`	`readValues(Map<String,AlexaScope> idsInScope)` Reads multiple single object values from the persistence store in scopes.
`void`	`removeValues(Collection<String> ids)` Removes multiple value states from the persistence store with given keys used when those values were written in store.
`AWSS3StateHandler`	`withUserId(String userId)` sets the userId used as a key when storing user-scoped model-state If no userId is provided the handler will use userId coming in with the session Note, the userId from Alexa will change when a user re-enables your skill
`void`	`writeModels(Collection<? extends AlexaStateModel> models)` The given models will be saved in the persistence store according to their `AlexaStateSave`-annotations.
`void`	`writeValues(Collection<? extends AlexaStateObject> stateObjects)` Values of given state objects will be saved with their ids in the persistence store.

Methods inherited from class io.klerch.alexa.state.handler.AlexaSessionStateHandler
createModel, createModel, exists, exists, exists, exists, exists, getSession, getUserId, readModel, readModel, readValue, readValue, readValues, readValues, removeModel, removeModels, removeValue, setUserId, writeModel, writeValue, writeValue, writeValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AWSS3StateHandler
```
public AWSS3StateHandler(com.amazon.speech.speechlet.Session session,
                         String bucketName)
```
    Takes the Alexa session. An AWS client for accessing the S3 bucket will make use of all the defaults in your runtime environment in regards to AWS region and credentials. The credentials of this client need permission for getting and putting objects to this bucket.
    
    Parameters:
    
    session - The Alexa session of your current skill invocation.
    
    bucketName - The bucket where all saved states will go into.
  - AWSS3StateHandler
```
public AWSS3StateHandler(com.amazon.speech.speechlet.Session session,
                         com.amazonaws.services.s3.AmazonS3 awsClient,
                         String bucketName)
```
    Takes the Alexa session and an AWS client set up for the AWS region the given bucket is in. The credentials of this client need permission for getting and putting objects to this bucket.
    
    Parameters:
    
    session - The Alexa session of your current skill invocation.
    
    awsClient - An AWS client capable of getting and putting objects to the given bucket.
    
    bucketName - The bucket where all saved states will go into.
- Method Detail
  - getAwsClient
```
public com.amazonaws.services.s3.AmazonS3 getAwsClient()
```
    Returns the AWS connection client used to write to and read from files in S3 bucket.
    
    Returns:
    
    AWS connection client to S3
  - getBucketName
```
public String getBucketName()
```
    Returns the name of the S3 bucket which is used by this handler to store JSON files with model states.
    
    Returns:
    
    Name of the S3 bucket
  - withUserId
```
public AWSS3StateHandler withUserId(String userId)
```
    sets the userId used as a key when storing user-scoped model-state If no userId is provided the handler will use userId coming in with the session Note, the userId from Alexa will change when a user re-enables your skill
    
    Overrides:
    
    withUserId in class AlexaSessionStateHandler
    
    Parameters:
    
    userId - userId used as a key when storing user-scoped model-state
    
    Returns:
    
    handler
  - writeModels
```
public void writeModels(Collection<? extends AlexaStateModel> models)
                 throws AlexaStateException
```
    The given models will be saved in the persistence store according to their AlexaStateSave-annotations. If you set up an Id for the model it will be accessible with it on later reads to the handler. If you have multiple models to save always prefer this method as it tries to batch process the models so it reduces the number of write-transactions to one.
    
    Specified by:
    
    writeModels in interface AlexaStateHandler
    
    Overrides:
    
    writeModels in class AlexaSessionStateHandler
    
    Parameters:
    
    models - list of models to save state
    
    Throws:
    
    AlexaStateException - Wraps all inner exceptions and gives you context related to handler and model
  - writeValues
```
public void writeValues(Collection<? extends AlexaStateObject> stateObjects)
                 throws AlexaStateException
```
    Values of given state objects will be saved with their ids in the persistence store. Keep in mind that for the AlexaSessionStateHandler USER and APPLICATION scope cannot be served. In that case the value will be saved to Alexa session and will not persist permanently.
    
    Specified by:
    
    writeValues in interface AlexaStateHandler
    
    Overrides:
    
    writeValues in class AlexaSessionStateHandler
    
    Parameters:
    
    stateObjects - the state objects to write to the persistence store
    
    Throws:
    
    AlexaStateException - Wraps all inner exceptions and gives you context related to handler and model
  - removeValues
```
public void removeValues(Collection<String> ids)
                  throws AlexaStateException
```
    Removes multiple value states from the persistence store with given keys used when those values were written in store. You could also use this method to remove models. In that case be sure you provide the attributeKey of those models - not their id.
    
    Specified by:
    
    removeValues in interface AlexaStateHandler
    
    Overrides:
    
    removeValues in class AlexaSessionStateHandler
    
    Parameters:
    
    ids - the keys of single value objects whose state you want to remove from the store.
    
    Throws:
    
    AlexaStateException - Wraps all inner exceptions and gives you context related to handler and model
  - exists
```
public boolean exists(String id,
                      AlexaScope scope)
               throws AlexaStateException
```
    Looks for a state object with the given id in the given scope. If you want to check existence of a state model keep in mind its id is the attribute-key of the model object, not the id you provided. The attribute-key derives from the model-id.
    
    Specified by:
    
    exists in interface AlexaStateHandler
    
    Overrides:
    
    exists in class AlexaSessionStateHandler
    
    Parameters:
    
    id - id of a state-object whose existence you want to be checked in the store.
    
    scope - look for state-object in that scope.
    
    Returns:
    
    True, if state object exists in that scope
    
    Throws:
    
    AlexaStateException - Wraps all inner exceptions and gives you context related to handler and model
  - readModels
```
public <TModel extends AlexaStateModel> Map<String,TModel> readModels(Class<TModel> modelClass,
                                                                      Collection<String> ids)
                                                               throws AlexaStateException
```
    Reads out models from the persistence store of this handler. Depending on the AlexaScopes configured in the AlexaStateSave annotations it will possibly collect data from more than one persistence store. (most likely from the Alexa session and maybe from the permanent persistence store associated with this handler.) You are providing ids with this call. If you never saved any model with one of the ids in the store you won't get them.
    
    Specified by:
    
    readModels in interface AlexaStateHandler
    
    Overrides:
    
    readModels in class AlexaSessionStateHandler
    
    Type Parameters:
    
    TModel - Type derived from AlexaStateModel
    
    Parameters:
    
    modelClass - Type of the model you would like to read out. It needs to be of type AlexaStateModel.
    
    ids - Collection of ids of existing instances of your model in the persistence store. If you provide ids of non-existing items they just won't show up in the returned map.
    
    Returns:
    
    Map of ids from your input list of ids pointing to models that were found in the persistence store. Augmented with all the attributes found in the persistence store.
    
    Throws:
    
    AlexaStateException - Wraps all inner exceptions and gives you context related to handler and model
  - readValues
```
public Map<String,AlexaStateObject> readValues(Map<String,AlexaScope> idsInScope)
                                        throws AlexaStateException
```
    Reads multiple single object values from the persistence store in scopes. If you want to check existence of a state model keep in mind its id is the attribute-key of the model object, not the id you provided. The attribute-key derives from the model-id.
    
    Specified by:
    
    readValues in interface AlexaStateHandler
    
    Overrides:
    
    readValues in class AlexaSessionStateHandler
    
    Parameters:
    
    idsInScope - ids with scope of state-objects whose state you want to read from the store.
    
    Returns:
    
    map of state-objects found in the store where key is the object-id. State-objects which were not found in the store will be missing in that map.
    
    Throws:
    
    AlexaStateException - Wraps all inner exceptions and gives you context related to handler and model

Class AWSS3StateHandler

Constructor Summary

Method Summary

Methods inherited from class io.klerch.alexa.state.handler.AlexaSessionStateHandler

Methods inherited from class java.lang.Object

Constructor Detail

AWSS3StateHandler

AWSS3StateHandler

Method Detail

getAwsClient

getBucketName

withUserId

writeModels

writeValues

removeValues

exists

readModels

readValues