2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.io.neeo.internal.servletservices;
15 import java.beans.PropertyChangeEvent;
16 import java.beans.PropertyChangeListener;
17 import java.io.IOException;
18 import java.util.Map.Entry;
19 import java.util.Objects;
20 import java.util.concurrent.ScheduledExecutorService;
22 import javax.servlet.http.HttpServletRequest;
23 import javax.servlet.http.HttpServletResponse;
24 import javax.ws.rs.client.ClientBuilder;
26 import org.eclipse.jdt.annotation.NonNull;
27 import org.eclipse.jdt.annotation.NonNullByDefault;
28 import org.eclipse.jdt.annotation.Nullable;
29 import org.openhab.core.common.ThreadPoolManager;
30 import org.openhab.core.events.Event;
31 import org.openhab.core.events.EventFilter;
32 import org.openhab.core.items.Item;
33 import org.openhab.core.items.ItemNotFoundException;
34 import org.openhab.core.items.events.ItemCommandEvent;
35 import org.openhab.core.items.events.ItemEventFactory;
36 import org.openhab.core.items.events.ItemStateChangedEvent;
37 import org.openhab.core.library.types.OnOffType;
38 import org.openhab.core.thing.ChannelUID;
39 import org.openhab.core.thing.ThingUID;
40 import org.openhab.core.thing.events.ChannelTriggeredEvent;
41 import org.openhab.core.thing.events.ThingEventFactory;
42 import org.openhab.core.types.Command;
43 import org.openhab.core.types.State;
44 import org.openhab.io.neeo.internal.NeeoApi;
45 import org.openhab.io.neeo.internal.NeeoConstants;
46 import org.openhab.io.neeo.internal.NeeoDeviceKeys;
47 import org.openhab.io.neeo.internal.NeeoItemValueConverter;
48 import org.openhab.io.neeo.internal.NeeoUtil;
49 import org.openhab.io.neeo.internal.ServiceContext;
50 import org.openhab.io.neeo.internal.models.ButtonInfo;
51 import org.openhab.io.neeo.internal.models.NeeoButtonGroup;
52 import org.openhab.io.neeo.internal.models.NeeoCapabilityType;
53 import org.openhab.io.neeo.internal.models.NeeoDevice;
54 import org.openhab.io.neeo.internal.models.NeeoDeviceChannel;
55 import org.openhab.io.neeo.internal.models.NeeoDeviceChannelDirectory;
56 import org.openhab.io.neeo.internal.models.NeeoDeviceChannelKind;
57 import org.openhab.io.neeo.internal.models.NeeoDirectoryRequest;
58 import org.openhab.io.neeo.internal.models.NeeoDirectoryRequestAction;
59 import org.openhab.io.neeo.internal.models.NeeoDirectoryResult;
60 import org.openhab.io.neeo.internal.models.NeeoItemValue;
61 import org.openhab.io.neeo.internal.models.NeeoNotification;
62 import org.openhab.io.neeo.internal.models.NeeoSensorNotification;
63 import org.openhab.io.neeo.internal.models.NeeoThingUID;
64 import org.openhab.io.neeo.internal.net.HttpRequest;
65 import org.openhab.io.neeo.internal.servletservices.models.PathInfo;
66 import org.openhab.io.neeo.internal.servletservices.models.ReturnStatus;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
70 import com.google.gson.Gson;
73 * The implementation of {@link ServletService} that will handle device callbacks from the Neeo Brain
75 * @author Tim Roberts - Initial Contribution
78 public class NeeoBrainService extends DefaultServletService {
81 private final Logger logger = LoggerFactory.getLogger(NeeoBrainService.class);
83 /** The gson used for communications */
84 private final Gson gson = NeeoUtil.createGson();
86 /** The NEEO API to use */
87 private final NeeoApi api;
89 /** The service context */
90 private final ServiceContext context;
92 /** The HTTP request */
93 private final HttpRequest request;
95 /** The scheduler to use to schedule recipe execution */
96 private final ScheduledExecutorService scheduler = ThreadPoolManager
97 .getScheduledPool(NeeoConstants.THREAD_POOL_NAME);
99 /** The {@link NeeoItemValueConverter} used to convert values with */
100 private final NeeoItemValueConverter itemConverter;
102 private final PropertyChangeListener listener = new PropertyChangeListener() {
104 public void propertyChange(@Nullable PropertyChangeEvent evt) {
105 if (evt != null && (Boolean) evt.getNewValue()) {
112 * Constructs the service from the {@link NeeoApi} and {@link ServiceContext}
114 * @param api the non-null api
115 * @param context the non-null context
117 public NeeoBrainService(NeeoApi api, ServiceContext context, ClientBuilder clientBuilder) {
118 Objects.requireNonNull(api, "api cannot be null");
119 Objects.requireNonNull(context, "context cannot be null");
121 this.context = context;
122 this.itemConverter = new NeeoItemValueConverter(context);
124 this.api.addPropertyChangeListener(NeeoApi.CONNECTED, listener);
125 scheduler.execute(() -> {
128 request = new HttpRequest(clientBuilder);
132 * Returns true if the path start with 'device' or ends with either 'subscribe' or 'unsubscribe'
134 * @see DefaultServletService#canHandleRoute(String[])
137 public boolean canHandleRoute(String[] paths) {
138 Objects.requireNonNull(paths, "paths cannot be null");
140 if (paths.length == 0) {
144 if (paths[0].equalsIgnoreCase("device")) {
148 final String lastPath = paths.length >= 2 ? paths[1] : null;
149 return "subscribe".equalsIgnoreCase(lastPath) || "unsubscribe".equalsIgnoreCase(lastPath);
153 public void handlePost(HttpServletRequest req, String[] paths, HttpServletResponse resp) throws IOException {
154 Objects.requireNonNull(req, "req cannot be null");
155 Objects.requireNonNull(paths, "paths cannot be null");
156 Objects.requireNonNull(resp, "resp cannot be null");
157 if (paths.length == 0) {
158 throw new IllegalArgumentException("paths cannot be empty");
161 final boolean hasDeviceStart = paths[0].equalsIgnoreCase("device");
163 if (hasDeviceStart) {
164 final PathInfo pathInfo = new PathInfo(paths);
166 if ("directory".equalsIgnoreCase(pathInfo.getComponentType())) {
167 handleDirectory(req, resp, pathInfo);
169 logger.debug("Unknown/unhandled brain service device route (POST): {}", String.join("/", paths));
173 logger.debug("Unknown/unhandled brain service route (POST): {}", String.join("/", paths));
178 public void handleGet(HttpServletRequest req, String[] paths, HttpServletResponse resp) throws IOException {
179 Objects.requireNonNull(req, "req cannot be null");
180 Objects.requireNonNull(paths, "paths cannot be null");
181 Objects.requireNonNull(resp, "resp cannot be null");
182 if (paths.length == 0) {
183 throw new IllegalArgumentException("paths cannot be empty");
186 // Paths handled specially
187 // 1. See PATHINFO for various /device/* keys (except for the next)
188 // 2. New subscribe path: /device/{thingUID}/subscribe/default/{devicekey}
189 // 3. New unsubscribe path: /device/{thingUID}/unsubscribe/default
190 // 4. Old subscribe path: /{thingUID}/subscribe or unsubscribe/{deviceid}/{devicekey}
191 // 4. Old unsubscribe path: /{thingUID}/subscribe or unsubscribe/{deviceid}
193 final boolean hasDeviceStart = paths[0].equalsIgnoreCase("device");
194 if (hasDeviceStart && (paths.length >= 3 && !paths[2].equalsIgnoreCase("subscribe")
195 && !paths[2].equalsIgnoreCase("unsubscribe"))) {
197 final PathInfo pathInfo = new PathInfo(paths);
199 String actionValue = pathInfo.getActionValue();
200 if (actionValue == null || actionValue.isEmpty()) {
201 handleGetValue(resp, pathInfo);
203 handleSetValue(resp, pathInfo);
205 } catch (IllegalArgumentException e) {
206 logger.debug("Bad path: {} - {}", String.join("", paths), e.getMessage(), e);
209 int idx = hasDeviceStart ? 1 : 0;
211 if (idx + 2 < paths.length) {
212 final String adapterName = paths[idx++];
213 final String action = paths[idx++].toLowerCase();
214 idx++; // deviceId/default - not used
218 if (idx < paths.length) {
219 final String deviceKey = paths[idx++];
220 handleSubscribe(resp, adapterName, deviceKey);
222 logger.debug("No device key set for a subscribe action: {}", String.join("/", paths));
226 handleUnsubscribe(resp, adapterName);
229 logger.debug("Unknown action: {}", action);
233 logger.debug("Unknown/unhandled brain service route (GET): {}", String.join("/", paths));
239 * Handle set value from the path
241 * @param resp the non-null response to write the response to
242 * @param pathInfo the non-null path information
244 private void handleSetValue(HttpServletResponse resp, PathInfo pathInfo) {
245 Objects.requireNonNull(resp, "resp cannot be null");
246 Objects.requireNonNull(pathInfo, "pathInfo cannot be null");
248 logger.debug("handleSetValue {}", pathInfo);
249 final NeeoDevice device = context.getDefinitions().getDevice(pathInfo.getThingUid());
250 if (device != null) {
251 final NeeoDeviceChannel channel = device.getChannel(pathInfo.getItemName(), pathInfo.getSubType(),
252 pathInfo.getChannelNbr());
253 if (channel != null && channel.getKind() == NeeoDeviceChannelKind.TRIGGER) {
254 String value = channel.getValue();
255 final ChannelTriggeredEvent event = ThingEventFactory.createTriggerEvent(value == null ? "" : value,
256 new ChannelUID(device.getUid(), channel.getItemName()));
257 logger.debug("Posting triggered event: {}", event);
258 context.getEventPublisher().post(event);
261 final Item item = context.getItemRegistry().getItem(pathInfo.getItemName());
262 final Command cmd = NeeoItemValueConverter.convert(item, pathInfo);
264 final ItemCommandEvent event = ItemEventFactory.createCommandEvent(item.getName(), cmd);
265 logger.debug("Posting item event: {}", event);
266 context.getEventPublisher().post(event);
268 logger.debug("Cannot set value - no command for path: {}", pathInfo);
270 } catch (ItemNotFoundException e) {
271 logger.debug("Cannot set value - no linked items: {}", pathInfo);
275 logger.debug("Cannot set value - no device definition: {}", pathInfo);
280 * Handle set value from the path
282 * @param resp the non-null response to write the response to
283 * @param pathInfo the non-null path information
284 * @throws IOException Signals that an I/O exception has occurred.
286 private void handleGetValue(HttpServletResponse resp, PathInfo pathInfo) throws IOException {
287 Objects.requireNonNull(resp, "resp cannot be null");
288 Objects.requireNonNull(pathInfo, "pathInfo cannot be null");
290 NeeoItemValue niv = new NeeoItemValue("");
293 final NeeoDevice device = context.getDefinitions().getDevice(pathInfo.getThingUid());
294 if (device != null) {
295 final NeeoDeviceChannel channel = device.getChannel(pathInfo.getItemName(), pathInfo.getSubType(),
296 pathInfo.getChannelNbr());
297 if (channel != null && channel.getKind() == NeeoDeviceChannelKind.ITEM) {
299 final Item item = context.getItemRegistry().getItem(pathInfo.getItemName());
300 niv = itemConverter.convert(channel, item.getState());
301 } catch (ItemNotFoundException e) {
302 logger.debug("Item '{}' not found to get a value ({})", pathInfo.getItemName(), pathInfo);
305 logger.debug("Channel definition for '{}' not found to get a value ({})", pathInfo.getItemName(),
309 logger.debug("Device definition for '{}' not found to get a value ({})", pathInfo.getItemName(),
313 NeeoUtil.write(resp, gson.toJson(niv));
315 logger.debug("handleGetValue {}: {}", pathInfo, niv.getValue());
320 * Handle unsubscribing from a device by removing all device keys for the related {@link ThingUID}
322 * @param resp the non-null response to write to
323 * @param adapterName the non-empty adapter name
324 * @throws IOException Signals that an I/O exception has occurred.
326 private void handleUnsubscribe(HttpServletResponse resp, String adapterName) throws IOException {
327 Objects.requireNonNull(resp, "resp cannot be null");
328 NeeoUtil.requireNotEmpty(adapterName, "adapterName cannot be empty");
330 logger.debug("handleUnsubscribe {}", adapterName);
333 final NeeoThingUID uid = new NeeoThingUID(adapterName);
334 api.getDeviceKeys().remove(uid);
335 NeeoUtil.write(resp, gson.toJson(ReturnStatus.SUCCESS));
336 } catch (IllegalArgumentException e) {
337 logger.debug("AdapterName {} is not a valid thinguid - ignoring", adapterName);
338 NeeoUtil.write(resp, gson.toJson(new ReturnStatus("AdapterName not a valid ThingUID: " + adapterName)));
343 * Handle subscribe to a device by adding the device key to the API for the related {@link ThingUID}
345 * @param resp the non-null response to write to
346 * @param adapterName the non-empty adapter name
347 * @param deviceKey the non-empty device key
348 * @throws IOException Signals that an I/O exception has occurred.
350 private void handleSubscribe(HttpServletResponse resp, String adapterName, String deviceKey) throws IOException {
351 Objects.requireNonNull(resp, "resp cannot be null");
352 NeeoUtil.requireNotEmpty(adapterName, "adapterName cannot be empty");
353 NeeoUtil.requireNotEmpty(deviceKey, "deviceKey cannot be empty");
355 logger.debug("handleSubscribe {}/{}", adapterName, deviceKey);
358 final NeeoThingUID uid = new NeeoThingUID(adapterName);
359 api.getDeviceKeys().put(uid, deviceKey);
360 NeeoUtil.write(resp, gson.toJson(ReturnStatus.SUCCESS));
361 } catch (IllegalArgumentException e) {
362 logger.debug("AdapterName {} is not a valid thinguid - ignoring", adapterName);
363 NeeoUtil.write(resp, gson.toJson(new ReturnStatus("AdapterName not a valid ThingUID: " + adapterName)));
368 * Handle a directory request
370 * @param req the non-null request to use
371 * @param resp the non-null response to write to
372 * @param pathInfo the non-null path information
373 * @throws IOException Signals that an I/O exception has occurred.
375 private void handleDirectory(HttpServletRequest req, HttpServletResponse resp, PathInfo pathInfo)
377 Objects.requireNonNull(req, "req cannot be null");
378 Objects.requireNonNull(resp, "resp cannot be null");
379 Objects.requireNonNull(pathInfo, "pathInfo cannot be null");
381 logger.debug("handleDirectory {}", pathInfo);
383 final NeeoDevice device = context.getDefinitions().getDevice(pathInfo.getThingUid());
384 if (device != null) {
385 final NeeoDeviceChannel channel = device.getChannel(pathInfo.getItemName(), pathInfo.getSubType(),
386 pathInfo.getChannelNbr());
387 if ("action".equalsIgnoreCase(pathInfo.getActionValue())) {
388 final NeeoDirectoryRequestAction discoveryAction = gson.fromJson(req.getReader(),
389 NeeoDirectoryRequestAction.class);
392 final Item item = context.getItemRegistry().getItem(pathInfo.getItemName());
393 final Command cmd = NeeoItemValueConverter.convert(item, pathInfo,
394 discoveryAction.getActionIdentifier());
396 final ItemCommandEvent event = ItemEventFactory.createCommandEvent(item.getName(), cmd);
397 logger.debug("Posting item event: {}", event);
398 context.getEventPublisher().post(event);
400 logger.debug("Cannot set value (directory) - no command for path: {}", pathInfo);
402 } catch (ItemNotFoundException e) {
403 logger.debug("Cannot set value(directory) - no linked items: {}", pathInfo);
407 if (channel instanceof NeeoDeviceChannelDirectory) {
408 final NeeoDirectoryRequest discoveryRequest = gson.fromJson(req.getReader(),
409 NeeoDirectoryRequest.class);
410 final NeeoDeviceChannelDirectory directoryChannel = (NeeoDeviceChannelDirectory) channel;
411 NeeoUtil.write(resp, gson.toJson(new NeeoDirectoryResult(discoveryRequest, directoryChannel)));
413 logger.debug("Channel definition for '{}' not found to directory set value ({})",
414 pathInfo.getItemName(), pathInfo);
418 logger.debug("Device definition for '{}' not found to directory set value ({})", pathInfo.getItemName(),
425 * Returns the {@link EventFilter} used by this service. The {@link EventFilter} will simply filter for those items
426 * that have been bound
428 * @return a non-null {@link EventFilter}
432 public EventFilter getEventFilter() {
433 return new EventFilter() {
436 public boolean apply(@Nullable Event event) {
437 Objects.requireNonNull(event, "event cannot be null");
439 final ItemStateChangedEvent ise = (ItemStateChangedEvent) event;
440 final String itemName = ise.getItemName();
442 final NeeoDeviceKeys keys = api.getDeviceKeys();
443 final boolean isBound = context.getDefinitions().isBound(keys, itemName);
444 logger.trace("Apply Event: {} --- {} --- {} = {}", event, itemName, isBound, keys);
451 * Handles the event by notifying the NEEO brain of the new value. If the channel has been linked to the
452 * {@link NeeoButtonGroup#POWERONOFF}, then the related recipe will be powered on/off (in addition to sending the
455 * @see DefaultServletService#handleEvent(Event)
459 public boolean handleEvent(Event event) {
460 Objects.requireNonNull(event, "event cannot be null");
462 final ItemStateChangedEvent ise = (ItemStateChangedEvent) event;
463 final String itemName = ise.getItemName();
465 logger.trace("handleEvent: {}", event);
466 notifyState(itemName, ise.getItemState());
472 * Helper function to send the current state of all bound channels
474 private void resendState() {
475 for (final Entry<NeeoDevice, NeeoDeviceChannel> boundEntry : context.getDefinitions()
476 .getBound(api.getDeviceKeys())) {
478 final NeeoDevice device = boundEntry.getKey();
479 final NeeoDeviceChannel channel = boundEntry.getValue();
482 final State state = context.getItemRegistry().getItem(channel.getItemName()).getState();
484 for (String deviceKey : api.getDeviceKeys().get(device.getUid())) {
485 sendNotification(channel, deviceKey, state);
487 } catch (ItemNotFoundException e) {
488 logger.debug("Item not found {}", channel.getItemName());
494 * Helper function to send some state for an itemName to the brain
496 * @param itemName a non-null, non-empty item name
497 * @param state a non-null state
499 private void notifyState(String itemName, State state) {
500 NeeoUtil.requireNotEmpty(itemName, "itemName cannot be empty");
501 Objects.requireNonNull(state, "state cannot be null");
503 logger.trace("notifyState: {} --- {}", itemName, state);
505 for (final Entry<NeeoDevice, NeeoDeviceChannel> boundEntry : context.getDefinitions()
506 .getBound(api.getDeviceKeys(), itemName)) {
507 final NeeoDevice device = boundEntry.getKey();
508 final NeeoDeviceChannel channel = boundEntry.getValue();
509 final NeeoThingUID uid = new NeeoThingUID(device.getUid());
511 logger.trace("notifyState (device): {} --- {} ", uid, channel);
512 for (String deviceKey : api.getDeviceKeys().get(uid)) {
513 logger.trace("notifyState (key): {} --- {}", uid, deviceKey);
515 if (state instanceof OnOffType) {
516 Boolean recipeState = null;
517 final String label = channel.getLabel();
518 if (NeeoButtonGroup.POWERONOFF.getText().equalsIgnoreCase(label)) {
519 recipeState = state == OnOffType.ON;
520 } else if (state == OnOffType.ON && ButtonInfo.POWERON.getLabel().equalsIgnoreCase(label)) {
522 } else if (state == OnOffType.OFF && ButtonInfo.POWEROFF.getLabel().equalsIgnoreCase(label)) {
526 if (recipeState != null) {
527 logger.trace("notifyState (executeRecipe): {} --- {} --- {}", uid, deviceKey, recipeState);
528 final boolean turnOn = recipeState;
529 scheduler.submit(() -> {
531 api.executeRecipe(deviceKey, turnOn);
532 } catch (IOException e) {
533 logger.debug("Exception occurred while handling executing a recipe: {}", e.getMessage(),
540 sendNotification(channel, deviceKey, state);
546 * Helper method to send a notification
548 * @param channel a non-null channel
549 * @param deviceKey a non-null, non-empty device id
550 * @param state a non-null state
552 private void sendNotification(NeeoDeviceChannel channel, String deviceKey, State state) {
553 Objects.requireNonNull(channel, "channel cannot be null");
554 NeeoUtil.requireNotEmpty(deviceKey, "deviceKey cannot be empty");
555 Objects.requireNonNull(state, "state cannot be null");
557 scheduler.execute(() -> {
558 final String uin = channel.getUniqueItemName();
560 final NeeoItemValue niv = itemConverter.convert(channel, state);
562 // Use sensor notification if we have a >= 0.50 firmware AND it's not a power sensor
563 if (api.getSystemInfo().isFirmwareGreaterOrEqual(NeeoConstants.NEEO_FIRMWARE_0_51_1)
564 && channel.getType() != NeeoCapabilityType.SENSOR_POWER) {
565 final NeeoSensorNotification notify = new NeeoSensorNotification(deviceKey, uin, niv.getValue());
567 api.notify(gson.toJson(notify));
568 } catch (IOException e) {
569 logger.debug("Exception occurred while handling event: {}", e.getMessage(), e);
572 final NeeoNotification notify = new NeeoNotification(deviceKey, uin, niv.getValue());
574 api.notify(gson.toJson(notify));
575 } catch (IOException e) {
576 logger.debug("Exception occurred while handling event: {}", e.getMessage(), e);
583 * Simply closes the {@link #request}
585 * @see DefaultServletService#close()
588 public void close() {
589 this.api.removePropertyChangeListener(listener);