smartrics.rest.fitnesse.fixture.support.HttpClientBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartrics-RestFixture Show documentation

The RestFixture is a FitNesse (http://fitnesse.org) fixture that allows developers and/or product owners to write test fixtures for REST services with simplicity in mind. The idea is to write tests that are self documenting and easy to write and read, without the need to write Java code. The fixture allows test writers to express tests as actions (any of the allowed HTTP methods) to operate on resource URIs and express expectations on the content of the return code, headers and body. All without writing one single line of Java code. And it also works as a living/executable documentation of the API.

There is a newer version: 4.4

Show newest version

/*  Copyright 2011 Fabrizio Cannizzo
 *
 *  This file is part of RestFixture.
 *
 *  RestFixture (http://code.google.com/p/rest-fixture/) is free software:
 *  you can redistribute it and/or modify it under the terms of the
 *  GNU Lesser General Public License as published by the Free Software Foundation,
 *  either version 3 of the License, or (at your option) any later version.
 *
 *  RestFixture 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with RestFixture.  If not, see .
 *
 *  If you want to contact the author please leave a comment here
 *  http://smartrics.blogspot.com/2008/08/get-fitnesse-with-some-rest.html
 */
package smartrics.rest.fitnesse.fixture.support;

import org.apache.commons.httpclient.Credentials;
import org.apache.commons.httpclient.HostConfiguration;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.commons.httpclient.auth.AuthScope;
import org.apache.commons.httpclient.params.HostParams;
import org.apache.commons.httpclient.params.HttpClientParams;


/**
 * Helper builder class for an apache {@link HttpClient} that uses data in the
 * {@link Config} to configure the object.
 * 
 * @author smartrics
 * 
 */
public class HttpClientBuilder {
	/**
	 * default value of the socket timeout: 3000ms.
	 */
    public static final Integer DEFAULT_SO_TO = 3000;
    /**
     * default value of the proxy port: 80.
     */
    public static final Integer DEFAULT_PROXY_PORT = 80;

    /**
     * @param config the {@link Config} containing the client configuration paramteres.
     * @return an instance of an {@link HttpClient}.
     */
    public HttpClient createHttpClient(final Config config) {
        HttpClient client = createConfiguredClient(config);
        if (config != null) {
            configureHost(config, client);
            configureCredentials(config, client);
        }
        return client;
    }

    private HttpClient createConfiguredClient(final Config config) {
        HttpClientParams params = new HttpClientParams();
        params.setSoTimeout(DEFAULT_SO_TO);
        if (config != null) {
            params.setSoTimeout(config.getAsInteger("http.client.connection.timeout", DEFAULT_SO_TO));
        }
        HttpClient client = new HttpClient(params);
        return client;
    }

    private void configureHost(final Config config, HttpClient client) {
        HostConfiguration hostConfiguration = client.getHostConfiguration();
        String proxyHost = config.get("http.proxy.host");
        if (proxyHost != null) {
            int proxyPort = config.getAsInteger("http.proxy.port", DEFAULT_PROXY_PORT);
            hostConfiguration.setProxy(proxyHost, proxyPort);
        }
        HostParams hostParams = new HostParams();
        hostConfiguration.setParams(hostParams);
    }

    private void configureCredentials(final Config config, HttpClient client) {
        String username = config.get("http.basicauth.username");
        String password = config.get("http.basicauth.password");
        if (username != null && password != null) {
            Credentials defaultcreds = new UsernamePasswordCredentials(username, password);
            client.getState().setCredentials(AuthScope.ANY, defaultcreds);
        }
    }
}