com.amazon.ask.mvc.annotation.mapping.RequestMapping Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ask-sdk-mvc Show documentation

The Alexa Skills Kit MVC Framework extends the existing ASK SDK, adding features for mapping requests to methods and rendering responses via view scripts and templates such as Nashorn Javascript and Freemarker. It also integrates with the ASK SDK Interaction Model Mapper framework to create a single environment where both the interaction model and business logic of skills can be managed as code packages.

The newest version!

/*
    Copyright 2018 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.ask.mvc.annotation.mapping;

import com.amazon.ask.dispatcher.request.handler.HandlerInput;
import com.amazon.ask.dispatcher.request.handler.RequestHandler;
import com.amazon.ask.model.IntentRequest;
import com.amazon.ask.model.Request;
import com.amazon.ask.mvc.annotation.plugin.AutoRequestHandler;
import com.amazon.ask.mvc.mapper.invoke.MethodInvoker;
import com.amazon.ask.mvc.mapper.invoke.RequestHandlerMethod;
import com.amazon.ask.mvc.view.ViewRenderer;
import com.amazon.ask.mvc.mapper.ControllerMethodContext;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.Arrays;
import java.util.Set;
import java.util.stream.Collectors;

import static com.amazon.ask.util.ValidationUtils.assertNotNull;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Annotation for mapping requests by type to methods.
 *
 * To map {@link IntentRequest} use {@link IntentMapping} instead.
 *
 * @see AutoRequestHandler to understand how this mapping is discovered
 * @see Plugin for the resolution implementation
 */
@Documented
@Target(METHOD)
@Retention(RUNTIME)
@AutoRequestHandler(RequestMapping.Plugin.class)
public @interface RequestMapping {
    /**
     * @return request types to match
     */
    Class[] value() default {};

    /**
     * @return request types to match. Same as value()
     */
    Class[] types() default {};

    /**
     * Resolve a {@link RequestHandler} from a method annotated with {@link RequestMapping}.
     *
     * @see Handler for the {@link RequestHandler} implementation.
     */
    class Plugin implements AutoRequestHandler.Plugin {
        @Override
        public RequestHandler apply(ControllerMethodContext context, RequestMapping annotation) {
            return new Handler(context, Arrays
                .stream(annotation.types().length == 0 ? annotation.value() : annotation.types())
                .collect(Collectors.toSet()));
        }
    }

    /**
     * Invoke a controller's method to handle a request.
     *
     * This class primarily implements {@link #canHandle(HandlerInput)} to filter requests by their type.
     *
     * @see RequestHandlerMethod for the invocation logic.
     */
    class Handler extends RequestHandlerMethod {
        private final Set> requestTypes;

        public Handler(ControllerMethodContext context, Set> requestTypes) {
            this(context, requestTypes, MethodInvoker.getInstance(), ViewRenderer.getInstance());

        }
        public Handler(ControllerMethodContext context, Set> requestTypes, MethodInvoker invoker, ViewRenderer renderer) {
            super(context, invoker, renderer);
            this.requestTypes = assertNotNull(requestTypes, "requestTypes");
        }

        @Override
        public boolean canHandle(HandlerInput input) {
            return requestTypes.contains(input.getRequestEnvelope().getRequest().getClass());
        }
    }
}