/
DeleteThing.java
executable file
·172 lines (149 loc) · 6.32 KB
/
DeleteThing.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
/*
* 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.modify;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
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.JsonParsableCommand;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.signals.commands.AbstractCommand;
import org.eclipse.ditto.base.model.signals.commands.CommandJsonDeserializer;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonField;
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.things.model.ThingId;
import org.eclipse.ditto.things.model.signals.commands.ThingCommand;
/**
* This command deletes a thing. Contains the thingId of the {@link org.eclipse.ditto.things.model.Thing}.
* If the {@link org.eclipse.ditto.things.model.Thing} did not exist in the
* system, a response with status code {@code 404} (Not found) will be generated.
*/
@Immutable
@JsonParsableCommand(typePrefix = ThingCommand.TYPE_PREFIX, name = DeleteThing.NAME)
public final class DeleteThing extends AbstractCommand<DeleteThing> implements ThingModifyCommand<DeleteThing> {
/**
* Name of the "Delete Thing" command.
*/
public static final String NAME = "deleteThing";
/**
* Type of this command.
*/
public static final String TYPE = ThingCommand.TYPE_PREFIX + NAME;
private final ThingId thingId;
private DeleteThing(final ThingId thingId, final DittoHeaders dittoHeaders) {
super(TYPE, dittoHeaders);
this.thingId = checkNotNull(thingId, "Thing ID");
}
/**
* Returns a command for deleting a Thing. Its ID is passed as argument.
*
* @param thingId the ID of a Thing to be deleted by this command.
* @param dittoHeaders the headers of the command.
* @return a command for deleting the Thing.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}
*/
public static DeleteThing of(final ThingId thingId, final DittoHeaders dittoHeaders) {
return new DeleteThing(thingId, dittoHeaders);
}
/**
* Creates a new {@code DeleteThing} 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 any argument 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.
* @throws org.eclipse.ditto.things.model.ThingIdInvalidException if the parsed thing ID did not comply to {@link
* org.eclipse.ditto.base.model.entity.id.RegexPatterns#ID_REGEX}.
*/
public static DeleteThing fromJson(final String jsonString, final DittoHeaders dittoHeaders) {
return fromJson(JsonFactory.newObject(jsonString), dittoHeaders);
}
/**
* Creates a new {@code DeleteThing} 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 any argument is {@code null}.
* @throws org.eclipse.ditto.json.JsonParseException if the passed in {@code jsonObject} was not in the expected
* format.
* @throws org.eclipse.ditto.things.model.ThingIdInvalidException if the parsed thing ID did not comply to {@link
* org.eclipse.ditto.base.model.entity.id.RegexPatterns#ID_REGEX}.
*/
public static DeleteThing fromJson(final JsonObject jsonObject, final DittoHeaders dittoHeaders) {
return new CommandJsonDeserializer<DeleteThing>(TYPE, jsonObject).deserialize(() -> {
final String extractedThingId = jsonObject.getValueOrThrow(ThingCommand.JsonFields.JSON_THING_ID);
final ThingId thingId = ThingId.of(extractedThingId);
return of(thingId, dittoHeaders);
});
}
@Override
public ThingId getEntityId() {
return thingId;
}
@Override
public JsonPointer getResourcePath() {
return JsonPointer.empty();
}
@Override
protected void appendPayload(final JsonObjectBuilder jsonObjectBuilder, final JsonSchemaVersion schemaVersion,
final Predicate<JsonField> thePredicate) {
final Predicate<JsonField> predicate = schemaVersion.and(thePredicate);
jsonObjectBuilder.set(ThingCommand.JsonFields.JSON_THING_ID, thingId.toString(), predicate);
}
@Override
public Category getCategory() {
return Category.DELETE;
}
@Override
public DeleteThing setDittoHeaders(final DittoHeaders dittoHeaders) {
return of(thingId, dittoHeaders);
}
@Override
public DeleteThing setEntity(final JsonValue entity) {
return this;
}
@Override
public boolean changesAuthorization() {
return true;
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), thingId);
}
@SuppressWarnings("squid:MethodCyclomaticComplexity")
@Override
public boolean equals(@Nullable final Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
final DeleteThing that = (DeleteThing) obj;
return that.canEqual(this) && Objects.equals(thingId, that.thingId) && super.equals(that);
}
@Override
public String toString() {
return getClass().getSimpleName() + " [" + super.toString() + ", thingId=" + thingId + "]";
}
}