org.shredzone.acme4j.exception

Class AcmeRateLimitExceededException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.shredzone.acme4j.exception.AcmeException

org.shredzone.acme4j.exception.AcmeServerException

org.shredzone.acme4j.exception.AcmeRateLimitExceededException

All Implemented Interfaces:

Serializable

public class AcmeRateLimitExceededException
extends AcmeServerException

An exception that is thrown when a rate limit was exceeded.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AcmeRateLimitExceededException(String type, String detail, Instant retryAfter, Collection<URI> documents) Creates a new AcmeRateLimitExceededException.

Method Summary

Modifier and Type	Method and Description
Collection<URI>	getDocuments() Collection of URIs pointing to documents about the rate limit that was hit.
Instant	getRetryAfter() Returns the moment the request is expected to succeed again.

Methods inherited from class org.shredzone.acme4j.exception.AcmeServerException

getAcmeErrorType, getType

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AcmeRateLimitExceededException

public AcmeRateLimitExceededException(String type,
                                      String detail,
                                      Instant retryAfter,
                                      Collection<URI> documents)

Creates a new AcmeRateLimitExceededException.

Parameters:

type - System readable error type (here "urn:ietf:params:acme:error:rateLimited")

detail - Human readable error message

retryAfter - The moment the request is expected to succeed again, may be null if not known

documents - URIs pointing to documents about the rate limit that was hit

Method Detail

getRetryAfter

public Instant getRetryAfter()

Returns the moment the request is expected to succeed again. null if this moment is not known.

getDocuments

public Collection<URI> getDocuments()

Collection of URIs pointing to documents about the rate limit that was hit. null if the server did not provide such URIs.