jakarta.ws.rs.NotFoundException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.jakartaee-web-api Show documentation
Jakarta EE Web Profile API
There is a newer version: 11.0.0-M4
Show newest version
/*
 * Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ws.rs;

import jakarta.ws.rs.core.Response;

/**
 * A runtime exception indicating a resource requested by a client was {@link jakarta.ws.rs.core.Response.Status#NOT_FOUND
 * not found} on the server.
 *
 * @author Sergey Beryozkin
 * @author Marek Potociar
 * @since 2.0
 */
public class NotFoundException extends ClientErrorException {

    private static final long serialVersionUID = -6820866117511628388L;

    /**
     * Construct a new "not found" exception.
     */
    public NotFoundException() {
        super(Response.Status.NOT_FOUND);
    }

    /**
     * Construct a new "not found" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     */
    public NotFoundException(final String message) {
        super(message, Response.Status.NOT_FOUND);
    }

    /**
     * Construct a new "not found" exception.
     *
     * @param response error response.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 404}.
     */
    public NotFoundException(final Response response) {
        super(validate(response, Response.Status.NOT_FOUND));
    }

    /**
     * Construct a new "not found" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param response error response.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 404}.
     */
    public NotFoundException(final String message, final Response response) {
        super(message, validate(response, Response.Status.NOT_FOUND));
    }

    /**
     * Construct a new "not found" exception.
     *
     * @param cause the underlying cause of the exception.
     */
    public NotFoundException(final Throwable cause) {
        super(Response.Status.NOT_FOUND, cause);
    }

    /**
     * Construct a new "not found" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param cause the underlying cause of the exception.
     */
    public NotFoundException(final String message, final Throwable cause) {
        super(message, Response.Status.NOT_FOUND, cause);
    }

    /**
     * Construct a new "not found" exception.
     *
     * @param response error response.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 404}.
     */
    public NotFoundException(final Response response, final Throwable cause) {
        super(validate(response, Response.Status.NOT_FOUND), cause);
    }

    /**
     * Construct a new "not found" exception.
     *
     * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     * @param response error response.
     * @param cause the underlying cause of the exception.
     * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 404}.
     */
    public NotFoundException(final String message, final Response response, final Throwable cause) {
        super(message, validate(response, Response.Status.NOT_FOUND), cause);
    }
}