HueGenericBindingProvider.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.hue.internal;

import java.util.ArrayList;
import java.util.List;

import org.openhab.binding.hue.HueBindingProvider;
import org.openhab.binding.hue.internal.HueBindingConfig.BindingType;
import org.openhab.core.binding.BindingConfig;
import org.openhab.core.items.Item;
import org.openhab.core.library.items.ColorItem;
import org.openhab.core.library.items.DimmerItem;
import org.openhab.core.library.items.SwitchItem;
import org.openhab.model.item.binding.AbstractGenericBindingProvider;
import org.openhab.model.item.binding.BindingConfigParseException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * <p>
 * This class can parse information from the generic binding format. It
 * registers as a {@link HueBindingProvider} service as well.
 * </p>
 *
 * <p>
 * Here are some examples for valid binding configuration strings:
 * <ul>
 * <li><code>{hue="1"}</code> - Connects to bulb 1 and switches the bulb without
 * changing the color or brightness.</li>
 * <li>
 * <code>{hue="1;brightness"} - Connects to bulb 1 and dims the bulbs brightness without changing the color. The step size set to default (25).</code>
 * </li>
 * <li>
 * <code>{hue="1;brightness;30"} - Connects to bulb 1 and dims the bulbs brightness without changing the color. The step size is set to 30.</code>
 * </li>
 * <li>
 * <code>{hue="1;colorTemperature"} - Connects to bulb 1 and dims the bulbs color temperature without changing the brightness. The step size set to default (25).</code>
 * </li>
 * <li>
 * <code>{hue="1;colorTemperature;30"} - Connects to bulb 1 and dims the bulbs color temperature without changing the brightness. The step size is set to 30.</code>
 * </li>
 * </ul>
 *
 * @author Roman Hartmann
 * @author Jos Schering
 * @since 1.2.0
 */
public class HueGenericBindingProvider extends AbstractGenericBindingProvider implements HueBindingProvider {

    static final Logger logger = LoggerFactory.getLogger(HueGenericBindingProvider.class);

    @Override
    public String getBindingType() {
        return "hue";
    }

    @Override
    public void validateItemType(Item item, String bindingConfig) throws BindingConfigParseException {

        if (!(item instanceof SwitchItem || item instanceof DimmerItem)) {
            throw new BindingConfigParseException("Item '" + item.getName() + "' is of type '"
                    + item.getClass().getSimpleName()
                    + "', only SwitchItems, DimmerItems and ColorItems are allowed - please check your *.items configuration");
        }

    }

    @Override
    public void processBindingConfiguration(String context, Item item, String bindingConfig)
            throws BindingConfigParseException {

        super.processBindingConfiguration(context, item, bindingConfig);

        try {

            if (bindingConfig != null) {

                String[] configParts = bindingConfig.split(";");

                if (item instanceof ColorItem) {
                    BindingConfig hueBindingConfig = new HueBindingConfig(configParts[0], BindingType.rgb.name(), null);
                    addBindingConfig(item, hueBindingConfig);
                } else if (item instanceof DimmerItem) {
                    BindingConfig hueBindingConfig = new HueBindingConfig(configParts[0],
                            configParts.length < 2 ? null : configParts[1],
                            configParts.length < 3 ? null : configParts[2]);
                    addBindingConfig(item, hueBindingConfig);
                } else if (item instanceof SwitchItem) {
                    BindingConfig hueBindingConfig = new HueBindingConfig(configParts[0], BindingType.switching.name(),
                            null);
                    addBindingConfig(item, hueBindingConfig);
                }

            } else {
                logger.warn("bindingConfig is NULL (item=" + item + ") -> processing bindingConfig aborted!");
            }
        } catch (ArrayIndexOutOfBoundsException e) {
            logger.warn("bindingConfig is invalid (item=" + item + ") -> processing bindingConfig aborted!");
        }

    }

    @Override
    public HueBindingConfig getItemConfig(String itemName) {
        return (HueBindingConfig) bindingConfigs.get(itemName);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List<String> getInBindingItemNames() {
        List<String> inBindings = new ArrayList<String>();
        for (String itemName : bindingConfigs.keySet()) {
            inBindings.add(itemName);
        }
        return inBindings;
    }
}