SocketMonitor

java.lang.Object
- socketMonitor.SocketMonitor

All Implemented Interfaces:

java.lang.Runnable
```
public class SocketMonitor
extends java.lang.Object
implements java.lang.Runnable
```
The class SocketMonitor is responsible for monitoring system (Linux or Windows) sockets. When a socket is detected as opened or closed, the appropriate information about this socket is added to the queue of opened or closed sockets, respectively.
Socket is being detected as opened or close by the SocketInfoGenerator class.

It is intended to run in its own thread.

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 java.util.Hashtable<java.lang.Integer,SocketInfo>`	`activeSocketsList` List of sockets, which were opened and they are not closed yet.
`private boolean`	`isStarted` Flag used to determine if the thread is fully started.
`private static org.apache.log4j.Logger`	`log` Used to log different events.
`private SocketInfoGenerator`	`mySocketInfoGenerator` Responsible for monitoring system (Linux or Windows) sockets.
`private SocketMonitorQueue`	`mySocketMonitorQueue` Queue containing information about opened or closed sockets.
`private java.util.Hashtable<java.lang.Integer,SocketInfo>`	`openSocketList` List of sockets which were opened, but they can be either open or closed.
`private boolean`	`runFlag` Flag used to stop the thread.
`private int`	`samplingInterval` Interval between checking if new sockets are opened or closed.
`private java.lang.Thread`	`socketMonitorThread` Thread used by this class.

Constructor Summary

Constructors
Constructor and Description

SocketMonitor()
Constructs the object.

Constructors
Constructor and Description
`SocketMonitor()` Constructs the object.

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`findClosedSockets()` Finds all closed sockets by comparing `activeSocketList` and `openSocketList`.
`private void`	`findOpenSockets()` Looks for information about open sockets.
`SocketMonitorQueue`	`getSocketMonitorQueue()` Gets the queue containing information about opened and closed sockets.
`boolean`	`isAlive()` Checks if `SocketMonitor` is alive.
`void`	`run()` Runs the thread in loop.
`void`	`setSamplingInterval(int samplingInterval)` Sets interval between checking if new sockets are opened or closed.
`void`	`start()` Starts the thread.
`void`	`stop()` Stops the thread.

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.
  - socketMonitorThread
```
private java.lang.Thread socketMonitorThread
```
    Thread used by this class.
  - runFlag
```
private boolean runFlag
```
    Flag used to stop the thread.
  - isStarted
```
private boolean isStarted
```
    Flag used to determine if the thread is fully started.
  - samplingInterval
```
private int samplingInterval
```
    Interval between checking if new sockets are opened or closed.
  - activeSocketsList
```
private java.util.Hashtable<java.lang.Integer,SocketInfo> activeSocketsList
```
    List of sockets, which were opened and they are not closed yet.
  - openSocketList
```
private java.util.Hashtable<java.lang.Integer,SocketInfo> openSocketList
```
    List of sockets which were opened, but they can be either open or closed.
  - mySocketInfoGenerator
```
private SocketInfoGenerator mySocketInfoGenerator
```
    Responsible for monitoring system (Linux or Windows) sockets.
  - mySocketMonitorQueue
```
private SocketMonitorQueue mySocketMonitorQueue
```
    Queue containing information about opened or closed sockets.
- Constructor Detail
  - SocketMonitor
```
public SocketMonitor()
```
    Constructs the object.
- Method Detail
  - start
```
public void start()
```
    Starts the thread.
  - stop
```
public void stop()
```
    Stops the thread.
  - isAlive
```
public boolean isAlive()
```
    Checks if SocketMonitor is alive. It means that:
    - the thread must exists
    - the thread must be fully started and running (isStarted equals true). This condition is used to check if the thread is fully started or if it needs more time to start.
    
    Returns:
    true if the thread is fully started and operational, false otherwise
  - run
```
public void run()
```
    Runs the thread in loop.
    
    Specified by:
    
    run in interface java.lang.Runnable
  - findOpenSockets
```
private void findOpenSockets()
```
    Looks for information about open sockets. The information is obtained from SocketInfoGenerator. Next, the information is added both to list of opened sockets and list of active sockets.
  - findClosedSockets
```
private void findClosedSockets()
```
    Finds all closed sockets by comparing activeSocketList and openSocketList.
  - setSamplingInterval
```
public void setSamplingInterval(int samplingInterval)
```
    Sets interval between checking if new sockets are opened or closed.
    
    Parameters:
    samplingInterval - the interval between checking if new sockets are opened or closed
  - getSocketMonitorQueue
```
public SocketMonitorQueue getSocketMonitorQueue()
```
    Gets the queue containing information about opened and closed sockets.
    
    Returns:
    the queue containing information about opened and closed sockets

Class SocketMonitor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

socketMonitorThread

runFlag

isStarted

samplingInterval

activeSocketsList

openSocketList

mySocketInfoGenerator

mySocketMonitorQueue

Constructor Detail

SocketMonitor

Method Detail

start

stop

isAlive

run

findOpenSockets

findClosedSockets

setSamplingInterval

getSocketMonitorQueue