org.kiwiproject.jaxrs.exception.JaxrsForbiddenException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kiwi Show documentation

Kiwi is a utility library. We really like Google's Guava, and also use Apache Commons. But if they don't have something we need, and we think it is useful, this is where we put it.

There is a newer version: 4.5.2

Show newest version

package org.kiwiproject.jaxrs.exception;

/**
 * Exception representing a 403 Forbidden that extends {@link JaxrsException} to use Kiwi's {@link ErrorMessage}.
 */
public class JaxrsForbiddenException extends JaxrsException {

    /**
     * The status code for all instances of this exception.
     */
    public static final int CODE = 403;

    /**
     * New instance with given cause and 403 status code.
     *
     * @param cause the cause of this exception
     */
    public JaxrsForbiddenException(Throwable cause) {
        super(cause, CODE);
    }

    /**
     * New instance with given message and 403 status code.
     *
     * @param message the message for this exception
     */
    public JaxrsForbiddenException(String message) {
        super(message, CODE);
    }

    /**
     * New instance with given message, cause, and 403 status code.
     *
     * @param message the message for this exception
     * @param cause   the cause of this exception
     */
    public JaxrsForbiddenException(String message, Throwable cause) {
        super(message, cause, CODE);
    }

    /**
     * New instance with the given message and field name, and 403 status code.
     *
     * @param message   the message for this exception
     * @param fieldName the field/property name that caused this error
     */
    public JaxrsForbiddenException(String message, String fieldName) {
        this(message, fieldName, null);
    }

    /**
     * New instance with the given message, field name, item ID, and 403 status code.
     *
     * @param message   the message for this exception
     * @param fieldName the field/property name that caused this error
     * @param itemId    the unique ID of the item that caused this error
     */
    public JaxrsForbiddenException(String message, String fieldName, String itemId) {
        this(message, fieldName, itemId, null);
    }

    /**
     * New instance with the given message, field name, item ID, cause, and 403 status code.
     *
     * @param message   the message for this exception
     * @param fieldName the field/property name that caused this error
     * @param itemId    the unique ID of the item that caused this error
     * @param cause     the cause of this exception
     */
    public JaxrsForbiddenException(String message, String fieldName, String itemId, Throwable cause) {
        super(new ErrorMessage(itemId, CODE, message, fieldName), cause);
    }
}