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

   1 /**
   2  * Copyright (c) 2010-2023 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.io.hueemulation.internal.automation;
  14
  15 import java.net.URI;
  16 import java.util.Map;
  17 import java.util.concurrent.ExecutionException;
  18 import java.util.concurrent.TimeUnit;
  19 import java.util.concurrent.TimeoutException;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.eclipse.jetty.client.HttpClient;
  24 import org.eclipse.jetty.client.api.Request;
  25 import org.eclipse.jetty.client.util.StringContentProvider;
  26 import org.eclipse.jetty.http.HttpMethod;
  27 import org.openhab.core.automation.Action;
  28 import org.openhab.core.automation.handler.ActionHandler;
  29 import org.openhab.core.automation.handler.BaseModuleHandler;
  30 import org.openhab.core.io.net.http.HttpClientFactory;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * The action module type handled by this class allows to execute a http request (GET, POST, PUT, etc)
  36  * on a given address. Relative addresses are supported.
  37  * <p>
  38  * The optional mimetype and body configuration parameters allow to send arbitrary data with a request.
  39  *
  40  * @author David Graeff - Initial contribution
  41  */
  42 @NonNullByDefault
  43 public class HttpActionHandler extends BaseModuleHandler<Action> implements ActionHandler {
  44     private final Logger logger = LoggerFactory.getLogger(HttpActionHandler.class);
  45
  46     public static final String MODULE_TYPE_ID = "rules.HttpAction";
  47     public static final String CALLBACK_CONTEXT_NAME = "CALLBACK";
  48     public static final String MODULE_CONTEXT_NAME = "MODULE";
  49
  50     public static final String CFG_METHOD = "method";
  51     public static final String CFG_URL = "url";
  52     public static final String CFG_BODY = "body";
  53     public static final String CFG_MIMETYPE = "mimetype";
  54     public static final String CFG_TIMEOUT = "timeout";
  55
  56     private static class Config {
  57         HttpMethod method = HttpMethod.GET;
  58         String url = "";
  59         String body = "";
  60         String mimetype = "application/json";
  61         int timeout = 5;
  62     }
  63
  64     private Config config = new Config();
  65     private HttpClient httpClient;
  66
  67     public HttpActionHandler(final Action module, HttpClientFactory httpFactory) {
  68         super(module);
  69
  70         this.config = module.getConfiguration().as(Config.class);
  71         if (config.url.isEmpty()) {
  72             throw new IllegalArgumentException("URL not set!");
  73         }
  74         // convert relative path to absolute one
  75         String url = config.url;
  76         if (url.startsWith("/")) {
  77             config.url = "http://localhost:" + Integer.getInteger("org.osgi.service.http.port", 8080).toString() + url;
  78         }
  79
  80         httpClient = httpFactory.createHttpClient("HttpActionHandler_" + module.getId());
  81     }
  82
  83     @Override
  84     public @Nullable Map<String, Object> execute(Map<String, Object> context) {
  85         try {
  86             Request request = httpClient.newRequest(URI.create(config.url)).method(config.method)
  87                     .timeout(config.timeout, TimeUnit.SECONDS);
  88             if (config.method == HttpMethod.POST || config.method == HttpMethod.PUT) {
  89                 request.content(new StringContentProvider(config.body), config.mimetype);
  90             }
  91             request.send();
  92         } catch (InterruptedException | TimeoutException | ExecutionException e) {
  93             logger.warn("Failed to send http request", e);
  94         }
  95         return null;
  96     }
  97 }