org.onosproject.incubator.net.intf

Interface InterfaceService

All Superinterfaces:

org.onosproject.event.ListenerService<InterfaceEvent,InterfaceListener>

All Known Implementing Classes:

InterfaceManager

@Beta
public interface InterfaceService
extends org.onosproject.event.ListenerService<InterfaceEvent,InterfaceListener>

Service for interacting with interfaces.

Method Summary

Modifier and Type	Method and Description
Interface	getInterfaceByName(org.onosproject.net.ConnectPoint connectPoint, String name) Returns the interface with the given name.
Set<Interface>	getInterfaces() Returns the set of all interfaces in the system.
Set<Interface>	getInterfacesByIp(org.onlab.packet.IpAddress ip) Returns the set of interfaces with the given IP address.
Set<Interface>	getInterfacesByPort(org.onosproject.net.ConnectPoint port) Returns the set of interfaces configured on the given port.
Set<Interface>	getInterfacesByVlan(org.onlab.packet.VlanId vlan) Returns the set of interfaces in the given VLAN.
Interface	getMatchingInterface(org.onlab.packet.IpAddress ip) Returns an interface that has an address that is in the same subnet as the given IP address.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

getInterfaces

Set<Interface> getInterfaces()

Returns the set of all interfaces in the system.

Returns:

set of interfaces

getInterfaceByName

Interface getInterfaceByName(org.onosproject.net.ConnectPoint connectPoint,
                             String name)

Returns the interface with the given name.

Parameters:

connectPoint - connect point of the interface

name - name of the interface

Returns:

interface if it exists, otherwise null

getInterfacesByPort

Set<Interface> getInterfacesByPort(org.onosproject.net.ConnectPoint port)

Returns the set of interfaces configured on the given port.

Parameters:

port - connect point

Returns:

set of interfaces

getInterfacesByIp

Set<Interface> getInterfacesByIp(org.onlab.packet.IpAddress ip)

Returns the set of interfaces with the given IP address.

Parameters:

ip - IP address

Returns:

set of interfaces

getInterfacesByVlan

Set<Interface> getInterfacesByVlan(org.onlab.packet.VlanId vlan)

Returns the set of interfaces in the given VLAN.

Parameters:

vlan - VLAN ID of the interfaces

Returns:

set of interfaces

getMatchingInterface

Interface getMatchingInterface(org.onlab.packet.IpAddress ip)

Returns an interface that has an address that is in the same subnet as the given IP address.

Parameters:

ip - IP address to find matching subnet interface for

Returns:

interface