com.offbytwo.jenkins.client

Interface JenkinsHttpConnection

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

JenkinsHttpClient

public interface JenkinsHttpConnection
extends Closeable

Author:

Dell Green

Method Summary

Modifier and Type	Method and Description
void	close()
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.
<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

Method Detail

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

get

<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

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.

getFile

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.

getQuietly

<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

isJenkinsVersionSet

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.

Returns:

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

post

<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

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

<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

<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

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

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

void post(String path,
          boolean crumbFlag)
   throws IOException

Perform POST request that takes no parameters and returns no response

Parameters:

path - path to request

crumbFlag - true / false.

Throws:

IOException - in case of an error.

post_form

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.

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

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.

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_text

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

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_xml

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

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.

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.

getJenkinsVersion

String getJenkinsVersion()

Get the Jenkins server version.

Returns:

the version string