org.kohsuke.github

Class AbuseLimitHandler

java.lang.Object

org.kohsuke.github.AbuseLimitHandler

public abstract class AbuseLimitHandler
extends Object

Pluggable strategy to determine what to do when the API abuse limit is hit.

Author:

Kohsuke Kawaguchi

See Also:

GitHubBuilder.withAbuseLimitHandler(AbuseLimitHandler), documentation, RateLimitHandler

Field Summary

Fields

Modifier and Type	Field and Description
static AbuseLimitHandler	FAIL Fail immediately.
static AbuseLimitHandler	WAIT Wait until the API abuse "wait time" is passed.

Constructor Summary

Constructors

Constructor and Description
AbuseLimitHandler()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	onError(IOException e, HttpURLConnection uc) Called when the library encounters HTTP error indicating that the API abuse limit is reached.

Methods inherited from class java.lang.Object

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

Field Detail

WAIT

public static final AbuseLimitHandler WAIT

Wait until the API abuse "wait time" is passed.

FAIL

public static final AbuseLimitHandler FAIL

Fail immediately.

Constructor Detail

AbuseLimitHandler

public AbuseLimitHandler()

Method Detail

onError

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

Called when the library encounters HTTP error indicating that the API abuse 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

See Also:

API documentation from GitHub