com.offbytwo.jenkins.client

类 JenkinsHttpClient

java.lang.Object

com.offbytwo.jenkins.client.JenkinsHttpClient

public class JenkinsHttpClient
extends java.lang.Object

构造器概要

构造器

构造器和说明
JenkinsHttpClient(java.net.URI uri) Create an unauthenticated Jenkins HTTP client
JenkinsHttpClient(java.net.URI uri, org.apache.http.impl.client.CloseableHttpClient client) Create an unauthenticated Jenkins HTTP client
JenkinsHttpClient(java.net.URI uri, org.apache.http.impl.client.HttpClientBuilder builder) Create an unauthenticated Jenkins HTTP client
JenkinsHttpClient(java.net.URI uri, java.lang.String username, java.lang.String password) Create an authenticated Jenkins HTTP client

方法概要

方法

限定符和类型	方法和说明
java.lang.String	get(java.lang.String path) Perform a GET request and parse the response and return a simple string of the content
<T extends BaseModel> T	get(java.lang.String path, java.lang.Class<T> cls) Perform a GET request and parse the response to the given class
java.io.InputStream	getFile(java.net.URI path) Perform a GET request and return the response as InputStream
java.lang.String	getJenkinsVersion()
<T extends BaseModel> T	getQuietly(java.lang.String path, java.lang.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(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> data, boolean crumbFlag) Perform a POST request using form url encoding.
java.lang.String	post_text(java.lang.String path, java.lang.String textData, boolean crumbFlag) Post a text entity to the given URL using the default content type
java.lang.String	post_text(java.lang.String path, java.lang.String textData, org.apache.http.entity.ContentType contentType, boolean crumbFlag) Post a text entity to the given URL with the given content type
java.lang.String	post_xml(java.lang.String path, java.lang.String xml_data) Perform a POST request of XML (instead of using json mapper) and return a string rendering of the response entity.
java.lang.String	post_xml(java.lang.String path, java.lang.String xml_data, boolean crumbFlag)
void	post(java.lang.String path) Perform POST request that takes no parameters and returns no response
void	post(java.lang.String path, boolean crumbFlag)
<R extends BaseModel,D> R	post(java.lang.String path, D data, java.lang.Class<R> cls)
<R extends BaseModel,D> R	post(java.lang.String path, D data, java.lang.Class<R> cls, boolean crumbFlag) Perform a POST request and parse the response to the given class

从类继承的方法 java.lang.Object

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

构造器详细资料

JenkinsHttpClient

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

Create an unauthenticated Jenkins HTTP client

参数:

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

client - Configured CloseableHttpClient to be used

JenkinsHttpClient

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

Create an unauthenticated Jenkins HTTP client

参数:

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

builder - Configured HttpClientBuilder to be used

JenkinsHttpClient

public JenkinsHttpClient(java.net.URI uri)

Create an unauthenticated Jenkins HTTP client

参数:

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

JenkinsHttpClient

public JenkinsHttpClient(java.net.URI uri,
                 java.lang.String username,
                 java.lang.String password)

Create an authenticated Jenkins HTTP client

参数:

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

方法详细资料

get

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

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

类型参数:

T - type of the response

参数:

path - path to request, can be relative or absolute

cls - class of the response

返回:

an instance of the supplied class

抛出:

java.io.IOException - in case of an error.

get

public java.lang.String get(java.lang.String path)
                     throws java.io.IOException

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

参数:

path - path to request, can be relative or absolute

返回:

the entity text

抛出:

java.io.IOException - in case of an error.

getQuietly

public <T extends BaseModel> T getQuietly(java.lang.String path,
                                 java.lang.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.

类型参数:

T - type of the response

参数:

path - path to request, can be relative or absolute

cls - class of the response

返回:

an instance of the supplied class

getFile

public java.io.InputStream getFile(java.net.URI path)
                            throws java.io.IOException

Perform a GET request and return the response as InputStream

参数:

path - path to request, can be relative or absolute

返回:

the response stream

抛出:

java.io.IOException - in case of an error.

post

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

抛出:

java.io.IOException

post

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

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

类型参数:

R - type of the response

D - type of the data

参数:

path - path to request, can be relative or absolute

data - data to post

cls - class of the response

crumbFlag - true / false.

返回:

an instance of the supplied class

抛出:

java.io.IOException - in case of an error.

post_form

public void post_form(java.lang.String path,
             java.util.Map<java.lang.String,java.lang.String> data,
             boolean crumbFlag)
               throws java.io.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.

参数:

path - path to request, can be relative or absolute

data - data to post

crumbFlag - true / false.

抛出:

java.io.IOException - in case of an error.

post_xml

public java.lang.String post_xml(java.lang.String path,
                        java.lang.String xml_data)
                          throws java.io.IOException

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

参数:

path - path to request, can be relative or absolute

xml_data - data data to post

返回:

A string containing the xml response (if present)

抛出:

java.io.IOException - in case of an error.

post_xml

public java.lang.String post_xml(java.lang.String path,
                        java.lang.String xml_data,
                        boolean crumbFlag)
                          throws java.io.IOException

抛出:

java.io.IOException

post_text

public java.lang.String post_text(java.lang.String path,
                         java.lang.String textData,
                         boolean crumbFlag)
                           throws java.io.IOException

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

参数:

path - The path.

textData - data.

crumbFlag - true/false.

返回:

resulting response

抛出:

java.io.IOException - in case of an error.

post_text

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

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

参数:

path - The path.

textData - The data.

contentType - ContentType

crumbFlag - true or false.

返回:

resulting response

抛出:

java.io.IOException - in case of an error.

post

public void post(java.lang.String path)
          throws java.io.IOException

Perform POST request that takes no parameters and returns no response

参数:

path - path to request

抛出:

java.io.IOException - in case of an error.

post

public void post(java.lang.String path,
        boolean crumbFlag)
          throws java.io.IOException

抛出:

java.io.IOException

getJenkinsVersion

public java.lang.String getJenkinsVersion()

返回:

the version string.