Java tutorial
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 2010-2011 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * http://glassfish.java.net/public/CDDL+GPL_1_1.html * or packager/legal/LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at packager/legal/LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. */ package com.sun.jersey.client.apache; import com.sun.jersey.api.client.Client; import com.sun.jersey.api.client.config.ClientConfig; import com.sun.jersey.api.client.config.DefaultClientConfig; import com.sun.jersey.client.apache.config.ApacheHttpClientConfig; import com.sun.jersey.client.apache.config.DefaultApacheHttpClientConfig; import com.sun.jersey.core.spi.component.ioc.IoCComponentProviderFactory; import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.MultiThreadedHttpConnectionManager; /** * A {@link Client} that utilizes the Apache HTTP client to send and receive * HTTP request and responses. * <p> * If an {@link ApacheHttpClientHandler} is not explicitly passed as a * constructor or method parameter then by default an instance is created with * an {@link HttpClient} constructed with a {@link MultiThreadedHttpConnectionManager} * instance. * <p> * The following properties are only supported at construction of this class: * {@link ApacheHttpClientConfig#PROPERTY_PREEMPTIVE_AUTHENTICATION} and * {@link ClientConfig#PROPERTY_CONNECT_TIMEOUT}. * <p> * By default a request entity is buffered and repeatable such that * authorization may be performed automatically in response to a 401 response. * <p> * If the property {@link ClientConfig#PROPERTY_CHUNKED_ENCODING_SIZE} size * is set to a value greater than 0 then chunked encoding will be enabled * and the request entity (if present) will not be buffered and is not * repeatable. For authorization to work in such scenarios the property * {@link ApacheHttpClientConfig#PROPERTY_PREEMPTIVE_AUTHENTICATION} must * be set to true. * <p> * If a response entity is obtained that is an instance of * {@link java.io.Closeable} * then the instance MUST be closed after processing the entity to release * connection-based resources. * <p> * If a {@link com.sun.jersey.api.client.ClientResponse} is obtained and an * entity is not read from the response then * {@link com.sun.jersey.api.client.ClientResponse#close() } MUST be called * after processing the response to release connection-based resources. * * @author jorgeluisw@mac.com * @author Paul.Sandoz@Sun.Com */ public class ApacheHttpClient extends Client { private ApacheHttpClientHandler clientHandler; /** * Create a new client instance. * */ public ApacheHttpClient() { this(createDefaultClientHander(new DefaultApacheHttpClientConfig())); } /** * Create a new client instance. * * @param root the root client handler for dispatching a request and * returning a response. */ public ApacheHttpClient(ApacheHttpClientHandler root) { this(root, null); } /** * Create a new instance with a client configuration and a * component provider. * * @param root the root client handler for dispatching a request and * returning a response. * @param config the client configuration. * @param provider the IoC component provider factory. * @deprecated the config parameter is no longer utilized and instead * the config obtained from the {@link ApacheHttpClientHandler#getConfig() } * is utilized instead. */ @Deprecated public ApacheHttpClient(ApacheHttpClientHandler root, ClientConfig config, IoCComponentProviderFactory provider) { this(root, provider); } /** * Create a new instance with a client configuration and a * component provider. * * @param root the root client handler for dispatching a request and * returning a response. * @param provider the IoC component provider factory. */ public ApacheHttpClient(ApacheHttpClientHandler root, IoCComponentProviderFactory provider) { super(root, root.getConfig(), provider); this.clientHandler = root; inject(this.clientHandler.getMethodProcessor()); } /** * Get the Apache HTTP client handler. * * @return the Apache HTTP client handler. */ public ApacheHttpClientHandler getClientHandler() { return clientHandler; } /** * Create a default client. * * @return a default client. */ public static ApacheHttpClient create() { return create(new DefaultApacheHttpClientConfig()); } /** * Create a default client with client configuration. * * @param cc the client configuration. * @return a default client. */ public static ApacheHttpClient create(ClientConfig cc) { return create(cc, null); } /** * Create a default client with client configuration and component provider. * * @param cc the client configuration. * @param provider the IoC component provider factory. * @return a default client. */ public static ApacheHttpClient create(ClientConfig cc, IoCComponentProviderFactory provider) { return new ApacheHttpClient(createDefaultClientHander(cc), provider); } /** * Create a default Apache HTTP client handler. * * @return a default Apache HTTP client handler. */ private static ApacheHttpClientHandler createDefaultClientHander(ClientConfig cc) { final HttpClient client = new HttpClient(new MultiThreadedHttpConnectionManager()); return new ApacheHttpClientHandler(client, cc); } }