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.Gone.*;
016
017import java.text.*;
018
019import org.apache.juneau.http.annotation.*;
020import org.apache.juneau.rest.*;
021
022/**
023 * Exception representing an HTTP 410 ().
024 *
025 * <p>
026 * Indicates that the resource requested is no longer available and will not be available again.
027 * <br>This should be used when a resource has been intentionally removed and the resource should be purged.
028 * <br>Upon receiving a 410 status code, the client should not request the resource in the future.
029 * <br>Clients such as search engines should remove the resource from their indices.
030 * <br>Most use cases do not require clients and search engines to purge the resource, and a <js>"404 Not Found"</js> may be used instead.
031 */
032@Response(code=CODE, description=MESSAGE)
033public class Gone extends RestException {
034   private static final long serialVersionUID = 1L;
035
036   /** HTTP status code */
037   public static final int CODE = 410;
038
039   /** Default message */
040   public static final String MESSAGE = "Gone";
041
042   /**
043    * Constructor.
044    *
045    * @param cause The cause.  Can be <jk>null</jk>.
046    * @param msg The message.  Can be <jk>null</jk>.
047    * @param args Optional {@link MessageFormat}-style arguments in the message.
048    */
049   public Gone(Throwable cause, String msg, Object...args) {
050      super(cause, CODE, msg, args);
051   }
052
053   /**
054    * Constructor.
055    */
056   public Gone() {
057      this((Throwable)null, MESSAGE);
058   }
059
060   /**
061    * Constructor.
062    *
063    * @param msg The message.  Can be <jk>null</jk>.
064    * @param args Optional {@link MessageFormat}-style arguments in the message.
065    */
066   public Gone(String msg, Object...args) {
067      this(null, msg, args);
068   }
069
070   /**
071    * Constructor.
072    *
073    * @param cause The cause.  Can be <jk>null</jk>.
074    */
075   public Gone(Throwable cause) {
076      this(cause, null);
077   }
078}