jakarta.ws.rs.ForbiddenException Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ws.rs;

import jakarta.ws.rs.core.Response;

/**
 * A runtime exception indicating that an access to a resource requested by a client has been
 * {@link jakarta.ws.rs.core.Response.Status#FORBIDDEN forbidden} by the server.
 *
 * @author Marek Potociar
 * @since 2.0
 */
public class ForbiddenException extends ClientErrorException {

    private static final long serialVersionUID = -2740045367479165061L;

    /**
     * Construct a new "forbidden" exception.
     */
    public ForbiddenException() {
        super(Response.Status.FORBIDDEN);
    }

    /**
     * Construct a new "forbidden" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     */
    public ForbiddenException(final String message) {
        super(message, Response.Status.FORBIDDEN);
    }

    /**
     * Construct a new "forbidden" exception.
     *
     * @param response error response.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 403}.
     */
    public ForbiddenException(final Response response) {
        super(validate(response, Response.Status.FORBIDDEN));
    }

    /**
     * Construct a new "forbidden" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param response error response.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 403}.
     */
    public ForbiddenException(final String message, final Response response) {
        super(message, validate(response, Response.Status.FORBIDDEN));
    }

    /**
     * Construct a new "forbidden" exception.
     *
     * @param cause the underlying cause of the exception.
     */
    public ForbiddenException(final Throwable cause) {
        super(Response.Status.FORBIDDEN, cause);
    }

    /**
     * Construct a new "forbidden" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param cause the underlying cause of the exception.
     */
    public ForbiddenException(final String message, final Throwable cause) {
        super(message, Response.Status.FORBIDDEN, cause);
    }

    /**
     * Construct a new "forbidden" exception.
     *
     * @param response error response.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 403}.
     */
    public ForbiddenException(final Response response, final Throwable cause) {
        super(validate(response, Response.Status.FORBIDDEN), cause);
    }

    /**
     * Construct a new "forbidden" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param response error response.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 403}.
     */
    public ForbiddenException(final String message, final Response response, final Throwable cause) {
        super(message, validate(response, Response.Status.FORBIDDEN), cause);
    }
}