001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.exception;
014
015import static org.apache.juneau.rest.exception.BadRequest.*;
016
017import java.text.*;
018
019import org.apache.juneau.http.annotation.*;
020import org.apache.juneau.rest.*;
021
022/**
023 * Exception representing an HTTP 400 (Bad Request).
024 *
025 * <p>
026 * The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing).
027 */
028@Response(code=CODE, description=MESSAGE)
029public class BadRequest extends RestException {
030   private static final long serialVersionUID = 1L;
031
032   /** HTTP status code */
033   public static final int CODE = 400;
034
035   /** Default message */
036   public static final String MESSAGE = "Bad Request";
037
038   /**
039    * Constructor.
040    *
041    * @param cause The cause.  Can be <jk>null</jk>.
042    * @param msg The message.  Can be <jk>null</jk>.
043    * @param args Optional {@link MessageFormat}-style arguments in the message.
044    */
045   public BadRequest(Throwable cause, String msg, Object...args) {
046      super(cause, CODE, msg, args);
047   }
048
049   /**
050    * Constructor.
051    *
052    * @param msg The message.  Can be <jk>null</jk>.
053    */
054   public BadRequest(String msg) {
055      super(msg);
056      setStatus(CODE);
057   }
058
059   /**
060    * Constructor.
061    */
062   public BadRequest() {
063      this((Throwable)null, MESSAGE);
064   }
065
066   /**
067    * Constructor.
068    *
069    * @param msg The message.  Can be <jk>null</jk>.
070    * @param args Optional {@link MessageFormat}-style arguments in the message.
071    */
072   public BadRequest(String msg, Object...args) {
073      this(null, msg, args);
074   }
075
076   /**
077    * Constructor.
078    *
079    * @param cause The cause.  Can be <jk>null</jk>.
080    */
081   public BadRequest(Throwable cause) {
082      this(cause, null);
083   }
084}