git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2021 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   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
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.ihc.internal.ws.services;
  14
  15 import java.io.IOException;
  16 import java.net.SocketTimeoutException;
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import java.util.Set;
  20
  21 import javax.xml.xpath.XPathExpressionException;
  22
  23 import org.apache.commons.lang.StringUtils;
  24 import org.openhab.binding.ihc.internal.ws.datatypes.XPathUtils;
  25 import org.openhab.binding.ihc.internal.ws.exeptions.IhcExecption;
  26 import org.openhab.binding.ihc.internal.ws.http.IhcConnectionPool;
  27 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSBooleanValue;
  28 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSDateValue;
  29 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSEnumValue;
  30 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSFloatingPointValue;
  31 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSIntegerValue;
  32 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSResourceValue;
  33 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSTimeValue;
  34 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSTimerValue;
  35 import org.openhab.binding.ihc.internal.ws.resourcevalues.WSWeekdayValue;
  36 import org.w3c.dom.Node;
  37 import org.w3c.dom.NodeList;
  38
  39 /**
  40  * Class to handle IHC / ELKO LS Controller's resource interaction service.
  41  *
  42  * Service is used to fetch or update resource values from/to controller.
  43  *
  44  * @author Pauli Anttila - Initial contribution
  45  */
  46 public class IhcResourceInteractionService extends IhcBaseService {
  47
  48     public IhcResourceInteractionService(String host, int timeout, IhcConnectionPool ihcConnectionPool) {
  49         super(ihcConnectionPool, timeout, host, "ResourceInteractionService");
  50     }
  51
  52     /**
  53      * Query resource value from controller.
  54      *
  55      * @param resoureId Resource Identifier.
  56      * @return Resource value.
  57      */
  58     public WSResourceValue resourceQuery(int resoureId) throws IhcExecption {
  59         // @formatter:off
  60         final String soapQuery =
  61                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
  62                 + "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
  63                 + " <soapenv:Body>\n"
  64                 + "  <ns1:getRuntimeValue1 xmlns:ns1=\"utcs\">%s</ns1:getRuntimeValue1>\n"
  65                 + " </soapenv:Body>\n"
  66                 + "</soapenv:Envelope>";
  67         // @formatter:on
  68
  69         String query = String.format(soapQuery, String.valueOf(resoureId));
  70         String response = sendSoapQuery(null, query);
  71         NodeList nodeList;
  72         try {
  73             nodeList = XPathUtils.parseList(response, "/SOAP-ENV:Envelope/SOAP-ENV:Body/ns1:getRuntimeValue2");
  74
  75             if (nodeList != null && nodeList.getLength() == 1) {
  76                 WSResourceValue val = parseResourceValue(nodeList.item(0));
  77
  78                 if (val != null && val.resourceID == resoureId) {
  79                     return val;
  80                 } else {
  81                     throw new IhcExecption("No resource id found");
  82                 }
  83             } else {
  84                 throw new IhcExecption("No resource value found");
  85             }
  86         } catch (XPathExpressionException | NumberFormatException | IOException e) {
  87             throw new IhcExecption("Error occured during XML data parsing", e);
  88         }
  89     }
  90
  91     private WSResourceValue parseResourceValue(Node n) throws XPathExpressionException, NumberFormatException {
  92         // parse resource id
  93         String resourceId = XPathUtils.getSpeficValueFromNode(n, "ns1:resourceID");
  94
  95         if (StringUtils.isNotBlank(resourceId)) {
  96             int id = Integer.parseInt(resourceId);
  97
  98             // Parse floating point value
  99             String floatingPointValue = getValue(n, "floatingPointValue");
 100             if (StringUtils.isNotBlank(floatingPointValue)) {
 101                 String min = getValue(n, "minimumValue");
 102                 String max = getValue(n, "maximumValue");
 103                 return new WSFloatingPointValue(id, Double.valueOf(floatingPointValue), Double.valueOf(min),
 104                         Double.valueOf(max));
 105             }
 106
 107             // Parse boolean value
 108             String value = getValue(n, "value");
 109             if (StringUtils.isNotBlank(value)) {
 110                 return new WSBooleanValue(id, Boolean.valueOf(value));
 111             }
 112
 113             // Parse integer value
 114             String integer = getValue(n, "integer");
 115             if (StringUtils.isNotBlank(integer)) {
 116                 String min = getValue(n, "minimumValue");
 117                 String max = getValue(n, "maximumValue");
 118                 return new WSIntegerValue(id, Integer.valueOf(integer), Integer.valueOf(min), Integer.valueOf(max));
 119             }
 120
 121             // Parse timer value
 122             String milliseconds = getValue(n, "milliseconds");
 123             if (StringUtils.isNotBlank(milliseconds)) {
 124                 return new WSTimerValue(id, Integer.valueOf(milliseconds));
 125             }
 126
 127             // Parse time value
 128             String hours = getValue(n, "hours");
 129             if (StringUtils.isNotBlank(hours)) {
 130                 String minutes = getValue(n, "minutes");
 131                 String seconds = getValue(n, "seconds");
 132                 return new WSTimeValue(id, Integer.valueOf(hours), Integer.valueOf(minutes), Integer.valueOf(seconds));
 133             }
 134
 135             // Parse date value
 136             String year = getValue(n, "year");
 137             if (StringUtils.isNotBlank(year)) {
 138                 String month = getValue(n, "month");
 139                 String day = getValue(n, "day");
 140                 return new WSDateValue(id, Short.valueOf(year), Byte.valueOf(month), Byte.valueOf(day));
 141             }
 142
 143             // Parse enum value
 144             String definitionTypeID = getValue(n, "definitionTypeID");
 145             if (StringUtils.isNotBlank(definitionTypeID)) {
 146                 String enumValueID = getValue(n, "enumValueID");
 147                 String enumName = getValue(n, "enumName");
 148                 return new WSEnumValue(id, Integer.valueOf(definitionTypeID), Integer.valueOf(enumValueID), enumName);
 149             }
 150
 151             // Parse week day value
 152             value = getValue(n, "weekdayNumber");
 153             if (StringUtils.isNotBlank(value)) {
 154                 return new WSWeekdayValue(id, Integer.valueOf(value));
 155             }
 156
 157             // Unknown value type
 158             throw new IllegalArgumentException("Unsupported value type");
 159         }
 160         return null;
 161     }
 162
 163     private String getValue(Node n, String value) throws XPathExpressionException {
 164         return XPathUtils.getSpeficValueFromNode(n, "ns1:value/" + XPathUtils.createIgnoreNameSpaceSyntaxExpr(value));
 165     }
 166
 167     /**
 168      * Update resource value to controller.
 169      *
 170      *
 171      * @param value Resource value.
 172      * @return True if value is successfully updated.
 173      */
 174     public boolean resourceUpdate(WSResourceValue value) throws IhcExecption {
 175         boolean retval = false;
 176
 177         if (value instanceof WSFloatingPointValue) {
 178             retval = resourceUpdate((WSFloatingPointValue) value);
 179         } else if (value instanceof WSBooleanValue) {
 180             retval = resourceUpdate((WSBooleanValue) value);
 181         } else if (value instanceof WSIntegerValue) {
 182             retval = resourceUpdate((WSIntegerValue) value);
 183         } else if (value instanceof WSTimerValue) {
 184             retval = resourceUpdate((WSTimerValue) value);
 185         } else if (value instanceof WSWeekdayValue) {
 186             retval = resourceUpdate((WSWeekdayValue) value);
 187         } else if (value instanceof WSEnumValue) {
 188             retval = resourceUpdate((WSEnumValue) value);
 189         } else if (value instanceof WSTimeValue) {
 190             retval = resourceUpdate((WSTimeValue) value);
 191         } else if (value instanceof WSDateValue) {
 192             retval = resourceUpdate((WSDateValue) value);
 193         } else {
 194             throw new IhcExecption("Unsupported value type " + value.getClass().toString());
 195         }
 196
 197         return retval;
 198     }
 199
 200     public boolean resourceUpdate(WSBooleanValue value) throws IhcExecption {
 201         // @formatter:off
 202         final String soapQuery =
 203                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 204                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 205                 + " <soap:Body>\n"
 206                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 207                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSBooleanValue\">\n"
 208                 + "    <q1:value>%s</q1:value>\n"
 209                 + "   </value>\n"
 210                 + "   <resourceID>%s</resourceID>\n"
 211                 + "   <isValueRuntime>true</isValueRuntime>\n"
 212                 + "  </setResourceValue1>\n"
 213                 + " </soap:Body>\n"
 214                 + "</soap:Envelope>";
 215         // @formatter:on
 216
 217         String query = String.format(soapQuery, value.value ? "true" : "false", value.resourceID);
 218         return doResourceUpdate(query);
 219     }
 220
 221     public boolean resourceUpdate(WSFloatingPointValue value) throws IhcExecption {
 222         // @formatter:off
 223         final String soapQuery =
 224                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 225                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 226                 + " <soap:Body>\n"
 227                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 228                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSFloatingPointValue\">\n"
 229                 + "    <q1:maximumValue>%s</q1:maximumValue>\n"
 230                 + "    <q1:minimumValue>%s</q1:minimumValue>\n"
 231                 + "    <q1:floatingPointValue>%s</q1:floatingPointValue>\n"
 232                 + "   </value>\n"
 233                 + "   <resourceID>%s</resourceID>\n"
 234                 + "   <isValueRuntime>true</isValueRuntime>\n"
 235                 + "  </setResourceValue1>\n"
 236                 + " </soap:Body>\n"
 237                 + "</soap:Envelope>";
 238         // @formatter:on
 239
 240         String query = String.format(soapQuery, value.maximumValue, value.minimumValue, value.value, value.resourceID);
 241         return doResourceUpdate(query);
 242     }
 243
 244     public boolean resourceUpdate(WSIntegerValue value) throws IhcExecption {
 245         // @formatter:off
 246         final String soapQuery =
 247                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 248                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 249                 + " <soap:Body>\n"
 250                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 251                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSIntegerValue\">\n"
 252                 + "    <q1:maximumValue>%s</q1:maximumValue>\n"
 253                 + "    <q1:minimumValue>%s</q1:minimumValue>\n"
 254                 + "    <q1:integer>%s</q1:integer>\n"
 255                 + "   </value>\n"
 256                 + "   <resourceID>%s</resourceID>\n"
 257                 + "   <isValueRuntime>true</isValueRuntime>\n"
 258                 + "  </setResourceValue1>\n"
 259                 + " </soap:Body>\n"
 260                 + "</soap:Envelope>";
 261         // @formatter:on
 262
 263         String query = String.format(soapQuery, value.maximumValue, value.minimumValue, value.value, value.resourceID);
 264         return doResourceUpdate(query);
 265     }
 266
 267     public boolean resourceUpdate(WSTimerValue value) throws IhcExecption {
 268         // @formatter:off
 269         final String soapQuery =
 270                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 271                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 272                 + " <soap:Body>\n"
 273                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 274                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSTimerValue\">\n"
 275                 + "    <q1:milliseconds>%s</q1:milliseconds>\n"
 276                 + "   </value>\n"
 277                 + "   <resourceID>%s</resourceID>\n"
 278                 + "   <isValueRuntime>true</isValueRuntime>\n"
 279                 + "  </setResourceValue1>\n"
 280                 + " </soap:Body>\n"
 281                 + "</soap:Envelope>";
 282         // @formatter:on
 283
 284         String query = String.format(soapQuery, value.milliseconds, value.resourceID);
 285         return doResourceUpdate(query);
 286     }
 287
 288     public boolean resourceUpdate(WSWeekdayValue value) throws IhcExecption {
 289         // @formatter:off
 290         final String soapQuery =
 291                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 292                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 293                 + " <soap:Body>\n"
 294                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 295                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSWeekdayValue\">\n"
 296                 + "    <q1:weekdayNumber>%s</q1:weekdayNumber>\n"
 297                 + "   </value>\n"
 298                 + "   <resourceID>%s</resourceID>\n"
 299                 + "   <isValueRuntime>true</isValueRuntime>\n"
 300                 + "  </setResourceValue1>\n"
 301                 + " </soap:Body>\n"
 302                 + "</soap:Envelope>";
 303         // @formatter:on
 304
 305         String query = String.format(soapQuery, value.weekdayNumber, value.resourceID);
 306         return doResourceUpdate(query);
 307     }
 308
 309     public boolean resourceUpdate(WSEnumValue value) throws IhcExecption {
 310         // @formatter:off
 311         final String soapQuery =
 312                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 313                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 314                 + " <soap:Body>\n"
 315                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 316                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSEnumValue\">\n"
 317                 + "    <q1:definitionTypeID>%s</q1:definitionTypeID>\n"
 318                 + "    <q1:enumValueID>%s</q1:enumValueID>\n"
 319                 + "    <q1:enumName>%s</q1:enumName>\n"
 320                 + "   </value>\n"
 321                 + "   <resourceID>%s</resourceID>\n"
 322                 + "   <isValueRuntime>true</isValueRuntime>\n"
 323                 + "  </setResourceValue1>\n"
 324                 + " </soap:Body>\n"
 325                 + "</soap:Envelope>";
 326         // @formatter:on
 327
 328         String query = String.format(soapQuery, value.definitionTypeID, value.enumValueID, value.enumName,
 329                 value.resourceID);
 330         return doResourceUpdate(query);
 331     }
 332
 333     public boolean resourceUpdate(WSTimeValue value) throws IhcExecption {
 334         // @formatter:off
 335         final String soapQuery =
 336                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 337                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 338                 + " <soap:Body>\n"
 339                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 340                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSTimeValue\">\n"
 341                 + "    <q1:hours>%s</q1:hours>\n"
 342                 + "    <q1:minutes>%s</q1:minutes>\n"
 343                 + "    <q1:seconds>%s</q1:seconds>\n"
 344                 + "   </value>\n"
 345                 + "   <resourceID>%s</resourceID>\n"
 346                 + "   <isValueRuntime>true</isValueRuntime>\n"
 347                 + "  </setResourceValue1>\n"
 348                 + " </soap:Body>\n"
 349                 + "</soap:Envelope>";
 350         // @formatter:on
 351
 352         String query = String.format(soapQuery, value.hours, value.minutes, value.seconds, value.resourceID);
 353         return doResourceUpdate(query);
 354     }
 355
 356     public boolean resourceUpdate(WSDateValue value) throws IhcExecption {
 357         // @formatter:off
 358         final String soapQuery =
 359                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 360                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 361                 + " <soap:Body>\n"
 362                 + "  <setResourceValue1 xmlns=\"utcs\">\n"
 363                 + "   <value xmlns:q1=\"utcs.values\" xsi:type=\"q1:WSDateValue\">\n"
 364                 + "    <q1:month>%s</q1:month>\n"
 365                 + "    <q1:year>%s</q1:year>\n"
 366                 + "    <q1:day>%s</q1:day>\n"
 367                 + "   </value>\n"
 368                 + "   <resourceID>%s</resourceID>\n"
 369                 + "   <isValueRuntime>true</isValueRuntime>\n"
 370                 + "  </setResourceValue1>\n"
 371                 + " </soap:Body>\n"
 372                 + "</soap:Envelope>";
 373         // @formatter:on
 374
 375         String query = String.format(soapQuery, value.month, value.year, value.day, value.resourceID);
 376         return doResourceUpdate(query);
 377     }
 378
 379     private boolean doResourceUpdate(String query) throws IhcExecption {
 380         String response = sendSoapQuery(null, query);
 381         try {
 382             return Boolean.parseBoolean(
 383                     XPathUtils.parseXMLValue(response, "/SOAP-ENV:Envelope/SOAP-ENV:Body/ns1:setResourceValue2"));
 384         } catch (IOException | XPathExpressionException e) {
 385             throw new IhcExecption(e);
 386         }
 387     }
 388
 389     /**
 390      * Enable resources runtime value notifications.
 391      *
 392      * @param resourceIdList List of resource Identifiers.
 393      * @return True is connection successfully opened.
 394      */
 395     public void enableRuntimeValueNotifications(Set<Integer> resourceIdList) throws IhcExecption {
 396         // @formatter:off
 397         final String soapQueryPrefix =
 398                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 399                 + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n"
 400                 + " <soap:Body>\n"
 401                 + "  <enableRuntimeValueNotifications1 xmlns=\"utcs\">\n";
 402
 403         final String soapQuerySuffix =
 404                   "  </enableRuntimeValueNotifications1>\n"
 405                 + " </soap:Body>\n"
 406                 + "</soap:Envelope>";
 407         // @formatter:on
 408
 409         String query = soapQueryPrefix;
 410         for (int i : resourceIdList) {
 411             query += "   <xsd:arrayItem>" + i + "</xsd:arrayItem>\n";
 412         }
 413         query += soapQuerySuffix;
 414         sendSoapQuery(null, query);
 415     }
 416
 417     /**
 418      * Wait runtime value notifications.
 419      *
 420      * Runtime value notification should firstly be activated by
 421      * enableRuntimeValueNotifications function.
 422      *
 423      * @param timeoutInSeconds How many seconds to wait notifications.
 424      * @return List of received runtime value notifications.
 425      * @throws SocketTimeoutException
 426      * @throws IhcTimeoutExecption
 427      */
 428     public List<WSResourceValue> waitResourceValueNotifications(int timeoutInSeconds) throws IhcExecption {
 429         // @formatter:off
 430         final String soapQuery =
 431                   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 432                 + "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:utcs=\"utcs\">\n"
 433                 + " <soapenv:Body>\n"
 434                 + "  <utcs:waitForResourceValueChanges1>%s</utcs:waitForResourceValueChanges1>\n"
 435                 + " </soapenv:Body>\n"
 436                 + "</soapenv:Envelope>";
 437         // @formatter:on
 438
 439         String query = String.format(soapQuery, timeoutInSeconds);
 440         String response = sendSoapQuery(null, query, getTimeout() + timeoutInSeconds * 1000);
 441         List<WSResourceValue> resourceValueList = new ArrayList<>();
 442
 443         try {
 444             NodeList nodeList = XPathUtils.parseList(response,
 445                     "/SOAP-ENV:Envelope/SOAP-ENV:Body/ns1:waitForResourceValueChanges2/ns1:arrayItem");
 446
 447             if (nodeList != null) {
 448                 if (nodeList.getLength() == 1) {
 449                     String resourceId = XPathUtils.getSpeficValueFromNode(nodeList.item(0), "ns1:resourceID");
 450                     if (resourceId == null || resourceId.isEmpty()) {
 451                         // IHC controller indicates timeout, return empty list
 452                         return resourceValueList;
 453                     }
 454                 }
 455
 456                 for (int i = 0; i < nodeList.getLength(); i++) {
 457                     WSResourceValue newVal = parseResourceValue(nodeList.item(i));
 458                     if (newVal != null) {
 459                         resourceValueList.add(newVal);
 460                     }
 461                 }
 462             } else {
 463                 throw new IhcExecption("Illegal resource value notification response received");
 464             }
 465             return resourceValueList;
 466         } catch (XPathExpressionException | NumberFormatException | IOException e) {
 467             throw new IhcExecption("Error occured during XML data parsing", e);
 468         }
 469     }
 470 }