001 /*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2011 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
019 */
020 package org.sonar.wsclient.connectors;
021
022 import java.io.IOException;
023 import java.io.UnsupportedEncodingException;
024
025 import org.apache.http.HttpEntity;
026 import org.apache.http.HttpException;
027 import org.apache.http.HttpHost;
028 import org.apache.http.HttpRequest;
029 import org.apache.http.HttpRequestInterceptor;
030 import org.apache.http.HttpResponse;
031 import org.apache.http.HttpStatus;
032 import org.apache.http.auth.AuthScheme;
033 import org.apache.http.auth.AuthScope;
034 import org.apache.http.auth.AuthState;
035 import org.apache.http.auth.Credentials;
036 import org.apache.http.auth.UsernamePasswordCredentials;
037 import org.apache.http.client.CredentialsProvider;
038 import org.apache.http.client.methods.HttpDelete;
039 import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
040 import org.apache.http.client.methods.HttpGet;
041 import org.apache.http.client.methods.HttpPost;
042 import org.apache.http.client.methods.HttpPut;
043 import org.apache.http.client.methods.HttpRequestBase;
044 import org.apache.http.client.protocol.ClientContext;
045 import org.apache.http.entity.StringEntity;
046 import org.apache.http.impl.auth.BasicScheme;
047 import org.apache.http.impl.client.DefaultHttpClient;
048 import org.apache.http.params.HttpConnectionParams;
049 import org.apache.http.params.HttpParams;
050 import org.apache.http.protocol.BasicHttpContext;
051 import org.apache.http.protocol.ExecutionContext;
052 import org.apache.http.protocol.HttpContext;
053 import org.apache.http.util.EntityUtils;
054 import org.sonar.wsclient.Host;
055 import org.sonar.wsclient.services.AbstractQuery;
056 import org.sonar.wsclient.services.CreateQuery;
057 import org.sonar.wsclient.services.DeleteQuery;
058 import org.sonar.wsclient.services.Query;
059 import org.sonar.wsclient.services.UpdateQuery;
060
061 /**
062 * @since 2.1
063 */
064 public class HttpClient4Connector extends Connector {
065
066 private Host server;
067
068 public HttpClient4Connector(Host server) {
069 this.server = server;
070 }
071
072 public String execute(Query<?> query) {
073 return executeRequest(newGetMethod(query));
074 }
075
076 public String execute(CreateQuery<?> query) {
077 return executeRequest(newPostMethod(query));
078 }
079
080 public String execute(UpdateQuery<?> query) {
081 return executeRequest(newPutMethod(query));
082 }
083
084 public String execute(DeleteQuery<?> query) {
085 return executeRequest(newDeleteMethod(query));
086 }
087
088 private String executeRequest(HttpRequestBase request) {
089 String json = null;
090 DefaultHttpClient client = createClient();
091 try {
092 BasicHttpContext context = createLocalContext(client);
093 HttpResponse response = client.execute(request, context);
094 HttpEntity entity = response.getEntity();
095 if (entity != null) {
096 if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
097 json = EntityUtils.toString(entity);
098
099 } else if (response.getStatusLine().getStatusCode() != HttpStatus.SC_NOT_FOUND) {
100 throw new ConnectionException("HTTP error: " + response.getStatusLine().getStatusCode()
101 + ", msg: " + response.getStatusLine().getReasonPhrase()
102 + ", query: " + request.toString());
103 }
104 }
105
106 } catch (IOException e) {
107 throw new ConnectionException("Query: " + request.getURI(), e);
108
109 } finally {
110 client.getConnectionManager().shutdown();
111 }
112 return json;
113 }
114
115 private DefaultHttpClient createClient() {
116 DefaultHttpClient client = new DefaultHttpClient();
117 HttpParams params = client.getParams();
118 HttpConnectionParams.setConnectionTimeout(params, TIMEOUT_MS);
119 HttpConnectionParams.setSoTimeout(params, TIMEOUT_MS);
120 if (server.getUsername() != null) {
121 client.getCredentialsProvider()
122 .setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(server.getUsername(), server.getPassword()));
123 }
124 return client;
125 }
126
127 private BasicHttpContext createLocalContext(DefaultHttpClient client) {
128 BasicHttpContext localcontext = new BasicHttpContext();
129
130 if (server.getUsername() != null) {
131 // Generate BASIC scheme object and stick it to the local
132 // execution context
133 BasicScheme basicAuth = new BasicScheme();
134 localcontext.setAttribute("preemptive-auth", basicAuth);
135
136 // Add as the first request interceptor
137 client.addRequestInterceptor(new PreemptiveAuth(), 0);
138 }
139 return localcontext;
140 }
141
142 private HttpGet newGetMethod(Query<?> query) {
143 HttpGet get = new HttpGet(server.getHost() + query.getUrl());
144 setJsonHeader(get);
145 return get;
146 }
147
148 private HttpDelete newDeleteMethod(DeleteQuery<?> query) {
149 HttpDelete delete = new HttpDelete(server.getHost() + query.getUrl());
150 setJsonHeader(delete);
151 return delete;
152 }
153
154 private HttpPost newPostMethod(CreateQuery<?> query) {
155 HttpPost post = new HttpPost(server.getHost() + query.getUrl());
156 setJsonHeader(post);
157 setRequestEntity(post, query);
158 return post;
159 }
160
161 private HttpPut newPutMethod(UpdateQuery<?> query) {
162 HttpPut put = new HttpPut(server.getHost() + query.getUrl());
163 setJsonHeader(put);
164 setRequestEntity(put, query);
165 return put;
166 }
167
168 private void setRequestEntity(HttpEntityEnclosingRequestBase request, AbstractQuery<?> query) {
169 if (query.getBody() != null) {
170 try {
171 request.setEntity(new StringEntity(query.getBody(), "UTF-8"));
172 } catch (UnsupportedEncodingException e) {
173 throw new ConnectionException("Encoding is not supported", e);
174 }
175 }
176 }
177
178 private void setJsonHeader(HttpRequestBase request) {
179 request.setHeader("Accept", "application/json");
180 }
181
182 static final class PreemptiveAuth implements HttpRequestInterceptor {
183 public void process(
184 final HttpRequest request,
185 final HttpContext context) throws HttpException {
186
187 AuthState authState = (AuthState) context.getAttribute(ClientContext.TARGET_AUTH_STATE);
188
189 // If no auth scheme available yet, try to initialize it preemptively
190 if (authState.getAuthScheme() == null) {
191 AuthScheme authScheme = (AuthScheme) context.getAttribute("preemptive-auth");
192 CredentialsProvider credsProvider = (CredentialsProvider) context.getAttribute(ClientContext.CREDS_PROVIDER);
193 HttpHost targetHost = (HttpHost) context.getAttribute(ExecutionContext.HTTP_TARGET_HOST);
194 if (authScheme != null) {
195 Credentials creds = credsProvider.getCredentials(
196 new AuthScope(
197 targetHost.getHostName(),
198 targetHost.getPort()));
199 if (creds == null) {
200 throw new HttpException("No credentials for preemptive authentication");
201 }
202 authState.setAuthScheme(authScheme);
203 authState.setCredentials(creds);
204 }
205 }
206 }
207 }
208 }