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.LoopDetected.*;
016
017import java.text.*;
018
019import org.apache.juneau.http.annotation.*;
020import org.apache.juneau.rest.*;
021
022/**
023 * Exception representing an HTTP 508 (Loop Detected).
024 *
025 * <p>
026 * The server detected an infinite loop while processing the request (sent in lieu of 208 Already Reported).
027 */
028@Response(code=CODE, description=MESSAGE)
029public class LoopDetected extends RestException {
030   private static final long serialVersionUID = 1L;
031
032   /** HTTP status code */
033   public static final int CODE = 508;
034
035   /** Default message */
036   public static final String MESSAGE = "Loop Detected";
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 LoopDetected(Throwable cause, String msg, Object...args) {
046      super(cause, CODE, msg, args);
047   }
048
049   /**
050    * Constructor.
051    */
052   public LoopDetected() {
053      this((Throwable)null, MESSAGE);
054   }
055
056   /**
057    * Constructor.
058    *
059    * @param msg The message.  Can be <jk>null</jk>.
060    * @param args Optional {@link MessageFormat}-style arguments in the message.
061    */
062   public LoopDetected(String msg, Object...args) {
063      this(null, msg, args);
064   }
065
066   /**
067    * Constructor.
068    *
069    * @param cause The cause.  Can be <jk>null</jk>.
070    */
071   public LoopDetected(Throwable cause) {
072      this(cause, null);
073   }
074}