001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
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 org.apache.http.*;
023    import org.apache.http.auth.*;
024    import org.apache.http.client.CredentialsProvider;
025    import org.apache.http.client.methods.HttpDelete;
026    import org.apache.http.client.methods.HttpGet;
027    import org.apache.http.client.methods.HttpPost;
028    import org.apache.http.client.methods.HttpRequestBase;
029    import org.apache.http.client.protocol.ClientContext;
030    import org.apache.http.impl.auth.BasicScheme;
031    import org.apache.http.impl.client.DefaultHttpClient;
032    import org.apache.http.params.HttpConnectionParams;
033    import org.apache.http.params.HttpParams;
034    import org.apache.http.protocol.BasicHttpContext;
035    import org.apache.http.protocol.ExecutionContext;
036    import org.apache.http.protocol.HttpContext;
037    import org.apache.http.util.EntityUtils;
038    import org.sonar.wsclient.Host;
039    import org.sonar.wsclient.services.CreateQuery;
040    import org.sonar.wsclient.services.DeleteQuery;
041    import org.sonar.wsclient.services.Query;
042    
043    import java.io.IOException;
044    
045    /**
046     * @since 2.1
047     */
048    public class HttpClient4Connector extends Connector {
049    
050      private Host server;
051    
052      public HttpClient4Connector(Host server) {
053        this.server = server;
054      }
055    
056      public String execute(Query query) {
057        return executeRequest(newGetMethod(query));
058      }
059    
060      public String execute(CreateQuery query) {
061        return executeRequest(newPostMethod(query));
062      }
063    
064      public String execute(DeleteQuery query) {
065        return executeRequest(newDeleteMethod(query));
066      }
067    
068      private String executeRequest(HttpRequestBase request) {
069        String json = null;
070        DefaultHttpClient client = createClient();
071        try {
072          BasicHttpContext context = createLocalContext(client);
073          HttpResponse response = client.execute(request, context);
074          HttpEntity entity = response.getEntity();
075          if (entity != null) {
076            if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
077              json = EntityUtils.toString(entity);
078    
079            } else if (response.getStatusLine().getStatusCode() != HttpStatus.SC_NOT_FOUND) {
080              throw new ConnectionException("HTTP error: " + response.getStatusLine().getStatusCode() + ", msg: " + response.getStatusLine().getReasonPhrase() + ", query: " + request.toString());
081            }
082          }
083    
084        } catch (IOException e) {
085          throw new ConnectionException("Query: " + request.getURI(), e);
086    
087        } finally {
088          client.getConnectionManager().shutdown();
089        }
090        return json;
091      }
092    
093      private DefaultHttpClient createClient() {
094        DefaultHttpClient client = new DefaultHttpClient();
095        HttpParams params = client.getParams();
096        HttpConnectionParams.setConnectionTimeout(params, TIMEOUT_MS);
097        HttpConnectionParams.setSoTimeout(params, TIMEOUT_MS);
098        if (server.getUsername() != null) {
099          client.getCredentialsProvider().setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(server.getUsername(), server.getPassword()));
100        }
101        return client;
102      }
103    
104      private BasicHttpContext createLocalContext(DefaultHttpClient client) {
105        BasicHttpContext localcontext = new BasicHttpContext();
106    
107        if (server.getUsername() != null) {
108          // Generate BASIC scheme object and stick it to the local
109          // execution context
110          BasicScheme basicAuth = new BasicScheme();
111          localcontext.setAttribute("preemptive-auth", basicAuth);
112    
113          // Add as the first request interceptor
114          client.addRequestInterceptor(new PreemptiveAuth(), 0);
115        }
116        return localcontext;
117      }
118    
119      private HttpGet newGetMethod(Query query) {
120        HttpGet get = new HttpGet(server.getHost() + query.getUrl());
121        setJsonHeader(get);
122        return get;
123      }
124    
125      private HttpDelete newDeleteMethod(DeleteQuery query) {
126        HttpDelete delete = new HttpDelete(server.getHost() + query.getUrl());
127        setJsonHeader(delete);
128        return delete;
129      }
130    
131      private HttpPost newPostMethod(CreateQuery query) {
132        HttpPost post = new HttpPost(server.getHost() + query.getUrl());
133        setJsonHeader(post);
134        return post;
135      }
136    
137      private void setJsonHeader(HttpRequestBase request) {
138        request.setHeader("Accept", "application/json");
139      }
140    
141      static final class PreemptiveAuth implements HttpRequestInterceptor {
142        public void process(
143            final HttpRequest request,
144            final HttpContext context) throws HttpException {
145    
146          AuthState authState = (AuthState) context.getAttribute(ClientContext.TARGET_AUTH_STATE);
147    
148          // If no auth scheme avaialble yet, try to initialize it preemptively
149          if (authState.getAuthScheme() == null) {
150            AuthScheme authScheme = (AuthScheme) context.getAttribute("preemptive-auth");
151            CredentialsProvider credsProvider = (CredentialsProvider) context.getAttribute(ClientContext.CREDS_PROVIDER);
152            HttpHost targetHost = (HttpHost) context.getAttribute(ExecutionContext.HTTP_TARGET_HOST);
153            if (authScheme != null) {
154              Credentials creds = credsProvider.getCredentials(
155                  new AuthScope(
156                      targetHost.getHostName(),
157                      targetHost.getPort()));
158              if (creds == null) {
159                throw new HttpException("No credentials for preemptive authentication");
160              }
161              authState.setAuthScheme(authScheme);
162              authState.setCredentials(creds);
163            }
164          }
165        }
166      }
167    }