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.http.exception;
014
015import static org.apache.juneau.http.exception.TooManyRequests.*;
016
017import java.text.*;
018
019import org.apache.juneau.http.annotation.*;
020
021/**
022 * Exception representing an HTTP 429 (Too Many Requests).
023 *
024 * <p>
025 * The user has sent too many requests in a given amount of time.
026 * <br>Intended for use with rate-limiting schemes.
027 */
028@Response(code=CODE, description=MESSAGE)
029public class TooManyRequests extends HttpException {
030   private static final long serialVersionUID = 1L;
031
032   /** HTTP status code */
033   public static final int CODE = 429;
034
035   /** Default message */
036   public static final String MESSAGE = "Too Many Requests";
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 TooManyRequests(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 TooManyRequests(String msg) {
055      this((Throwable)null, msg);
056   }
057
058   /**
059    * Constructor.
060    */
061   public TooManyRequests() {
062      this((Throwable)null, MESSAGE);
063   }
064
065   /**
066    * Constructor.
067    *
068    * @param msg The message.  Can be <jk>null</jk>.
069    * @param args Optional {@link MessageFormat}-style arguments in the message.
070    */
071   public TooManyRequests(String msg, Object...args) {
072      this(null, msg, args);
073   }
074
075   /**
076    * Constructor.
077    *
078    * @param cause The cause.  Can be <jk>null</jk>.
079    */
080   public TooManyRequests(Throwable cause) {
081      this(cause, null);
082   }
083
084   //------------------------------------------------------------------------------------------------------------------
085   // Fluent setters.
086   //------------------------------------------------------------------------------------------------------------------
087
088   // <FluentSetters>
089
090   @Override /* GENERATED - HttpException */
091   public TooManyRequests header(String name, Object val) {
092      super.header(name, val);
093      return this;
094   }
095
096   // </FluentSetters>
097}