Interface XconnectService

  • All Known Implementing Classes:
    XconnectManager

    public interface XconnectService
    VLAN cross connect between exactly two ports.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addOrUpdateXconnect​(org.onosproject.net.DeviceId deviceId, org.onlab.packet.VlanId vlanId, Set<XconnectEndpoint> endpoints)
      Creates or updates Xconnect.
      com.google.common.collect.ImmutableMap<XconnectKey,​Integer> getNext()
      Returns the Xconnect next objective store.
      int getNextId​(org.onosproject.net.DeviceId deviceId, org.onlab.packet.VlanId vlanId)
      Returns Xconnect next objective ID associated with group device + vlan.
      Set<XconnectDesc> getXconnects()
      Gets Xconnects.
      List<org.onlab.packet.VlanId> getXconnectVlans​(org.onosproject.net.DeviceId deviceId, org.onosproject.net.PortNumber port)
      Gives xconnect VLAN of given port of a device.
      boolean hasXconnect​(org.onosproject.net.ConnectPoint cp)
      Check if there is Xconnect configured on given connect point.
      boolean isXconnectVlan​(org.onosproject.net.DeviceId deviceId, org.onlab.packet.VlanId vlanId)
      Checks given VLAN is XConnect VLAN in given device.
      void removeNextId​(int nextId)
      Removes given next ID from Xconnect next objective store.
      void removeXonnect​(org.onosproject.net.DeviceId deviceId, org.onlab.packet.VlanId vlanId)
      Deletes Xconnect.
    • Field Detail

      • XCONNECT_ACL_PRIORITY

        static final int XCONNECT_ACL_PRIORITY
        VLAN cross-connect ACL priority.
        See Also:
        Constant Field Values
      • XCONNECT_PRIORITY

        static final int XCONNECT_PRIORITY
        VLAN cross-connect Bridging priority.
        See Also:
        Constant Field Values
    • Method Detail

      • addOrUpdateXconnect

        void addOrUpdateXconnect​(org.onosproject.net.DeviceId deviceId,
                                 org.onlab.packet.VlanId vlanId,
                                 Set<XconnectEndpoint> endpoints)
        Creates or updates Xconnect.
        Parameters:
        deviceId - device ID
        vlanId - VLAN ID
        endpoints - set of endpoints
      • removeXonnect

        void removeXonnect​(org.onosproject.net.DeviceId deviceId,
                           org.onlab.packet.VlanId vlanId)
        Deletes Xconnect.
        Parameters:
        deviceId - device ID
        vlanId - VLAN ID
      • getXconnects

        Set<XconnectDesc> getXconnects()
        Gets Xconnects.
        Returns:
        set of Xconnect descriptions
      • hasXconnect

        boolean hasXconnect​(org.onosproject.net.ConnectPoint cp)
        Check if there is Xconnect configured on given connect point.
        Parameters:
        cp - connect point
        Returns:
        true if there is Xconnect configured on the connect point
      • getXconnectVlans

        List<org.onlab.packet.VlanId> getXconnectVlans​(org.onosproject.net.DeviceId deviceId,
                                                       org.onosproject.net.PortNumber port)
        Gives xconnect VLAN of given port of a device.
        Parameters:
        deviceId - Device ID
        port - Port number
        Returns:
        true if given VLAN vlanId is XConnect VLAN on device deviceId.
      • isXconnectVlan

        boolean isXconnectVlan​(org.onosproject.net.DeviceId deviceId,
                               org.onlab.packet.VlanId vlanId)
        Checks given VLAN is XConnect VLAN in given device.
        Parameters:
        deviceId - Device ID
        vlanId - VLAN ID
        Returns:
        true if given VLAN vlanId is XConnect VLAN on device deviceId.
      • getNext

        com.google.common.collect.ImmutableMap<XconnectKey,​Integer> getNext()
        Returns the Xconnect next objective store.
        Returns:
        current contents of the xconnectNextObjStore
      • removeNextId

        void removeNextId​(int nextId)
        Removes given next ID from Xconnect next objective store.
        Parameters:
        nextId - next ID
      • getNextId

        int getNextId​(org.onosproject.net.DeviceId deviceId,
                      org.onlab.packet.VlanId vlanId)
        Returns Xconnect next objective ID associated with group device + vlan.
        Parameters:
        deviceId - - Device ID
        vlanId - - VLAN ID
        Returns:
        Current associated group ID