PreconditionRequiredException.java

/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2011-2013 ForgeRock AS.
 */

package org.forgerock.json.resource;

/**
 * An exception that is thrown to indicate that a resource requires a version,
 * but no version was supplied in the request. Equivalent to
 * draft-nottingham-http-new-status-03 HTTP status: 428 Precondition Required.
 */
public class PreconditionRequiredException extends ResourceException {

    private static final long serialVersionUID = 1L;

    /**
     * Constructs a new exception with {@code null} as its detail message.
     */
    public PreconditionRequiredException() {
        super(ResourceException.VERSION_REQUIRED);
    }

    /**
     * Constructs a new exception with the specified detail message.
     *
     * @param message
     *            The detail message.
     */
    public PreconditionRequiredException(final String message) {
        super(ResourceException.VERSION_REQUIRED, message);
    }

    /**
     * Constructs a new exception with the specified detail message and cause.
     *
     * @param message
     *            The detail message.
     * @param cause
     *            The exception which caused this exception to be thrown.
     */
    public PreconditionRequiredException(final String message, final Throwable cause) {
        super(ResourceException.VERSION_REQUIRED, message, cause);
    }

    /**
     * Constructs a new exception with the specified cause.
     *
     * @param cause
     *            The exception which caused this exception to be thrown.
     */
    public PreconditionRequiredException(final Throwable cause) {
        super(ResourceException.VERSION_REQUIRED, cause);
    }
}