com.amazon.speech.speechlet.verifier.OutputSpeechSpeechletResponseVerifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alexa-skills-kit Show documentation

Contains classes used by the Alexa Skills Kit.

There is a newer version: 1.8.1

/*
    Copyright 2014-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.

    Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file
    except in compliance with the License. A copy of the License is located at

        http://aws.amazon.com/apache2.0/

    or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
    the specific language governing permissions and limitations under the License.
 */

package com.amazon.speech.speechlet.verifier;

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.amazon.speech.json.SpeechletResponseEnvelope;
import com.amazon.speech.speechlet.Session;
import com.amazon.speech.ui.OutputSpeech;
import com.amazon.speech.ui.PlainTextOutputSpeech;
import com.amazon.speech.ui.SsmlOutputSpeech;

/**
 * A {@link SpeechletResponseVerifier} to verify the size of the {@link OutputSpeech} returned in
 * {@link SpeechletResponseEnvelope}. In the current implementation, the
 * {@link #verify(SpeechletResponseEnvelope, Session)} method logs a warning if the output speech
 * size in bytes exceeds {@value #MAX_SPEECH_SIZE}.
 * 
 * Note: This verifier currently does not not enforce response checks and always returns true. The
 * primary purpose of this verifier is to log a warning in the app developer's runtime.
 */
public class OutputSpeechSpeechletResponseVerifier implements SpeechletResponseVerifier {
    private static final Logger log = LoggerFactory
            .getLogger(OutputSpeechSpeechletResponseVerifier.class);

    private static final int MAX_SPEECH_SIZE = 8000;

    @Override
    public boolean verify(SpeechletResponseEnvelope responseEnvelope, Session session) {
        if (responseEnvelope == null || responseEnvelope.getResponse() == null) {
            return true;
        }

        OutputSpeech outputSpeech = responseEnvelope.getResponse().getOutputSpeech();
        String speechContent = null;
        if (outputSpeech instanceof PlainTextOutputSpeech) {
            speechContent = ((PlainTextOutputSpeech) outputSpeech).getText();
        } else if (outputSpeech instanceof SsmlOutputSpeech) {
            speechContent = ((SsmlOutputSpeech) outputSpeech).getSsml();
        }

        int speechContentLength = StringUtils.length(speechContent);
        if (speechContentLength > MAX_SPEECH_SIZE) {
            log
                    .warn("OutputSpeech with size {} exceeds the maximum allowed size of {} and "
                            + "will be rejected by the Alexa service", speechContentLength,
                            MAX_SPEECH_SIZE);
        }

        // We are currently not enforcing response checks. Always return true.
        return true;
    }
}