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.opensprinkler.internal.discovery;
  14
  15 import static org.openhab.binding.opensprinkler.internal.OpenSprinklerBindingConstants.DISCOVERY_DEFAULT_IP_TIMEOUT_RATE;
  16 import static org.openhab.binding.opensprinkler.internal.api.OpenSprinklerApiConstants.*;
  17
  18 import java.io.IOException;
  19 import java.net.InetAddress;
  20 import java.net.InetSocketAddress;
  21 import java.net.Socket;
  22
  23 import org.openhab.binding.opensprinkler.internal.api.OpenSprinklerApi;
  24 import org.openhab.binding.opensprinkler.internal.config.OpenSprinklerHttpInterfaceConfig;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * The {@link OpenSprinklerDiscoveryJob} class allow manual discovery of
  30  * OpenSprinkler devices for a single IP address. This is used
  31  * for threading to make discovery faster.
  32  *
  33  * @author Chris Graham - Initial contribution
  34  */
  35 public class OpenSprinklerDiscoveryJob implements Runnable {
  36     private final Logger logger = LoggerFactory.getLogger(OpenSprinklerDiscoveryJob.class);
  37
  38     private OpenSprinklerDiscoveryService discoveryClass;
  39
  40     private String ipAddress;
  41
  42     public OpenSprinklerDiscoveryJob(OpenSprinklerDiscoveryService service, String ip) {
  43         this.discoveryClass = service;
  44         this.ipAddress = ip;
  45     }
  46
  47     @Override
  48     public void run() {
  49         if (hasOpenSprinklerDevice(this.ipAddress)) {
  50             discoveryClass.submitDiscoveryResults(this.ipAddress);
  51         }
  52     }
  53
  54     /**
  55      * Determines if an OpenSprinkler device is available at a given IP address.
  56      *
  57      * @param ip IP address of the OpenSprinkler device as a string.
  58      * @return True if a device is found, false if not.
  59      */
  60     private boolean hasOpenSprinklerDevice(String ip) {
  61         try {
  62             InetAddress address = InetAddress.getByName(ip);
  63
  64             if (canEstablishConnection(address, DEFAULT_API_PORT)) {
  65                 OpenSprinklerHttpInterfaceConfig config = new OpenSprinklerHttpInterfaceConfig();
  66                 config.hostname = ip;
  67                 config.port = DEFAULT_API_PORT;
  68                 config.password = DEFAULT_ADMIN_PASSWORD;
  69                 OpenSprinklerApi openSprinkler = discoveryClass.getApiFactory().getHttpApi(config);
  70
  71                 return (openSprinkler != null);
  72             } else {
  73                 logger.trace("No OpenSprinkler device found at IP address ({})", ip);
  74
  75                 return false;
  76             }
  77         } catch (Exception exp) {
  78             logger.debug("No OpenSprinkler device found at IP address ({}) because of error: {}", ip, exp.getMessage());
  79
  80             return false;
  81         }
  82     }
  83
  84     /**
  85      * Tries to establish a connection to a hostname and port.
  86      *
  87      * @param host Hostname or IP address to connect to.
  88      * @param port Port to attempt to connect to.
  89      * @return True if a connection can be established, false if not.
  90      */
  91     private boolean canEstablishConnection(InetAddress host, int port) {
  92         boolean reachable = false;
  93
  94         try (Socket socket = new Socket()) {
  95             socket.connect(new InetSocketAddress(host, port), DISCOVERY_DEFAULT_IP_TIMEOUT_RATE);
  96
  97             reachable = true;
  98         } catch (IOException e) {
  99             // do nothing
 100         }
 101
 102         return reachable;
 103     }
 104 }