summaryrefslogtreecommitdiffstats
path: root/src/main/java/net/sf/antcontrib/net/httpclient/AbstractMethodTask.java
blob: 1cb65cdd1bd3968fae0a3009cbba47cbfbd16e19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
 * Copyright (c) 2001-2006 Ant-Contrib project.  All rights reserved.
 *
 * 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 net.sf.antcontrib.net.httpclient;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpMethodBase;
import org.apache.commons.httpclient.URI;
import org.apache.commons.httpclient.URIException;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.Property;
import org.apache.tools.ant.util.FileUtils;

public abstract class AbstractMethodTask
	extends Task {

	private HttpMethodBase method;
	private File responseDataFile;
	private String responseDataProperty;
	private String statusCodeProperty;
	private HttpClient httpClient;
	private List responseHeaders = new ArrayList();
	
	public static class ResponseHeader {
		private String name;
		private String property;
		public String getName() {
			return name;
		}
		public void setName(String name) {
			this.name = name;
		}
		public String getProperty() {
			return property;
		}
		public void setProperty(String property) {
			this.property = property;
		}		
	}
	
	protected abstract HttpMethodBase createNewMethod();
	protected void configureMethod(HttpMethodBase method) {	
	}
	protected void cleanupResources(HttpMethodBase method) {		
	}
	
	public void addConfiguredResponseHeader(ResponseHeader responseHeader) {
		this.responseHeaders.add(responseHeader);
	}
	
	public void addConfiguredHttpClient(HttpClientType httpClientType) {
		this.httpClient = httpClientType.getClient();
	}
	
	protected HttpMethodBase createMethodIfNecessary() {
		if (method == null) {
			method = createNewMethod();
		}
		return method;
	}
	
	public void setResponseDataFile(File responseDataFile) {
		this.responseDataFile = responseDataFile;
	}

	public void setResponseDataProperty(String responseDataProperty) {
		this.responseDataProperty = responseDataProperty;
	}

	public void setStatusCodeProperty(String statusCodeProperty) {
		this.statusCodeProperty = statusCodeProperty;
	}

	public void setClientRefId(String clientRefId) {
		Object clientRef = getProject().getReference(clientRefId);
		if (clientRef == null) {
			throw new BuildException("Reference '" + clientRefId + "' does not exist.");
		}
		if (! (clientRef instanceof HttpClientType)) {
			throw new BuildException("Reference '" + clientRefId + "' is of the wrong type.");
		}
		httpClient = ((HttpClientType) clientRef).getClient();
	}

	public void setDoAuthentication(boolean doAuthentication) {
		createMethodIfNecessary().setDoAuthentication(doAuthentication);
	}

	public void setFollowRedirects(boolean doFollowRedirects) {
		createMethodIfNecessary().setFollowRedirects(doFollowRedirects);
	}

	public void addConfiguredParams(MethodParams params) {
		createMethodIfNecessary().setParams(params);
	}
	
	public void setPath(String path) {
		createMethodIfNecessary().setPath(path);
	}
	
	public void setURL(String url) {
		try {
			createMethodIfNecessary().setURI(new URI(url, false));
		}
		catch (URIException e) {
			throw new BuildException(e);
		}
	}
	
	public void setQueryString(String queryString) {
		createMethodIfNecessary().setQueryString(queryString);
	}
	
	public void addConfiguredHeader(Header header) {
		createMethodIfNecessary().setRequestHeader(header);
	}
	
	public void execute() throws BuildException {
		if (httpClient == null) {
			httpClient = new HttpClient();
		}
		
		HttpMethodBase method = createMethodIfNecessary();
		configureMethod(method);
		try {
			int statusCode = httpClient.executeMethod(method);
			if (statusCodeProperty != null) {
				Property p = (Property)getProject().createTask("property");
				p.setName(statusCodeProperty);
				p.setValue(String.valueOf(statusCode));
				p.perform();
			}
			
			Iterator it = responseHeaders.iterator();
			while (it.hasNext()) {
				ResponseHeader header = (ResponseHeader)it.next();
				Property p = (Property)getProject().createTask("property");
				p.setName(header.getProperty());
				Header h = method.getResponseHeader(header.getName());
				if (h != null && h.getValue() != null) {
					p.setValue(h.getValue());
					p.perform();
				}
				
			}
			if (responseDataProperty != null) {
				Property p = (Property)getProject().createTask("property");
				p.setName(responseDataProperty);
				p.setValue(method.getResponseBodyAsString());
				p.perform();				
			}
			else if (responseDataFile != null) {
				FileOutputStream fos = null;
				InputStream is = null;
				try {
					is = method.getResponseBodyAsStream();
					fos = new FileOutputStream(responseDataFile);
					byte buf[] = new byte[10*1024];
					int read = 0;
					while ((read = is.read(buf, 0, 10*1024)) != -1) {
						fos.write(buf, 0, read);
					}
				}
				finally {
					FileUtils.close(fos);
					FileUtils.close(is);
				}
			}
		}
		catch (IOException e) {
			throw new BuildException(e);
		}
		finally {
			cleanupResources(method);
		}
	}
}