Package org.kohsuke.github
Class RateLimitHandler
java.lang.Object
org.kohsuke.github.GitHubRateLimitHandler
org.kohsuke.github.RateLimitHandler
Deprecated.
Pluggable strategy to determine what to do when the API rate limit is reached.
- Author:
- Kohsuke Kawaguchi
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final RateLimitHandler
Deprecated.static final RateLimitHandler
Deprecated. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract 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.
-
Field Details
-
WAIT
Deprecated.Block until the API rate limit is reset. Useful for long-running batch processing. -
FAIL
Deprecated.Fail immediately.
-
-
Constructor Details
-
RateLimitHandler
public RateLimitHandler()Deprecated.
-
-
Method Details
-
onError
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 classGitHubRateLimitHandler
- Parameters:
connectorResponse
- Response information for this request.- Throws:
IOException
- the io exception- See Also:
-
onError
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:
-
GitHubRateLimitHandler
or even better provideRateLimitChecker
s.