io.github.belgif.rest.problem.TooManyRequestsProblem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of belgif-rest-problem Show documentation

Support classes for generating standardized problem types (https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types).

The newest version!

package io.github.belgif.rest.problem;

import java.net.URI;
import java.util.Objects;

import io.github.belgif.rest.problem.api.ProblemType;
import io.github.belgif.rest.problem.api.RetryAfterClientProblem;

/**
 * HTTP 429: Too Many Requests (https://www.belgif.be/specification/rest/api-guide/problems/tooManyRequests.html)
 *
 * @see 
 *      https://www.belgif.be/specification/rest/api-guide/#too-many-requests
 */
@ProblemType(TooManyRequestsProblem.TYPE)
public class TooManyRequestsProblem extends RetryAfterClientProblem {

    /**
     * The problem type.
     */
    public static final String TYPE = "urn:problem-type:belgif:tooManyRequests";

    /**
     * The problem type URI.
     */
    public static final URI TYPE_URI = URI.create(TYPE);

    /**
     * The href URI.
     */
    public static final URI HREF =
            URI.create("https://www.belgif.be/specification/rest/api-guide/problems/tooManyRequests.html");

    /**
     * The title.
     */
    public static final String TITLE = "Too Many Requests";

    /**
     * The status.
     */
    public static final int STATUS = 429;

    private static final long serialVersionUID = 1L;

    private Long limit;

    public TooManyRequestsProblem() {
        super(TYPE_URI, HREF, TITLE, STATUS);
    }

    public Long getLimit() {
        return limit;
    }

    public void setLimit(Long limit) {
        this.limit = limit;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        if (!super.equals(o)) {
            return false;
        }
        TooManyRequestsProblem that = (TooManyRequestsProblem) o;
        return Objects.equals(limit, that.limit);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), limit);
    }

}