-
Notifications
You must be signed in to change notification settings - Fork 215
/
PolicyIdNotExplicitlySettableException.java
executable file
·152 lines (129 loc) · 6.1 KB
/
PolicyIdNotExplicitlySettableException.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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
* 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.policies.model.signals.commands.exceptions;
import java.net.URI;
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.policies.model.PolicyException;
/**
* Thrown if either for a REST PUT request for creating a Policy it was tried to set an explicit {@code policyId}
* in the JSON body.
*/
@Immutable
@JsonParsableException(errorCode = PolicyIdNotExplicitlySettableException.ERROR_CODE)
public final class PolicyIdNotExplicitlySettableException extends DittoRuntimeException implements PolicyException {
/**
* Error code of this exception.
*/
public static final String ERROR_CODE = ERROR_CODE_PREFIX + "id.notsettable";
private static final String MESSAGE_TEMPLATE =
"The Policy ID in the request body is not equal to the Policy ID in the request URL.";
private static final String MESSAGE_TEMPLATE_POST =
"It is not allowed to provide a Policy ID in the request body for "
+ "method POST. The method POST will generate the Policy ID by itself.";
private static final String DEFAULT_DESCRIPTION =
"Either delete the Policy ID from the request body or use the same Policy ID as in the request URL.";
private static final String DEFAULT_DESCRIPTION_POST =
"To provide your own Policy ID use a PUT request instead.";
private PolicyIdNotExplicitlySettableException(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
super(ERROR_CODE, HttpStatus.BAD_REQUEST, dittoHeaders, message, description, cause, href);
}
private static final long serialVersionUID = 2497658333219185859L;
/**
* A mutable builder for a {@code PolicyIdNotExplicitlySettableException}.
*
* @return the builder.
*/
public static Builder newBuilder() {
return new Builder(MESSAGE_TEMPLATE, DEFAULT_DESCRIPTION);
}
/**
* A mutable builder for a {@code PolicyIdNotExplicitlySettableException} in scope of POSTing a policy.
*
* @return the builder.
* @since 3.0.0
*/
public static Builder forPostMethod() {
return new Builder(MESSAGE_TEMPLATE_POST, DEFAULT_DESCRIPTION_POST);
}
/**
* Constructs a new {@code PolicyIdNotExplicitlySettableException} object with the given exception message.
*
* @param message detail message. This message can be later retrieved by the {@link #getMessage()} method.
* @param dittoHeaders the headers of the command which resulted in this exception.
* @return the new PolicyIdNotExplicitlySettableException.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}.
*/
public static PolicyIdNotExplicitlySettableException fromMessage(@Nullable final String message,
final DittoHeaders dittoHeaders) {
return DittoRuntimeException.fromMessage(message, dittoHeaders, new Builder());
}
/**
* Constructs a new {@code PolicyIdNotExplicitlySettableException} 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 PolicyIdNotExplicitlySettableException.
* @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 PolicyIdNotExplicitlySettableException 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 PolicyIdNotExplicitlySettableException}.
*/
@NotThreadSafe
public static final class Builder extends DittoRuntimeExceptionBuilder<PolicyIdNotExplicitlySettableException> {
private Builder(final String message, final String description) {
message(message);
description(description);
}
private Builder() {
}
@Override
protected PolicyIdNotExplicitlySettableException doBuild(final DittoHeaders dittoHeaders,
@Nullable final String message,
@Nullable final String description,
@Nullable final Throwable cause,
@Nullable final URI href) {
return new PolicyIdNotExplicitlySettableException(dittoHeaders, message, description, cause, href);
}
}
}