com.offbytwo.jenkins.client

Class JenkinsHttpClient

java.lang.Object

com.offbytwo.jenkins.client.JenkinsHttpClient

public class JenkinsHttpClient
extends Object

Constructor Summary

Constructors

Constructor and Description
JenkinsHttpClient(URI uri) Create an unauthenticated Jenkins HTTP client
JenkinsHttpClient(URI uri, org.apache.http.impl.client.CloseableHttpClient client) Create an unauthenticated Jenkins HTTP client
JenkinsHttpClient(URI uri, org.apache.http.impl.client.HttpClientBuilder builder) Create an unauthenticated Jenkins HTTP client
JenkinsHttpClient(URI uri, String username, String password) Create an authenticated Jenkins HTTP client

Method Summary

Modifier and Type	Method and Description
protected static org.apache.http.impl.client.HttpClientBuilder	addAuthentication(org.apache.http.impl.client.HttpClientBuilder builder, URI uri, String username, String password)
String	get(String path) Perform a GET request and parse the response and return a simple string of the content
<T extends BaseModel> T	get(String path, Class<T> cls) Perform a GET request and parse the response to the given class
InputStream	getFile(URI path) Perform a GET request and return the response as InputStream
String	getJenkinsVersion()
protected org.apache.http.protocol.HttpContext	getLocalContext()
<T extends BaseModel> T	getQuietly(String path, Class<T> cls) Perform a GET request and parse the response to the given class, logging any IOException that is thrown rather than propagating it.
void	post_form(String path, Map<String,String> data, boolean crumbFlag) Perform a POST request using form url encoding.
String	post_text(String path, String textData, boolean crumbFlag) Post a text entity to the given URL using the default content type
String	post_text(String path, String textData, org.apache.http.entity.ContentType contentType, boolean crumbFlag) Post a text entity to the given URL with the given content type
String	post_xml(String path, String xml_data) Perform a POST request of XML (instead of using json mapper) and return a string rendering of the response entity.
String	post_xml(String path, String xml_data, boolean crumbFlag)
void	post(String path) Perform POST request that takes no parameters and returns no response
void	post(String path, boolean crumbFlag)
<R extends BaseModel,D> R	post(String path, D data, Class<R> cls)
<R extends BaseModel,D> R	post(String path, D data, Class<R> cls, boolean crumbFlag) Perform a POST request and parse the response to the given class
protected void	setLocalContext(org.apache.http.protocol.HttpContext localContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JenkinsHttpClient

public JenkinsHttpClient(URI uri,
                         org.apache.http.impl.client.CloseableHttpClient client)

Create an unauthenticated Jenkins HTTP client

Parameters:

uri - Location of the jenkins server (ex. http://localhost:8080)

client - Configured CloseableHttpClient to be used

JenkinsHttpClient

public JenkinsHttpClient(URI uri,
                         org.apache.http.impl.client.HttpClientBuilder builder)

Create an unauthenticated Jenkins HTTP client

Parameters:

uri - Location of the jenkins server (ex. http://localhost:8080)

builder - Configured HttpClientBuilder to be used

JenkinsHttpClient

public JenkinsHttpClient(URI uri)

Create an unauthenticated Jenkins HTTP client

Parameters:

uri - Location of the jenkins server (ex. http://localhost:8080)

JenkinsHttpClient

public JenkinsHttpClient(URI uri,
                         String username,
                         String password)

Create an authenticated Jenkins HTTP client

Parameters:

uri - Location of the jenkins server (ex. http://localhost:8080)

username - Username to use when connecting

password - Password or auth token to use when connecting

Method Detail

get

public <T extends BaseModel> T get(String path,
                                   Class<T> cls)
                            throws IOException

Perform a GET request and parse the response to the given class

Type Parameters:

T - type of the response

Parameters:

path - path to request, can be relative or absolute

cls - class of the response

Returns:

an instance of the supplied class

Throws:

IOException - in case of an error.

get

public String get(String path)
           throws IOException

Perform a GET request and parse the response and return a simple string of the content

Parameters:

path - path to request, can be relative or absolute

Returns:

the entity text

Throws:

IOException - in case of an error.

getQuietly

public <T extends BaseModel> T getQuietly(String path,
                                          Class<T> cls)

Perform a GET request and parse the response to the given class, logging any IOException that is thrown rather than propagating it.

Type Parameters:

T - type of the response

Parameters:

path - path to request, can be relative or absolute

cls - class of the response

Returns:

an instance of the supplied class

getFile

public InputStream getFile(URI path)
                    throws IOException

Perform a GET request and return the response as InputStream

Parameters:

path - path to request, can be relative or absolute

Returns:

the response stream

Throws:

IOException - in case of an error.

post

public <R extends BaseModel,D> R post(String path,
                                      D data,
                                      Class<R> cls)
                               throws IOException

Throws:

IOException

post

public <R extends BaseModel,D> R post(String path,
                                      D data,
                                      Class<R> cls,
                                      boolean crumbFlag)
                               throws IOException

Perform a POST request and parse the response to the given class

Type Parameters:

R - type of the response

D - type of the data

Parameters:

path - path to request, can be relative or absolute

data - data to post

cls - class of the response

crumbFlag - true / false.

Returns:

an instance of the supplied class

Throws:

IOException - in case of an error.

post_form

public void post_form(String path,
                      Map<String,String> data,
                      boolean crumbFlag)
               throws IOException

Perform a POST request using form url encoding. This method was added for the purposes of creating folders, but may be useful for other API calls as well. Unlike post and post_xml, the path is *not* modified by adding "/api/json". Additionally, the params in data are provided as both request parameters including a json parameter, *and* in the JSON-formatted StringEntity, because this is what the folder creation call required. It is unclear if any other jenkins APIs operate in this fashion.

Parameters:

path - path to request, can be relative or absolute

data - data to post

crumbFlag - true / false.

Throws:

IOException - in case of an error.

post_xml

public String post_xml(String path,
                       String xml_data)
                throws IOException

Perform a POST request of XML (instead of using json mapper) and return a string rendering of the response entity.

Parameters:

path - path to request, can be relative or absolute

xml_data - data data to post

Returns:

A string containing the xml response (if present)

Throws:

IOException - in case of an error.

post_xml

public String post_xml(String path,
                       String xml_data,
                       boolean crumbFlag)
                throws IOException

Throws:

IOException

post_text

public String post_text(String path,
                        String textData,
                        boolean crumbFlag)
                 throws IOException

Post a text entity to the given URL using the default content type

Parameters:

path - The path.

textData - data.

crumbFlag - true/false.

Returns:

resulting response

Throws:

IOException - in case of an error.

post_text

public String post_text(String path,
                        String textData,
                        org.apache.http.entity.ContentType contentType,
                        boolean crumbFlag)
                 throws IOException

Post a text entity to the given URL with the given content type

Parameters:

path - The path.

textData - The data.

contentType - ContentType

crumbFlag - true or false.

Returns:

resulting response

Throws:

IOException - in case of an error.

post

public void post(String path)
          throws IOException

Perform POST request that takes no parameters and returns no response

Parameters:

path - path to request

Throws:

IOException - in case of an error.

post

public void post(String path,
                 boolean crumbFlag)
          throws IOException

Throws:

IOException

getJenkinsVersion

public String getJenkinsVersion()

Returns:

the version string.

addAuthentication

protected static org.apache.http.impl.client.HttpClientBuilder addAuthentication(org.apache.http.impl.client.HttpClientBuilder builder,
                                                                                 URI uri,
                                                                                 String username,
                                                                                 String password)

getLocalContext

protected org.apache.http.protocol.HttpContext getLocalContext()

setLocalContext

protected void setLocalContext(org.apache.http.protocol.HttpContext localContext)