Package org.kohsuke.github

Class AbuseLimitHandler

java.lang.Object

org.kohsuke.github.GitHubAbuseLimitHandler

org.kohsuke.github.AbuseLimitHandler

@Deprecated
public abstract class AbuseLimitHandler
extends GitHubAbuseLimitHandler

Deprecated.

Switch to GitHubAbuseLimitHandler.

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

Author:

Kohsuke Kawaguchi

See Also:

GitHubBuilder#withAbuseLimitHandler(GitHubAbuseLimitHandler), documentation, RateLimitHandler

Field Summary

Fields

Modifier and Type	Field	Description
static AbuseLimitHandler	FAIL	Deprecated.
static AbuseLimitHandler	WAIT	Deprecated.

Constructor Summary

Constructors

Constructor	Description
AbuseLimitHandler()	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 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

@Deprecated
public static final AbuseLimitHandler WAIT

Deprecated.

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

FAIL

@Deprecated
public static final AbuseLimitHandler FAIL

Deprecated.

Fail immediately.

Constructor Detail

AbuseLimitHandler

public AbuseLimitHandler()

Deprecated.

Method Detail

onError

public void onError(@Nonnull
                    GitHubConnectorResponse connectorResponse)
             throws IOException

Deprecated.

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.

Specified by:

onError in class GitHubAbuseLimitHandler

Parameters:

connectorResponse - Response information for this request.

Throws:

IOException - on failure

See Also:

API documentation from GitHub, Dealing with abuse rate limits

onError

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

Deprecated.

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 - on failure

See Also:

API documentation from GitHub, Dealing with abuse rate limits