HttpGetRequestSender.java

package com.epam.wilma.gepard.testclient;

/*==========================================================================
Copyright 2013-2017 EPAM Systems

This file is part of Wilma.

Wilma is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Wilma 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.

You should have received a copy of the GNU General Public License
along with Wilma.  If not, see <http://www.gnu.org/licenses/>.
===========================================================================*/

import com.epam.wilma.gepard.WilmaTestCase;
import com.epam.wilma.gepard.testclient.compression.fis.FastInfosetCompressor;
import com.epam.wilma.gepard.testclient.compression.gzip.GzipCompressor;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.io.IOUtils;
import org.xml.sax.SAXException;

import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map.Entry;

/**
 * Sends a new HTTP request to a server through a proxy.
 *
 * @author Tamas_Kohegyi
 */
public class HttpGetRequestSender {

    private static final String DEFAULT_BUFFER_SIZE_STRING = "20000";
    private final FastInfosetCompressor fastInfosetCompressor = new FastInfosetCompressor();
    private final GzipCompressor gzipCompressor = new GzipCompressor();

    /**
     * Sends a new HTTP request to a server through a proxy. Also logs request and response with gepard framework.
     *
     * @param tc is the caller Test Case.
     * @param requestParameters a set of parameters that will set the content of the request
     *                          and specify the proxy it should go through
     * @return with Response Holder class.
     * @throws IOException                  in case error occurs
     * @throws ParserConfigurationException in case error occurs
     * @throws SAXException                 in case error occurs
     */
    public ResponseHolder callWilmaTestServer(final WilmaTestCase tc, final RequestParameters requestParameters) throws IOException,
            ParserConfigurationException, SAXException {
        String responseCode;
        ResponseHolder responseMessage;

        HttpClient httpClient = new HttpClient();
        GetMethod httpGet = new GetMethod(requestParameters.getTestServerUrl());
        if (requestParameters.isUseProxy()) {
            httpClient.getHostConfiguration().setProxy(requestParameters.getWilmaHost(), requestParameters.getWilmaPort());
        }
        createRequest(requestParameters, httpGet);
        tc.logGetRequestEvent(requestParameters); //this dumps the request

        String sendBuffer;
        try {
            sendBuffer = tc.getTestClassExecutionData().getEnvironment().getProperty("http.socket.sendbuffer");
        } catch (NullPointerException e) {
            sendBuffer = DEFAULT_BUFFER_SIZE_STRING;
        }
        String receiveBuffer;
        try {
            receiveBuffer = tc.getTestClassExecutionData().getEnvironment().getProperty("http.socket.receivebuffer");
        } catch (NullPointerException e) {
            receiveBuffer = DEFAULT_BUFFER_SIZE_STRING;
        }

        httpClient.getHttpConnectionManager().getParams().setSendBufferSize(Integer.valueOf(sendBuffer));
        httpClient.getHttpConnectionManager().getParams().setReceiveBufferSize(Integer.valueOf(receiveBuffer));
        int statusCode;
        statusCode = httpClient.executeMethod(httpGet);
        responseCode = "status code: " + statusCode + "\n";
        responseMessage = createResponse(httpGet);
        responseMessage.setResponseCode(responseCode);
        tc.setActualResponseCode(statusCode);
        Header contentTypeHeader = httpGet.getResponseHeader("Content-Type");
        if (contentTypeHeader != null) {
            tc.setActualResponseContentType(contentTypeHeader.getValue());
        }
        Header sequenceHeader = httpGet.getResponseHeader("Wilma-Sequence");
        if (sequenceHeader != null) {
            tc.setActualDialogDescriptor(sequenceHeader.getValue());
        }
        tc.logResponseEvent(responseMessage); //this dumps the response

        return responseMessage;
    }

    private void createRequest(final RequestParameters requestParameters, final GetMethod httpGet) throws IOException, ParserConfigurationException,
            SAXException {
        httpGet.setRequestHeader("Accept", requestParameters.getAcceptHeader());
        httpGet.addRequestHeader("Accept-Encoding", requestParameters.getAcceptEncoding());
        if (requestParameters.getSpecialHeader() != null) {
            httpGet.addRequestHeader("Special-Header", requestParameters.getSpecialHeader());
        }
        for (Entry<String, String> header : requestParameters.getCustomHeaders()) {
            httpGet.addRequestHeader(header.getKey(), header.getValue());
        }
    }

    private ResponseHolder createResponse(final GetMethod httpGet) throws IOException {
        ResponseHolder responseHolder = new ResponseHolder();
        String responseMessage;
        InputStream responseBodyAsStream = httpGet.getResponseBodyAsStream();
        if (httpGet.getResponseHeader("Content-Encoding") != null && httpGet.getResponseHeader("Content-Encoding").getValue().contains("gzip")) {
            responseBodyAsStream = gzipCompressor.decompress(responseBodyAsStream);
        }
        if (httpGet.getResponseHeader("Content-type") != null && httpGet.getResponseHeader("Content-type").getValue().contains("fastinfoset")) {
            try {
                responseMessage = fastInfosetCompressor.decompress(responseBodyAsStream);
            } catch (TransformerException e) {
                responseMessage = httpGet.getResponseBodyAsString();
            }
        } else {
            responseMessage = IOUtils.toString(responseBodyAsStream, "UTF-8");
        }
        responseHolder.setResponseMessage(responseMessage);
        responseHolder.setHttpGet(httpGet);
        return responseHolder;
    }
}