-
Notifications
You must be signed in to change notification settings - Fork 214
/
ThingPreconditionFailedException.java
133 lines (116 loc) · 5.37 KB
/
ThingPreconditionFailedException.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.things.model.signals.commands.exceptions;
import java.net.URI;
import java.text.MessageFormat;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.eclipse.ditto.base.model.common.HttpStatus;
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeException;
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeExceptionBuilder;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.json.JsonParsableException;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.things.model.ThingException;
/**
* Thrown when validating a precondition header fails on a Thing or one of its sub-entities.
*/
@Immutable
@JsonParsableException(errorCode = ThingPreconditionFailedException.ERROR_CODE)
public final class ThingPreconditionFailedException extends DittoRuntimeException implements ThingException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "precondition.failed";
private static final String MESSAGE_TEMPLATE =
"The comparison of precondition header ''{0}'' for the requested Thing resource evaluated to false." +
" Header value: ''{1}'', actual entity-tag: ''{2}''.";
private static final String DEFAULT_DESCRIPTION = "The comparison of the provided precondition header with the " +
"current ETag value of the requested Thing resource evaluated to false. Check the value of your " +
"conditional header value.";
private ThingPreconditionFailedException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatus.PRECONDITION_FAILED, dittoHeaders, message, description, cause, href);
}
/**
* A mutable builder for a {@link ThingPreconditionFailedException}.
*
* @return the builder.
*/
public static Builder newBuilder() {
return new Builder();
}
/**
* A mutable builder for a {@link ThingPreconditionFailedException}.
*
* @param conditionalHeaderName the name of the conditional header.
* @param expected the expected value.
* @param actual the actual ETag value.
* @return the builder.
*/
public static Builder newBuilder(final String conditionalHeaderName, final String expected, final String actual) {
return new Builder(conditionalHeaderName, expected, actual);
}
/**
* Constructs a new {@link ThingPreconditionFailedException} object with the exception message extracted from
* the given JSON object.
*
* @param jsonObject the JSON to read the {@link org.eclipse.ditto.base.model.exceptions.DittoRuntimeException.JsonFields#MESSAGE} field from.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new {@link ThingPreconditionFailedException}.
* @throws NullPointerException if any argument is {@code null}.
* @throws org.eclipse.ditto.json.JsonMissingFieldException if this JsonObject did not contain an error message.
* @throws org.eclipse.ditto.json.JsonParseException if the passed in {@code jsonObject} was not in the expected
* format.
*/
public static ThingPreconditionFailedException fromJson(final JsonObject jsonObject,
final DittoHeaders dittoHeaders) {
return DittoRuntimeException.fromJson(jsonObject, dittoHeaders, new Builder());
}
@Override
public DittoRuntimeException setDittoHeaders(final DittoHeaders dittoHeaders) {
return new Builder()
.message(getMessage())
.description(getDescription().orElse(null))
.cause(getCause())
.href(getHref().orElse(null))
.dittoHeaders(dittoHeaders)
.build();
}
/**
* A mutable builder with a fluent API for a {@link ThingPreconditionFailedException}.
*/
@NotThreadSafe
public static final class Builder
extends DittoRuntimeExceptionBuilder<ThingPreconditionFailedException> {
private Builder() {
description(DEFAULT_DESCRIPTION);
}
private Builder(final String conditionalHeaderName, final String expected, final String actual) {
this();
message(MessageFormat.format(MESSAGE_TEMPLATE, conditionalHeaderName, expected, actual));
}
@Override
protected ThingPreconditionFailedException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new ThingPreconditionFailedException(dittoHeaders, message, description, cause, href);
}
}
}