com.offbytwo.jenkins.client

Class JenkinsHttpClient

java.lang.Object

com.offbytwo.jenkins.client.JenkinsHttpClient

All Implemented Interfaces:

JenkinsHttpConnection, Closeable, AutoCloseable

public class JenkinsHttpClient
extends Object
implements JenkinsHttpConnection

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_VERSION

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, org.apache.http.impl.client.HttpClientBuilder builder, String username, String password) Create an authenticated 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) Add authentication to supplied builder.
void	close() Closes underlying resources.
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() Get the Jenkins server version.
protected org.apache.http.protocol.HttpContext	getLocalContext() Get the local context.
<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.
boolean	isJenkinsVersionSet() Check to see if the Jenkins version has been set to something different than the initialisation value from the constructor.
org.apache.http.HttpResponse	post_form_with_result(String path, List<org.apache.http.NameValuePair> data, boolean crumbFlag) Perform a POST request using form url encoding and return HttpResponse object This method is not performing validation and can be used for more generic queries to jenkins.
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) Perform a POST request of XML (instead of using json mapper) and return a string rendering of the response entity.
void	post(String path) Perform POST request that takes no parameters and returns no response
void	post(String path, boolean crumbFlag) Perform POST request that takes no parameters and returns no response
<R extends BaseModel,D> R	post(String path, D data, Class<R> cls) Perform a POST request and parse the response to the given class
<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
<R extends BaseModel,D> R	post(String path, D data, Class<R> cls, Map<String,File> fileParams, boolean crumbFlag) Perform a POST request and parse the response to the given class
protected void	setLocalContext(org.apache.http.protocol.HttpContext localContext) Set the local context.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_VERSION

public static final String EMPTY_VERSION

See Also:

Constant Field Values

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

JenkinsHttpClient

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

Create an authenticated Jenkins HTTP client

Parameters:

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

builder - Configured HttpClientBuilder to be used

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

Specified by:

get in interface JenkinsHttpConnection

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

Specified by:

get in interface JenkinsHttpConnection

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.

Specified by:

getQuietly in interface JenkinsHttpConnection

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

Specified by:

getFile in interface JenkinsHttpConnection

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

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

Specified by:

post in interface JenkinsHttpConnection

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

Returns:

an instance of the supplied class

Throws:

IOException - in case of an error.

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

Specified by:

post in interface JenkinsHttpConnection

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

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

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

Specified by:

post in interface JenkinsHttpConnection

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

fileParams - file parameters

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 "/toJsonApiUri/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.

Specified by:

post_form in interface JenkinsHttpConnection

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_form_with_result

public org.apache.http.HttpResponse post_form_with_result(String path,
                                                          List<org.apache.http.NameValuePair> data,
                                                          boolean crumbFlag)
                                                   throws IOException

Perform a POST request using form url encoding and return HttpResponse object This method is not performing validation and can be used for more generic queries to jenkins.

Specified by:

post_form_with_result in interface JenkinsHttpConnection

Parameters:

path - path to request, can be relative or absolute

data - data to post

crumbFlag - true / false.

Returns:

resulting response

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.

Specified by:

post_xml in interface JenkinsHttpConnection

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

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

Specified by:

post_xml in interface JenkinsHttpConnection

Parameters:

path - path to request, can be relative or absolute

xml_data - data data to post

crumbFlag - true or false.

Returns:

A string containing the xml response (if present)

Throws:

IOException - in case of an error.

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

Specified by:

post_text in interface JenkinsHttpConnection

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

Specified by:

post_text in interface JenkinsHttpConnection

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

Specified by:

post in interface JenkinsHttpConnection

Parameters:

path - path to request

Throws:

IOException - in case of an error.

post

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

Perform POST request that takes no parameters and returns no response

Specified by:

post in interface JenkinsHttpConnection

Parameters:

path - path to request

crumbFlag - true / false.

Throws:

IOException - in case of an error.

getJenkinsVersion

public String getJenkinsVersion()

Get the Jenkins server version.

Specified by:

getJenkinsVersion in interface JenkinsHttpConnection

Returns:

the version string

isJenkinsVersionSet

public boolean isJenkinsVersionSet()

Check to see if the Jenkins version has been set to something different than the initialisation value from the constructor. This means there has never been made a communication with the Jenkins server.

Specified by:

isJenkinsVersionSet in interface JenkinsHttpConnection

Returns:

true if jenkinsVersion has been set by communication, false otherwise.

close

public void close()

Closes underlying resources. Any I/O errors whilst closing are logged with debug log level Closed instances should no longer be used Closing an already closed instance has no side effects

Specified by:

close in interface JenkinsHttpConnection

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

addAuthentication

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

Add authentication to supplied builder.

Parameters:

builder - the builder to configure

uri - the server URI

username - the username

password - the password

Returns:

the passed in builder

getLocalContext

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

Get the local context.

Returns:

context

setLocalContext

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

Set the local context.

Parameters:

localContext - the context