-
Notifications
You must be signed in to change notification settings - Fork 215
/
ThingCommand.java
executable file
·129 lines (113 loc) · 4.38 KB
/
ThingCommand.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
/*
* 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;
import javax.annotation.Nullable;
import org.eclipse.ditto.base.model.entity.type.EntityType;
import org.eclipse.ditto.base.model.entity.type.WithEntityType;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.headers.LiveChannelTimeoutStrategy;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.signals.Signal;
import org.eclipse.ditto.base.model.signals.SignalWithEntityId;
import org.eclipse.ditto.base.model.signals.WithType;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.things.model.ThingConstants;
import org.eclipse.ditto.things.model.WithThingId;
/**
* Aggregates all {@link org.eclipse.ditto.base.model.signals.commands.Command}s which are related to a {@link org.eclipse.ditto.things.model.Thing}.
*
* @param <T> the type of the implementing class.
*/
public interface ThingCommand<T extends ThingCommand<T>> extends Command<T>, WithThingId, WithEntityType,
SignalWithEntityId<T> {
/**
* Type Prefix of Thing commands.
*/
String TYPE_PREFIX = "things." + TYPE_QUALIFIER + ":";
/**
* Thing resource type.
*/
String RESOURCE_TYPE = ThingConstants.ENTITY_TYPE.toString();
@Override
default String getTypePrefix() {
return TYPE_PREFIX;
}
@Override
default String getResourceType() {
return RESOURCE_TYPE;
}
/**
* Returns the entity type {@link org.eclipse.ditto.things.model.ThingConstants#ENTITY_TYPE}.
*
* @return the Thing entity type.
* @since 1.1.0
*/
@Override
default EntityType getEntityType() {
return ThingConstants.ENTITY_TYPE;
}
@Override
T setDittoHeaders(DittoHeaders dittoHeaders);
/**
* Indicates whether the specified signal argument is a {@link ThingCommand}.
*
* @param signal the signal to be checked.
* @return {@code true} if {@code signal} is a {@code ThingCommand}, {@code false} else.
* @since 3.0.0
*/
static boolean isThingCommand(@Nullable final WithType signal) {
return WithType.hasTypePrefix(signal, ThingCommand.TYPE_PREFIX);
}
/**
* Indicates whether the specified {@code Signal} argument is a {@code query} command using smart channel
* selection.
*
* @param signal the signal to be checked.
* @return {@code true} if {@code signal} is a {@code query} command handled by smart channel selection.
* @since 3.0.0
*/
static boolean isChannelSmart(@Nullable final Signal<?> signal) {
final boolean result;
if (signal instanceof ThingCommand<?>) {
final ThingCommand<?> thingCommand = (ThingCommand<?>) signal;
if (thingCommand.getCategory() == Category.QUERY) {
final DittoHeaders headers = thingCommand.getDittoHeaders();
if (Signal.isChannelLive(thingCommand)) {
result = LiveChannelTimeoutStrategy.USE_TWIN ==
headers.getLiveChannelTimeoutStrategy().orElse(LiveChannelTimeoutStrategy.FAIL);
} else {
result = headers.getLiveChannelCondition().isPresent();
}
} else {
result = false;
}
} else {
result = false;
}
return result;
}
/**
* This class contains definitions for all specific fields of a {@code ThingCommand}'s JSON representation.
*/
class JsonFields extends Command.JsonFields {
/**
* JSON field containing the ThingCommand's thingId.
*/
public static final JsonFieldDefinition<String> JSON_THING_ID =
JsonFactory.newStringFieldDefinition("thingId", FieldType.REGULAR,
JsonSchemaVersion.V_2);
}
}