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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.9

Show newest version

/*
 * 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 base runtime application exception indicating a client request error (HTTP {@code 4xx} status codes).
 *
 * @author Marek Potociar
 * @since 2.0
 */
public class ClientErrorException extends WebApplicationException {

    private static final long serialVersionUID = -4101970664444907990L;

    /**
     * Construct a new client error exception.
     *
     * @param status client error status. Must be a {@code 4xx} status code.
     * @throws IllegalArgumentException in case the status code is {@code null} or is not from
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final Response.Status status) {
        super((Throwable) null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param status client error status. Must be a {@code 4xx} status code.
     * @throws IllegalArgumentException in case the status code is {@code null} or is not from
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final String message, final Response.Status status) {
        super(message, null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param status client error status. Must be a {@code 4xx} status code.
     * @throws IllegalArgumentException in case the status code is not a valid HTTP status code or if it is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final int status) {
        super((Throwable) null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param status client error status. Must be a {@code 4xx} status code.
     * @throws IllegalArgumentException in case the status code is not a valid HTTP status code or if it is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final String message, final int status) {
        super(message, null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param response client error response. Must have a status code set to a {@code 4xx} status code.
     * @throws IllegalArgumentException in case the response status code is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final Response response) {
        super((Throwable) null, validate(response, Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param response client error response. Must have a status code set to a {@code 4xx} status code.
     * @throws IllegalArgumentException in case the response status code is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final String message, final Response response) {
        super(message, null, validate(response, Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param status client error status. Must be a {@code 4xx} status code.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code is {@code null} or is not from
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final Response.Status status, final Throwable cause) {
        super(cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param status client error status. Must be a {@code 4xx} status code.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code is {@code null} or is not from
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final String message, final Response.Status status, final Throwable cause) {
        super(message, cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param status client error status. Must be a {@code 4xx} status code.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code is not a valid HTTP status code or if it is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final int status, final Throwable cause) {
        super(cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param status client error status. Must be a {@code 4xx} status code.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code is not a valid HTTP status code or if it is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final String message, final int status, final Throwable cause) {
        super(message, cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param response client error response. Must have a status code set to a {@code 4xx} status code.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the response status code is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final Response response, final Throwable cause) {
        super(cause, validate(response, Response.Status.Family.CLIENT_ERROR));
    }

    /**
     * Construct a new client error exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param response client error response. Must have a status code set to a {@code 4xx} status code.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the response status code is not from the
     * {@link jakarta.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(final String message, final Response response, final Throwable cause) {
        super(message, cause, validate(response, Response.Status.Family.CLIENT_ERROR));
    }
}