Package com.atlassian.jira.rest.client.api

Interface JiraRestClientFactory

public interface JiraRestClientFactory

Factory for producing JIRA REST com.atlassian.jira.client with selected authentication handler

Since:

v0.1

Method Summary

Modifier and Type	Method	Description
JiraRestClient	create(URI serverUri, com.atlassian.httpclient.api.HttpClient httpClient)	Creates an instance of JiraRestClient with given Atlassian HttpClient.
JiraRestClient	create(URI serverUri, AuthenticationHandler authenticationHandler)	Creates an instance of JiraRestClient with default HttpClient settings.
JiraRestClient	createWithAuthenticationHandler(URI serverUri, AuthenticationHandler authenticationHandler)	Creates an instance of JiraRestClient with default HttpClient settings.
JiraRestClient	createWithBasicHttpAuthentication(URI serverUri, String username, String password)	Creates an instance of JiraRestClient with default HttpClient settings.

Method Details

create

JiraRestClient create(URI serverUri,
 AuthenticationHandler authenticationHandler)

Creates an instance of JiraRestClient with default HttpClient settings.

Parameters:

serverUri - - URI of JIRA instance.

authenticationHandler - - requests authenticator.

createWithBasicHttpAuthentication

JiraRestClient createWithBasicHttpAuthentication(URI serverUri,
 String username,
 String password)

Creates an instance of JiraRestClient with default HttpClient settings. HttpClient will conduct a basic authentication for given credentials.

Parameters:

serverUri - - URI or JIRA instance.

username - - username of the user used to log in to JIRA.

password - - password of the user used to log in to JIRA.

createWithAuthenticationHandler

JiraRestClient createWithAuthenticationHandler(URI serverUri,
 AuthenticationHandler authenticationHandler)

Creates an instance of JiraRestClient with default HttpClient settings. HttpClient will call the provided authentication handler prior to making requests.

Parameters:

serverUri - - URI or JIRA instance.

authenticationHandler - - Authentication handler.

create

JiraRestClient create(URI serverUri,
 com.atlassian.httpclient.api.HttpClient httpClient)

Creates an instance of JiraRestClient with given Atlassian HttpClient. Please note, that this com.atlassian.jira.rest.client.api has to be fully configured to do the request authentication.

Parameters:

serverUri - - URI of JIRA instance.

httpClient - - instance of Atlassian HttpClient.