com.sirika.httpclienthelpers.springframework.HttpClientFactoryBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of httpclienthelpers-springsupport Show documentation
The newest version!
/**
 * Copyright 2009 Sami Dalouche
 *
 * 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.sirika.httpclienthelpers.springframework;

import java.util.HashMap;
import java.util.Map;

import org.apache.http.auth.AuthScope;
import org.apache.http.auth.Credentials;
import org.apache.http.client.CookieStore;
import org.apache.http.client.HttpClient;
import org.apache.http.client.params.AllClientPNames;
import org.apache.http.conn.params.ConnPerRouteBean;
import org.apache.http.impl.client.BasicCookieStore;
import org.springframework.beans.factory.FactoryBean;

import com.sirika.httpclienthelpers.DefaultHttpClientFactory;

/**
 * Spring {@link FactoryBean} helper that eases the creation and configuration
 * of HttpComponents' {@link HttpClient}. Configuring HttpClient authentication,
 * number of connections, ... cannot be done declaratively using HttpClient's
 * native mechanisms. {@link HttpClientFactoryBean}'s goal is to expose these
 * settings so they can be changed declaratively using Spring.
 * 
 * 
 * @author Sami Dalouche ([email protected])
 * 
 */
public final class HttpClientFactoryBean implements FactoryBean {
    private Map credentials = new HashMap();
    private Map params = new HashMap();
    private CookieStore cookieStore = null;
    private boolean shouldUseCookieStore = false;
    private boolean shouldUseGzipContentcompression = true;
    private Integer maxTotalConnections = null;
    private Integer defaultMaxConnectionsPerRoute = null;

    public HttpClient getObject() throws Exception {
        if (maxTotalConnections != null) {
            params.put(AllClientPNames.MAX_TOTAL_CONNECTIONS,
                    maxTotalConnections);
        }
        if (defaultMaxConnectionsPerRoute != null) {
            params.put(AllClientPNames.MAX_CONNECTIONS_PER_ROUTE,
                    new ConnPerRouteBean(defaultMaxConnectionsPerRoute));
        }

        return DefaultHttpClientFactory.httpClient(credentials, params,
                cookieStore(), shouldUseGzipContentcompression);
    }

    private CookieStore cookieStore() {
        CookieStore cookieStoreToUse = null;
        if (shouldUseCookieStore == true) {
            cookieStoreToUse = cookieStore == null ? new BasicCookieStore()
                    : cookieStore;
        }
        return cookieStoreToUse;
    }

    public Class getObjectType() {
        return HttpClient.class;
    }

    public boolean isSingleton() {
        return true;
    }

    public void setCredentials(Map credentials) {
        this.credentials = credentials;
    }

    public void setCookieStore(CookieStore cookieStore) {
        this.shouldUseCookieStore = true;
        this.cookieStore = cookieStore;
    }

    public void setShouldUseCookieStore(boolean shouldUseCookieStore) {
        this.shouldUseCookieStore = shouldUseCookieStore;
    }

    public void setShouldUseGzipContentcompression(
            boolean shouldUseGzipContentcompression) {
        this.shouldUseGzipContentcompression = shouldUseGzipContentcompression;
    }

    /**
     * See http://hc.apache.org/httpclient-3.x/preference-api.html
     * 
     * @param params
     */
    public void setParams(Map params) {
        this.params = params;
    }

    public void setMaxTotalConnections(Integer maxTotalConnections) {
        this.maxTotalConnections = maxTotalConnections;
    }

    public void setDefaultMaxConnectionsPerRoute(
            Integer defaultMaxConnectionsPerRoute) {
        this.defaultMaxConnectionsPerRoute = defaultMaxConnectionsPerRoute;
    }

}