-
Notifications
You must be signed in to change notification settings - Fork 215
/
ModifyPolicyImportsResponse.java
259 lines (225 loc) · 10.6 KB
/
ModifyPolicyImportsResponse.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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/*
* Copyright (c) 2022 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.modify;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import java.util.Collections;
import java.util.HashSet;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.Predicate;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.model.common.HttpStatus;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonParsableCommandResponse;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse;
import org.eclipse.ditto.base.model.signals.commands.CommandResponseHttpStatusValidator;
import org.eclipse.ditto.base.model.signals.commands.CommandResponseJsonDeserializer;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonField;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonObjectBuilder;
import org.eclipse.ditto.json.JsonPointer;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.policies.model.PoliciesModelFactory;
import org.eclipse.ditto.policies.model.PolicyId;
import org.eclipse.ditto.policies.model.PolicyImports;
import org.eclipse.ditto.policies.model.signals.commands.PolicyCommandResponse;
/**
* Response to a {@link ModifyPolicyImports} command.
*
* @since 3.x.0 TODO ditto#298
*/
@Immutable
@JsonParsableCommandResponse(type = ModifyPolicyImportsResponse.TYPE)
public final class ModifyPolicyImportsResponse extends AbstractCommandResponse<ModifyPolicyImportsResponse> implements
PolicyModifyCommandResponse<ModifyPolicyImportsResponse> {
/**
* Type of this response.
*/
public static final String TYPE = TYPE_PREFIX + ModifyPolicyImports.NAME;
static final JsonFieldDefinition<JsonObject> JSON_POLICY_IMPORTS =
JsonFactory.newJsonObjectFieldDefinition("policyImports", FieldType.REGULAR, JsonSchemaVersion.V_2);
private static final Set<HttpStatus> HTTP_STATUSES;
static {
final Set<HttpStatus> httpStatuses = new HashSet<>();
Collections.addAll(httpStatuses, HttpStatus.CREATED, HttpStatus.NO_CONTENT);
HTTP_STATUSES = Collections.unmodifiableSet(httpStatuses);
}
private static final CommandResponseJsonDeserializer<ModifyPolicyImportsResponse> JSON_DESERIALIZER =
CommandResponseJsonDeserializer.newInstance(TYPE,
context -> {
final JsonObject jsonObject = context.getJsonObject();
final PolicyImports extractedPolicyImportsCreated = jsonObject.getValue(JSON_POLICY_IMPORTS)
.filter(JsonValue::isObject)
.map(JsonValue::asObject)
.map(PoliciesModelFactory::newPolicyImports)
.orElse(null);
return newInstance(
PolicyId.of(jsonObject.getValueOrThrow(PolicyCommandResponse.JsonFields.JSON_POLICY_ID)),
extractedPolicyImportsCreated,
context.getDeserializedHttpStatus(),
context.getDittoHeaders()
);
});
private final PolicyId policyId;
@Nullable private final PolicyImports policyImportsCreated;
private ModifyPolicyImportsResponse(final PolicyId policyId, @Nullable final PolicyImports policyImportsCreated,
final HttpStatus statusCode, final DittoHeaders dittoHeaders) {
super(TYPE, statusCode, dittoHeaders);
this.policyId = checkNotNull(policyId, "policyId");
this.policyImportsCreated = policyImportsCreated;
}
/**
* Creates a response to a {@code ModifyPolicyImport} command.
*
* @param policyId the Policy ID of the created policy imports.
* @param policyImportsCreated (optional) the PolicyImports created.
* @param dittoHeaders the headers of the preceding command.
* @return the response.
* @throws NullPointerException if {@code statusCode} or {@code dittoHeaders} is {@code null}.
*/
public static ModifyPolicyImportsResponse created(final PolicyId policyId, final PolicyImports policyImportsCreated,
final DittoHeaders dittoHeaders) {
return new ModifyPolicyImportsResponse(policyId, policyImportsCreated, HttpStatus.CREATED, dittoHeaders);
}
/**
* Creates a response to a {@code ModifyPolicyImports} command.
*
* @param policyId the Policy ID of the modified policy imports.
* @param dittoHeaders the headers of the preceding command.
* @return the response.
* @throws NullPointerException if any argument is {@code null}.
*/
public static ModifyPolicyImportsResponse modified(final PolicyId policyId, final DittoHeaders dittoHeaders) {
return new ModifyPolicyImportsResponse(policyId, null, HttpStatus.NO_CONTENT, dittoHeaders);
}
/**
* Returns a new instance of {@code ModifyPolicyImportsResponse} for the specified arguments.
*
* @param policyId the Policy ID of the modified resource.
* @param policyImportsCreated the created PolicyImports.
* @param httpStatus the status of the response.
* @param dittoHeaders the headers of the response.
* @return the {@code ModifyPolicyImportsResponse} instance.
* @throws NullPointerException if any argument is {@code null} except {@code resource}.
* @throws IllegalArgumentException if {@code httpStatus} is not allowed for a {@code ModifyPolicyImportsResponse}.
*/
public static ModifyPolicyImportsResponse newInstance(final PolicyId policyId,
@Nullable final PolicyImports policyImportsCreated,
final HttpStatus httpStatus,
final DittoHeaders dittoHeaders) {
return new ModifyPolicyImportsResponse(policyId,
policyImportsCreated,
CommandResponseHttpStatusValidator.validateHttpStatus(httpStatus,
HTTP_STATUSES,
ModifyPolicyImportsResponse.class),
dittoHeaders);
}
/**
* Creates a response to a {@code ModifyPolicyImports} command from a JSON string.
*
* @param jsonString the JSON string of which the response is to be created.
* @param dittoHeaders the headers of the preceding command.
* @return the response.
* @throws NullPointerException if {@code jsonString} is {@code null}.
* @throws IllegalArgumentException if {@code jsonString} is empty.
* @throws org.eclipse.ditto.json.JsonParseException if the passed in {@code jsonString} was not in the expected
* format.
*/
public static ModifyPolicyImportsResponse fromJson(final String jsonString, final DittoHeaders dittoHeaders) {
return fromJson(JsonFactory.newObject(jsonString), dittoHeaders);
}
/**
* Creates a response to a {@code ModifyPolicyImports} command from a JSON object.
*
* @param jsonObject the JSON object of which the response is to be created.
* @param dittoHeaders the headers of the preceding command.
* @return the response.
* @throws NullPointerException if {@code jsonObject} is {@code null}.
* @throws org.eclipse.ditto.json.JsonParseException if the passed in {@code jsonObject} was not in the expected
* format.
*/
public static ModifyPolicyImportsResponse fromJson(final JsonObject jsonObject,
final DittoHeaders dittoHeaders) {
return JSON_DESERIALIZER.deserialize(jsonObject, dittoHeaders);
}
/**
* Returns the created PolicyImport.
*
* @return the created PolicyImport.
*/
public Optional<PolicyImports> getPolicyImportsCreated() {
return Optional.ofNullable(policyImportsCreated);
}
@Override
public Optional<JsonValue> getEntity(final JsonSchemaVersion schemaVersion) {
return Optional.ofNullable(policyImportsCreated).map(obj -> obj.toJson(schemaVersion, FieldType.notHidden()));
}
@Override
public JsonPointer getResourcePath() {
return JsonPointer.of("/imports");
}
@Override
protected void appendPayload(final JsonObjectBuilder jsonObjectBuilder, final JsonSchemaVersion schemaVersion,
final Predicate<JsonField> thePredicate) {
final Predicate<JsonField> predicate = schemaVersion.and(thePredicate);
jsonObjectBuilder.set(PolicyCommandResponse.JsonFields.JSON_POLICY_ID, policyId.toString(), predicate);
if (null != policyImportsCreated) {
jsonObjectBuilder.set(JSON_POLICY_IMPORTS, policyImportsCreated.toJson(schemaVersion, thePredicate),
predicate);
}
}
@Override
public ModifyPolicyImportsResponse setDittoHeaders(final DittoHeaders dittoHeaders) {
return (policyImportsCreated != null) ? created(policyId, policyImportsCreated, dittoHeaders) :
modified(policyId, dittoHeaders);
}
@Override
public PolicyId getEntityId() {
return policyId;
}
@Override
public boolean equals(@Nullable final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
final ModifyPolicyImportsResponse that = (ModifyPolicyImportsResponse) o;
return that.canEqual(this) &&
Objects.equals(policyId, that.policyId) &&
Objects.equals(policyImportsCreated, that.policyImportsCreated) &&
super.equals(o);
}
@Override
protected boolean canEqual(@Nullable final Object other) {
return other instanceof ModifyPolicyImportsResponse;
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), policyId, policyImportsCreated);
}
@Override
public String toString() {
return getClass().getSimpleName() + " [" + super.toString() +
", policyId=" + policyId +
", policyImportsCreated=" + policyImportsCreated +
"]";
}
}