Package org.kohsuke.github
Class GitHubAbuseLimitHandler
- java.lang.Object
-
- org.kohsuke.github.GitHubAbuseLimitHandler
-
- Direct Known Subclasses:
AbuseLimitHandler
public abstract class GitHubAbuseLimitHandler extends Object
Pluggable strategy to determine what to do when the API rate limit is reached.- Author:
- Kohsuke Kawaguchi, Liam Newman
- See Also:
GitHubBuilder#withRateLimitHandler(AbuseLimitHandler)
,GitHubRateLimitHandler
-
-
Constructor Summary
Constructors Constructor Description GitHubAbuseLimitHandler()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract void
onError(GitHubConnectorResponse connectorResponse)
Called when the library encounters HTTP error indicating that the API abuse limit is reached.
-
-
-
Method Detail
-
onError
public abstract void onError(@Nonnull GitHubConnectorResponse connectorResponse) 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:
connectorResponse
- Response information for this request.- Throws:
IOException
- on failure- See Also:
- API documentation from GitHub, Dealing with abuse rate limits
-
-