2011/08/05 - Jakarta Cactus has been retired.

For more information, please explore the Attic.

Clover coverage report - Cactus 1.8dev for J2EE API 1.3

Coverage timestamp: Sun Mar 26 2006 18:50:18 BRT

FRAMES NO FRAMES

file stats:	LOC:	223		Methods:	5
	NCLOC:	119		Classes:	1

30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover

Source file

Conditionals

Statements

Methods

TOTAL

HttpClientConnectionHelper.java

72.2%

87%

80%

82.6%

 /* 
  * ========================================================================
  * 
  * Copyright 2001-2004 The Apache Software Foundation.
  *
  * 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 org.apache.cactus.internal.client.connector.http;
 
 import java.io.IOException;
 
 import java.net.HttpURLConnection;
 import java.net.URL;
 
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
 
 import org.apache.cactus.WebRequest;
 import org.apache.cactus.client.authentication.Authentication;
 import org.apache.cactus.internal.configuration.Configuration;
 import org.apache.cactus.internal.util.CookieUtil;
 import org.apache.cactus.internal.util.UrlUtil;
 import org.apache.commons.httpclient.HostConfiguration;
 import org.apache.commons.httpclient.HttpClient;
 import org.apache.commons.httpclient.HttpState;
 import org.apache.commons.httpclient.HttpMethod;
 import org.apache.commons.httpclient.NameValuePair;
 import org.apache.commons.httpclient.methods.GetMethod;
 import org.apache.commons.httpclient.methods.PostMethod;
 import org.apache.commons.httpclient.protocol.Protocol;
 
 /**
  * Implementation of <code>ConnectionHelper</code> using Jakarta Commons
  * HttpClient.
  *
  * @version $Id: HttpClientConnectionHelper.java 238991 2004-05-22 11:34:50Z vmassol $
  */
 public class HttpClientConnectionHelper implements ConnectionHelper
 {
     /**
      * The <code>HttpMethod</code> used to connect to the HTTP server. It is
      * either a <code>GetMethod</code> or a <code>PostMethod</code>.
      */
     private HttpMethod method;
 
     /**
      * The URL that will be used for the HTTP connection.
      */
     private String url;
 
     /**
      * @param theURL the URL that will be used for the HTTP connection.
      */
     public HttpClientConnectionHelper(String theURL)
     {
         this.url = theURL;
     }
 
     /**
      * @see ConnectionHelper#connect(WebRequest, Configuration)
      */
     public HttpURLConnection connect(WebRequest theRequest, 
         Configuration theConfiguration) throws Throwable
     {
         URL url = new URL(this.url);
 
         HttpState state = new HttpState();
 
         // Choose the method that we will use to post data :
         // - If at least one parameter is to be sent in the request body, then
         //   we are doing a POST.
         // - If user data has been specified, then we are doing a POST
         if (theRequest.getParameterNamesPost().hasMoreElements()
             || (theRequest.getUserData() != null))
         {
             this.method = new PostMethod();
         }
         else
         {
             this.method = new GetMethod();
         }
 
         // Add Authentication headers, if necessary. This is the first
         // step to allow authentication to add extra headers, HTTP parameters,
         // etc.
         Authentication authentication = theRequest.getAuthentication();
 
         if (authentication != null)
         {
             authentication.configure(state, this.method, theRequest, 
                 theConfiguration);
         }
 
         // Add the parameters that need to be passed as part of the URL
         url = HttpUtil.addHttpGetParameters(theRequest, url);
 
         this.method.setFollowRedirects(false);
         this.method.setPath(UrlUtil.getPath(url));
         this.method.setQueryString(UrlUtil.getQuery(url));
 
         // Sets the content type
         this.method.setRequestHeader("Content-type", 
             theRequest.getContentType());
 
         // Add the other header fields
         addHeaders(theRequest);
 
         // Add the POST parameters if no user data has been specified (user data
         // overried post parameters)
         if (theRequest.getUserData() != null)
         {
             addUserData(theRequest);
         }
         else
         {
             addHttpPostParameters(theRequest);
         }
 
         // Add the cookies to the state
         state.addCookies(CookieUtil.createHttpClientCookies(theRequest, 
             url));
 
         // Open the connection and get the result
         HttpClient client = new HttpClient();
         HostConfiguration hostConfiguration = new HostConfiguration();
         hostConfiguration.setHost(url.getHost(), url.getPort(),
             Protocol.getProtocol(url.getProtocol()));
         client.setState(state);
         client.executeMethod(hostConfiguration, this.method);
 
         // Wrap the HttpClient method in a java.net.HttpURLConnection object
         return new org.apache.commons.httpclient.util.HttpURLConnection(
             this.method, url);
     }
     
     /**
      * Add the HTTP parameters that need to be passed in the request body.
      *
      * @param theRequest the request containing all data to pass to the server
      *        redirector.
      */
     private void addHttpPostParameters(WebRequest theRequest)
     {
         // If no parameters, then exit
         if (!theRequest.getParameterNamesPost().hasMoreElements())
         {
             return;
         }
 
         Enumeration keys = theRequest.getParameterNamesPost();
         List parameters = new ArrayList();
         while (keys.hasMoreElements())
         {
             String key = (String) keys.nextElement();
             String[] values = theRequest.getParameterValuesPost(key);
             for (int i = 0; i < values.length; i++)
             {
                 parameters.add(new NameValuePair(key, values[i]));
             }
         }
         ((PostMethod) this.method).setRequestBody(
             (NameValuePair[]) parameters.toArray(
                 new NameValuePair[parameters.size()]));
     }
 
     /**
      * Add the Headers to the request.
      *
      * @param theRequest the request containing all data to pass to the server
      *        redirector.
      */
     private void addHeaders(WebRequest theRequest)
     {
         Enumeration keys = theRequest.getHeaderNames();
 
         while (keys.hasMoreElements())
         {
             String key = (String) keys.nextElement();
             String[] values = theRequest.getHeaderValues(key);
 
             StringBuffer fullHeaderValue = new StringBuffer(values[0]);
 
             for (int i = 1; i < values.length; i++)
             {
                 fullHeaderValue.append("," + values[i]);
             }
 
             this.method.addRequestHeader(key, fullHeaderValue.toString());
         }
     }
 
     /**
      * Add user data in the request body.
      *
      * @param theRequest the request containing all data to pass to the server
      *        redirector.
      * @exception IOException if we fail to read the user data
      */
     private void addUserData(WebRequest theRequest) throws IOException
     {
         // If no user data, then exit
         if (theRequest.getUserData() == null)
         {
             return;
         }
 
         ((PostMethod) this.method).setRequestBody(theRequest.getUserData());
     }
 }
 

1		/*
2		* ========================================================================
3		*
4		* Copyright 2001-2004 The Apache Software Foundation.
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*
18		* ========================================================================
19		*/
20		package org.apache.cactus.internal.client.connector.http;
21
22		import java.io.IOException;
23
24		import java.net.HttpURLConnection;
25		import java.net.URL;
26
27		import java.util.ArrayList;
28		import java.util.Enumeration;
29		import java.util.List;
30
31		import org.apache.cactus.WebRequest;
32		import org.apache.cactus.client.authentication.Authentication;
33		import org.apache.cactus.internal.configuration.Configuration;
34		import org.apache.cactus.internal.util.CookieUtil;
35		import org.apache.cactus.internal.util.UrlUtil;
36		import org.apache.commons.httpclient.HostConfiguration;
37		import org.apache.commons.httpclient.HttpClient;
38		import org.apache.commons.httpclient.HttpState;
39		import org.apache.commons.httpclient.HttpMethod;
40		import org.apache.commons.httpclient.NameValuePair;
41		import org.apache.commons.httpclient.methods.GetMethod;
42		import org.apache.commons.httpclient.methods.PostMethod;
43		import org.apache.commons.httpclient.protocol.Protocol;
44
45		/**
46		* Implementation of <code>ConnectionHelper</code> using Jakarta Commons
47		* HttpClient.
48		*
49		* @version $Id: HttpClientConnectionHelper.java 238991 2004-05-22 11:34:50Z vmassol $
50		*/
51		public class HttpClientConnectionHelper implements ConnectionHelper
52		{
53		/**
54		* The <code>HttpMethod</code> used to connect to the HTTP server. It is
55		* either a <code>GetMethod</code> or a <code>PostMethod</code>.
56		*/
57		private HttpMethod method;
58
59		/**
60		* The URL that will be used for the HTTP connection.
61		*/
62		private String url;
63
64		/**
65		* @param theURL the URL that will be used for the HTTP connection.
66		*/
67	48	public HttpClientConnectionHelper(String theURL)
68		{
69	48	this.url = theURL;
70		}
71
72		/**
73		* @see ConnectionHelper#connect(WebRequest, Configuration)
74		*/
75	48	public HttpURLConnection connect(WebRequest theRequest,
76		Configuration theConfiguration) throws Throwable
77		{
78	48	URL url = new URL(this.url);
79
80	48	HttpState state = new HttpState();
81
82		// Choose the method that we will use to post data :
83		// - If at least one parameter is to be sent in the request body, then
84		// we are doing a POST.
85		// - If user data has been specified, then we are doing a POST
86	48	if (theRequest.getParameterNamesPost().hasMoreElements()
87		\|\| (theRequest.getUserData() != null))
88		{
89	1	this.method = new PostMethod();
90		}
91		else
92		{
93	47	this.method = new GetMethod();
94		}
95
96		// Add Authentication headers, if necessary. This is the first
97		// step to allow authentication to add extra headers, HTTP parameters,
98		// etc.
99	48	Authentication authentication = theRequest.getAuthentication();
100
101	48	if (authentication != null)
102		{
103	0	authentication.configure(state, this.method, theRequest,
104		theConfiguration);
105		}
106
107		// Add the parameters that need to be passed as part of the URL
108	48	url = HttpUtil.addHttpGetParameters(theRequest, url);
109
110	48	this.method.setFollowRedirects(false);
111	48	this.method.setPath(UrlUtil.getPath(url));
112	48	this.method.setQueryString(UrlUtil.getQuery(url));
113
114		// Sets the content type
115	48	this.method.setRequestHeader("Content-type",
116		theRequest.getContentType());
117
118		// Add the other header fields
119	48	addHeaders(theRequest);
120
121		// Add the POST parameters if no user data has been specified (user data
122		// overried post parameters)
123	48	if (theRequest.getUserData() != null)
124		{
125	0	addUserData(theRequest);
126		}
127		else
128		{
129	48	addHttpPostParameters(theRequest);
130		}
131
132		// Add the cookies to the state
133	48	state.addCookies(CookieUtil.createHttpClientCookies(theRequest,
134		url));
135
136		// Open the connection and get the result
137	48	HttpClient client = new HttpClient();
138	48	HostConfiguration hostConfiguration = new HostConfiguration();
139	48	hostConfiguration.setHost(url.getHost(), url.getPort(),
140		Protocol.getProtocol(url.getProtocol()));
141	48	client.setState(state);
142	48	client.executeMethod(hostConfiguration, this.method);
143
144		// Wrap the HttpClient method in a java.net.HttpURLConnection object
145	48	return new org.apache.commons.httpclient.util.HttpURLConnection(
146		this.method, url);
147		}
148
149		/**
150		* Add the HTTP parameters that need to be passed in the request body.
151		*
152		* @param theRequest the request containing all data to pass to the server
153		* redirector.
154		*/
155	48	private void addHttpPostParameters(WebRequest theRequest)
156		{
157		// If no parameters, then exit
158	48	if (!theRequest.getParameterNamesPost().hasMoreElements())
159		{
160	47	return;
161		}
162
163	1	Enumeration keys = theRequest.getParameterNamesPost();
164	1	List parameters = new ArrayList();
165	1	while (keys.hasMoreElements())
166		{
167	1	String key = (String) keys.nextElement();
168	1	String[] values = theRequest.getParameterValuesPost(key);
169	1	for (int i = 0; i < values.length; i++)
170		{
171	1	parameters.add(new NameValuePair(key, values[i]));
172		}
173		}
174	1	((PostMethod) this.method).setRequestBody(
175		(NameValuePair[]) parameters.toArray(
176		new NameValuePair[parameters.size()]));
177		}
178
179		/**
180		* Add the Headers to the request.
181		*
182		* @param theRequest the request containing all data to pass to the server
183		* redirector.
184		*/
185	48	private void addHeaders(WebRequest theRequest)
186		{
187	48	Enumeration keys = theRequest.getHeaderNames();
188
189	48	while (keys.hasMoreElements())
190		{
191	1	String key = (String) keys.nextElement();
192	1	String[] values = theRequest.getHeaderValues(key);
193
194	1	StringBuffer fullHeaderValue = new StringBuffer(values[0]);
195
196	1	for (int i = 1; i < values.length; i++)
197		{
198	0	fullHeaderValue.append("," + values[i]);
199		}
200
201	1	this.method.addRequestHeader(key, fullHeaderValue.toString());
202		}
203		}
204
205		/**
206		* Add user data in the request body.
207		*
208		* @param theRequest the request containing all data to pass to the server
209		* redirector.
210		* @exception IOException if we fail to read the user data
211		*/
212	0	private void addUserData(WebRequest theRequest) throws IOException
213		{
214		// If no user data, then exit
215	0	if (theRequest.getUserData() == null)
216		{
217	0	return;
218		}
219
220	0	((PostMethod) this.method).setRequestBody(theRequest.getUserData());
221		}
222		}
223