1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/SimpleHttpConnectionManager.java,v 1.12.2.1 2003/07/31 02:31:09 mbecke Exp $
3 * $Revision: 1.12.2.1 $
4 * $Date: 2003/07/31 02:31:09 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 2002-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient;
65
66 import java.io.IOException;
67 import java.io.InputStream;
68
69 /***
70 * A connection manager that provides access to a single HttpConnection. This
71 * manager makes no attempt to provide exclusive access to the contained
72 * HttpConnection.
73 *
74 * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a>
75 * @author Eric Johnson
76 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
77 * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
78 * @author Laura Werner
79 *
80 * @since 2.0
81 */
82 public class SimpleHttpConnectionManager implements HttpConnectionManager {
83
84 /*** The http connection */
85 private HttpConnection httpConnection;
86
87 /*** The value to set when calling setStaleCheckingEnabled() on connections */
88 private boolean connectionStaleCheckingEnabled = true;
89
90 /***
91 * Constructor for SimpleHttpConnectionManager.
92 */
93 public SimpleHttpConnectionManager() {
94 super();
95 }
96
97 /***
98 * @see HttpConnectionManager#getConnection(HostConfiguration)
99 */
100 public HttpConnection getConnection(HostConfiguration hostConfiguration) {
101 return getConnection(hostConfiguration, 0);
102 }
103
104 /***
105 * Gets the staleCheckingEnabled value to be set on HttpConnections that are created.
106 *
107 * @return <code>true</code> if stale checking will be enabled on HttpConections
108 *
109 * @see HttpConnection#isStaleCheckingEnabled()
110 */
111 public boolean isConnectionStaleCheckingEnabled() {
112 return connectionStaleCheckingEnabled;
113 }
114
115 /***
116 * Sets the staleCheckingEnabled value to be set on HttpConnections that are created.
117 *
118 * @param connectionStaleCheckingEnabled <code>true</code> if stale checking will be enabled
119 * on HttpConections
120 *
121 * @see HttpConnection#setStaleCheckingEnabled(boolean)
122 */
123 public void setConnectionStaleCheckingEnabled(boolean connectionStaleCheckingEnabled) {
124 this.connectionStaleCheckingEnabled = connectionStaleCheckingEnabled;
125 }
126
127 /***
128 * @see HttpConnectionManager#getConnection(HostConfiguration, long)
129 */
130 public HttpConnection getConnection(
131 HostConfiguration hostConfiguration, long timeout) {
132
133 if (httpConnection == null) {
134 httpConnection = new HttpConnection(hostConfiguration);
135 httpConnection.setStaleCheckingEnabled(connectionStaleCheckingEnabled);
136 } else {
137
138 // make sure the host and proxy are correct for this connection
139 // close it and set the values if they are not
140 if (!hostConfiguration.hostEquals(httpConnection)
141 || !hostConfiguration.proxyEquals(httpConnection)) {
142
143 if (httpConnection.isOpen()) {
144 httpConnection.close();
145 }
146
147 httpConnection.setStaleCheckingEnabled(connectionStaleCheckingEnabled);
148
149 httpConnection.setHost(hostConfiguration.getHost());
150 httpConnection.setVirtualHost(hostConfiguration.getVirtualHost());
151 httpConnection.setPort(hostConfiguration.getPort());
152 httpConnection.setProtocol(hostConfiguration.getProtocol());
153 httpConnection.setLocalAddress(hostConfiguration.getLocalAddress());
154
155 httpConnection.setProxyHost(hostConfiguration.getProxyHost());
156 httpConnection.setProxyPort(hostConfiguration.getProxyPort());
157 } else {
158 finishLastResponse(httpConnection);
159 }
160 }
161
162 return httpConnection;
163 }
164
165 /***
166 * @see HttpConnectionManager#releaseConnection(org.apache.commons.httpclient.HttpConnection)
167 */
168 public void releaseConnection(HttpConnection conn) {
169 if (conn != httpConnection) {
170 throw new IllegalStateException("Unexpected close on a different connection.");
171 }
172
173 finishLastResponse(httpConnection);
174 }
175
176 /***
177 * Since the same connection is about to be reused, make sure the
178 * previous request was completely processed, and if not
179 * consume it now.
180 * @param conn The connection
181 */
182 static void finishLastResponse(HttpConnection conn) {
183 InputStream lastResponse = conn.getLastResponseInputStream();
184 if (lastResponse != null) {
185 conn.setLastResponseInputStream(null);
186 try {
187 lastResponse.close();
188 } catch (IOException ioe) {
189 //FIXME: badness - close to force reconnect.
190 conn.close();
191 }
192 }
193 }
194 }
This page was automatically generated by Maven