ChannelBindingProvider.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.tcp;

import java.net.InetSocketAddress;
import java.util.Collection;
import java.util.List;

import org.openhab.core.binding.BindingProvider;
import org.openhab.core.types.Command;
import org.openhab.core.types.State;

/**
 *
 * the ChannelBindingProvider interface is just a "base" interface
 * that ensures us that each binding config somehow defines or captures
 * host:ip information. Obviously, more specialised sub-classes can
 * define additional binding configuration/information as required
 *
 * @author Karel Goderis
 * @since 1.1.0
 *
 */
public interface ChannelBindingProvider extends BindingProvider {

    // return a list of internet socket addresses associated with the given Item, e.g. socket addresses that are used in
    // the configuration strings, regardless of the Command
    public List<InetSocketAddress> getInetSocketAddresses(String itemName);

    // return the internet socket address for the given Item *and* Command
    public InetSocketAddress getInetSocketAddress(String itemName, Command command);

    // return the hostname in the configuration string, for the given Item and Command
    public String getHost(String itemName, Command command);

    // return the portnumber in the configuration string, for the given Item and Command
    public int getPort(String itemName, Command command);

    // return the portnumber, as a String, in the configuration string, for the given Item and Command
    public String getPortAsString(String itemName, Command command);

    // return a collection of all the Items that have host:port in their configuration
    public Collection<String> getItemNames(String host, int port);

    // return a list of all the Commands that are associated with the given Item, given the provided command. This
    // allows implementing Providers
    // to filter and decide which Commands are really 'qualified' for a given Item/Command combination
    public List<Command> getQualifiedCommands(String itemName, Command command);

    // return a list of all the accepted DataTypes for the given Item and Command
    public List<Class<? extends State>> getAcceptedDataTypes(String itemName, Command command);

    // return a list of Commands for the given Item
    public List<Command> getAllCommands(String itemName);

    // return the Direction of the given Item/Command combination
    public Direction getDirection(String itemName, Command command);

}