com.amazon.ask.mvc.view.BaseView 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.view;

import com.amazon.ask.model.RequestEnvelope;
import com.amazon.ask.model.Response;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.HashMap;
import java.util.Map;

import static com.amazon.ask.util.ValidationUtils.assertNotNull;

/**
 * Appends the request envelope to the mode, renders the response to a JSON string and parses the result.
 */
public abstract class BaseView implements View {
    protected final Logger logger = LoggerFactory.getLogger(getClass());
    protected final ObjectMapper mapper;

    protected BaseView(ObjectMapper mapper) {
        this.mapper = assertNotNull(mapper, "mapper");
    }

    @Override
    public Response render(Object mav, RequestEnvelope requestEnvelope) throws Exception {
        return render(prepareModel((ModelAndView) mav, requestEnvelope));
    }

    protected Response render(Map model) throws Exception {
        return mapper.readValue(renderInternal(model), Response.class);
    }

    protected abstract String renderInternal(Map model) throws Exception;

    protected Map prepareModel(ModelAndView mav, RequestEnvelope requestEnvelope) {
        Map model = new HashMap<>(mav.getModel());
        model.put("envelope", requestEnvelope);
        model.put("request", requestEnvelope.getRequest());
        model.put("session", requestEnvelope.getSession());
        return model;
    }

}