-
Notifications
You must be signed in to change notification settings - Fork 215
/
AggregatedDevOpsCommandResponse.java
271 lines (236 loc) · 11.1 KB
/
AggregatedDevOpsCommandResponse.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
260
261
262
263
264
265
266
267
268
269
270
271
/*
* 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.base.api.devops.signals.commands;
import java.util.List;
import java.util.Objects;
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.CommandResponse;
import org.eclipse.ditto.base.model.signals.commands.CommandResponseJsonDeserializer;
import org.eclipse.ditto.base.model.signals.commands.WithEntity;
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.JsonValue;
/**
* A {@link DevOpsCommandResponse} aggregating multiple {@link org.eclipse.ditto.base.model.signals.commands.CommandResponse}s.
*/
@Immutable
@JsonParsableCommandResponse(type = AggregatedDevOpsCommandResponse.TYPE)
public final class AggregatedDevOpsCommandResponse
extends AbstractDevOpsCommandResponse<AggregatedDevOpsCommandResponse>
implements WithEntity<AggregatedDevOpsCommandResponse> {
/**
* Type of this response.
*/
public static final String TYPE = TYPE_PREFIX + "aggregatedResponse";
private static final JsonFieldDefinition<String> JSON_RESPONSES_TYPE =
JsonFieldDefinition.ofString("responsesType", FieldType.REGULAR, JsonSchemaVersion.V_2);
private static final JsonFieldDefinition<JsonObject> JSON_AGGREGATED_RESPONSES =
JsonFieldDefinition.ofJsonObject("responses", FieldType.REGULAR, JsonSchemaVersion.V_2);
private static final CommandResponseJsonDeserializer<AggregatedDevOpsCommandResponse> JSON_DESERIALIZER =
CommandResponseJsonDeserializer.newInstance(TYPE,
context -> {
final var jsonObject = context.getJsonObject();
return new AggregatedDevOpsCommandResponse(
jsonObject.getValueOrThrow(JSON_AGGREGATED_RESPONSES),
jsonObject.getValueOrThrow(JSON_RESPONSES_TYPE),
context.getDeserializedHttpStatus(),
context.getDittoHeaders());
});
private final JsonObject aggregatedResponses;
private final String responsesType;
private AggregatedDevOpsCommandResponse(final JsonObject aggregatedResponses,
final String responsesType,
final HttpStatus httpStatus,
final DittoHeaders dittoHeaders) {
super(TYPE, null, null, httpStatus, dittoHeaders);
this.aggregatedResponses = aggregatedResponses;
this.responsesType = responsesType;
}
/**
* Returns a new instance of {@code AggregatedDevOpsCommandResponse}.
*
* @param commandResponses the aggregated {@link DevOpsCommandResponse}s.
* @param responsesType the responses type of the responses to expect.
* @param httpStatus the HTTP status to send back as response status.
* @param dittoHeaders the headers of the request.
* @param aggregateResults true if a single response is required, false if aggregated multiple response are required
* @return the new RetrieveLoggerConfigResponse response.
* @since 2.0.0
*/
public static AggregatedDevOpsCommandResponse of(final List<CommandResponse<?>> commandResponses,
final String responsesType,
final HttpStatus httpStatus,
final DittoHeaders dittoHeaders,
final boolean aggregateResults) {
final var jsonRepresentation = buildJsonRepresentation(commandResponses, dittoHeaders, aggregateResults);
return new AggregatedDevOpsCommandResponse(jsonRepresentation, responsesType, httpStatus, dittoHeaders);
}
/**
* Returns a new instance of {@code AggregatedDevOpsCommandResponse}.
*
* @param aggregatedResponses the aggregated {@link DevOpsCommandResponse}s as a JsonObject.
* @param responsesType the responses type of the responses to expect.
* @param httpStatus the HTTP status to send back as response status.
* @param dittoHeaders the headers of the request.
* @return the new RetrieveLoggerConfigResponse response.
* @since 2.0.0
*/
public static AggregatedDevOpsCommandResponse of(final JsonObject aggregatedResponses,
final String responsesType,
final HttpStatus httpStatus,
final DittoHeaders dittoHeaders) {
return new AggregatedDevOpsCommandResponse(aggregatedResponses, responsesType, httpStatus, dittoHeaders);
}
/**
* Creates a response to a {@code AggregatedDevOpsCommandResponse} command from a JSON string.
*
* @param jsonString contains the data of the AggregatedDevOpsCommandResponse command.
* @param dittoHeaders the headers of the request.
* @return the AggregatedDevOpsCommandResponse command which is based on the dta of {@code jsonString}.
* @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 AggregatedDevOpsCommandResponse fromJson(final String jsonString, final DittoHeaders dittoHeaders) {
return fromJson(JsonFactory.newObject(jsonString), dittoHeaders);
}
/**
* Creates a response to a {@code AggregatedDevOpsCommandResponse} 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 AggregatedDevOpsCommandResponse fromJson(final JsonObject jsonObject,
final DittoHeaders dittoHeaders) {
return JSON_DESERIALIZER.deserialize(jsonObject, dittoHeaders);
}
@Override
public AggregatedDevOpsCommandResponse setDittoHeaders(final DittoHeaders dittoHeaders) {
return of(aggregatedResponses, responsesType, getHttpStatus(), dittoHeaders);
}
/**
* @return the responses type of the responses to expect.
*/
public String getResponsesType() {
return responsesType;
}
@Override
public AggregatedDevOpsCommandResponse setEntity(final JsonValue entity) {
throw new UnsupportedOperationException("Setting entity on AggregatedDevOpsCommandResponse is not supported");
}
@Override
public JsonValue getEntity(final JsonSchemaVersion schemaVersion) {
return aggregatedResponses;
}
@Override
protected void appendPayload(final JsonObjectBuilder jsonObjectBuilder,
final JsonSchemaVersion schemaVersion,
final Predicate<JsonField> thePredicate) {
super.appendPayload(jsonObjectBuilder, schemaVersion, thePredicate);
final var predicate = schemaVersion.and(thePredicate);
jsonObjectBuilder.set(JSON_RESPONSES_TYPE, responsesType, predicate);
jsonObjectBuilder.set(JSON_AGGREGATED_RESPONSES, aggregatedResponses, predicate);
}
private static JsonObject buildJsonRepresentation(final List<CommandResponse<?>> commandResponses,
final DittoHeaders dittoHeaders,
final boolean aggregateResults) {
final var schemaVersion = dittoHeaders.getSchemaVersion().orElse(JsonSchemaVersion.LATEST);
final var builder = JsonObject.newBuilder();
var i = 0;
for (final var cmdR : commandResponses) {
final var key = String.format("/%s/%s", calculateServiceName(cmdR), calculateInstance(cmdR, i++));
// include both regular and special fields for devops command responses
final JsonObject responseJson;
if (cmdR instanceof ExecutePiggybackCommandResponse response) {
responseJson = response.getResponse().asObject();
} else {
responseJson = cmdR.toJson(schemaVersion, FieldType.regularOrSpecial());
}
if (!aggregateResults && commandResponses.size() == 1) {
return responseJson;
}
builder.set(key, responseJson);
}
if (builder.isEmpty()) {
return JsonFactory.nullObject();
} else {
return builder.build();
}
}
private static String calculateServiceName(final CommandResponse<?> commandResponse) {
final String result;
if (commandResponse instanceof DevOpsCommandResponse) {
result = ((DevOpsCommandResponse<?>) commandResponse).getServiceName().orElse("?");
} else {
result = "?";
}
return result;
}
private static String calculateInstance(final CommandResponse<?> commandResponse, final int i) {
final String result;
final var fallBackValue = "?" + (i == 0 ? "" : String.valueOf(i));
if (commandResponse instanceof DevOpsCommandResponse) {
result = ((DevOpsCommandResponse<?>) commandResponse).getInstance()
.orElse(fallBackValue);
} else {
result = fallBackValue;
}
return result;
}
@SuppressWarnings("squid:MethodCyclomaticComplexity")
@Override
public boolean equals(@Nullable final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
if (!super.equals(o)) {
return false;
}
final var that = (AggregatedDevOpsCommandResponse) o;
return that.canEqual(this) &&
Objects.equals(responsesType, that.responsesType) &&
Objects.equals(aggregatedResponses, that.aggregatedResponses) &&
super.equals(that);
}
@Override
protected boolean canEqual(@Nullable final Object other) {
return other instanceof AggregatedDevOpsCommandResponse;
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), responsesType, aggregatedResponses);
}
@Override
public String toString() {
return getClass().getSimpleName() + " [" + super.toString() + ", responsesType=" + responsesType +
", aggregatedResponses=" + aggregatedResponses + "]";
}
}