Package org.onosproject.net.behaviour

Interface BridgeDescription

  • All Superinterfaces:
    Annotated, Description
    All Known Implementing Classes:
    DefaultBridgeDescription
    public interface BridgeDescription
extends Description
    The abstraction of a bridge. Bridge represents an Ethernet switch with no or multiple OpenFlow controllers. Only OVSDB device provides bridge config behavior now and the bridge description is based on OVSDB schema.

    • Method Detail

      • name

        java.lang.String name()
        Returns bridge name.
        Returns:
        bridge name

      • controllers

        java.util.List<ControllerInfo> controllers()
        Returns OpenFlow controllers of the bridge. If it's empty, then no OpenFlow controllers are used for the bridge.
        Returns:
        set of controllers

      • enableLocalController

        boolean enableLocalController()
        Returns whether to use local controller as an OpenFlow controller of the bridge if no controllers are specified.
        Returns:
        true to set local controller, false otherwise

      • failMode

        java.util.Optional<BridgeDescription.FailMode> failMode()
        Returns fail mode of the bridge. If it's not set, the default setting of the bridge is used.
        Returns:
        fail mode

      • datapathId

        java.util.Optional<java.lang.String> datapathId()
        Returns OpenFlow datapath ID of the bridge. Valid only if OpenFlow controller is configured for the bridge.
        Returns:
        datapath id

      • datapathType

        java.util.Optional<java.lang.String> datapathType()
        Returns OVSDB datapath Type of the bridge.
        Returns:
        datapath type

      • deviceId

        java.util.Optional<DeviceId> deviceId()
        Returns OpenFlow device ID. Valid only if OpenFlow controller is configured for the bridge.
        Returns:
        device id

      • disableInBand

        java.util.Optional<java.lang.Boolean> disableInBand()
        Returns in band control is enabled or not. If set to true, disable in-band control on the bridge regardless of controller and manager settings. If it's not set, the default setting of the bridge is used.
        Returns:
        true if in-band is disabled, false if in-band is enabled

      • controlProtocols

        java.util.Optional<java.util.List<ControlProtocolVersion>> controlProtocols()
        Returns list of Control Protocol Versions supported on device.
        Returns:
        List of Control Protocol Versions enabled on bridge