com.amazon.speech.speechlet.verifier.ApplicationIdSpeechletRequestVerifier 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 java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.amazon.speech.speechlet.Application;
import com.amazon.speech.speechlet.IntentRequest;
import com.amazon.speech.speechlet.LaunchRequest;
import com.amazon.speech.speechlet.Session;
import com.amazon.speech.speechlet.SessionEndedRequest;
import com.amazon.speech.speechlet.SpeechletRequest;

/**
 * Verifies whether or not individual application IDs are supported by the service.
 *
 * @deprecated Use {@link ApplicationIdSpeechletRequestEnvelopeVerifier} instead. This version does not
 *             look in the {@link com.amazon.speech.speechlet.Context} for applicationId.
 */
@Deprecated
public class ApplicationIdSpeechletRequestVerifier implements SpeechletRequestVerifier {
    private final Set supportedApplicationIds;
    private static final Logger log = LoggerFactory
            .getLogger(ApplicationIdSpeechletRequestVerifier.class);

    /**
     * Constructs a new application ID verifier with the provided set of supported application IDs.
     * If the set is empty, this verifier will support any application ID (including null values).
     *
     * @param supportedApplicationIds
     *            a set of application IDs supported by the service
     */
    public ApplicationIdSpeechletRequestVerifier(Set supportedApplicationIds) {
        this.supportedApplicationIds =
                Collections.unmodifiableSet(new HashSet(supportedApplicationIds));
    }

    /**
     * Returns true if the provided {@code applicationId} is supported by this verifier. If this
     * verifier was constructed from an empty set of supported {@code applicationId}s, this method
     * returns true for any application ID (including null values). Otherwise, this method returns
     * true only if the {@link SpeechletRequest}'s {@code applicationId} is supported. If any of
     * {@link Session}, {@link Session#getApplication()}, or {@link Application#getApplicationId()}
     * is {@code null}, this method returns false, unless the {@link SpeechletRequest} is of a type
     * that does not have a {@link Session}.
     *
     * @return true if the provided application ID is supported by this verifier
     */
    @Override
    public boolean verify(SpeechletRequest request, Session session) {
        if (supportedApplicationIds.isEmpty()) {
            log.warn("Application ID verification has been disabled, allowing request for all "
                    + "application IDs");
            return true;
        }

        if (request == null) {
            return false;
        }

        boolean doesRequestTypeHaveASession =
                request instanceof LaunchRequest || request instanceof IntentRequest
                        || request instanceof SessionEndedRequest;

        if (!doesRequestTypeHaveASession) {
            return true;
        }

        boolean applicationIdIsMissingFromSession = session == null || session.getApplication() == null
                || session.getApplication().getApplicationId() == null;

        if (applicationIdIsMissingFromSession) {
            return false;
        }

        return supportedApplicationIds.contains(session.getApplication().getApplicationId());
    }

    /**
     * @return the set of supported application IDs
     */
    public Set getSupportedApplicationIds() {
        return supportedApplicationIds;
    }
}