org.kohsuke.github.extras.okhttp3

Class OkHttpConnector

java.lang.Object

org.kohsuke.github.extras.okhttp3.OkHttpConnector

All Implemented Interfaces:

HttpConnector

public class OkHttpConnector
extends Object
implements HttpConnector

HttpConnector for OkHttpClient.

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

Author:

Liam Newman, Kohsuke Kawaguchi

Field Summary

Fields inherited from interface org.kohsuke.github.HttpConnector

DEFAULT, OFFLINE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HttpURLConnection	connect(URL url) Opens a connection to the given URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpConnector

public OkHttpConnector(okhttp3.OkHttpClient client)

Instantiates a new Ok http connector.

Parameters:

client - the client

OkHttpConnector

public OkHttpConnector(okhttp3.OkHttpClient client,
                       int cacheMaxAge)

Instantiates a new Ok http connector.

Parameters:

client - the client

cacheMaxAge - the cache max age

Method Detail

connect

public HttpURLConnection connect(URL url)
                          throws IOException

Description copied from interface: HttpConnector

Opens a connection to the given URL.

Specified by:

connect in interface HttpConnector

Parameters:

url - the url

Returns:

the http url connection

Throws:

IOException - the io exception