1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions Copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2011-2013 ForgeRock AS.
15 */
16
17 package org.forgerock.json.resource;
18
19 /**
20 * An exception that is thrown to indicate that a resource requires a version,
21 * but no version was supplied in the request. Equivalent to
22 * draft-nottingham-http-new-status-03 HTTP status: 428 Precondition Required.
23 */
24 public class PreconditionRequiredException extends ResourceException {
25
26 private static final long serialVersionUID = 1L;
27
28 /**
29 * Constructs a new exception with {@code null} as its detail message.
30 */
31 public PreconditionRequiredException() {
32 super(ResourceException.VERSION_REQUIRED);
33 }
34
35 /**
36 * Constructs a new exception with the specified detail message.
37 *
38 * @param message
39 * The detail message.
40 */
41 public PreconditionRequiredException(final String message) {
42 super(ResourceException.VERSION_REQUIRED, message);
43 }
44
45 /**
46 * Constructs a new exception with the specified detail message and cause.
47 *
48 * @param message
49 * The detail message.
50 * @param cause
51 * The exception which caused this exception to be thrown.
52 */
53 public PreconditionRequiredException(final String message, final Throwable cause) {
54 super(ResourceException.VERSION_REQUIRED, message, cause);
55 }
56
57 /**
58 * Constructs a new exception with the specified cause.
59 *
60 * @param cause
61 * The exception which caused this exception to be thrown.
62 */
63 public PreconditionRequiredException(final Throwable cause) {
64 super(ResourceException.VERSION_REQUIRED, cause);
65 }
66 }