HomematicConfig.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.homematic.internal.common;

import java.util.Dictionary;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.openhab.binding.homematic.internal.model.HmInterface;
import org.openhab.binding.homematic.internal.util.LocalNetworkInterface;
import org.osgi.service.cm.ConfigurationException;

/**
 * Parses the config in openhab.cfg.
 *
 * <pre>
 * ############################## Homematic Binding ##############################
 * #
 * # Hostname / IP address of the Homematic CCU or Homegear server
 * homematic:host=
 *
 * # The timeout in seconds for connections to a slower CCU (optional, default is 15)
 * # If you have a CCU1 with many devices, you may get a read time out exception.
 * # Increase this timeout to give the CCU1 more time to respond.
 * # homematic:host.timeout=
 *
 * # Hostname / IP address for the callback server (optional, default is auto-discovery)
 * # This is normally the IP / hostname of the local host (but not "localhost" or "127.0.0.1").
 * # homematic:callback.host=
 *
 * # Port number for the callback server. (optional, default is 9123)
 * # homematic:callback.port=
 *
 * # The interval in seconds to check if the communication with the Homematic server is still alive.
 * # If no message receives from the Homematic server, the binding restarts. (optional, default is 300)
 * # homematic:alive.interval=
 *
 * # The interval in seconds to reconnect to the Homematic server (optional, default is disabled)
 * # If you have no sensors which sends messages in regular intervals and/or you have low communication,
 * # the alive.interval may restart the connection to the Homematic server to often.
 * # The reconnect.interval disables the alive.interval and reconnects after a fixed period in time.
 * # Think in hours when configuring (one hour = 3600)
 * # homematic:reconnect.interval=
 * </pre>
 *
 * @author Gerhard Riegler
 * @since 1.5.0
 */
public class HomematicConfig {
    private static final String CONFIG_KEY_HOMEMATIC_HOST = "host";
    private static final String CONFIG_KEY_HOMEMATIC_HOST_TIMEOUT = "host.timeout";
    private static final String CONFIG_KEY_CALLBACK_HOST = "callback.host";
    private static final String CONFIG_KEY_CALLBACK_PORT = "callback.port";
    private static final String CONFIG_KEY_ALIVE_INTERVAL = "alive.interval";
    private static final String CONFIG_KEY_RECONNECT_INTERVAL = "reconnect.interval";

    private static final Integer DEFAULT_CALLBACK_PORT = 9123;
    private static final int DEFAULT_ALIVE_INTERVAL = 300;
    private static final int DEFAULT_HOST_TIMEOUT = 15;

    private boolean valid;
    private String host;
    private Integer timeout;
    private String callbackHost;
    private Integer callbackPort;
    private Integer aliveInterval;
    private Integer reconnectInterval;

    /**
     * Parses and validates the properties in the openhab.cfg.
     */
    public void parse(Dictionary<String, ?> properties) throws ConfigurationException {
        valid = false;

        host = (String) properties.get(CONFIG_KEY_HOMEMATIC_HOST);
        if (StringUtils.isBlank(host)) {
            throw new ConfigurationException("homematic",
                    "Parameter host is mandatory and must be configured. Please check your openhab.cfg!");
        }

        timeout = parseInt(properties, CONFIG_KEY_HOMEMATIC_HOST_TIMEOUT, DEFAULT_HOST_TIMEOUT);

        callbackHost = (String) properties.get(CONFIG_KEY_CALLBACK_HOST);
        if (StringUtils.isBlank(callbackHost)) {
            callbackHost = LocalNetworkInterface.getLocalNetworkInterface();
        }

        callbackPort = parseInt(properties, CONFIG_KEY_CALLBACK_PORT, DEFAULT_CALLBACK_PORT);
        aliveInterval = parseInt(properties, CONFIG_KEY_ALIVE_INTERVAL, DEFAULT_ALIVE_INTERVAL);
        reconnectInterval = parseInt(properties, CONFIG_KEY_RECONNECT_INTERVAL, null);
        valid = true;
    }

    /**
     * Parses a integer property.
     */
    private Integer parseInt(Dictionary<String, ?> properties, String key, Integer defaultValue)
            throws ConfigurationException {
        String value = (String) properties.get(key);
        if (StringUtils.isNotBlank(value)) {
            try {
                return Integer.parseInt(value);
            } catch (NumberFormatException ex) {
                throw new ConfigurationException("homematic",
                        "Parameter " + key + " in wrong format. Please check your openhab.cfg!");
            }

        } else {
            return defaultValue;
        }
    }

    /**
     * Returns the Homematic server host.
     */
    public String getHost() {
        return host;
    }

    /**
     * Returns the timeout connecting to a Homematic server host.
     */
    public Integer getTimeout() {
        return timeout;
    }

    /**
     * Returns the callback host.
     */
    public String getCallbackHost() {
        return callbackHost;
    }

    /**
     * Returns the callback port.
     */
    public Integer getCallbackPort() {
        return callbackPort;
    }

    /**
     * Returns the alive interval.
     */
    public Integer getAliveInterval() {
        return aliveInterval;
    }

    /**
     * Returns the reconnect interval.
     */
    public Integer getReconnectInterval() {
        return reconnectInterval;
    }

    /**
     * Returns true if this config is valid.
     */
    public boolean isValid() {
        return valid;
    }

    /**
     * Returns the BIN-RPC url.
     */
    public String getBinRpcCallbackUrl() {
        return "binary://" + callbackHost + ":" + callbackPort;
    }

    /**
     * Returns the TclRegaScript url.
     */
    public String getTclRegaUrl() {
        return "http://" + host + ":" + HmInterface.TCL.getPort() + "/tclrega.exe";
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE).append("host", host)
                .append("timeout", timeout).append("callbackHost", callbackHost).append("callbackPort", callbackPort)
                .append("aliveInterval", reconnectInterval == null ? aliveInterval : "disabled")
                .append("reconnectInterval", reconnectInterval == null ? "disabled" : reconnectInterval).toString();
    }
}