Skip to content

Commit a41c6d4

Browse files
pgfellerpgfeller
authored
[huesync] Fix lost api-token when device goes offline (openhab#18100)
* fix(18062): [huesync] Configuration (API Token) lost if device goes offline Signed-off-by: Patrik Gfeller <[email protected]>
1 parent 51df8f3 commit a41c6d4

File tree

12 files changed

+329
-222
lines changed

12 files changed

+329
-222
lines changed

‎bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/HueSyncConstants.java

+11-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@
2323
*/
2424
@NonNullByDefault
2525
public class HueSyncConstants {
26+
public static class EXCEPTION_TYPES {
27+
public static class CONNECTION {
28+
public static final String UNAUTHORIZED_401 = "invalidLogin";
29+
public static final String NOT_FOUND_404 = "notFound";
30+
public static final String INTERNAL_SERVER_ERROR_500 = "deviceError";
31+
}
32+
}
33+
2634
public static class ENDPOINTS {
2735
public static final String DEVICE = "device";
2836
public static final String REGISTRATIONS = "registrations";
@@ -81,9 +89,11 @@ public static class HDMI {
8189
public static final String PARAMETER_HOST = "host";
8290
public static final String PARAMETER_PORT = "port";
8391

84-
public static final Integer REGISTRATION_INITIAL_DELAY = 3;
92+
public static final Integer REGISTRATION_INITIAL_DELAY = 5;
8593
public static final Integer REGISTRATION_INTERVAL = 1;
8694

95+
public static final Integer POLL_INITIAL_DELAY = 10;
96+
8797
public static final String REGISTRATION_ID = "registrationId";
8898
public static final String API_TOKEN = "apiAccessToken";
8999
}

‎bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/connection/HueSyncConnection.java

+77-95
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import java.security.cert.CertificateException;
1919
import java.util.Optional;
2020
import java.util.concurrent.ExecutionException;
21+
import java.util.concurrent.TimeUnit;
2122
import java.util.concurrent.TimeoutException;
2223

2324
import org.eclipse.jdt.annotation.NonNullByDefault;
@@ -26,8 +27,6 @@
2627
import org.eclipse.jetty.client.HttpResponseException;
2728
import org.eclipse.jetty.client.api.AuthenticationStore;
2829
import org.eclipse.jetty.client.api.ContentResponse;
29-
import org.eclipse.jetty.client.api.Request;
30-
import org.eclipse.jetty.client.api.Response;
3130
import org.eclipse.jetty.client.util.StringContentProvider;
3231
import org.eclipse.jetty.http.HttpHeader;
3332
import org.eclipse.jetty.http.HttpMethod;
@@ -55,8 +54,10 @@ public class HueSyncConnection {
5554
public static final ObjectMapper OBJECT_MAPPER = new ObjectMapper()
5655
.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
5756
/**
58-
* Request format: The Sync Box API can be accessed locally via HTTPS on root level (port 443,
59-
* /api/v1), resource level /api/v1/<resource> and in some cases sub-resource level
57+
* Request format: The Sync Box API can be accessed locally via HTTPS on root
58+
* level (port 443,
59+
* /api/v1), resource level /api/v1/<resource> and in some cases sub-resource
60+
* level
6061
* /api/v1/<resource>/<sub-resource>.
6162
*/
6263
private static final String REQUEST_FORMAT = "https://%s:%s/%s/%s";
@@ -72,6 +73,41 @@ public class HueSyncConnection {
7273

7374
private Optional<HueSyncAuthenticationResult> authentication = Optional.empty();
7475

76+
private class Request {
77+
78+
private final String endpoint;
79+
80+
private HttpMethod method = HttpMethod.GET;
81+
private String payload = "";
82+
83+
private Request(HttpMethod httpMethod, String endpoint, String payload) {
84+
this.method = httpMethod;
85+
this.endpoint = endpoint;
86+
this.payload = payload;
87+
}
88+
89+
protected Request(String endpoint) {
90+
this.endpoint = endpoint;
91+
}
92+
93+
private Request(HttpMethod httpMethod, String endpoint) {
94+
this.method = httpMethod;
95+
this.endpoint = endpoint;
96+
}
97+
98+
protected ContentResponse execute() throws InterruptedException, ExecutionException, TimeoutException {
99+
String uri = String.format(REQUEST_FORMAT, host, port, API, endpoint);
100+
101+
var request = httpClient.newRequest(uri).method(method).timeout(1, TimeUnit.SECONDS);
102+
if (!payload.isBlank()) {
103+
request.header(HttpHeader.CONTENT_TYPE, MimeTypes.Type.APPLICATION_JSON_UTF_8.toString())
104+
.content(new StringContentProvider(payload));
105+
}
106+
107+
return request.send();
108+
}
109+
}
110+
75111
protected String registrationId = "";
76112

77113
public HueSyncConnection(HttpClient httpClient, String host, Integer port)
@@ -102,46 +138,30 @@ public void updateAuthentication(String id, String token) {
102138

103139
// #region protected
104140
protected @Nullable <T> T executeRequest(HttpMethod method, String endpoint, String payload,
105-
@Nullable Class<T> type) {
106-
try {
107-
return this.processedResponse(this.executeRequest(method, endpoint, payload), type);
108-
} catch (ExecutionException e) {
109-
this.handleExecutionException(e);
110-
} catch (InterruptedException | TimeoutException e) {
111-
this.logger.warn("{}", e.getMessage());
112-
}
141+
@Nullable Class<T> type) throws HueSyncConnectionException {
113142

114-
return null;
143+
return this.executeRequest(new Request(method, endpoint, payload), type);
115144
}
116145

117-
protected @Nullable <T> T executeGetRequest(String endpoint, Class<T> type) {
118-
try {
119-
return this.processedResponse(this.executeGetRequest(endpoint), type);
120-
} catch (ExecutionException e) {
121-
this.handleExecutionException(e);
122-
} catch (InterruptedException | TimeoutException e) {
123-
this.logger.warn("{}", e.getMessage());
124-
}
146+
protected @Nullable <T> T executeRequest(HttpMethod httpMethod, String endpoint, @Nullable Class<T> type)
147+
throws HueSyncConnectionException {
148+
return this.executeRequest(new Request(httpMethod, endpoint), type);
149+
}
125150

126-
return null;
151+
protected @Nullable <T> T executeGetRequest(String endpoint, Class<T> type) throws HueSyncConnectionException {
152+
return this.executeRequest(new Request(endpoint), type);
127153
}
128154

129155
protected boolean isRegistered() {
130156
return this.authentication.isPresent();
131157
}
132158

133-
protected void unregisterDevice() {
159+
protected void unregisterDevice() throws HueSyncConnectionException {
134160
if (this.isRegistered()) {
135-
try {
136-
String endpoint = ENDPOINTS.REGISTRATIONS + "/" + this.registrationId;
137-
ContentResponse response = this.executeRequest(HttpMethod.DELETE, endpoint);
161+
String endpoint = ENDPOINTS.REGISTRATIONS + "/" + this.registrationId;
138162

139-
if (response.getStatus() == HttpStatus.OK_200) {
140-
this.removeAuthentication();
141-
}
142-
} catch (InterruptedException | TimeoutException | ExecutionException e) {
143-
this.logger.warn("{}", e.getMessage());
144-
}
163+
this.executeRequest(HttpMethod.DELETE, endpoint, null);
164+
this.removeAuthentication();
145165
}
146166
}
147167

@@ -151,93 +171,55 @@ protected void dispose() {
151171
// #endregion
152172

153173
// #region private
154-
private @Nullable <T> T processedResponse(Response response, @Nullable Class<T> type) {
155-
int status = response.getStatus();
174+
175+
private @Nullable <T> T executeRequest(Request request, @Nullable Class<T> type) throws HueSyncConnectionException {
176+
String message = "@text/connection.generic-error";
177+
156178
try {
179+
ContentResponse response = request.execute();
180+
157181
/*
158182
* 400 Invalid State: Registration in progress
159183
*
160-
* 401 Authentication failed: If credentials are missing or invalid, errors out. If
161-
* credentials are missing, continues on to GET only the Configuration state when
184+
* 401 Authentication failed: If credentials are missing or invalid, errors out.
185+
* If
186+
* credentials are missing, continues on to GET only the Configuration state
187+
* when
162188
* unauthenticated, to allow for device identification.
163189
*
164190
* 404 Invalid URI Path: Accessing URI path which is not supported
165191
*
166192
* 500 Internal: Internal errors like out of memory
167193
*/
168-
switch (status) {
194+
switch (response.getStatus()) {
169195
case HttpStatus.OK_200 -> {
170-
return (type != null && (response instanceof ContentResponse))
171-
? this.deserialize(((ContentResponse) response).getContentAsString(), type)
172-
: null;
196+
return this.deserialize(response.getContentAsString(), type);
173197
}
174-
case HttpStatus.BAD_REQUEST_400 -> this.logger.debug("registration in progress: no token received yet");
175-
case HttpStatus.UNAUTHORIZED_401 -> {
176-
this.authentication = Optional.empty();
177-
throw new HueSyncConnectionException("@text/connection.invalid-login");
198+
case HttpStatus.BAD_REQUEST_400 -> {
199+
logger.debug("registration in progress: no token received yet");
200+
return null;
178201
}
179-
case HttpStatus.NOT_FOUND_404 -> this.logger.warn("invalid device URI or API endpoint");
180-
case HttpStatus.INTERNAL_SERVER_ERROR_500 -> this.logger.warn("hue sync box server problem");
181-
default -> this.logger.warn("unexpected HTTP status: {}", status);
202+
case HttpStatus.UNAUTHORIZED_401 -> message = "@text/connection.invalid-login";
203+
case HttpStatus.NOT_FOUND_404 -> message = "@text/connection.generic-error";
182204
}
183-
} catch (HueSyncConnectionException e) {
184-
this.logger.warn("{}", e.getMessage());
185-
}
186-
return null;
187-
}
205+
throw new HueSyncConnectionException(message, new HttpResponseException(message, response));
206+
} catch (JsonProcessingException | InterruptedException | ExecutionException | TimeoutException e) {
188207

189-
private @Nullable <T> T deserialize(String json, Class<T> type) {
190-
try {
191-
return OBJECT_MAPPER.readValue(json, type);
192-
} catch (JsonProcessingException | NoClassDefFoundError e) {
193-
this.logger.error("{}", e.getMessage());
208+
var logMessage = message + " {}";
209+
this.logger.warn(logMessage, e.toString());
194210

195-
return null;
211+
throw new HueSyncConnectionException(message, e);
196212
}
197213
}
198214

199-
private ContentResponse executeRequest(HttpMethod method, String endpoint)
200-
throws InterruptedException, TimeoutException, ExecutionException {
201-
return this.executeRequest(method, endpoint, "");
202-
}
203-
204-
private ContentResponse executeGetRequest(String endpoint)
205-
throws InterruptedException, ExecutionException, TimeoutException {
206-
String uri = String.format(REQUEST_FORMAT, this.host, this.port, API, endpoint);
207-
208-
return httpClient.GET(uri);
209-
}
210-
211-
private ContentResponse executeRequest(HttpMethod method, String endpoint, String payload)
212-
throws InterruptedException, TimeoutException, ExecutionException {
213-
String uri = String.format(REQUEST_FORMAT, this.host, this.port, API, endpoint);
214-
215-
Request request = this.httpClient.newRequest(uri).method(method);
216-
217-
this.logger.trace("uri: {}", uri);
218-
this.logger.trace("method: {}", method);
219-
this.logger.trace("payload: {}", payload);
220-
221-
if (!payload.isBlank()) {
222-
request.header(HttpHeader.CONTENT_TYPE, MimeTypes.Type.APPLICATION_JSON_UTF_8.toString())
223-
.content(new StringContentProvider(payload));
224-
}
225-
226-
return request.send();
227-
}
228-
229-
private void handleExecutionException(ExecutionException e) {
230-
this.logger.warn("{}", e.getMessage());
231-
232-
Throwable cause = e.getCause();
233-
if (cause != null && cause instanceof HttpResponseException) {
234-
processedResponse(((HttpResponseException) cause).getResponse(), null);
235-
}
215+
private @Nullable <T> T deserialize(String json, @Nullable Class<T> type) throws JsonProcessingException {
216+
return type == null ? null : OBJECT_MAPPER.readValue(json, type);
236217
}
237218

238219
private void removeAuthentication() {
239220
AuthenticationStore store = this.httpClient.getAuthenticationStore();
240221
store.clearAuthenticationResults();
222+
241223
this.httpClient.setAuthenticationStore(store);
242224

243225
this.registrationId = "";

‎bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/connection/HueSyncDeviceConnection.java

+21-9
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
import org.openhab.binding.huesync.internal.api.dto.registration.HueSyncRegistrationRequest;
3535
import org.openhab.binding.huesync.internal.config.HueSyncConfiguration;
3636
import org.openhab.binding.huesync.internal.exceptions.HueSyncConnectionException;
37+
import org.openhab.binding.huesync.internal.types.HueSyncExceptionHandler;
3738
import org.openhab.core.library.types.OnOffType;
3839
import org.openhab.core.library.types.QuantityType;
3940
import org.openhab.core.library.types.StringType;
@@ -55,11 +56,14 @@ public class HueSyncDeviceConnection {
5556
private final Logger logger = LoggerFactory.getLogger(HueSyncDeviceConnection.class);
5657

5758
private final HueSyncConnection connection;
59+
private final HueSyncExceptionHandler exceptionHandler;
5860

5961
private final Map<String, Consumer<Command>> deviceCommandExecutors = new HashMap<>();
6062

61-
public HueSyncDeviceConnection(HttpClient httpClient, HueSyncConfiguration configuration)
62-
throws CertificateException, IOException, URISyntaxException {
63+
public HueSyncDeviceConnection(HttpClient httpClient, HueSyncConfiguration configuration,
64+
HueSyncExceptionHandler exceptionHandler) throws CertificateException, IOException, URISyntaxException {
65+
66+
this.exceptionHandler = exceptionHandler;
6367
this.connection = new HueSyncConnection(httpClient, configuration.host, configuration.port);
6468

6569
registerCommandHandlers();
@@ -109,7 +113,11 @@ private void execute(String key, Command command) {
109113

110114
String json = String.format("{ \"%s\": %s }", key, value);
111115

112-
this.connection.executeRequest(HttpMethod.PUT, ENDPOINTS.EXECUTION, json, null);
116+
try {
117+
this.connection.executeRequest(HttpMethod.PUT, ENDPOINTS.EXECUTION, json, null);
118+
} catch (HueSyncConnectionException exception) {
119+
exceptionHandler.handle(exception);
120+
}
113121
}
114122

115123
// #endregion
@@ -131,29 +139,29 @@ public void executeCommand(Channel channel, Command command) {
131139
}
132140
}
133141

134-
public @Nullable HueSyncDevice getDeviceInfo() {
142+
public @Nullable HueSyncDevice getDeviceInfo() throws Exception {
135143
return this.connection.executeGetRequest(ENDPOINTS.DEVICE, HueSyncDevice.class);
136144
}
137145

138-
public @Nullable HueSyncDeviceDetailed getDetailedDeviceInfo() {
146+
public @Nullable HueSyncDeviceDetailed getDetailedDeviceInfo() throws Exception {
139147
return this.connection.isRegistered()
140148
? this.connection.executeRequest(HttpMethod.GET, ENDPOINTS.DEVICE, "", HueSyncDeviceDetailed.class)
141149
: null;
142150
}
143151

144-
public @Nullable HueSyncHdmi getHdmiInfo() {
152+
public @Nullable HueSyncHdmi getHdmiInfo() throws Exception {
145153
return this.connection.isRegistered()
146154
? this.connection.executeRequest(HttpMethod.GET, ENDPOINTS.HDMI, "", HueSyncHdmi.class)
147155
: null;
148156
}
149157

150-
public @Nullable HueSyncExecution getExecutionInfo() {
158+
public @Nullable HueSyncExecution getExecutionInfo() throws Exception {
151159
return this.connection.isRegistered()
152160
? this.connection.executeRequest(HttpMethod.GET, ENDPOINTS.EXECUTION, "", HueSyncExecution.class)
153161
: null;
154162
}
155163

156-
public @Nullable HueSyncRegistration registerDevice(String id) throws HueSyncConnectionException {
164+
public @Nullable HueSyncRegistration registerDevice(String id) throws Exception {
157165
if (!id.isBlank()) {
158166
try {
159167
HueSyncRegistrationRequest dto = new HueSyncRegistrationRequest();
@@ -181,7 +189,11 @@ public boolean isRegistered() {
181189
}
182190

183191
public void unregisterDevice() {
184-
this.connection.unregisterDevice();
192+
try {
193+
this.connection.unregisterDevice();
194+
} catch (HueSyncConnectionException e) {
195+
this.logger.warn("{}", e.getMessage());
196+
}
185197
}
186198

187199
public void dispose() {

‎bundles/org.openhab.binding.huesync/src/main/java/org/openhab/binding/huesync/internal/exceptions/HueSyncConnectionException.java

+11
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
package org.openhab.binding.huesync.internal.exceptions;
1414

1515
import org.eclipse.jdt.annotation.NonNullByDefault;
16+
import org.eclipse.jdt.annotation.Nullable;
1617

1718
/**
1819
*
@@ -21,8 +22,18 @@
2122
@NonNullByDefault
2223
public class HueSyncConnectionException extends HueSyncException {
2324
private static final long serialVersionUID = 0L;
25+
private @Nullable Exception innerException = null;
26+
27+
public HueSyncConnectionException(String message, Exception exception) {
28+
super(message);
29+
this.innerException = exception;
30+
}
2431

2532
public HueSyncConnectionException(String message) {
2633
super(message);
2734
}
35+
36+
public @Nullable Exception getInnerException() {
37+
return this.innerException;
38+
}
2839
}

0 commit comments

Comments
 (0)