core/api/src/main/java/org/onosproject/net/behaviour/TunnelConfig.java

/*
 * Copyright 2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.net.behaviour;

import java.util.Collection;

import org.onosproject.net.driver.HandlerBehaviour;

/**
 * Behaviour for handling various drivers for tunnel configuration.
 */
public interface TunnelConfig extends HandlerBehaviour {

    /**
     * Creates a tunnel on this device.
     *
     * @param tunnel tunnel descriptor
     */
    void createTunnel(TunnelDescription tunnel);

    /**
     * Creates a tunnel interface on a given bridge of this device.
     *
     * @param bridgeName bridge name
     * @param tunnel tunnel description
     * @return true if succeeds, false otherwise
     */
    boolean createTunnelInterface(BridgeName bridgeName, TunnelDescription tunnel);

    /**
     * Removes a tunnel on this device.
     *
     * @param tunnel tunnel descriptor
     */
    void removeTunnel(TunnelDescription tunnel);

    /**
     * Updates a tunnel on this device.
     *
     * @param tunnel tunnel descriptor
     */
    void updateTunnel(TunnelDescription tunnel);

    /**
     * Returns tunnels created on this device.
     *
     * @return collection of tunnels
     */
    Collection<TunnelDescription> getTunnels();

}