org.n52.tamis.rest.forward.processes.jobs.StatusRequestForwarder.java Source code

Java tutorial

Introduction

Here is the source code for org.n52.tamis.rest.forward.processes.jobs.StatusRequestForwarder.java

Source

/**
 * Copyright (C) 2016-2016 52North Initiative for Geospatial Open Source
 * Software GmbH
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 2 as publishedby the Free
 * Software Foundation.
 *
 * If the program is linked with libraries which are licensed under one of the
 * following licenses, the combination of the program with the linked library is
 * not considered a "derivative work" of the program:
 *
 *     - Apache License, version 2.0
 *     - Apache Software License, version 1.0
 *     - GNU Lesser General Public License, version 3
 *     - Mozilla Public License, versions 1.0, 1.1 and 2.0
 *     - Common Development and Distribution License (CDDL), version 1.0
 *
 * Therefore the distribution of the program linked with libraries licensed under
 * the aforementioned licenses, is permitted by the copyright holders if the
 * distribution is compliant with both the GNU General Public License version 2
 * and the aforementioned licenses.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.
 */
package org.n52.tamis.rest.forward.processes.jobs;

import javax.servlet.http.HttpServletRequest;

import org.n52.tamis.core.javarepresentations.processes.jobs.StatusDescription;
import org.n52.tamis.core.urlconstants.URL_Constants_TAMIS;
import org.n52.tamis.core.urlconstants.URL_Constants_WpsProxy;
import org.n52.tamis.rest.controller.ParameterValueStore;
import org.n52.tamis.rest.forward.AbstractRequestForwarder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.client.RestTemplate;

/**
 * Class to delegate a status description request to the WPS proxy.
 * 
 * @author Christian Danowski (contact: c.danowski@52north.org)
 *
 */
public class StatusRequestForwarder extends AbstractRequestForwarder {

    private static Logger logger = LoggerFactory.getLogger(StatusRequestForwarder.class);

    /**
     * {@inheritDoc} <br/>
     * <br/>
     * Delegates an incoming status description request to the WPS proxyand
     * creates an instance of {@link StatusDescription}
     * 
     * @param parameterValueStore
     *            must contain the URL variable
     *            {@link URL_Constants_TAMIS#SERVICE_ID_VARIABLE_NAME} to
     *            identify the WPS instance and
     *            {@link URL_Constants_TAMIS#PROCESS_ID_VARIABLE_NAME} to
     *            identify the process and
     *            {@link URL_Constants_TAMIS#JOB_ID_VARIABLE_NAME} to identify
     *            the job
     * @return an instance of {@link StatusDescription}
     */
    @Override
    public StatusDescription forwardRequestToWpsProxy(HttpServletRequest request, Object requestBody,
            ParameterValueStore parameterValueStore) {
        initializeRequestSpecificParameters(parameterValueStore);

        String statusDescription_url_wpsProxy = createTargetURL_WpsProxy(request);

        RestTemplate statusDescriptionTemplate = new RestTemplate();

        // fetch the status description from WPS proxy and
        // deserialize it into TAMIS status decsription
        StatusDescription statusDescriptionDoc = statusDescriptionTemplate
                .getForObject(statusDescription_url_wpsProxy, StatusDescription.class);

        String outputs = statusDescriptionDoc.getStatusInfo().getOutput();

        if (outputs != null) {
            /*
             * we want to replace the baseURL of the outputUrl field of the
             * statusDescription. From the WPS proxy, the returned outputUrl
             * field will point to a URL specific for the proxy. We need to
             * replace it with the right URL of this application (the base URL
             * will change).
             * 
             * outputURL_wpsProxy =
             * <baseURL_WpsProxy>/processes/<process_id>/jobs/<job_id>
             * outputURL_tamis =
             * <baseURL_Tamis>tamis_prefix/<service_id>/processes/<process_id>/
             * jobs/< job_id>
             */
            String tamis_baseUrl = constructTamisBaseUrl(request);

            String outputURL_tamis = tamis_baseUrl + "/" + URL_Constants_TAMIS.API_V1_BASE_PREFIX + "/"
                    + URL_Constants_TAMIS.TAMIS_PREFIX + "/" + this.getServiceId()
                    + URL_Constants_TAMIS.SLASH_PROCESSES + "/" + this.getProcessId()
                    + URL_Constants_TAMIS.SLASH_JOBS + "/" + this.getJobId() + URL_Constants_TAMIS.SLASH_OUTPUTS;
            statusDescriptionDoc.getStatusInfo().setOutput(outputURL_tamis);
        }

        return statusDescriptionDoc;
    }

    private String constructTamisBaseUrl(HttpServletRequest request) {
        String target_baseUrl = request.getScheme() + "://" + request.getServerName() + ":"
                + request.getServerPort() + request.getContextPath();
        return target_baseUrl;
    }

    @Override
    protected String setUpTargetUrl_WithSameBaseUrl(String contextURL) {
        /*
         * The difference between contextURL of TAMIS interface and the
         * targetURL of the WPS proxy is a prefix + service number:
         * 
         * contexURL:
         * "<baseURL>/constantServicePrefix/{service_id}/processes/{process_id}/jobs/{job_id}"
         * 
         * targetURL: "<baseURL>/processes/{process_id}/jobs/{job_id}"
         */

        String targetURL = contextURL.split(URL_Constants_TAMIS.TAMIS_PREFIX)[0];
        targetURL = targetURL + URL_Constants_WpsProxy.SLASH_PROCESSES + "/" + this.getProcessId()
                + URL_Constants_WpsProxy.SLASH_JOBS + "/" + this.getJobId();

        return targetURL;
    }

    @Override
    protected String setUpTargetUrl_WithDifferentBaseUrl(String baseURL_WpsProxy) {
        // targetURL: "<baseURL>/processes/{process_id}/jobs/{job_id}"
        return baseURL_WpsProxy + URL_Constants_WpsProxy.PROCESSES + "/" + this.getProcessId()
                + URL_Constants_WpsProxy.SLASH_JOBS + "/" + this.getJobId();
    }

}