com.amazon.ask.dispatcher.request.handler

Class HandlerInput

java.lang.Object

com.amazon.ask.request.exception.handler.impl.AbstractHandlerInput<Request>

com.amazon.ask.dispatcher.request.handler.HandlerInput

public class HandlerInput
extends AbstractHandlerInput<Request>

Input that is passed to all RequestHandler, ExceptionHandler, RequestInterceptor, and ResponseInterceptor. Contains the RequestEnvelope, AttributesManager, ServiceClientFactory, ResponseBuilder, and other useful utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HandlerInput.Builder HandlerInput Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributesManager	attributesManager Manager for all skill attributes.
protected RequestEnvelope	requestEnvelope Request Envelope.
protected com.fasterxml.jackson.databind.JsonNode	requestEnvelopeJson Request envelope in JSON format.
protected ResponseBuilder	responseBuilder Response Builder.
protected ServiceClientFactory	serviceClientFactory Factory class to vend out various service clients.
protected TemplateFactory<HandlerInput,Response>	templateFactory Interface to process template and data to generate skill response.

Fields inherited from class com.amazon.ask.request.exception.handler.impl.AbstractHandlerInput

context, request

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HandlerInput(RequestEnvelope requestEnvelope, PersistenceAdapter persistenceAdapter, Object context, ServiceClientFactory serviceClientFactory, com.fasterxml.jackson.databind.JsonNode requestEnvelopeJson, TemplateFactory<HandlerInput,Response> templateFactory) Constructor for HandlerInput.

Method Summary

Modifier and Type	Method and Description
static HandlerInput.Builder	builder() Static method to build an instance of Builder.
Optional<Response>	generateTemplateResponse(String responseTemplateName, Map<String,Object> dataMap) Generate Response using skill response template and injecting data.
AttributesManager	getAttributesManager() Returns an AttributesManager which can be used to retrieve and store skill attributes.
RequestEnvelope	getRequestEnvelope() Returns the RequestEnvelope of the incoming request.
com.fasterxml.jackson.databind.JsonNode	getRequestEnvelopeJson() Returns a JsonNode representation of the incoming Request Envelope.
ResponseBuilder	getResponseBuilder() Returns a ResponseBuilder that can be used to construct a complete skill response containing speech, directives, etc.
ServiceClientFactory	getServiceClientFactory() Returns a ServiceClientFactory used to retrieve service client instances that can call Alexa APIs.
boolean	matches(Predicate<HandlerInput> predicate) Evaluates a Predicate against the current handler input state.

Methods inherited from class com.amazon.ask.request.exception.handler.impl.AbstractHandlerInput

getContext, getRequest

Methods inherited from class java.lang.Object

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

Field Detail

requestEnvelope

protected final RequestEnvelope requestEnvelope

Request Envelope.

attributesManager

protected final AttributesManager attributesManager

Manager for all skill attributes.

serviceClientFactory

protected final ServiceClientFactory serviceClientFactory

Factory class to vend out various service clients.

responseBuilder

protected final ResponseBuilder responseBuilder

Response Builder.

requestEnvelopeJson

protected final com.fasterxml.jackson.databind.JsonNode requestEnvelopeJson

Request envelope in JSON format.

templateFactory

protected final TemplateFactory<HandlerInput,Response> templateFactory

Interface to process template and data to generate skill response.

Constructor Detail

HandlerInput

protected HandlerInput(RequestEnvelope requestEnvelope,
                       PersistenceAdapter persistenceAdapter,
                       Object context,
                       ServiceClientFactory serviceClientFactory,
                       com.fasterxml.jackson.databind.JsonNode requestEnvelopeJson,
                       TemplateFactory<HandlerInput,Response> templateFactory)

Constructor for HandlerInput.

Parameters:

requestEnvelope - Request Envelope.

persistenceAdapter - Store skill attributes to a persistence layer.

context - object passed in when using AWS Lambda to host Skill backend code.

serviceClientFactory - Factory class to vend out various service clients.

requestEnvelopeJson - Request envelope in JSON format.

templateFactory - Interface to process template and data to generate skill response.

Method Detail

builder

public static HandlerInput.Builder builder()

Static method to build an instance of Builder.

Returns:

HandlerInput.Builder.

generateTemplateResponse

public Optional<Response> generateTemplateResponse(String responseTemplateName,
                                                   Map<String,Object> dataMap)
                                            throws TemplateFactoryException

Generate Response using skill response template and injecting data. Response template contains response components including but not limited to OutputSpeech, Card, Directive and CanFulfillIntent and placeholders for injecting data. Injecting data provides component values to be injected into template.

Parameters:

responseTemplateName - name of response template

dataMap - a map that contains injecting data

Returns:

skill response

Throws:

TemplateFactoryException - if fail to load or render template using provided TemplateLoader or TemplateRenderer

getRequestEnvelope

public RequestEnvelope getRequestEnvelope()

Returns the RequestEnvelope of the incoming request.

Returns:

request envelope

getAttributesManager

public AttributesManager getAttributesManager()

Returns an AttributesManager which can be used to retrieve and store skill attributes.

Returns:

attributes manager

getRequestEnvelopeJson

public com.fasterxml.jackson.databind.JsonNode getRequestEnvelopeJson()

Returns a JsonNode representation of the incoming Request Envelope.

Returns:

JSON request envelope representation

getServiceClientFactory

public ServiceClientFactory getServiceClientFactory()

Returns a ServiceClientFactory used to retrieve service client instances that can call Alexa APIs.

Returns:

service client factory

Throws:

IllegalStateException - if this method is called when an ApiClient is not configured on this SDK instance.

matches

public boolean matches(Predicate<HandlerInput> predicate)

Evaluates a Predicate against the current handler input state.

Parameters:

predicate - predicate to evaluate

Returns:

true if the predicates matches this input, false if not

getResponseBuilder

public ResponseBuilder getResponseBuilder()

Returns a ResponseBuilder that can be used to construct a complete skill response containing speech, directives, etc.

Returns:

response builder