001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2011-2013 ForgeRock AS.
015 */
016
017package org.forgerock.json.resource;
018
019/**
020 * An exception that is thrown to indicate that a resource's current version
021 * does not match the version provided. Equivalent to HTTP status: 412
022 * Precondition Failed.
023 */
024public class PreconditionFailedException extends ResourceException {
025
026    private static final long serialVersionUID = 1L;
027
028    /**
029     * Constructs a new exception with {@code null} as its detail message.
030     */
031    public PreconditionFailedException() {
032        super(ResourceException.VERSION_MISMATCH);
033    }
034
035    /**
036     * Constructs a new exception with the specified detail message.
037     *
038     * @param message
039     *            The detail message.
040     */
041    public PreconditionFailedException(final String message) {
042        super(ResourceException.VERSION_MISMATCH, message);
043    }
044
045    /**
046     * Constructs a new exception with the specified detail message and cause.
047     *
048     * @param message
049     *            The detail message.
050     * @param cause
051     *            The exception which caused this exception to be thrown.
052     */
053    public PreconditionFailedException(final String message, final Throwable cause) {
054        super(ResourceException.VERSION_MISMATCH, message, cause);
055    }
056
057    /**
058     * Constructs a new exception with the specified cause.
059     *
060     * @param cause
061     *            The exception which caused this exception to be thrown.
062     */
063    public PreconditionFailedException(final Throwable cause) {
064        super(ResourceException.VERSION_MISMATCH, cause);
065    }
066}