apps/l3vpn/src/main/java/org/onosproject/l3vpn/netl3vpn/DeviceInfo.java

/*
 * Copyright 2017-present Open Networking Foundation
 *
 * 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.l3vpn.netl3vpn;

import org.onosproject.net.DeviceId;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
import org.onosproject.yang.model.ModelObjectData;

import java.util.LinkedList;
import java.util.List;

/**
 * Representation of standard device model, with interface, instance and its
 * respective device id.
 */
public class DeviceInfo {

    /**
     * Device id of the device.
     */
    private final DeviceId deviceId;

    /**
     * Type of the VPN.
     */
    private final VpnType type;

    /**
     * BGP information of the device.
     */
    private BgpInfo bgpInfo;

    /**
     * List of interface names of the device.
     */
    private List<String> ifNames;

    /**
     * List of network access of the device.
     */
    private List<AccessInfo> accesses;

    /**
     * List of tunnel names belonging to the device.
     */
    private List<String> tnlNames;

    /**
     * Status of tunnel policy being created for this device in this VPN.
     */
    private boolean isTnlPolCreated;

    /**
     * Constructs device info with a device id and VPN type.
     *
     * @param d device id
     * @param t VPN type
     */
    public DeviceInfo(DeviceId d, VpnType t) {
        deviceId = d;
        type = t;
    }

    /**
     * Returns the device id.
     *
     * @return device id
     */
    public DeviceId deviceId() {
        return deviceId;
    }

    /**
     * Returns the type of the VPN instance.
     *
     * @return VPN type
     */
    public VpnType type() {
        return type;
    }

    /**
     * Adds a interface name to the list.
     *
     * @param ifName interface name
     */
    public void addIfName(String ifName) {
        if (ifNames == null) {
            ifNames = new LinkedList<>();
        }
        ifNames.add(ifName);
    }

    /**
     * Returns the list of interface name.
     *
     * @return interface names
     */
    public List<String> ifNames() {
        return ifNames;
    }

    /**
     * Sets the list of interface name.
     *
     * @param ifNames interface names
     */
    public void ifNames(List<String> ifNames) {
        this.ifNames = ifNames;
    }

    /***
     * Returns the list of tunnel names.
     *
     * @return tunnel names
     */
    public List<String> tnlNames() {
        return tnlNames;
    }

    /**
     * Sets the list of tunnel names.
     *
     * @param tnlNames tunnel names
     */
    public void tnlNames(List<String> tnlNames) {
        this.tnlNames = tnlNames;
    }

    /**
     * Adds a tunnel name to the list.
     *
     * @param tnlName tunnel name
     */
    public void addTnlName(String tnlName) {
        if (tnlNames == null) {
            tnlNames = new LinkedList<>();
        }
        tnlNames.add(tnlName);
    }

    /**
     * Returns true if tunnel policy is created for this device in this VPN;
     * false otherwise.
     *
     * @return true if tunnel policy is created; false otherwise
     */
    public boolean isTnlPolCreated() {
        return isTnlPolCreated;
    }

    /**
     * Sets true if tunnel policy is created for this device in this VPN;
     * false otherwise.
     *
     * @param tnlPolCreated status of tunnel policy creation
     */
    public void setTnlPolCreated(boolean tnlPolCreated) {
        isTnlPolCreated = tnlPolCreated;
    }

    /**
     * Returns the BGP information.
     *
     * @return BGP info
     */
    public BgpInfo bgpInfo() {
        return bgpInfo;
    }

    /**
     * Sets the BGP information.
     *
     * @param bgpInfo BGP info
     */
    public void bgpInfo(BgpInfo bgpInfo) {
        this.bgpInfo = bgpInfo;
    }

    /**
     * Returns the list of network accesses.
     *
     * @return network accesses
     */
    public List<AccessInfo> accesses() {
        return accesses;
    }

    /**
     * Sets the list of network accesses.
     *
     * @param accesses network accesses
     */
    public void accesses(List<AccessInfo> accesses) {
        this.accesses = accesses;
    }

    /**
     * Adds a access info to the network accesses list.
     *
     * @param accessInfo access info
     */
    public void addAccessInfo(AccessInfo accessInfo) {
        if (accesses == null) {
            accesses = new LinkedList<>();
        }
        accesses.add(accessInfo);
    }

    /**
     * Processes the creation of VPN instance to the driver with the model
     * object data of standard device model. It returns the VPN instance of
     * driver constructed model object data.
     *
     * @param driverSvc driver service
     * @param modelData std device model object data
     * @return driver instance model object data
     */
    public ModelObjectData processCreateInstance(DriverService driverSvc,
                                                 ModelObjectData modelData) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.createInstance(modelData);
    }

    /**
     * Processes the creation of interface to the driver with the model
     * object data of standard device model. It returns the interface of driver
     * constructed model object data.
     *
     * @param driverSvc driver service
     * @param modData   std device model object data
     * @return driver interface model object data
     */
    public ModelObjectData processCreateInterface(DriverService driverSvc,
                                                  ModelObjectData modData) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.bindInterface(modData);
    }

    /**
     * Processes the creation of BGP info to the driver with the BGP info and
     * the BGP driver configuration. It returns the BGP info of driver
     * constructed model object data.
     *
     * @param driverSvc  driver service
     * @param bgpInfo    BGP info
     * @param driverInfo driver config details
     * @return driver BGP model object data
     */
    public ModelObjectData processCreateBgpInfo(DriverService driverSvc,
                                                BgpInfo bgpInfo,
                                                BgpDriverInfo driverInfo) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.createBgpInfo(bgpInfo, driverInfo);
    }

    /**
     * Processes the creation of tunnel tree from the devices and device
     * level. It returns the tunnel info with devices and device of driver
     * constructed model object data.
     *
     * @param driverSvc driver service
     * @param tnlInfo   tunnel info
     * @return driver model object data of tunnel info with devices and device
     */
    public ModelObjectData processCreateTnlDev(DriverService driverSvc,
                                               TunnelInfo tnlInfo) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.createTnlDev(tnlInfo);
    }

    /**
     * Processes the creation of tunnel policy in the tree from the tunnel
     * manager or tunnel policy level. It returns the tunnel info with
     * tunnel policy level of driver constructed model object data.
     *
     * @param driverSvc driver service
     * @param tnlInfo   tunnel info
     * @return driver model object data of tunnel info with tunnel policy
     */
    public ModelObjectData processCreateTnlPol(DriverService driverSvc,
                                               TunnelInfo tnlInfo) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.createTnlPol(tnlInfo);
    }

    /**
     * Processes the creation of tunnel in the tree from the tunnel next hops
     * or only tunnel next hop. It returns the tunnel info with tunnel level
     * of driver constructed model object data
     *
     * @param driverSvc driver service
     * @param tnlInfo   tunnel info
     * @return driver model object data of tunnel info with tunnel
     */
    public ModelObjectData processCreateTnl(DriverService driverSvc,
                                            TunnelInfo tnlInfo) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.createTnl(tnlInfo);
    }

    /**
     * Processes the binding of tunnel policy to the VPN instance. It returns
     * the VPN instance with tunnel policy of driver constructed model object
     * data.
     *
     * @param driverSvc driver service
     * @param tnlInfo   tunnel info
     * @return driver model object data of VPN instance with tunnel
     */
    public ModelObjectData processBindTnl(DriverService driverSvc,
                                          TunnelInfo tnlInfo) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.bindTnl(tnlInfo);
    }

    /**
     * Processes the deletion of VPN instance to the driver with the model
     * object data of standard device model. It returns the VPN instance of
     * driver constructed model object data.
     *
     * @param driverSvc driver service
     * @param modData   model object data
     * @return driver instance model object data
     */
    public ModelObjectData processDeleteInstance(DriverService driverSvc,
                                                 ModelObjectData modData) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.deleteInstance(modData);
    }

    /**
     * Processes the deletion of interface to the driver with the model
     * object data of standard device model. It returns the interface of driver
     * constructed model object data.
     *
     * @param driverSvc  driver service
     * @param objectData model object data
     * @return driver interface model object data
     */
    public ModelObjectData processDeleteInterface(DriverService driverSvc,
                                                  ModelObjectData objectData) {
        // TODO: Need to call the behaviour.
        return null;
    }

    /**
     * Processes the deletion of BGP info to the driver with the BGP info and
     * the BGP driver configuration. It returns the BGP info of driver
     * constructed model object data.
     *
     * @param driverSvc  driver service
     * @param bgpInfo    BGP info
     * @param driverInfo driver config details
     * @return driver BGP model object data
     */
    public ModelObjectData processDeleteBgpInfo(DriverService driverSvc,
                                                BgpInfo bgpInfo,
                                                BgpDriverInfo driverInfo) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.deleteBgpInfo(bgpInfo, driverInfo);
    }

    /**
     * Processes the deletion of tunnel info according to the levels it has
     * to be deleted. It returns the tunnel info of driver constructed model
     * object data.
     *
     * @param driverSvc driver service
     * @param tnlInfo   tunnel info
     * @return driver tunnel info model object data
     */
    public ModelObjectData processDeleteTnl(DriverService driverSvc,
                                            TunnelInfo tnlInfo) {
        L3VpnConfig config = getL3VpnConfig(driverSvc);
        return config.deleteTnl(tnlInfo);
    }

    /**
     * Returns the L3VPN config instance from the behaviour.
     *
     * @param driverSvc driver service
     * @return L3VPN config
     */
    private L3VpnConfig getL3VpnConfig(DriverService driverSvc) {
        DriverHandler handler = driverSvc.createHandler(deviceId);
        return handler.behaviour(L3VpnConfig.class);
    }
}