datastructure

Class Flow

java.lang.Object

datastructure.Flow

public class Flow
extends java.lang.Object

The class Flow represents a network flow based on 5-tuple:
- local IP address
- remote IP address
- local transport layer port
- remote transport layer port
- transport layer protocol

Author:

Jacob Honoré Broberg, Kartheepan Balachandran (kba@es.aau.dk), Tomasz Bujlow (tbu@es.aau.dk)

Field Summary

Fields

Modifier and Type	Field and Description
private long	flowEndTime Timestamp of end of the flow.
private int	flowID Identifier of the flow.
private long	flowStartTime Timestamp of start of the flow.
private long	lastUpdatedTime Timestamp showing when the flow was updated last time.
private java.util.ArrayList<CapturedPacket>	listOfPackets List of packets assigned to the flow.
private java.lang.String	localIP Local IP address of the flow.
private int	localPort Local transport layer port of the flow.
private static org.apache.log4j.Logger	log Used to log different events.
private static int	MAX_NO_PACKETS Maximum number of packets in flow.
private java.lang.String	protocolName Transport layer protocol name of the flow.
private java.lang.String	remoteIP Remote IP address of the flow.
private int	remotePort Remote transport layer port of the flow.
private java.lang.String	socketAppName Application name taken from system socket associated with the flow.

Constructor Summary

Constructors

Constructor and Description
Flow(CapturedPacket newCapturedPacket) Constructs the object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addPacket(CapturedPacket newCapturedPacket) Adds packet to the flow.
long	getFlowEndTime() Gets end time of the flow.
int	getFlowID() Gets the identifier of the flow.
long	getFlowStartTime() Gets start time of the flow.
long	getLastUpdatedTime() Sets timestamp when the flow was updated last time.
java.lang.String	getLocalIP() Gets local IP address of the flow.
int	getLocalPort() Gets local transport layer port of the flow.
int	getNoPackets() Gets number of packets associated with this flow.
java.util.ArrayList<CapturedPacket>	getPackets() Gets all the packets associated with the flow.
java.lang.String	getProtocolName() Gets transport layer protocol name.
java.lang.String	getRemoteIP() Gets remote IP address of the flow.
int	getRemotePort() Gets remote transport layer port of the flow.
java.lang.String	getSocketAppName() Gets application name associated with the flow.
void	setFlowEndTime(long flowEndTime) Sets end time of the flow.
private void	setFlowID(int flowID) Sets identifier of the flow.
void	setFlowStartTime(long flowStartTime) Sets start time of the flow.
private void	setLocalIP(java.lang.String localIP) Sets local IP address of the flow.
private void	setLocalPort(int localPort) Sets local transport layer port of the flow.
private void	setProtocolName(java.lang.String protocolName) Set transport layer protocol name.
private void	setRemoteIP(java.lang.String remoteIP) Sets remote IP address of the flow.
private void	setRemotePort(int remotePort) Sets remote transport layer port of the flow.
void	setSocketAppName(java.lang.String socketAppName) Sets application name associated with the flow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

private static org.apache.log4j.Logger log

Used to log different events.

MAX_NO_PACKETS

private static final int MAX_NO_PACKETS

Maximum number of packets in flow. If the number is reached, new packets cannot be added to the flow.

See Also:

Constant Field Values

flowID

private int flowID

Identifier of the flow. It is equal to the hashcode of the first packet in the flow.

flowStartTime

private long flowStartTime

Timestamp of start of the flow. It is measured in microseconds.

flowEndTime

private long flowEndTime

Timestamp of end of the flow. It is measured in microseconds.

localIP

private java.lang.String localIP

Local IP address of the flow.

remoteIP

private java.lang.String remoteIP

Remote IP address of the flow.

localPort

private int localPort

Local transport layer port of the flow.

remotePort

private int remotePort

Remote transport layer port of the flow.

protocolName

private java.lang.String protocolName

Transport layer protocol name of the flow.

socketAppName

private java.lang.String socketAppName

Application name taken from system socket associated with the flow.

listOfPackets

private java.util.ArrayList<CapturedPacket> listOfPackets

List of packets assigned to the flow.

lastUpdatedTime

private long lastUpdatedTime

Timestamp showing when the flow was updated last time. It is measured in microseconds.

Constructor Detail

Flow

public Flow(CapturedPacket newCapturedPacket)

Constructs the object.

Parameters:

newCapturedPacket - the first packet, based on which the flow will be created

Method Detail

getFlowID

public int getFlowID()

Gets the identifier of the flow.

Returns:

identifier of the flow

getLocalIP

public java.lang.String getLocalIP()

Gets local IP address of the flow.

Returns:

local IP address

getRemoteIP

public java.lang.String getRemoteIP()

Gets remote IP address of the flow.

Returns:

remote IP address

getLocalPort

public int getLocalPort()

Gets local transport layer port of the flow.

Returns:

local port

getRemotePort

public int getRemotePort()

Gets remote transport layer port of the flow.

Returns:

remote port

getProtocolName

public java.lang.String getProtocolName()

Gets transport layer protocol name.

Returns:

protocol name

setLocalIP

private void setLocalIP(java.lang.String localIP)

Sets local IP address of the flow.

Parameters:

localIP - local IP address

setRemoteIP

private void setRemoteIP(java.lang.String remoteIP)

Sets remote IP address of the flow.

Parameters:

remoteIP - remote IP address

setLocalPort

private void setLocalPort(int localPort)

Sets local transport layer port of the flow.

Parameters:

localPort - local tranport layer port

setRemotePort

private void setRemotePort(int remotePort)

Sets remote transport layer port of the flow.

Parameters:

remotePort - remote transport layer port

setProtocolName

private void setProtocolName(java.lang.String protocolName)

Set transport layer protocol name.

Parameters:

protocolName - transport layer protocol name

getNoPackets

public int getNoPackets()

Gets number of packets associated with this flow.

Returns:

number of packets

getFlowStartTime

public long getFlowStartTime()

Gets start time of the flow.

Returns:

start timestamp in microseconds

getFlowEndTime

public long getFlowEndTime()

Gets end time of the flow.

Returns:

end timestamp in microseconds

getSocketAppName

public java.lang.String getSocketAppName()

Gets application name associated with the flow.

Returns:

application name

getPackets

public java.util.ArrayList<CapturedPacket> getPackets()

Gets all the packets associated with the flow.

Returns:

packets associated with the flow

setSocketAppName

public void setSocketAppName(java.lang.String socketAppName)

Sets application name associated with the flow.

Parameters:

socketAppName - application name

setFlowStartTime

public void setFlowStartTime(long flowStartTime)

Sets start time of the flow.

Parameters:

flowStartTime - timestamp in microseconds

setFlowEndTime

public void setFlowEndTime(long flowEndTime)

Sets end time of the flow.

Parameters:

flowEndTime - timestamp in microseconds

getLastUpdatedTime

public long getLastUpdatedTime()

Sets timestamp when the flow was updated last time.

Returns:

timestamp in microseconds

addPacket

public boolean addPacket(CapturedPacket newCapturedPacket)

Adds packet to the flow. Packet could not be added if the flow is not already started, or if maximum number of packets in the flow is reached.

Parameters:

newCapturedPacket - packet, which is supposed to be added to the flow

Returns:

true if the packet was added, false otherwise

setFlowID

private void setFlowID(int flowID)

Sets identifier of the flow.

Parameters:

flowID - identifier of the flow