org.shredzone.acme4j.exception.AcmeRateLimitedException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acme4j-client Show documentation
ACME client for Java
The newest version!
/*
 * acme4j - Java ACME client
 *
 * Copyright (C) 2015 Richard "Shred" Körber
 *   http://acme4j.shredzone.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */
package org.shredzone.acme4j.exception;

import java.net.URL;
import java.time.Instant;
import java.util.Collection;
import java.util.Collections;
import java.util.Optional;

import edu.umd.cs.findbugs.annotations.Nullable;
import org.shredzone.acme4j.Problem;

/**
 * A rate limit was exceeded. If provided by the server, it also includes the earliest
 * time at which a new attempt will be accepted, and a reference to a document that
 * further explains the rate limit that was exceeded.
 */
public class AcmeRateLimitedException extends AcmeServerException {
    private static final long serialVersionUID = 4150484059796413069L;

    private final @Nullable Instant retryAfter;
    private final Collection documents;

    /**
     * Creates a new {@link AcmeRateLimitedException}.
     *
     * @param problem
     *         {@link Problem} that caused the exception
     * @param retryAfter
     *         The instant of time that the request is expected to succeed again, may be
     *         {@code null} if not known
     * @param documents
     *         URLs pointing to documents about the rate limit that was hit, may be
     *         {@code null} if not known
     */
    public AcmeRateLimitedException(Problem problem, @Nullable Instant retryAfter,
                @Nullable Collection documents) {
        super(problem);
        this.retryAfter = retryAfter;
        this.documents = documents != null ? documents : Collections.emptyList();
    }

    /**
     * Returns the instant of time the request is expected to succeed again. Empty
     * if this moment is not known.
     */
    public Optional getRetryAfter() {
        return Optional.ofNullable(retryAfter);
    }

    /**
     * Collection of URLs pointing to documents about the rate limit that was hit.
     * Empty if the server did not provide such URLs.
     */
    public Collection getDocuments() {
        return Collections.unmodifiableCollection(documents);
    }

}