-
Notifications
You must be signed in to change notification settings - Fork 215
/
RetrieveConnections.java
167 lines (144 loc) · 5.75 KB
/
RetrieveConnections.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
/*
* 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.connectivity.model.signals.commands.query;
import java.util.Objects;
import java.util.function.Predicate;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonParsableCommand;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.signals.commands.AbstractCommand;
import org.eclipse.ditto.connectivity.model.signals.commands.ConnectivityCommand;
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;
/**
* Command that retrieves several {@link org.eclipse.ditto.connectivity.model.Connection}s based on the passed in list
* of Connection IDs.
*
* @since 3.0.0
*/
@Immutable
@JsonParsableCommand(typePrefix = ConnectivityCommand.TYPE_PREFIX, name = RetrieveConnections.NAME)
public final class RetrieveConnections extends AbstractCommand<RetrieveConnections>
implements ConnectivityQueryCommand<RetrieveConnections> {
/**
* Name of the "Retrieve Connections" command.
*/
public static final String NAME = "retrieveConnections";
/**
* Type of this command.
*/
public static final String TYPE = ConnectivityCommand.TYPE_PREFIX + NAME;
static final JsonFieldDefinition<Boolean> JSON_IDS_ONLY =
JsonFactory.newBooleanFieldDefinition("idsOnly", FieldType.REGULAR, JsonSchemaVersion.V_2);
private final boolean idsOnly;
private RetrieveConnections(final boolean idsOnly, final DittoHeaders dittoHeaders) {
super(TYPE, dittoHeaders);
this.idsOnly = idsOnly;
}
/**
* Returns a new instance of the retrieve connections command.
*
* @param dittoHeaders provide additional information regarding connections retrieval like a correlation ID.
* @return the instance.
* @throws NullPointerException if any argument is {@code null}.
*/
public static RetrieveConnections newInstance(final boolean idsOnly, final DittoHeaders dittoHeaders) {
return new RetrieveConnections(idsOnly, dittoHeaders);
}
/**
* Creates a new {@code RetrieveConnections} from a JSON string.
*
* @param jsonString the JSON string of which the command is to be created.
* @param dittoHeaders the headers of the command.
* @return the command.
* @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 RetrieveConnections fromJson(final String jsonString, final DittoHeaders dittoHeaders) {
return fromJson(JsonFactory.newObject(jsonString), dittoHeaders);
}
/**
* Creates a new {@code RetrieveConnections} from a JSON object.
*
* @param jsonObject the JSON object of which the command is to be created.
* @param dittoHeaders the headers of the command.
* @return the command.
* @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 RetrieveConnections fromJson(final JsonObject jsonObject, final DittoHeaders dittoHeaders) {
final boolean idsOnly = jsonObject.getValueOrThrow(JSON_IDS_ONLY);
return new RetrieveConnections(idsOnly, dittoHeaders);
}
/**
* Specifies if only connections ids are to be retrieved.
*
* @return if only connections ids are to be retrieved.
*/
public boolean getIdsOnly() {
return idsOnly;
}
@Override
public Category getCategory() {
return Category.QUERY;
}
@Override
public RetrieveConnections setDittoHeaders(final DittoHeaders dittoHeaders) {
return new RetrieveConnections(idsOnly, dittoHeaders);
}
@Override
public JsonPointer getResourcePath() {
return JsonPointer.of("/connections");
}
@Override
protected void appendPayload(final JsonObjectBuilder jsonObjectBuilder, final JsonSchemaVersion jsonSchemaVersion,
final Predicate<JsonField> thePredicate) {
final Predicate<JsonField> predicate = jsonSchemaVersion.and(thePredicate);
jsonObjectBuilder.set(JSON_IDS_ONLY, idsOnly, predicate);
}
@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 RetrieveConnections that = (RetrieveConnections) o;
return Objects.equals(idsOnly, that.idsOnly);
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), idsOnly);
}
@Override
public String toString() {
return getClass().getSimpleName() + " [" +
super.toString() +
", idsOnly=" + idsOnly +
"]";
}
}