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 * @deprecated Use {@link org.apache.juneau.http.exception.Gone} 033 */ 034@Response(code=CODE, description=MESSAGE) 035@Deprecated 036public class Gone extends RestException { 037 private static final long serialVersionUID = 1L; 038 039 /** HTTP status code */ 040 public static final int CODE = 410; 041 042 /** Default message */ 043 public static final String MESSAGE = "Gone"; 044 045 /** 046 * Constructor. 047 * 048 * @param cause The cause. Can be <jk>null</jk>. 049 * @param msg The message. Can be <jk>null</jk>. 050 * @param args Optional {@link MessageFormat}-style arguments in the message. 051 */ 052 public Gone(Throwable cause, String msg, Object...args) { 053 super(cause, CODE, msg, args); 054 } 055 056 /** 057 * Constructor. 058 * 059 * @param msg The message. Can be <jk>null</jk>. 060 */ 061 public Gone(String msg) { 062 super(msg); 063 setStatus(CODE); 064 } 065 066 /** 067 * Constructor. 068 */ 069 public Gone() { 070 this((Throwable)null, MESSAGE); 071 } 072 073 /** 074 * Constructor. 075 * 076 * @param msg The message. Can be <jk>null</jk>. 077 * @param args Optional {@link MessageFormat}-style arguments in the message. 078 */ 079 public Gone(String msg, Object...args) { 080 this(null, msg, args); 081 } 082 083 /** 084 * Constructor. 085 * 086 * @param cause The cause. Can be <jk>null</jk>. 087 */ 088 public Gone(Throwable cause) { 089 this(cause, null); 090 } 091}