com.cognifide.aet.rest.ConfigsServlet.java Source code

Introduction

Here is the source code for com.cognifide.aet.rest.ConfigsServlet.java

Source

/**
 * Automated Exploratory Tests
 *
 * Copyright (C) 2013 Cognifide Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.cognifide.aet.rest;

import com.google.gson.Gson;

import com.cognifide.aet.communication.api.CommunicationSettings;
import com.cognifide.aet.communication.api.queues.JmsConnection;
import com.cognifide.aet.communication.api.queues.JmsEndpointConfig;
import com.cognifide.aet.rest.helpers.ReportConfigurationManager;
import com.cognifide.aet.rest.helpers.SuitesListProvider;
import com.cognifide.aet.vs.MetadataDAO;

import org.apache.commons.lang3.StringUtils;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.ConfigurationPolicy;
import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.osgi.service.http.HttpService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.io.PrintWriter;
import java.net.HttpURLConnection;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Service
@Component(label = "ConfigsServlet", description = "Provides config for clients a", immediate = true, metatype = true, policy = ConfigurationPolicy.IGNORE)
public class ConfigsServlet extends HttpServlet {

    private static final long serialVersionUID = 101244102274582495L;

    private static final Logger LOGGER = LoggerFactory.getLogger(ConfigsServlet.class);

    public static final String LOCKS_PARAM = "locks";

    public static final String LIST_PARAM = "list";

    public static final String COMMUNICATION_SETTINGS_PARAM = "communicationSettings";

    @Reference
    private transient HttpService httpService;

    @Reference
    private transient JmsConnection jmsConnection;

    @Reference
    private transient MetadataDAO metadataDAO;

    @Reference
    private transient LockService lockService;

    @Reference
    private transient ReportConfigurationManager reportConfigurationManager;

    /***
     * Returns JSON representation of Suite based on correlationId or suite name.
     * If suite name is provided, then newest version of JSON is returned.
     *
     * @param req
     * @param resp
     */
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
        LOGGER.debug("GET, req: '{}'", req);
        PrintWriter responseWriter = retrieveResponseWriter(req, resp);
        if (responseWriter != null) {
            resp.setContentType("application/json");
            String configType = StringUtils.substringAfter(req.getRequestURI(), Helper.getConfigsPath())
                    .replace(Helper.PATH_SEPARATOR, "");
            String reportDomain = reportConfigurationManager.getReportDomain();

            if (COMMUNICATION_SETTINGS_PARAM.equals(configType)) {
                JmsEndpointConfig jmsEndpointConfig = jmsConnection.getEndpointConfig();
                CommunicationSettings communicationSettings = new CommunicationSettings(jmsEndpointConfig,
                        reportDomain);
                responseWriter.write(new Gson().toJson(communicationSettings));
            } else if (LIST_PARAM.equals(configType)) {
                resp.setContentType("text/html; charset=utf-8");
                resp.setHeader("User-Agent",
                        "Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36");
                responseWriter.write(new SuitesListProvider(metadataDAO, reportDomain).listSuites());
            } else if (LOCKS_PARAM.equals(configType)) {
                responseWriter.write(getLocks());
            } else {
                resp.setStatus(HttpURLConnection.HTTP_BAD_REQUEST);
                responseWriter.write("Unable to get given config.");
            }
        } else {
            resp.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
        }
        flushResponseBuffer(req, resp);
    }

    private PrintWriter retrieveResponseWriter(HttpServletRequest req, HttpServletResponse resp) {
        PrintWriter printWriter = null;
        try {
            printWriter = resp.getWriter();
        } catch (IOException e) {
            LOGGER.error("error while getting response writer for request: '{}' and response: '{}'", req, resp, e);
        }
        return printWriter;
    }

    private void flushResponseBuffer(HttpServletRequest req, HttpServletResponse resp) {
        try {
            resp.flushBuffer();
        } catch (IOException e) {
            LOGGER.error("error while flushing response buffer for request: '{}' and response: '{}'", req, resp, e);
        }
    }

    private String getLocks() {
        return lockService.getAllLocks().toString();
    }

    @Override
    public void init(ServletConfig config) throws ServletException {
        LOGGER.info("Initializing " + config.getServletName());
    }

    @Activate
    public void start() {
        LOGGER.debug("Registering servlet at " + Helper.getConfigsPath());
        try {
            httpService.registerServlet(Helper.getConfigsPath(), this, null, null);
        } catch (Exception e) {
            LOGGER.error("Failed to register servlet at " + Helper.getConfigsPath(), e);
        }
    }

    @Deactivate
    public void stop() {
        httpService.unregister(Helper.getConfigsPath());
        httpService = null;
    }

}