com.unispezi.cpanelremotebackup.http.HTTPClient.java Source code

Introduction

Here is the source code for com.unispezi.cpanelremotebackup.http.HTTPClient.java

Source

/*  Copyright (C) 2012 Carsten Lergenmller
    
Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to the following
conditions:
    
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
    INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
    PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package com.unispezi.cpanelremotebackup.http;

import com.unispezi.cpanelremotebackup.tools.Log;
import org.apache.http.HttpHost;
import org.apache.http.HttpRequest;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.protocol.ClientContext;
import org.apache.http.impl.auth.BasicScheme;
import org.apache.http.impl.client.BasicAuthCache;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpParams;
import org.apache.http.protocol.BasicHttpContext;

import java.io.IOException;
import java.util.Map;

/**
 * This class is an HTTP client. It currently just hides an Apache Commons
 * HTTP client V4, but since all HTTP client logic is hidden behind this
 * class this could later be changed.
 */
public class HTTPClient {
    private DefaultHttpClient httpClient;
    private HttpHost host;
    private BasicHttpContext localcontext;

    public HTTPClient(String hostName, int port, boolean secure, String userName, String password) {
        this.httpClient = new DefaultHttpClient();
        host = new HttpHost(hostName, port, secure ? "https" : null);
        httpClient.getCredentialsProvider().setCredentials(new AuthScope(hostName, port),
                new UsernamePasswordCredentials(userName, password));

        //        HttpHost proxy = new HttpHost("localhost", 8888);
        //        httpClient.getParams().setParameter(ConnRoutePNames.DEFAULT_PROXY, proxy);

        // Set up HTTP basic auth (without challenge) or "preemptive auth"
        // Taken from http://hc.apache.org/httpcomponents-client-ga/tutorial/html/authentication.html#d5e1031

        // Create AuthCache instance
        BasicAuthCache authCache = new BasicAuthCache();
        // Generate BASIC scheme object and add it to the local auth cache
        BasicScheme basicAuth = new BasicScheme();
        authCache.put(host, basicAuth);

        // Add AuthCache to the execution context
        localcontext = new BasicHttpContext();
        localcontext.setAttribute(ClientContext.AUTH_CACHE, authCache);
    }

    public void post(String uri, Map<String, Object> params) {

        //Construct request
        HttpRequest request = new HttpPost(uri);
        Log.debug("Preparing POST of " + getUriLogString(uri));

        //set params
        HttpParams httpParams = new BasicHttpParams();
        for (String key : params.keySet()) {
            Object value = params.get(key);
            httpParams.setParameter(key, value);
            Log.debug("Adding param " + key + "=" + value);
        }
        request.setParams(httpParams);

        //Post
        try {
            Log.debug("POSTing " + getUriLogString(uri));
            HttpResponse response = httpClient.execute(host, request, localcontext);
            Log.debug("Response was " + response);
            int statusCode = response.getStatusLine().getStatusCode();
            if (statusCode == HttpStatus.SC_OK) {
                Log.info("POSTing " + getUriLogString(uri) + " was successful");
            } else {
                Log.error("POSTing " + getUriLogString(uri) + " failed with status code " + statusCode);
                throw new HTTPException(
                        "POSTing " + getUriLogString(uri) + " failed with status code " + statusCode);
            }
        } catch (IOException e) {
            Log.error("POSTing " + getUriLogString(uri) + " failed with exception " + e);
            throw new HTTPException("POSTing " + getUriLogString(uri) + " failed with exception ", e);
        }
    }

    private String getUriLogString(String uri) {
        return "\"" + host + uri + "\"";
    }
}