[unifi] Make request timeout configurable (#18349)

* Make http timeout configurable

Signed-off-by: Arne Seime <[email protected]>

Author: seime

bundles/org.openhab.binding.unifi/README.md

@@ -28,14 +28,15 @@ It requires a network accessible instance of the [Ubiquiti Networks Controller S
 
 The following table describes the Bridge configuration parameters:
 
-| Parameter                | Description                                                                 | Config   | Default |
-| ------------------------ | --------------------------------------------------------------------------- |--------- | ------- |
-| host                     | Hostname of IP address of the UniFi Controller                              | Required | -       |
-| port                     | Port of the UniFi Controller. For UniFi OS, the default port is usually 443 | Required | -       |
-| unifios                  | If the UniFi Controller is running on UniFi OS                              | Required | false   |
-| username                 | The username to access the UniFi Controller                                 | Required | -       |
-| password                 | The password to access the UniFi Controller                                 | Required | -       |
-| refresh                  | Refresh interval in seconds                                                 | Optional | 10      |
+| Parameter      | Description                                                                 | Config   | Default |
+|----------------|-----------------------------------------------------------------------------|--------- |---------|
+| host           | Hostname of IP address of the UniFi Controller                              | Required | -       |
+| port           | Port of the UniFi Controller. For UniFi OS, the default port is usually 443 | Required | -       |
+| unifios        | If the UniFi Controller is running on UniFi OS                              | Required | false   |
+| username       | The username to access the UniFi Controller                                 | Required | -       |
+| password       | The password to access the UniFi Controller                                 | Required | -       |
+| refresh        | Refresh interval in seconds                                                 | Optional | 10      |
+| timeoutSeconds | Request timeout in seconds. Increase if you experience TimeoutExceptions    | Optional | 5       |
 
 ## Thing Configuration
 

bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/UniFiControllerThingConfig.java

@@ -35,6 +35,8 @@ public class UniFiControllerThingConfig {
 
     private int refresh = 10;
 
+    private int timeoutSeconds = 5;
+
     private boolean unifios = false;
 
     public String getHost() {
@@ -82,6 +84,14 @@ private void setRefresh(final int refresh) {
         this.refresh = refresh;
     }
 
+    public int getTimeoutSeconds() {
+        return timeoutSeconds;
+    }
+
+    public void setTimeoutSeconds(int timeoutSeconds) {
+        this.timeoutSeconds = timeoutSeconds;
+    }
+
     public boolean isUniFiOS() {
         return unifios;
     }
@@ -98,6 +108,7 @@ public boolean isValid() {
     @Override
     public String toString() {
         return "UniFiControllerConfig{host = " + host + ", port = " + port + ", username = " + username
-                + ", password = *****, refresh = " + refresh + ", unifios = " + unifios + "}";
+                + ", password = *****, refresh = " + refresh + ", timeout = " + timeoutSeconds + ", unifios = "
+                + unifios + "}";
     }
 }

bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/api/UniFiController.java

@@ -70,19 +70,21 @@ public class UniFiController {
     private final String username;
     private final String password;
     private final boolean unifios;
+    private final int timeoutSeconds;
     private final Gson gson;
     private final Gson poeGson;
 
     private String csrfToken;
 
     public UniFiController(final HttpClient httpClient, final String host, final int port, final String username,
-            final String password, final boolean unifios) {
+            final String password, final boolean unifios, int timeoutSeconds) {
         this.httpClient = httpClient;
         this.host = host;
         this.port = port;
         this.username = username;
         this.password = password;
         this.unifios = unifios;
+        this.timeoutSeconds = timeoutSeconds;
         this.csrfToken = "";
         final UniFiSiteInstanceCreator siteInstanceCreator = new UniFiSiteInstanceCreator(cache);
         final UniFiWlanInstanceCreator wlanInstanceCreator = new UniFiWlanInstanceCreator(cache);
@@ -271,7 +273,8 @@ public void revokeVouchers(final UniFiSite site, final List<UniFiVoucher> vouche
 
     private <T> UniFiControllerRequest<T> newRequest(final Class<T> responseType, final HttpMethod method,
             final Gson gson) {
-        return new UniFiControllerRequest<>(responseType, gson, httpClient, method, host, port, csrfToken, unifios);
+        return new UniFiControllerRequest<>(responseType, gson, httpClient, method, host, port, csrfToken, unifios,
+                timeoutSeconds);
     }
 
     private <T> @Nullable T executeRequest(final UniFiControllerRequest<T> request) throws UniFiException {

bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/api/UniFiControllerRequest.java

@@ -64,8 +64,6 @@ class UniFiControllerRequest<T> {
 
     private static final String CONTENT_TYPE_APPLICATION_JSON_UTF_8 = MimeTypes.Type.APPLICATION_JSON_UTF_8.asString();
 
-    private static final long TIMEOUT_SECONDS = 5;
-
     private static final String PROPERTY_DATA = "data";
 
     private final Logger logger = LoggerFactory.getLogger(UniFiControllerRequest.class);
@@ -79,6 +77,7 @@ class UniFiControllerRequest<T> {
     private final int port;
 
     private final boolean unifios;
+    private final int timeoutSeconds;
 
     private final HttpMethod method;
 
@@ -95,7 +94,8 @@ class UniFiControllerRequest<T> {
     // Public API
 
     public UniFiControllerRequest(final Class<T> resultType, final Gson gson, final HttpClient httpClient,
-            final HttpMethod method, final String host, final int port, final String csrfToken, final boolean unifios) {
+            final HttpMethod method, final String host, final int port, final String csrfToken, final boolean unifios,
+            int timeoutSeconds) {
         this.resultType = resultType;
         this.gson = gson;
         this.httpClient = httpClient;
@@ -104,6 +104,7 @@ public UniFiControllerRequest(final Class<T> resultType, final Gson gson, final
         this.port = port;
         this.csrfToken = csrfToken;
         this.unifios = unifios;
+        this.timeoutSeconds = timeoutSeconds;
     }
 
     public void setAPIPath(final String relativePath) {
@@ -189,7 +190,7 @@ private Response getContentResponse(final InputStreamResponseListener listener)
         Response response;
         try {
             request.send(listener);
-            response = listener.get(TIMEOUT_SECONDS, TimeUnit.SECONDS);
+            response = listener.get(timeoutSeconds, TimeUnit.SECONDS);
         } catch (TimeoutException | InterruptedException e) {
             throw new UniFiCommunicationException(e);
         } catch (final ExecutionException e) {
@@ -237,7 +238,7 @@ public String getCsrfToken() {
 
     private Request newRequest() {
         final HttpURI uri = new HttpURI(HttpScheme.HTTPS.asString(), host, port, path);
-        final Request request = httpClient.newRequest(uri.toString()).timeout(TIMEOUT_SECONDS, TimeUnit.SECONDS)
+        final Request request = httpClient.newRequest(uri.toString()).timeout(timeoutSeconds, TimeUnit.SECONDS)
                 .method(method);
         for (final Entry<String, String> entry : queryParameters.entrySet()) {
             request.param(entry.getKey(), entry.getValue());

bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/handler/UniFiControllerThingHandler.java

@@ -88,7 +88,7 @@ public void initialize() {
         config = getConfigAs(UniFiControllerThingConfig.class);
         logger.debug("Initializing the UniFi Controller Handler with config = {}", config);
         final UniFiController uc = new UniFiController(httpClient, config.getHost(), config.getPort(),
-                config.getUsername(), config.getPassword(), config.isUniFiOS());
+                config.getUsername(), config.getPassword(), config.isUniFiOS(), config.getTimeoutSeconds());
 
         controller = uc;
         updateStatus(UNKNOWN);

bundles/org.openhab.binding.unifi/src/main/resources/OH-INF/config/config.xml

@@ -35,6 +35,12 @@
 			<description>The refresh interval in seconds to poll the UniFi controller</description>
 			<default>10</default>
 		</parameter>
+		<parameter name="timeoutSeconds" type="integer" required="false">
+			<label>Connection Timeout</label>
+			<description>Connection timeout in seconds for API calls to the UniFi Controller.</description>
+			<default>5</default>
+			<advanced>true</advanced>
+		</parameter>
 	</config-description>
 
 	<config-description uri="thing-type:unifi:site">

bundles/org.openhab.binding.unifi/src/main/resources/OH-INF/i18n/unifi.properties

@@ -48,6 +48,8 @@ thing-type.config.unifi.controller.port.label = Port
 thing-type.config.unifi.controller.port.description = Port of the UniFi Controller
 thing-type.config.unifi.controller.refresh.label = Refresh Interval
 thing-type.config.unifi.controller.refresh.description = The refresh interval in seconds to poll the UniFi controller
+thing-type.config.unifi.controller.timeoutSeconds.label = Connection Timeout
+thing-type.config.unifi.controller.timeoutSeconds.description = Connection timeout in seconds for API calls to the UniFi Controller.
 thing-type.config.unifi.controller.unifios.label = UniFi OS
 thing-type.config.unifi.controller.unifios.description = If the UniFi Controller is running on UniFi OS.
 thing-type.config.unifi.controller.username.label = Username