Package org.onosproject.vpls.api

Interface Vpls

  • All Known Implementing Classes:
    VplsManager
    public interface Vpls

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addInterface​(VplsData vplsData, org.onosproject.net.intf.Interface iface)
      Adds a network interface to a VPLS.
      void addInterfaces​(VplsData vplsData, java.util.Collection<org.onosproject.net.intf.Interface> interfaces)
      Adds network interfaces to a VPLS.
      VplsData createVpls​(java.lang.String vplsName, org.onosproject.net.EncapsulationType encapsulationType)
      Creates a new VPLS.
      java.util.Collection<VplsData> getAllVpls()
      Gets all VPLSs.
      VplsData getVpls​(java.lang.String vplsName)
      Retrieves a VPLS.
      void removeAllVpls()
      Removes all VPLSs and cleans up the VPLS configuration.
      org.onosproject.net.intf.Interface removeInterface​(VplsData vplsData, org.onosproject.net.intf.Interface iface)
      Removes the interface specified from a VPLS.
      java.util.Collection<org.onosproject.net.intf.Interface> removeInterfaces​(VplsData vplsData, java.util.Collection<org.onosproject.net.intf.Interface> interfaces)
      Removes the interfaces specified from a VPLS.
      VplsData removeVpls​(VplsData vplsData)
      Removes a VPLS.
      void setEncapsulationType​(VplsData vplsData, org.onosproject.net.EncapsulationType encapsulationType)
      Sets an encapsulation type for a VPLS.

    • Method Detail

      • createVpls

        VplsData createVpls​(java.lang.String vplsName,
                    org.onosproject.net.EncapsulationType encapsulationType)
        Creates a new VPLS.
        Parameters:
        vplsName - the name of the VPLS
        encapsulationType - the encapsulation type
        Returns:
        a VPLS instance if the operation is successful; null otherwise

      • removeVpls

        VplsData removeVpls​(VplsData vplsData)
        Removes a VPLS.
        Parameters:
        vplsData - the VPLS to be removed
        Returns:
        the VPLS removed if the operation is successful; null otherwise

      • addInterfaces

        void addInterfaces​(VplsData vplsData,
                   java.util.Collection<org.onosproject.net.intf.Interface> interfaces)
        Adds network interfaces to a VPLS.
        Parameters:
        vplsData - the VPLS to which the interfaces have to be added to
        interfaces - the interfaces to add

      • addInterface

        void addInterface​(VplsData vplsData,
                  org.onosproject.net.intf.Interface iface)
        Adds a network interface to a VPLS.
        Parameters:
        vplsData - the VPLS to which the interface has to be added to
        iface - the interface to add

      • setEncapsulationType

        void setEncapsulationType​(VplsData vplsData,
                          org.onosproject.net.EncapsulationType encapsulationType)
        Sets an encapsulation type for a VPLS.
        Parameters:
        vplsData - the VPLS for which the encapsulation has to be set
        encapsulationType - the encapsulation type

      • getVpls

        VplsData getVpls​(java.lang.String vplsName)
        Retrieves a VPLS.
        Parameters:
        vplsName - the name of the VPLS
        Returns:
        the VPLS instance if the VPLS exists; null otherwise

      • getAllVpls

        java.util.Collection<VplsData> getAllVpls()
        Gets all VPLSs.
        Returns:
        a collection of VPLSs

      • removeInterfaces

        java.util.Collection<org.onosproject.net.intf.Interface> removeInterfaces​(VplsData vplsData,
                                                                          java.util.Collection<org.onosproject.net.intf.Interface> interfaces)
        Removes the interfaces specified from a VPLS.
        Parameters:
        vplsData - the VPLS from which the interfaces are to be removed
        interfaces - the interfaces to remove
        Returns:
        the interfaces removed

      • removeInterface

        org.onosproject.net.intf.Interface removeInterface​(VplsData vplsData,
                                                   org.onosproject.net.intf.Interface iface)
        Removes the interface specified from a VPLS.
        Parameters:
        vplsData - the VPLS from which the interface is to be removed
        iface - the interface to remove
        Returns:
        the interface removed

      • removeAllVpls

        void removeAllVpls()
        Removes all VPLSs and cleans up the VPLS configuration.