Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* jira-client - a simple JIRA REST client
* Copyright (c) 2013 Bob Carroll ([email protected])
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package net.rcarz.jiraclient;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.lang.StringBuilder;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Map;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.StatusLine;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.StringEntity;
import net.sf.json.JSON;
import net.sf.json.JSONSerializer;
/**
* A simple REST client that speaks JSON.
*/
public class RestClient {
private HttpClient httpclient = null;
private ICredentials creds = null;
private URI uri = null;
/**
* Creates a REST client instance with a URI.
*
* @param httpclient Underlying HTTP client to use
* @param uri Base URI of the remote REST service
*/
public RestClient(HttpClient httpclient, URI uri) {
this(httpclient, null, uri);
}
/**
* Creates an authenticated REST client instance with a URI.
*
* @param httpclient Underlying HTTP client to use
* @param creds Credentials to send with each request
* @param uri Base URI of the remote REST service
*/
public RestClient(HttpClient httpclient, ICredentials creds, URI uri) {
this.httpclient = httpclient;
this.creds = creds;
this.uri = uri;
}
/**
* Build a URI from a path.
*
* @param path Path to append to the base URI
*
* @return the full URI
*
* @throws URISyntaxException when the path is invalid
*/
public URI buildURI(String path) throws URISyntaxException {
return buildURI(path, null);
}
/**
* Build a URI from a path and query parmeters.
*
* @param path Path to append to the base URI
* @param params Map of key value pairs
*
* @return the full URI
*
* @throws URISyntaxException when the path is invalid
*/
public URI buildURI(String path, Map params) throws URISyntaxException {
URIBuilder ub = new URIBuilder(uri);
ub.setPath(ub.getPath() + path);
if (params != null) {
for (Map.Entry ent : params.entrySet())
ub.addParameter(ent.getKey(), ent.getValue());
}
return ub.build();
}
private JSON request(HttpRequestBase req) throws RestException, IOException {
req.addHeader("Accept", "application/json");
if (creds != null)
creds.authenticate(req);
HttpResponse resp = httpclient.execute(req);
HttpEntity ent = resp.getEntity();
StringBuilder result = new StringBuilder();
if (ent != null) {
BufferedReader br = new BufferedReader(new InputStreamReader(ent.getContent()));
String line = "";
while ((line = br.readLine()) != null)
result.append(line);
}
StatusLine sl = resp.getStatusLine();
if (sl.getStatusCode() >= 300)
throw new RestException(sl.getReasonPhrase(), sl.getStatusCode(), result.toString());
return result.length() > 0 ? JSONSerializer.toJSON(result.toString()): null;
}
private JSON request(HttpEntityEnclosingRequestBase req, String payload)
throws RestException, IOException {
if (payload != null) {
StringEntity ent = null;
try {
ent = new StringEntity(payload, "UTF-8");
ent.setContentType("application/json");
} catch (UnsupportedEncodingException ex) {
/* utf-8 should always be supported... */
}
req.addHeader("Content-Type", "application/json");
req.setEntity(ent);
}
return request(req);
}
private JSON request(HttpEntityEnclosingRequestBase req, JSON payload)
throws RestException, IOException {
return request(req, payload != null ? payload.toString() : null);
}
/**
* Executes an HTTP DELETE with the given URI.
*
* @param uri Full URI of the remote endpoint
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
*/
public JSON delete(URI uri) throws RestException, IOException {
return request(new HttpDelete(uri));
}
/**
* Executes an HTTP DELETE with the given path.
*
* @param path Path to be appended to the URI supplied in the construtor
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
* @throws URISyntaxException when an error occurred appending the path to the URI
*/
public JSON delete(String path) throws RestException, IOException, URISyntaxException {
return delete(buildURI(path));
}
/**
* Executes an HTTP GET with the given URI.
*
* @param uri Full URI of the remote endpoint
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
*/
public JSON get(URI uri) throws RestException, IOException {
return request(new HttpGet(uri));
}
/**
* Executes an HTTP GET with the given path.
*
* @param path Path to be appended to the URI supplied in the construtor
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
* @throws URISyntaxException when an error occurred appending the path to the URI
*/
public JSON get(String path) throws RestException, IOException, URISyntaxException {
return get(buildURI(path));
}
/**
* Executes an HTTP POST with the given URI and payload.
*
* @param uri Full URI of the remote endpoint
* @param payload JSON-encoded data to send to the remote service
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
*/
public JSON post(URI uri, JSON payload) throws RestException, IOException {
return request(new HttpPost(uri), payload);
}
/**
* Executes an HTTP POST with the given URI and payload.
*
* At least one JIRA REST endpoint expects malformed JSON. The payload
* argument is quoted and sent to the server with the application/json
* Content-Type header. You should not use this function when proper JSON
* is expected.
*
* @see https://jira.atlassian.com/browse/JRA-29304
*
* @param uri Full URI of the remote endpoint
* @param payload Raw string to send to the remote service
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
*/
public JSON post(URI uri, String payload) throws RestException, IOException {
String quoted = payload != null ?
String.format("\"%s\"", payload) :
null;
return request(new HttpPost(uri), quoted);
}
/**
* Executes an HTTP POST with the given path and payload.
*
* @param path Path to be appended to the URI supplied in the construtor
* @param payload JSON-encoded data to send to the remote service
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
* @throws URISyntaxException when an error occurred appending the path to the URI
*/
public JSON post(String path, JSON payload)
throws RestException, IOException, URISyntaxException {
return post(buildURI(path), payload);
}
/**
* Executes an HTTP PUT with the given URI and payload.
*
* @param uri Full URI of the remote endpoint
* @param payload JSON-encoded data to send to the remote service
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
*/
public JSON put(URI uri, JSON payload) throws RestException, IOException {
return request(new HttpPut(uri), payload);
}
/**
* Executes an HTTP PUT with the given path and payload.
*
* @param path Path to be appended to the URI supplied in the construtor
* @param payload JSON-encoded data to send to the remote service
*
* @return JSON-encoded result or null when there's no content returned
*
* @throws RestException when an HTTP-level error occurs
* @throws IOException when an error reading the response occurs
* @throws URISyntaxException when an error occurred appending the path to the URI
*/
public JSON put(String path, JSON payload)
throws RestException, IOException, URISyntaxException {
return put(buildURI(path), payload);
}
}
