org.apache.juneau.rest.exception.Gone Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.rest.exception;
import static org.apache.juneau.rest.exception.Gone.*;
import java.text.*;
import org.apache.juneau.http.annotation.*;
import org.apache.juneau.rest.*;
/**
* Exception representing an HTTP 410 ().
*
*
* Indicates that the resource requested is no longer available and will not be available again.
*
This should be used when a resource has been intentionally removed and the resource should be purged.
*
Upon receiving a 410 status code, the client should not request the resource in the future.
*
Clients such as search engines should remove the resource from their indices.
*
Most use cases do not require clients and search engines to purge the resource, and a "404 Not Found" may be used instead.
*/
@Response(code=CODE, description=MESSAGE)
public class Gone extends RestException {
private static final long serialVersionUID = 1L;
/** HTTP status code */
public static final int CODE = 410;
/** Default message */
public static final String MESSAGE = "Gone";
/**
* Constructor.
*
* @param cause The cause. Can be null .
* @param msg The message. Can be null .
* @param args Optional {@link MessageFormat}-style arguments in the message.
*/
public Gone(Throwable cause, String msg, Object...args) {
super(cause, CODE, msg, args);
}
/**
* Constructor.
*/
public Gone() {
this((Throwable)null, MESSAGE);
}
/**
* Constructor.
*
* @param msg The message. Can be null .
* @param args Optional {@link MessageFormat}-style arguments in the message.
*/
public Gone(String msg, Object...args) {
this(null, msg, args);
}
/**
* Constructor.
*
* @param cause The cause. Can be null .
*/
public Gone(Throwable cause) {
this(cause, null);
}
}