- AlexaAppStateSerializer - Class in io.klerch.alexa.state.model.serializer
-
The serializer considers all fields in a model tagged with AlexaStateSave and scoped with APPLICATION or a scope
which includes APPLICATION.
- AlexaAppStateSerializer() - Constructor for class io.klerch.alexa.state.model.serializer.AlexaAppStateSerializer
-
- AlexaScope - Enum in io.klerch.alexa.state.model
-
The scope defines in which context state is stored in the persistence stores.
- AlexaSessionStateHandler - Class in io.klerch.alexa.state.handler
-
As this handler works in the session scope it persists all models to the attributes of an associate Alexa Session object.
- AlexaSessionStateHandler(Session) - Constructor for class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Initializes a handler and applies an Alexa Session to persist models.
- AlexaSessionStateSerializer - Class in io.klerch.alexa.state.model.serializer
-
The serializer considers all fields in a model tagged with AlexaStateSave and scoped with SESSION or a scope
which includes SESSION.
- AlexaSessionStateSerializer() - Constructor for class io.klerch.alexa.state.model.serializer.AlexaSessionStateSerializer
-
- AlexaStateException - Exception in io.klerch.alexa.state.utils
-
- AlexaStateException(AlexaStateException.AlexaStateExceptionBuilder) - Constructor for exception io.klerch.alexa.state.utils.AlexaStateException
-
- AlexaStateException.AlexaStateExceptionBuilder - Class in io.klerch.alexa.state.utils
-
- AlexaStateExceptionBuilder(String) - Constructor for class io.klerch.alexa.state.utils.AlexaStateException.AlexaStateExceptionBuilder
-
- AlexaStateHandler - Interface in io.klerch.alexa.state.handler
-
A state handler is an object which encapsulates persistence logic of your model states
It comes in multiple flavours where each of the implementation is dedicated to a persistence store.
- AlexaStateIgnore - Annotation Type in io.klerch.alexa.state.model
-
A field having this annotation will be ignored from being saved and loaded by AlexaStateHandlers
even when they have the AlexaStateSave annotation.
- AlexaStateModel - Class in io.klerch.alexa.state.model
-
This abstract class turns your POJO model into a model compatible to the AlexaStateHandler.
- AlexaStateModel() - Constructor for class io.klerch.alexa.state.model.AlexaStateModel
-
- AlexaStateModelFactory - Class in io.klerch.alexa.state.model
-
- AlexaStateModelFactory() - Constructor for class io.klerch.alexa.state.model.AlexaStateModelFactory
-
- AlexaStateObject - Class in io.klerch.alexa.state.model
-
Instead of managing state of POJO models you can also provide id-value objects
to the state handlers.
- AlexaStateObject(String, Object) - Constructor for class io.klerch.alexa.state.model.AlexaStateObject
-
Creates a id-value state.
- AlexaStateObject(String, Object, AlexaScope) - Constructor for class io.klerch.alexa.state.model.AlexaStateObject
-
Creates a id-value state.
- AlexaStateSave - Annotation Type in io.klerch.alexa.state.model
-
A field having this annotation will be saved and loaded by AlexaStateHandlers
as long as they don't have the AlexaStateIgnore-tag.
- AlexaStateSerializer - Class in io.klerch.alexa.state.model.serializer
-
This custom JSON serializer considers all fields tagged with the AlexaStateSave annotation in a given scope.
- AlexaStateSerializer() - Constructor for class io.klerch.alexa.state.model.serializer.AlexaStateSerializer
-
- AlexaUserStateSerializer - Class in io.klerch.alexa.state.model.serializer
-
The serializer considers all fields in a model tagged with AlexaStateSave and scoped with USER or a scope
which includes USER.
- AlexaUserStateSerializer() - Constructor for class io.klerch.alexa.state.model.serializer.AlexaUserStateSerializer
-
- AWSDynamoStateHandler - Class in io.klerch.alexa.state.handler
-
As this handler works in the user and application scope it persists all models to a AWS DynamoDB table.
- AWSDynamoStateHandler(Session) - Constructor for class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
The most convenient constructor just takes the Alexa session.
- AWSDynamoStateHandler(Session, AmazonDynamoDB) - Constructor for class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Takes the Alexa session and a AWS client which is set up for
the correct AWS region.
- AWSDynamoStateHandler(Session, String) - Constructor for class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Takes the Alexa session and a table.
- AWSDynamoStateHandler(Session, AmazonDynamoDB, String) - Constructor for class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Takes the Alexa session and a AWS client which is set up for
the correct AWS region.
- AWSDynamoStateHandler(Session, AmazonDynamoDB, long, long) - Constructor for class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Takes the Alexa session, an AWS client which is set up for
the correct AWS region.
- AWSIotStateHandler - Class in io.klerch.alexa.state.handler
-
As this handler works in the user and application scope it persists all models to a thing shadow in AWS IoT.
- AWSIotStateHandler(Session) - Constructor for class io.klerch.alexa.state.handler.AWSIotStateHandler
-
- AWSIotStateHandler(Session, AWSIot, AWSIotData) - Constructor for class io.klerch.alexa.state.handler.AWSIotStateHandler
-
- AWSS3StateHandler - Class in io.klerch.alexa.state.handler
-
As this handler works in the user and application scope it persists all models to an S3 bucket.
- AWSS3StateHandler(Session, String) - Constructor for class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Takes the Alexa session.
- AWSS3StateHandler(Session, AmazonS3, String) - Constructor for class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Takes the Alexa session and an AWS client set up for the AWS region the given bucket is in.
- encryptSha1(String) - Static method in class io.klerch.alexa.state.utils.EncryptUtils
-
- EncryptUtils - Class in io.klerch.alexa.state.utils
-
- EncryptUtils() - Constructor for class io.klerch.alexa.state.utils.EncryptUtils
-
- excludes(AlexaScope) - Method in enum io.klerch.alexa.state.model.AlexaScope
-
Checks if the given scope is not covered by this scope.
- exists(Class<TModel>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Looks for a model in the persistence store.
- exists(Class<TModel>, String) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Looks for a model with given id in the persistence store.
- exists(Class<TModel>, AlexaScope) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Looks for a model in the persistence store in a given scope.
- exists(Class<TModel>, String, AlexaScope) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Looks for a model with the given id in the persistence store in a given scope.
- exists(String) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Looks for a state object with the given id.
- exists(String, AlexaScope) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Looks for a state object with the given id in the given scope.
- exists(Class<TModel>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Looks for a model in the persistence store.
- exists(Class<TModel>, String) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Looks for a model with given id in the persistence store.
- exists(Class<TModel>, AlexaScope) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Looks for a model in the persistence store in a given scope.
- exists(Class<TModel>, String, AlexaScope) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Looks for a model with the given id in the persistence store in a given scope.
- exists(String) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Looks for a state object with the given id.
- exists(String, AlexaScope) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Looks for a state object with the given id in the given scope.
- exists(String, AlexaScope) - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Looks for a state object with the given id in the given scope.
- exists(String, AlexaScope) - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Looks for a state object with the given id in the given scope.
- get(Field) - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
Generic getter for all the fields in this model.
- getAttributeKey(Class<TModel>) - Static method in class io.klerch.alexa.state.model.AlexaStateModel
-
Returns the key used to save the model in the session attributes.
- getAttributeKey(Class<TModel>, String) - Static method in class io.klerch.alexa.state.model.AlexaStateModel
-
Returns the key used to save the model in the session attributes.
- getAttributeKey() - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
Returns the key used to save the model in the session attributes.
- getAwsClient() - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Returns the AWS connection client used to write to and read from items in DynamoDB table.
- getAwsClient() - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
Returns the AWS connection client used by this handler to manage resources
in AWS IoT.
- getAwsClient() - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Returns the AWS connection client used to write to and read from files in S3 bucket.
- getBucketName() - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Returns the name of the S3 bucket which is used by this handler to store JSON files with
model states.
- getGetter(Object, String) - Static method in class io.klerch.alexa.state.utils.ReflectionUtils
-
Returns the method of a given object which is the getter-method of a given field
whose name is expected to be like getFieldname.
- getHandler() - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
- getHandler() - Method in exception io.klerch.alexa.state.utils.AlexaStateException
-
- getId() - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
Gets id for this model instance.
- getId() - Method in class io.klerch.alexa.state.model.AlexaStateObject
-
Returns the id used by the state handler to read/write value from/to persistence store.
- getModel() - Method in exception io.klerch.alexa.state.utils.AlexaStateException
-
- getSaveStateFields() - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
Gives you all the fields of this model which are annotated with AlexaStateSave
- getSaveStateFields(AlexaScope) - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
Gives you all the fields of this model which are annotated with AlexaStateSave and whose scope is set to a scope
which at least in included in the given scope.
- getScope() - Method in class io.klerch.alexa.state.model.AlexaStateObject
-
Returns the scope used by the state handler to read/write value from/to persistence store.
- getSession() - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Returns the Alexa Session object which was given to this handler.
- getSession() - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Returns the Alexa Session object which was given to this handler.
- getSetter(Object, String) - Static method in class io.klerch.alexa.state.utils.ReflectionUtils
-
Returns the method of a given object which is the setter-method of a given field
whose name is expected to be like setFieldname.
- getThingName(AlexaScope) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
Returns name of the thing whose shadow is updated by this handler.
- getUserId() - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Gets the userId used as a key when storing user-scoped model-state.
- getValue() - Method in enum io.klerch.alexa.state.model.AlexaScope
-
- getValue() - Method in class io.klerch.alexa.state.model.AlexaStateObject
-
Returns the value written/read by a state handler from/to persistence store
- readModel(Class<TModel>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Reads out the model from the persistence store of this handler.
- readModel(Class<TModel>, String) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Reads out the model from the persistence store of this handler.
- readModel(Class<TModel>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads out the model from the persistence store of this handler.
- readModel(Class<TModel>, String) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads out the model from the persistence store of this handler.
- readModel(Class<TModel>) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
Reads out the model from the persistence store of this handler.
- readModels(Class<TModel>, Collection<String>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
- readModels(Class<TModel>, Collection<String>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads out models from the persistence store of this handler.
- readModels(Class<TModel>, Collection<String>) - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
- readModels(Class<TModel>, Collection<String>) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
Reads out models from the persistence store of this handler.
- readModels(Class<TModel>, Collection<String>) - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Reads out models from the persistence store of this handler.
- readValue(String) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Reads a single object value from the persistence store.
- readValue(String, AlexaScope) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Reads a single object value from the persistence store.
- readValue(String) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads a single object value from the persistence store.
- readValue(String, AlexaScope) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads a single object value from the persistence store.
- readValue(String, AlexaScope) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
Reads a single object value from the persistence store.
- readValues(Collection<String>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Reads multiple single object values from the persistence store.
- readValues(Collection<String>, AlexaScope) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Reads multiple single object values from the persistence store in a specific scope.
- readValues(Map<String, AlexaScope>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Reads multiple single object values from the persistence store in scopes.
- readValues(Collection<String>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads multiple single object values from the persistence store.
- readValues(Collection<String>, AlexaScope) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads multiple single object values from the persistence store in a specific scope.
- readValues(Map<String, AlexaScope>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Reads multiple single object values from the persistence store in scopes.
- readValues(Map<String, AlexaScope>) - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Reads multiple single object values from the persistence store in scopes.
- readValues(Map<String, AlexaScope>) - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Reads multiple single object values from the persistence store in scopes.
- ReflectionUtils - Class in io.klerch.alexa.state.utils
-
- ReflectionUtils() - Constructor for class io.klerch.alexa.state.utils.ReflectionUtils
-
- removeModel(AlexaStateModel) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
The given model will be removed from the persistence store.
- removeModel(AlexaStateModel) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
The given model will be removed from the persistence store.
- removeModels(Collection<? extends AlexaStateModel>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
- removeModels(Collection<? extends AlexaStateModel>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
The given models will be removed from the persistence store.
- removeModels(Collection<? extends AlexaStateModel>) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
The given models will be removed from the persistence store.
- removeState() - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
Asks the state handler associated with this model to remove the model from the persistence store.
- removeValue(String) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Removes a single value state from the persistence store with the given key used
when single value was written in store.
- removeValue(String) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Removes a single value state from the persistence store with the given key used
when single value was written in store.
- removeValues(Collection<String>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
- removeValues(Collection<String>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Removes multiple value states from the persistence store with given keys used
when those values were written in store.
- removeValues(Collection<String>) - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Removes multiple value states from the persistence store with given keys used
when those values were written in store.
- removeValues(Collection<String>) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
Removes multiple value states from the persistence store with given keys used
when those values were written in store.
- removeValues(Collection<String>) - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Removes multiple value states from the persistence store with given keys used
when those values were written in store.
- resolveAttributeKeyToId(Class<TModel>, String) - Static method in class io.klerch.alexa.state.model.AlexaStateModel
-
- withCause(Throwable) - Method in class io.klerch.alexa.state.utils.AlexaStateException.AlexaStateExceptionBuilder
-
- withHandler(AlexaStateHandler) - Method in class io.klerch.alexa.state.model.AlexaStateModel
-
- withHandler(AlexaStateHandler) - Method in class io.klerch.alexa.state.utils.AlexaStateException.AlexaStateExceptionBuilder
-
- withModel(AlexaStateModel) - Method in class io.klerch.alexa.state.utils.AlexaStateException.AlexaStateExceptionBuilder
-
- withUserId(String) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
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
- withUserId(String) - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
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
- withUserId(String) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
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
- withUserId(String) - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
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
- writeModel(AlexaStateModel) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
The given model will be saved in the persistence store according to its
AlexaStateSave
-annotations.
- writeModel(AlexaStateModel) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
The given model will be saved in the persistence store according to its
AlexaStateSave
-annotations.
- writeModels(Collection<? extends AlexaStateModel>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
The given models will be saved in the persistence store according to their
AlexaStateSave
-annotations.
- writeModels(Collection<? extends AlexaStateModel>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
The given models will be saved in the persistence store according to their
AlexaStateSave
-annotations.
- writeModels(Collection<? extends AlexaStateModel>) - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
The given models will be saved in the persistence store according to their
AlexaStateSave
-annotations.
- writeModels(Collection<? extends AlexaStateModel>) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
The given models will be saved in the persistence store according to their
AlexaStateSave
-annotations.
- writeModels(Collection<? extends AlexaStateModel>) - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
The given models will be saved in the persistence store according to their
AlexaStateSave
-annotations.
- writeValue(String, Object) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
The given value will be saved with the given id in the persistence store.
- writeValue(String, Object, AlexaScope) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
The given value will be saved with the given id in the persistence store.
- writeValue(AlexaStateObject) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
The value of a given state object will be saved with its id in the persistence store.
- writeValue(String, Object) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
The given value will be saved with the given id in the persistence store.
- writeValue(String, Object, AlexaScope) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
The given value will be saved with the given id in the persistence store.
- writeValue(AlexaStateObject) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
The value of a given state object will be saved with its id in the persistence store.
- writeValues(Collection<? extends AlexaStateObject>) - Method in class io.klerch.alexa.state.handler.AlexaSessionStateHandler
-
Values of given state objects will be saved with their ids in the persistence store.
- writeValues(Collection<? extends AlexaStateObject>) - Method in interface io.klerch.alexa.state.handler.AlexaStateHandler
-
Values of given state objects will be saved with their ids in the persistence store.
- writeValues(Collection<? extends AlexaStateObject>) - Method in class io.klerch.alexa.state.handler.AWSDynamoStateHandler
-
Values of given state objects will be saved with their ids in the persistence store.
- writeValues(Collection<? extends AlexaStateObject>) - Method in class io.klerch.alexa.state.handler.AWSIotStateHandler
-
Values of given state objects will be saved with their ids in the persistence store.
- writeValues(Collection<? extends AlexaStateObject>) - Method in class io.klerch.alexa.state.handler.AWSS3StateHandler
-
Values of given state objects will be saved with their ids in the persistence store.