Package org.kohsuke.github

Class RateLimitHandler

java.lang.Object

org.kohsuke.github.GitHubRateLimitHandler

org.kohsuke.github.RateLimitHandler

@Deprecated
public abstract class RateLimitHandler
extends GitHubRateLimitHandler

Deprecated.

Switch to GitHubRateLimitHandler or even better provide RateLimitCheckers.

Pluggable strategy to determine what to do when the API rate limit is reached.

Author:

Kohsuke Kawaguchi

See Also:

• GitHubBuilder#withRateLimitHandler(GitHubRateLimitHandler)
• AbuseLimitHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final RateLimitHandler	FAIL	Deprecated.
static final int	TOO_MANY_REQUESTS	The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
static final RateLimitHandler	WAIT	Deprecated.

Constructor Summary

Constructors

Constructor	Description
RateLimitHandler()	Deprecated.

Method Summary

Modifier and Type	Method	Description
abstract void	onError(IOException e, HttpURLConnection uc)	Deprecated.
void	onError(GitHubConnectorResponse connectorResponse)	Deprecated. Called when the library encounters HTTP error indicating that the API rate limit has been exceeded.

Methods inherited from class java.lang.Object

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

Field Details

WAIT

@Deprecated
public static final RateLimitHandler WAIT

Deprecated.

Block until the API rate limit is reset. Useful for long-running batch processing.

FAIL

@Deprecated
public static final RateLimitHandler FAIL

Deprecated.

Fail immediately.

TOO_MANY_REQUESTS

public static final int TOO_MANY_REQUESTS

The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting"). A Retry-After header might be included to this response indicating how long to wait before making a new request. Why is this hardcoded here? The HttpURLConnection class is missing the status codes above 415, so the constant needs to be sourced from elsewhere.

See Also:

• Constant Field Values

Constructor Details

RateLimitHandler

public RateLimitHandler()

Deprecated.

Method Details

onError

public void onError(@Nonnull
 GitHubConnectorResponse connectorResponse)
             throws IOException

Deprecated.

Called when the library encounters HTTP error indicating that the API rate limit has been exceeded.

Any exception thrown from this method will cause the request to fail, and the caller of github-api will receive an exception. If this method returns normally, another request will be attempted. For that to make sense, the implementation needs to wait for some time.

Specified by:

onError in class GitHubRateLimitHandler

Parameters:

connectorResponse - Response information for this request.

Throws:

IOException - the io exception

See Also:

• API documentation from GitHub

onError

@Deprecated
public abstract void onError(IOException e,
 HttpURLConnection uc)
                      throws IOException

Deprecated.

Called when the library encounters HTTP error indicating that the API rate limit is reached.

Any exception thrown from this method will cause the request to fail, and the caller of github-api will receive an exception. If this method returns normally, another request will be attempted. For that to make sense, the implementation needs to wait for some time.

Parameters:

e - Exception from Java I/O layer. If you decide to fail the processing, you can throw this exception (or wrap this exception into another exception and throw it.)

uc - Connection that resulted in an error. Useful for accessing other response headers.

Throws:

IOException - the io exception

See Also:

• API documentation from GitHub