Java tutorial
/** * openHAB, the open Home Automation Bus. * Copyright (C) 2010-2013, openHAB.org <admin@openhab.org> * * See the contributors.txt file in the distribution for a * full listing of individual contributors. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as * published by the Free Software Foundation; either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see <http://www.gnu.org/licenses>. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or * combining it with Eclipse (or a modified version of that library), * containing parts covered by the terms of the Eclipse Public License * (EPL), the licensors of this Program grant you additional permission * to convey the resulting work. */ package org.openhab.binding.koubachi.internal; import java.util.ArrayList; import java.util.Dictionary; import java.util.List; import java.util.Map; import java.util.Properties; import org.apache.commons.lang.StringUtils; import org.codehaus.jackson.map.ObjectMapper; import org.codehaus.jackson.type.TypeReference; import org.openhab.binding.koubachi.internal.api.Device; import org.openhab.binding.koubachi.internal.api.Plant; import org.openhab.io.net.http.HttpUtil; import org.osgi.service.cm.ConfigurationException; import org.osgi.service.cm.ManagedService; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Helper class which queries the Koubachi server and returns {@link Device}s and {@link Plant}s. * It furthermore handles the general Koubachi binding configuration (read from openhab.cfg). * * @author Thomas.Eichstaedt-Engelen * @since 1.2.0 */ public class KoubachiConnector implements ManagedService { private static final Logger logger = LoggerFactory.getLogger(KoubachiConnector.class); /** Timeout of the HTTP Requests in ms (defaults to 10000ms) */ private static final int HTTP_REQUEST_TIMEOUT = 10000; /** the refresh interval which is used to poll values from the Koubachi server (optional, defaults to 900000ms, 15m) */ private static long refreshInterval = 900000; /** the URL of the Device list (optional, defaults to 'https://api.koubachi.com/v2/user/smart_devices?user_credentials=%1$s&app_key=%2$s') */ private static String apiDeviceListUrl = "https://api.koubachi.com/v2/user/smart_devices?user_credentials=%1$s&app_key=%2$s"; /** the URL of the Plant list (optional, defaults to 'https://api.koubachi.com/v2/user/smart_devices?user_credentials=%1$s&app_key=%2$s') */ private static String apiPlantListUrl = "https://api.koubachi.com/v2/plants?user_credentials=%1$s&app_key=%2$s"; /** The single access token configured at http://labs.kpubachi.com */ private static String credentials; /** The personal appKey configured at http://labs.koubachi.com */ private static String appKey; private static boolean properlyConfigured = false; /** * @return the refresh interval which is used to poll values from the Koubachi server */ public static long getRefreshInterval() { return refreshInterval; } /** * @return indicates whether this binding is properly configured which means the refresh Thread * can be startet. */ public static boolean isProperlyConfigured() { return properlyConfigured; } /** * Gets the list of all configured Devices from the Koubachi server. * * @return the list of all configured Devices. Is never {@code null}. */ public static List<Device> getDevices() { List<Device> devices = new ArrayList<Device>(); String url = String.format(apiDeviceListUrl, credentials, appKey); Properties headers = new Properties(); headers.put("Accept", "application/json"); String response = HttpUtil.executeUrl("GET", url, headers, null, null, HTTP_REQUEST_TIMEOUT); if (response == null) { logger.error("No response received from '{}'", url); } else { logger.debug("Koubachi returned '{}'", response); List<Map<String, Device>> deviceList = fromJSON(new TypeReference<List<Map<String, Device>>>() { }, response); for (Map<String, Device> element : deviceList) { devices.add(element.get("device")); } } return devices; } /** * Gets the list of all configured Plants from the Koubachi server. * * @return the list of all configured Plants. Is never {@code null}. */ public static List<Plant> getPlants() { List<Plant> plants = new ArrayList<Plant>(); String url = String.format(apiPlantListUrl, credentials, appKey); Properties headers = new Properties(); headers.put("Accept", "application/json"); String response = HttpUtil.executeUrl("GET", url, headers, null, null, HTTP_REQUEST_TIMEOUT); if (response == null) { logger.error("No response received from '{}'", url); } else { logger.debug("Koubachi returned '{}'", response); List<Map<String, Plant>> plantList = fromJSON(new TypeReference<List<Map<String, Plant>>>() { }, response); for (Map<String, Plant> element : plantList) { plants.add(element.get("plant")); } } return plants; } /** * Maps the given {@code jsonString} to {@code type}. * * @param type to type to map the given {@code jsonString} * @param jsonString the content which should be mapped to {@code type} * * @return a new instance of {@code type} with content of {@code jsonString} */ private static <T> T fromJSON(final TypeReference<T> type, final String jsonString) { T data = null; try { data = new ObjectMapper().readValue(jsonString, type); } catch (Exception e) { logger.error("Mapping JSON to '" + type.getType() + "' throws an exception.", e); } return data; } @Override public void updated(Dictionary<String, ?> config) throws ConfigurationException { if (config != null) { String refreshIntervalString = (String) config.get("refresh"); if (StringUtils.isNotBlank(refreshIntervalString)) { refreshInterval = Long.parseLong(refreshIntervalString); } String apiDeviceUrlString = (String) config.get("deviceurl"); if (StringUtils.isNotBlank(apiDeviceUrlString)) { apiDeviceListUrl = apiDeviceUrlString; } String apiPlantUrlString = (String) config.get("planturl"); if (StringUtils.isNotBlank(apiPlantUrlString)) { apiPlantListUrl = apiPlantUrlString; } credentials = (String) config.get("credentials"); if (StringUtils.isBlank(credentials)) { throw new ConfigurationException("koubachi:credentials", "Users' credentials parameter must be set"); } appKey = (String) config.get("appkey"); if (StringUtils.isBlank(appKey)) { throw new ConfigurationException("koubachi:appkey", "AppKey parameter must be set"); } properlyConfigured = true; } } }