package org.opendaylight.ovsdb.sal.configuration;

import java.util.List;
import java.util.Map;

import org.opendaylight.controller.sal.core.Node;

/**
 * @file IPluginInConfigurationService.java
 *
 */
public interface IPluginInNetworkConfigurationService {

    /**
     * Create a Bridge Domain
     *
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     */
    public boolean createBridgeDomain(Node node, String bridgeIdentifier) throws Throwable;

    /**
     * Delete a Bridge Domain
     *
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     */
    public boolean deleteBridgeDomain(Node node, String bridgeIdentifier);

    /**
     * Returns the configured Bridge Domains
     *
     * @param node Node serving this configuration service
     * @return Bridge Domains
     */
    public List<String> getBridgeDomains(Node node);

    /**
     * add Bridge Domain Configuration
     *
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @param configs Map representation of ConfigName and Configuration Value in Strings.
     */
    public boolean addBridgeDomainConfig(Node node, String bridgeIdentifier, Map <String, String> config);

    /**
     * Delete Bridge Domain Configuration
     *
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @param configs Map representation of ConfigName and Configuration Value in Strings.
     */
    public boolean removeBridgeDomainConfig(Node node, String bridgeIdentifier, Map <String, String> config);

    /**
     * Returns Bridge Domain Configurations
     *
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @return Bridge Domain configurations
     */

    public Map <String, String> getBridgeDomainConfigs(Node node, String bridgeIdentifier);

    /**
     * Create a Bridge Connector
     *
     * @param node Node serving this configuration service
     * @param bridgeConnectorIdentifier String representation of the node connector.
     */
    public boolean createBridgeConnector(Node node, String bridgeConnectorIdentifier);

    /**
     * Delete a Bridge Connector
     *
     * @param node Node serving this configuration service
     * @param bridgeConnectorIdentifier String representation of the node connector.
     */
    public boolean deleteBridgeConnector(Node node, String bridgeConnectorIdentifier);

    /**
     * Add/Associate BridgeConnectors on a given Bridge Domain
     *
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @param bridgeConnectorIdentifier String representation of the node connector.
     */
    public boolean associateBridgeConnector(Node node, String bridgeIdentifier, String bridgeConnectorIdentifier);

    /**
     * Add/Associate BridgeConnectors on a given Bridge Domain
     *
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @param bridgeConnectorIdentifier String representation of the node connector.
     */
    public boolean disassociateBridgeConnector(Node node, String bridgeIdentifier, String bridgeConnectorIdentifier);

    /**
     * add Bridge Connector Configuration
     *
     * @param node Node serving this configuration service
     * @param bridgeConnectorIdentifier String representation of the node connector.
     * @param config Map representation of ConfigName and Configuration Value in Strings.
     */
    public boolean addBridgeConnectorConfig(Node node, String bridgeConnectorIdentifier, Map <String, String> config);

    /**
     * Delete Bridge Connector Configuration
     *
     * @param node Node serving this configuration service
     * @param bridgeConnectorIdentifier String representation of the node connector.
     * @param config Map representation of ConfigName and Configuration Value in Strings.
     */
    public boolean removeBridgeConnectorConfig(Node node, String bridgeConnectorIdentifier, Map <String, String> config);

    /**
     * Returns Bridge Connector Configurations
     *
     * @param node Node serving this configuration service
     * @param bridgeConnectorIdentifier String representation of a Bridge Connector
     * @return Bridge Connector configurations
     */
    public Map <String, String> getBridgeConnectorConfigs(Node node, String bridgeConnectorIdentifier);

    /**
     * Create a Port Attached to a Bridge
     * Ex. ovs-vsctl add-port br0 vif0
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @param portIdentifier String representation of a user defined Port Name
     */
    public boolean addPort(Node node, String bridgeIdentifier, String portIdentifier) throws Throwable;

    /**
     * Create an Encapsulated Tunnel Interface and destination Tunnel Endpoint
     *
     * Ex. ovs-vsctl add-port br0 vxlan1 -- set interface vxlan1 type=vxlan options:remote_ip=192.168.1.11
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @param portIdentifier String representation of a user defined Port Name
     * @param tunnelendpoint IP address of the destination Tunnel Endpoint
     * @param tunencap is the tunnel encapsulation options being CAPWAP, GRE or VXLAN
     * The Bridge must already be defined before calling addTunnel.
     */
    public boolean addTunnel(Node node, String bridgeIdentifier, String portIdentifier,
            String TunnelEndPoint, String TunEncap) throws Throwable;

    /**
     * Create a Port with a user defined VLAN, and attach it to the specified bridge.
     *
     * Ex. ovs-vsctl add-port JUNIT_BRIDGE_TEST Jvlanvif0 tag=100
     * @param node Node serving this configuration service
     * @param bridgeDomainIdentifier String representation of a Bridge Domain
     * @param portIdentifier String representation of a user defined Port Name
     * @param vlanid Integer note: only one VID is accepted with tag=x method
     */
    public boolean addPortVlan(Node node, String bridgeIdentifier, String portIdentifier,
     int vlanid) throws Throwable;

    /**
     * Generic Configuration Event/Command. It is not practically possible to define all the possible combinations
     * of configurations across various plugins. Hence having a generic event/command will help bridge the gap until
     * a more abstracted explicit call is defined in Configuration Service.
     */
    public Object genericConfigurationEvent(Node node, Map <String, String> config);
}