Module org.kohsuke.github.api

Package org.kohsuke.github.extras.okhttp3

Class OkHttpGitHubConnector

java.lang.Object

org.kohsuke.github.extras.okhttp3.OkHttpGitHubConnector

All Implemented Interfaces:

GitHubConnector

public class OkHttpGitHubConnector
extends Object
implements GitHubConnector

GitHubConnector for OkHttpClient.

Unlike GitHubConnector.DEFAULT, OkHttp supports response caching. Making a conditional request against GitHub API and receiving a 304 response does not count against the rate limit. See http://developer.github.com/v3/#conditional-requests

Author:

Liam Newman

Field Summary

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

DEFAULT, OFFLINE

Constructor Summary

Constructors

Constructor	Description
OkHttpGitHubConnector(okhttp3.OkHttpClient client)	Instantiates a new Ok http connector.
OkHttpGitHubConnector(okhttp3.OkHttpClient client, int cacheMaxAge)	Instantiates a new Ok http connector.

Method Summary

Modifier and Type	Method	Description
GitHubConnectorResponse	send(GitHubConnectorRequest request)	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

OkHttpGitHubConnector

public OkHttpGitHubConnector(okhttp3.OkHttpClient client)

Instantiates a new Ok http connector.

Parameters:

client - the client

OkHttpGitHubConnector

public OkHttpGitHubConnector(okhttp3.OkHttpClient client,
 int cacheMaxAge)

Instantiates a new Ok http connector.

Parameters:

client - the client

cacheMaxAge - the cache max age

Method Details

send

public GitHubConnectorResponse send(GitHubConnectorRequest request)
                             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:

request - the request data to be sent.

Returns:

a GitHubConnectorResponse for the request

Throws:

IOException - if there is an I/O error