etri.sdn.controller.module.devicemanager

Class Entity

java.lang.Object

etri.sdn.controller.module.devicemanager.Entity

All Implemented Interfaces:

java.lang.Comparable<Entity>

public class Entity
extends java.lang.Object
implements java.lang.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 java.util.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
private int	hashCode
protected java.lang.Integer	ipv4Address The IP address associated with this entity, or null if no IP learned from the network observation associated with this entity
protected java.util.Date	lastSeenTimestamp The last time we observed this entity on the network
protected long	macAddress The MAC address associated with this entity
protected java.lang.Long	switchDPID The dpid of the switch for the ingress point for this entity, or null if not present
protected java.lang.Integer	switchPort The port number of the switch for the ingress point for this entity, or null if not present
protected java.lang.Short	vlan The VLAN tag on this entity, or null if untagged

Constructor Summary

Constructors

Constructor and Description
Entity(long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort, java.util.Date lastSeenTimestamp) Creates a new entity.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Entity o)
boolean	equals(java.lang.Object obj)
java.util.Date	getActiveSince() Returns timestamp from when this entity is activated.
java.lang.Integer	getIpv4Address() Returns the IP address.
java.util.Date	getLastSeenTimestamp() Returns the recent last seen timestamp.
long	getMacAddress() Returns the MAC address.
java.lang.Long	getSwitchDPID() Returns the switch dpid.
java.lang.Integer	getSwitchPort() Returns the switch port.
java.lang.Short	getVlan() Returns the VLAN ID.
int	hashCode()
void	setActiveSince(java.util.Date activeSince) Sets the activation timestamps
void	setLastSeenTimestamp(java.util.Date lastSeenTimestamp) Sets the last seen timestamp and also update activeSince if appropriate
java.lang.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

macAddress

protected long macAddress

The MAC address associated with this entity

ipv4Address

protected java.lang.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 java.lang.Short vlan

The VLAN tag on this entity, or null if untagged

switchDPID

protected java.lang.Long switchDPID

The dpid of the switch for the ingress point for this entity, or null if not present

switchPort

protected java.lang.Integer switchPort

The port number of the switch for the ingress point for this entity, or null if not present

lastSeenTimestamp

protected java.util.Date lastSeenTimestamp

The last time we observed this entity on the network

activeSince

protected java.util.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.

hashCode

private int hashCode

Constructor Detail

Entity

public Entity(long macAddress,
      java.lang.Short vlan,
      java.lang.Integer ipv4Address,
      java.lang.Long switchDPID,
      java.lang.Integer switchPort,
      java.util.Date lastSeenTimestamp)

Creates a new entity.

Parameters:

macAddress - the MAC address

vlan - the VLAN ID

ipv4Address - the IP address

switchDPID - the switch dpid

switchPort - the switch port

lastSeenTimestamp - the recent timestamp

Method Detail

getMacAddress

public long getMacAddress()

Returns the MAC address.

Returns:

the MAC address

getIpv4Address

public java.lang.Integer getIpv4Address()

Returns the IP address.

Returns:

the IP address

getVlan

public java.lang.Short getVlan()

Returns the VLAN ID.

Returns:

the VLAN ID

getSwitchDPID

public java.lang.Long getSwitchDPID()

Returns the switch dpid.

Returns:

the switch dpid

getSwitchPort

public java.lang.Integer getSwitchPort()

Returns the switch port.

Returns:

the switch port

getLastSeenTimestamp

public java.util.Date getLastSeenTimestamp()

Returns the recent last seen timestamp.

Returns:

the recent last seen timestamp

setLastSeenTimestamp

public void setLastSeenTimestamp(java.util.Date lastSeenTimestamp)

Sets the last seen timestamp and also update activeSince if appropriate

Parameters:

lastSeenTimestamp - the new last seen timestamp

See Also:

activeSince

getActiveSince

public java.util.Date getActiveSince()

Returns timestamp from when this entity is activated.

Returns:

the activation timestamp

setActiveSince

public void setActiveSince(java.util.Date activeSince)

Sets the activation timestamps

Parameters:

activeSince - the activation timestamp

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Entity o)

Specified by:

compareTo in interface java.lang.Comparable<Entity>