/*
 * Copyright (c) 2012, 2017 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 javax.ws.rs;

import javax.ws.rs.core.Response;

A base runtime application exception indicating a client request error (HTTP 4xx status codes). 
Author:
Marek Potociar
Since:
2.0/**
 * 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.
Params:
status – client error status. Must be a 4xx status code.
Throws:
IllegalArgumentException – in case the status code is null or is not from Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code
     *                                  family.
     */
    public ClientErrorException(Response.Status status) {
        super((Throwable) null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }


    
Construct a new client error exception.
Params:
message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
status –  client error status. Must be a 4xx status code.
Throws:
IllegalArgumentException – in case the status code is null or is not from Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code
     *                                  family.
     */
    public ClientErrorException(String message, Response.Status status) {
        super(message, null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
status – client error status. Must be a 4xx status code.
Throws:
IllegalArgumentException – in case the status code is not a valid HTTP status code or if it is not from the Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR}
     *                                  status code family.
     */
    public ClientErrorException(int status) {
        super((Throwable) null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
status –  client error status. Must be a 4xx status code.
Throws:
IllegalArgumentException – in case the status code is not a valid HTTP status code or if it is not from the Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR}
     *                                  status code family.
     */
    public ClientErrorException(String message, int status) {
        super(message, null, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
response – client error response. Must have a status code set to a 4xx status code.
Throws:
IllegalArgumentException – in case the response status code is not from the Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(Response response) {
        super((Throwable) null, validate(response, Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
message –  the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
response – client error response. Must have a status code set to a 4xx status code.
Throws:
IllegalArgumentException – in case the response status code is not from the Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(String message, Response response) {
        super(message, null, validate(response, Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
status – client error status. Must be a 4xx status code.
cause –  the underlying cause of the exception.
Throws:
IllegalArgumentException – in case the status code is null or is not from Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code
     *                                  family.
     */
    public ClientErrorException(Response.Status status, Throwable cause) {
        super(cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
status –  client error status. Must be a 4xx status code.
cause –   the underlying cause of the exception.
Throws:
IllegalArgumentException – in case the status code is null or is not from Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code
     *                                  family.
     */
    public ClientErrorException(String message, Response.Status status, Throwable cause) {
        super(message, cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
status – client error status. Must be a 4xx status code.
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 Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR}
     *                                  status code family.
     */
    public ClientErrorException(int status, Throwable cause) {
        super(cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
status –  client error status. Must be a 4xx status code.
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 Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR}
     *                                  status code family.
     */
    public ClientErrorException(String message, int status, Throwable cause) {
        super(message, cause, validate(Response.status(status).build(), Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
response – client error response. Must have a status code set to a 4xx status code.
cause –    the underlying cause of the exception.
Throws:
IllegalArgumentException – in case the response status code is not from the Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(Response response, Throwable cause) {
        super(cause, validate(response, Response.Status.Family.CLIENT_ERROR));
    }

    
Construct a new client error exception.
Params:
message –  the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
response – client error response. Must have a status code set to a 4xx status code.
cause –    the underlying cause of the exception.
Throws:
IllegalArgumentException – in case the response status code is not from the Family.CLIENT_ERROR status code family./**
     * 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 javax.ws.rs.core.Response.Status.Family#CLIENT_ERROR} status code family.
     */
    public ClientErrorException(String message, Response response, Throwable cause) {
        super(message, cause, validate(response, Response.Status.Family.CLIENT_ERROR));
    }
}