A C D E F G H I L M N O P Q R S T V

A

activeSince - Variable in class org.opendaylight.controller.hosttracker.Entity

The time between Entity.activeSince and Entity.lastSeenTimestamp is a period of activity for this entity where it was observed repeatedly.

ACTIVITY_TIMEOUT - Static variable in class org.opendaylight.controller.hosttracker.Entity

Timeout for computing Entity.activeSince.

addIndex(boolean, EnumSet<IDeviceService.DeviceField>) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Create an index over a set of fields.

addListener(IDeviceListener) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Adds a listener to listen for IDeviceManagerServices notifications

addListener(IEntityClassListener) - Method in interface org.opendaylight.controller.hosttracker.IEntityClassifierService

Adds a listener to listen for IEntityClassifierServices notifications

addStaticHost(String, String, NodeConnector, String) - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Hosts can be learned dynamically or added statically.

addSuppressAPs(NodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Specify points in the network where attachment points are not to be learned.

C

classifyEntity(Entity) - Method in interface org.opendaylight.controller.hosttracker.IEntityClassifierService

Classify the given entity into an IEntityClass.

compareTo(Entity) - Method in class org.opendaylight.controller.hosttracker.Entity

D

deviceAdded(IDevice) - Method in interface org.opendaylight.controller.hosttracker.IDeviceListener

Called when a new Device is found

deviceIPV4AddrChanged(IDevice) - Method in interface org.opendaylight.controller.hosttracker.IDeviceListener

Called when a network address has been added or remove from a device

deviceMoved(IDevice) - Method in interface org.opendaylight.controller.hosttracker.IDeviceListener

Called when a Device has moved to a new location on the network.

deviceRemoved(IDevice) - Method in interface org.opendaylight.controller.hosttracker.IDeviceListener

Called when a Device is removed, this typically occurs when the port the Device is attached to goes down, or the switch it is attached to is removed.

deviceUpdate(IDevice, Collection<? extends IDevice>) - Method in interface org.opendaylight.controller.hosttracker.IEntityClassifierService

Once reclassification is complete for a device, this method will be called.

deviceVlanChanged(IDevice) - Method in interface org.opendaylight.controller.hosttracker.IDeviceListener

Called when a VLAN tag for the device has been added or removed

discoverHost(InetAddress) - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Initiates an immediate discovery of the Host for a given IP address.

E

Entity - Class in org.opendaylight.controller.hosttracker

An entity on the network is a visible trace of a device that corresponds to a packet received from a particular interface on the edge of a network, with a particular VLAN tag, and a particular MAC address, along with any other packet characteristics we might want to consider as helpful for disambiguating devices.

Entity(long, Short, Integer, NodeConnector, Date) - Constructor for class org.opendaylight.controller.hosttracker.Entity

Create a new entity

entityClassChanged(Set<String>) - Method in interface org.opendaylight.controller.hosttracker.IEntityClassListener

Process entity classes change event.

equals(Object) - Method in class org.opendaylight.controller.hosttracker.Entity

equals(Object) - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

equals(Object) - Method in class org.opendaylight.controller.hosttracker.SwitchPort

equalsByIP(InetAddress) - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

F

find(InetAddress) - Method in interface org.opendaylight.controller.hosttracker.hostAware.IHostFinder

This method initiates the discovery of a host based on its IP address.

findClassDevice(IEntityClass, long, Short, Integer) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Get a destination device using entity fields that corresponds with the given source device.

findDevice(long, Short, Integer, NodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Search for a device exactly matching the provided device fields.

fromString(String) - Static method in enum org.opendaylight.controller.hosttracker.SwitchPort.ErrorStatus

G

getActiveSince() - Method in class org.opendaylight.controller.hosttracker.Entity

getActiveStaticHosts() - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Returns all the "Active Hosts" learned "Statically" via Northbound APIs.

getAllDevices() - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Get an unmodifiable collection view over all devices currently known.

getAllHosts() - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Returns all the the Hosts either learned dynamically or added statically via Northbound APIs.

getArpSendCountDown() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

getAttachmentPoints() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get all unique attachment points associated with the device.

getAttachmentPoints(boolean) - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get all unique attachment points associated with the device.

getDataLayerAddressBytes() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

getDevice(Long) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Get the device with the given device key.

getDeviceKey() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get the primary key for this device.

getEntityClass() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get the entity class for the device.

getErrorStatus() - Method in class org.opendaylight.controller.hosttracker.SwitchPort

getHostNetworkHierarchy(InetAddress) - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Returns the Network Hierarchy for a given Host.

getInactiveStaticHosts() - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Returns all the "Inactive Hosts" learned "Statically" via Northbound APIs.

getIpv4Address() - Method in class org.opendaylight.controller.hosttracker.Entity

getIPv4Addresses() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get all unique IPv4 addresses associated with the device.

getKeyFields() - Method in interface org.opendaylight.controller.hosttracker.IEntityClass

Return the set of key fields for this entity class.

getKeyFields() - Method in interface org.opendaylight.controller.hosttracker.IEntityClassifierService

Return the most general list of fields that should be used as key fields.

getLastSeen() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get the most recent timestamp for this device

getLastSeenTimestamp() - Method in class org.opendaylight.controller.hosttracker.Entity

getMacAddress() - Method in class org.opendaylight.controller.hosttracker.Entity

getMACAddress() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get the MAC address of the device as a Long value.

getMACAddressString() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get the MAC address of the device as a String value.

getName() - Method in interface org.opendaylight.controller.hosttracker.IEntityClass

Returns a user-friendly, unique name for this EntityClass

getnodeConnector() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

getnodeconnectorNode() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

getnodeconnectornodeId() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

getnodeconnectorportId() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

getOldAP() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get all old attachment points associated with the device. this is used in host movement scenario.

getPort() - Method in class org.opendaylight.controller.hosttracker.Entity

getPort() - Method in class org.opendaylight.controller.hosttracker.SwitchPort

getSuppressAPs() - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

getSwitchPortVlanIds(SwitchPort) - Method in interface org.opendaylight.controller.hosttracker.IDevice

Returns all unique VLAN IDs for the device that were observed on the given switch port

getVlan() - Method in class org.opendaylight.controller.hosttracker.Entity

getVlan() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

getVlanId() - Method in interface org.opendaylight.controller.hosttracker.IDevice

Get all unique VLAN IDs for the device.

H

hashCode() - Method in class org.opendaylight.controller.hosttracker.Entity

hashCode() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

hashCode() - Method in class org.opendaylight.controller.hosttracker.SwitchPort

hasSwitchPort() - Method in class org.opendaylight.controller.hosttracker.Entity

hostFind(InetAddress) - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Applications call this interface methods to determine IP address to MAC binding and its connectivity to an OpenFlow switch in term of Node, Port, and VLAN.

hostListener(HostNodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IfHostListener

Learns new Hosts.

HostNodeConnector - Class in org.opendaylight.controller.hosttracker.hostAware

HostNodeConnector(InetAddress) - Constructor for class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

HostNodeConnector(InetAddress, NodeConnector) - Constructor for class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

HostNodeConnector(byte[], InetAddress, NodeConnector, short) - Constructor for class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

HostNodeConnector(EthernetAddress, InetAddress, NodeConnector, short) - Constructor for class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

hostQuery(InetAddress) - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Checks the local Host Database to see if a Host has been learned for a given IP address.

I

IDevice - Interface in org.opendaylight.controller.hosttracker

Represents an independent device on the network.

IDeviceListener - Interface in org.opendaylight.controller.hosttracker

Implementors of this interface can receive updates from DeviceManager about the state of devices under its control.

IDeviceService - Interface in org.opendaylight.controller.hosttracker

Device manager allows interacting with devices on the network.

IDeviceService.DeviceField - Enum in org.opendaylight.controller.hosttracker

Fields used in devices for indexes and querying

IEntityClass - Interface in org.opendaylight.controller.hosttracker

Entities within an entity class are grouped into Device objects based on the IEntityClass, and the key fields specified by the entity class.

IEntityClassifierService - Interface in org.opendaylight.controller.hosttracker

A component that wishes to participate in entity classification needs to implement the IEntityClassifier interface, and register with the Device Manager as an entity classifier.

IEntityClassListener - Interface in org.opendaylight.controller.hosttracker

Implementors of this interface can receive updates from the Entity Classifier about the changes to entity Classes.

IfHostListener - Interface in org.opendaylight.controller.hosttracker

This interface defines the method to notify detected Host on the network.

IfIptoHost - Interface in org.opendaylight.controller.hosttracker

This interface defines the methods to retrieve information about learned Hosts.

IfNewHostNotify - Interface in org.opendaylight.controller.hosttracker

This Interface defines the methods for client applications of Host Tracker to get notifications when a new host is learned or existing host is removed from the network.

IHostFinder - Interface in org.opendaylight.controller.hosttracker.hostAware

This Interface defines the methods to trigger the discovery of a Host and to probe if a learned Host is still in the network.

initArpSendCountDown() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

ipv4Address - Variable in class org.opendaylight.controller.hosttracker.Entity

The IP address associated with this entity, or null if no IP learned from the network observation associated with this entity

isRewriteEnabled() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

isStaticHost() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

isStaticHost() - Method in interface org.opendaylight.controller.hosttracker.IDevice

isV4Host() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

isV6Host() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

L

lastSeenTimestamp - Variable in class org.opendaylight.controller.hosttracker.Entity

The last time we observed this entity on the network

M

macAddress - Variable in class org.opendaylight.controller.hosttracker.Entity

The MAC address associated with this entity

N

notifyHTClient(HostNodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IfNewHostNotify

Notifies the HostTracker Clients that a new Host has been learned

notifyHTClientHostRemoved(HostNodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IfNewHostNotify

Notifies the HostTracker Clients that a Host which was learned in the past has been removed either due to switch/port down event or due to ARP Aging

O

org.opendaylight.controller.hosttracker - package org.opendaylight.controller.hosttracker

org.opendaylight.controller.hosttracker.hostAware - package org.opendaylight.controller.hosttracker.hostAware

P

probe(HostNodeConnector) - Method in interface org.opendaylight.controller.hosttracker.hostAware.IHostFinder

This method is called by HostTracker to see if a learned Host is still in the network.

Q

queryClassDevices(IEntityClass, Long, Short, Integer, NodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Find devices that match the provided query.

queryDevices(Long, Short, Integer, NodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

Find devices that match the provided query.

R

reclassifyEntity(IDevice, Entity) - Method in interface org.opendaylight.controller.hosttracker.IEntityClassifierService

Reclassify the given entity into a class.

removeStaticHost(String) - Method in interface org.opendaylight.controller.hosttracker.IfIptoHost

Allows the deletion of statically learned Host

removeSuppressAPs(NodeConnector) - Method in interface org.opendaylight.controller.hosttracker.IDeviceService

S

setActiveSince(Date) - Method in class org.opendaylight.controller.hosttracker.Entity

setArpSendCountDown(short) - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

setLastSeenTimestamp(Date) - Method in class org.opendaylight.controller.hosttracker.Entity

Set the last seen timestamp and also update Entity.activeSince if appropriate

setStaticHost(boolean) - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

setStaticHost(boolean) - Method in interface org.opendaylight.controller.hosttracker.IDevice

SwitchPort - Class in org.opendaylight.controller.hosttracker

A simple switch DPID/port pair This class is immutable

SwitchPort(NodeConnector, SwitchPort.ErrorStatus) - Constructor for class org.opendaylight.controller.hosttracker.SwitchPort

Simple constructor

SwitchPort(NodeConnector) - Constructor for class org.opendaylight.controller.hosttracker.SwitchPort

Simple constructor

SwitchPort.ErrorStatus - Enum in org.opendaylight.controller.hosttracker

T

toHostNodeConnector() - Method in class org.opendaylight.controller.hosttracker.Entity

toHostNodeConnector() - Method in interface org.opendaylight.controller.hosttracker.IDevice

toJson() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

toString() - Method in class org.opendaylight.controller.hosttracker.Entity

toString() - Method in class org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector

toString() - Method in enum org.opendaylight.controller.hosttracker.SwitchPort.ErrorStatus

toString() - Method in class org.opendaylight.controller.hosttracker.SwitchPort

V

valueOf(String) - Static method in enum org.opendaylight.controller.hosttracker.IDeviceService.DeviceField

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.opendaylight.controller.hosttracker.SwitchPort.ErrorStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.opendaylight.controller.hosttracker.IDeviceService.DeviceField

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.opendaylight.controller.hosttracker.SwitchPort.ErrorStatus

Returns an array containing the constants of this enum type, in the order they are declared.

vlan - Variable in class org.opendaylight.controller.hosttracker.Entity

The VLAN tag on this entity, or null if untagged

A C D E F G H I L M N O P Q R S T V