Module org.kohsuke.github.api

Package org.kohsuke.github.connector

Interface GitHubConnector

All Known Implementing Classes:

HttpClientGitHubConnector, OkHttpGitHubConnector

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface GitHubConnector

Interface for customizing HTTP request behaviors or using any HTTP client library for interacting with GitHub.

Author:

Liam Newman

Field Summary

Fields

Modifier and Type	Field	Description
static final GitHubConnector	DEFAULT	Default implementation used when connector is not set by user.
static final GitHubConnector	OFFLINE	Stub implementation that is always off-line.

Method Summary

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

Field Details

DEFAULT

static final GitHubConnector DEFAULT

Default implementation used when connector is not set by user. This calls DefaultGitHubConnector.create() to get the default connector instance. The output of that method may differ depending on Java version and system properties.

See Also:

• DefaultGitHubConnector#create()

OFFLINE

static final GitHubConnector OFFLINE

Stub implementation that is always off-line.

Method Details

send

GitHubConnectorResponse send(GitHubConnectorRequest connectorRequest)
                      throws IOException

Sends a request and retrieves a raw response for processing. Implementers of 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 send(GitHubConnectorRequest) should be passed to the constructor of GitHubConnectorResponse.

Parameters:

connectorRequest - the request data to be sent.

Returns:

a GitHubConnectorResponse for the request

Throws:

IOException - if there is an I/O error