com.amazon.ask.servlet

Class ServletConstants

java.lang.Object

com.amazon.ask.servlet.ServletConstants

public final class ServletConstants
extends Object

Helper class to hold package's constant values.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARACTER_ENCODING The character encoding used.
static long	DEFAULT_TOLERANCE_MILLIS Default timestamp offset tolerance value in millis, used if a custom value is not provided through the "com.amazon.speech.speechlet.servlet.timestampTolerance" system property.
static String	DISABLE_REQUEST_SIGNATURE_CHECK_SYSTEM_PROPERTY The name of the system property that can be used to disable request signature verification.
static String	ECHO_API_DOMAIN_NAME The domain name used by the Alexa Skills Kit API.
static long	MAXIMUM_TOLERANCE_MILLIS Maximum allowed timestamp offset tolerance value in millis for standard skill requests.
static String	SIGNATURE_ALGORITHM The algorithm used to generate the signature.
static String	SIGNATURE_CERTIFICATE_CHAIN_URL_REQUEST_HEADER The name of the request header that contains the URL for the certificate chain needed to verify the request signature.
static String	SIGNATURE_CERTIFICATE_TYPE The format of the certificate needed to verify the request signature.
static String	SIGNATURE_REQUEST_HEADER The name of the request header that contains the signature.
static String	SIGNATURE_TYPE The type of encryption key used to generate the signature.
static Set<String>	SKILL_EVENT_REQUESTS Set of skill event requests.
static String	TIMESTAMP_TOLERANCE_SYSTEM_PROPERTY The name of the system property that can be used to configure the timestamp tolerance (in millis) of the SkillServlet.
static long	TOLERANCE_SKILL_EVENTS_MILLIS Timestamp offset tolerance value in millis for skill event requests.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SIGNATURE_ALGORITHM

public static final String SIGNATURE_ALGORITHM

The algorithm used to generate the signature.

See Also:

Constant Field Values

CHARACTER_ENCODING

public static final String CHARACTER_ENCODING

The character encoding used.

See Also:

Constant Field Values

SIGNATURE_CERTIFICATE_TYPE

public static final String SIGNATURE_CERTIFICATE_TYPE

The format of the certificate needed to verify the request signature.

See Also:

Constant Field Values

SIGNATURE_TYPE

public static final String SIGNATURE_TYPE

The type of encryption key used to generate the signature.

See Also:

Constant Field Values

ECHO_API_DOMAIN_NAME

public static final String ECHO_API_DOMAIN_NAME

The domain name used by the Alexa Skills Kit API.

See Also:

Constant Field Values

SIGNATURE_REQUEST_HEADER

public static final String SIGNATURE_REQUEST_HEADER

The name of the request header that contains the signature.

See Also:

Constant Field Values

SIGNATURE_CERTIFICATE_CHAIN_URL_REQUEST_HEADER

public static final String SIGNATURE_CERTIFICATE_CHAIN_URL_REQUEST_HEADER

The name of the request header that contains the URL for the certificate chain needed to verify the request signature.

See Also:

Constant Field Values

DISABLE_REQUEST_SIGNATURE_CHECK_SYSTEM_PROPERTY

public static final String DISABLE_REQUEST_SIGNATURE_CHECK_SYSTEM_PROPERTY

The name of the system property that can be used to disable request signature verification. This feature verifies the certificate authenticity using the configured TrustStore and the signature of the skill request, and will throw a SecurityException if the signature does not pass verification. This feature should only be disabled in testing scenarios and never in a production environment.

See Also:

Constant Field Values

TIMESTAMP_TOLERANCE_SYSTEM_PROPERTY

public static final String TIMESTAMP_TOLERANCE_SYSTEM_PROPERTY

The name of the system property that can be used to configure the timestamp tolerance (in millis) of the SkillServlet. Requests with timestamps outside of this inclusive tolerance range, either in the past or future, are rejected. If this property is not provided the default value, 30000L, will be used.

See Also:

Constant Field Values

DEFAULT_TOLERANCE_MILLIS

public static final long DEFAULT_TOLERANCE_MILLIS

Default timestamp offset tolerance value in millis, used if a custom value is not provided through the "com.amazon.speech.speechlet.servlet.timestampTolerance" system property.

See Also:

Constant Field Values

MAXIMUM_TOLERANCE_MILLIS

public static final long MAXIMUM_TOLERANCE_MILLIS

Maximum allowed timestamp offset tolerance value in millis for standard skill requests.

See Also:

Constant Field Values

TOLERANCE_SKILL_EVENTS_MILLIS

public static final long TOLERANCE_SKILL_EVENTS_MILLIS

Timestamp offset tolerance value in millis for skill event requests. These requests may be delivered up to one hour past their original timestamp.

See Also:

Constant Field Values

SKILL_EVENT_REQUESTS

public static final Set<String> SKILL_EVENT_REQUESTS

Set of skill event requests. Due to the delivery characteristics of events, these requests may arrive with a timestamp value of up to 1 hour prior to the current time and are verified against a different upper bound value than standard requests. https://developer.amazon.com/en-US/docs/alexa/smapi/skill-events-in-alexa-skills.html#delivery-of-events-to-the-skill