Module org.kohsuke.github.api

Package org.kohsuke.github.extras

Class HttpClientGitHubConnector

java.lang.Object

org.kohsuke.github.extras.HttpClientGitHubConnector

All Implemented Interfaces:

GitHubConnector

public class HttpClientGitHubConnector
extends Object
implements GitHubConnector

GitHubConnector for HttpClient.

Author:

Liam Newman

Field Summary

Fields inherited from interface org.kohsuke.github.connector.GitHubConnector

DEFAULT, OFFLINE

Constructor Summary

Constructors

Constructor	Description
HttpClientGitHubConnector()	Instantiates a new HttpClientGitHubConnector with a default HttpClient.
HttpClientGitHubConnector(HttpClient client)	Instantiates a new HttpClientGitHubConnector.

Method Summary

Modifier and Type	Method	Description
GitHubConnectorResponse	send(GitHubConnectorRequest connectorRequest)	Sends a request and retrieves a raw response for processing.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpClientGitHubConnector

public HttpClientGitHubConnector()

Instantiates a new HttpClientGitHubConnector with a default HttpClient.

HttpClientGitHubConnector

public HttpClientGitHubConnector(HttpClient client)

Instantiates a new HttpClientGitHubConnector.

Parameters:

client - the HttpClient to be used

Method Details

send

public GitHubConnectorResponse send(GitHubConnectorRequest connectorRequest)
                             throws IOException

Description copied from interface: GitHubConnector

Sends a request and retrieves a raw response for processing. Implementers of GitHubConnector.send(GitHubConnectorRequest) process the information from a GitHubConnectorRequest to open an HTTP connection and retrieve a raw response. They then return a class that extends GitHubConnectorResponse corresponding their response data. Clients should not implement their own GitHubConnectorRequest. The GitHubConnectorRequest provided by the caller of GitHubConnector.send(GitHubConnectorRequest) should be passed to the constructor of GitHubConnectorResponse.

Specified by:

send in interface GitHubConnector

Parameters:

connectorRequest - the request data to be sent.

Returns:

a GitHubConnectorResponse for the request

Throws:

IOException - if there is an I/O error