Module org.shredzone.acme4j

Package org.shredzone.acme4j.exception

Class AcmeRateLimitedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.shredzone.acme4j.exception.AcmeException

org.shredzone.acme4j.exception.AcmeServerException

org.shredzone.acme4j.exception.AcmeRateLimitedException

All Implemented Interfaces:

Serializable

public class AcmeRateLimitedException
extends AcmeServerException

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AcmeRateLimitedException(Problem problem, Instant retryAfter, Collection<URL> documents)	Creates a new AcmeRateLimitedException.

Method Summary

Modifier and Type	Method	Description
Collection<URL>	getDocuments()	Collection of URLs 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

getProblem, 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 Details

AcmeRateLimitedException

public AcmeRateLimitedException(Problem problem,
 @Nullable
 Instant retryAfter,
 @Nullable
 Collection<URL> documents)

Creates a new AcmeRateLimitedException.

Parameters:

problem - Problem that caused the exception

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

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

Method Details

getRetryAfter

@Nullable
public Instant getRetryAfter()

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

getDocuments

@Nullable
public Collection<URL> getDocuments()

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