org.opendaylight.controller.hosttracker

Class Entity

java.lang.Object

org.opendaylight.controller.hosttracker.Entity

All Implemented Interfaces:

Comparable<Entity>

public class Entity
extends Object
implements Comparable<Entity>

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. Entities are the most basic element of devices; devices consist of one or more entities. Entities are immutable once created, except for the last seen timestamp.

Author:

readams

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	activeSince The time between activeSince and lastSeenTimestamp is a period of activity for this entity where it was observed repeatedly.
protected static int	ACTIVITY_TIMEOUT Timeout for computing activeSince.
protected Integer	ipv4Address The IP address associated with this entity, or null if no IP learned from the network observation associated with this entity
protected Date	lastSeenTimestamp The last time we observed this entity on the network
protected long	macAddress The MAC address associated with this entity
protected Short	vlan The VLAN tag on this entity, or null if untagged

Constructor Summary

Constructors

Constructor and Description
Entity(long macAddress, Short vlan, Integer ipv4Address, org.opendaylight.controller.sal.core.NodeConnector port, Date lastSeenTimestamp) Create a new entity

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Entity o)
boolean	equals(Object obj)
Date	getActiveSince()
Integer	getIpv4Address()
Date	getLastSeenTimestamp()
long	getMacAddress()
org.opendaylight.controller.sal.core.NodeConnector	getPort()
Short	getVlan()
int	hashCode()
boolean	hasSwitchPort()
void	setActiveSince(Date activeSince)
void	setLastSeenTimestamp(Date lastSeenTimestamp) Set the last seen timestamp and also update activeSince if appropriate
HostNodeConnector	toHostNodeConnector()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ACTIVITY_TIMEOUT

protected static int ACTIVITY_TIMEOUT

Timeout for computing activeSince.

See Also:

Entity#activeSince}

macAddress

protected long macAddress

The MAC address associated with this entity

ipv4Address

protected Integer ipv4Address

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

vlan

protected Short vlan

The VLAN tag on this entity, or null if untagged

lastSeenTimestamp

protected Date lastSeenTimestamp

The last time we observed this entity on the network

activeSince

protected Date activeSince

The time between activeSince and lastSeenTimestamp is a period of activity for this entity where it was observed repeatedly. If, when the entity is observed, the is longer ago than the activity timeout, lastSeenTimestamp and activeSince will be set to the current time.

Constructor Detail

Entity

public Entity(long macAddress,
      Short vlan,
      Integer ipv4Address,
      org.opendaylight.controller.sal.core.NodeConnector port,
      Date lastSeenTimestamp)

Create a new entity

Parameters:

macAddress -

vlan -

ipv4Address -

switchDPID -

switchPort -

lastSeenTimestamp -

Method Detail

getMacAddress

public long getMacAddress()

getIpv4Address

public Integer getIpv4Address()

getVlan

public Short getVlan()

getPort

public org.opendaylight.controller.sal.core.NodeConnector getPort()

hasSwitchPort

public boolean hasSwitchPort()

getLastSeenTimestamp

public Date getLastSeenTimestamp()

setLastSeenTimestamp

public void setLastSeenTimestamp(Date lastSeenTimestamp)

Set the last seen timestamp and also update activeSince if appropriate

Parameters:

lastSeenTimestamp - the new last seen timestamp

See Also:

Entity#activeSince}

getActiveSince

public Date getActiveSince()

setActiveSince

public void setActiveSince(Date activeSince)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toHostNodeConnector

public HostNodeConnector toHostNodeConnector()

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Entity o)

Specified by:

compareTo in interface Comparable<Entity>