VbsClient

java.lang.Object
- vbsClient.VbsClient

All Implemented Interfaces:

java.lang.Runnable
```
public class VbsClient
extends java.lang.Object
implements java.lang.Runnable
```
The class VbsClient is the primary class of the VBS client application. It loads the settings from a XML file. If a client id is not specified in the settings, the client is registered at the server. The application stops when it is externally terminated. When this happens a VbsClientShutdown is run as a shutdown hook, to shut down nicely.

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.lang.String`	`clientId` Identifier of the client.
`private int`	`DEFAULT_DATABASE_HANDLER_INTERVAL` Default interval between looking for closed SQLite database files which can be sent to the server.
`private int`	`DEFAULT_FLOW_TIMEOUT_INTERVAL` Default time after which an unmodified flow is considered as closed.
`private java.lang.String`	`DEFAULT_FOLDER` Default folder for storing VBS client data.
`private int`	`DEFAULT_PERFORMANCE_MONITOR_INTERVAL` Default interval between monitoring system performance.
`private int`	`DEFAULT_SOCKET_MONITOR_INTERVAL` Default interval between monitoring system sockets.
`private int`	`fdbServerPort` Default VBS server TCP port used to transfer SQLite database files.
`private java.lang.String`	`globalIP` Global IP address of the client.
`private static org.apache.log4j.Logger`	`log` Used to log different events.
`private DatabaseHandler`	`myDatabaseHandler` `DatabaseHandler` module of the VBS client.
`private DataTransmitter`	`myDataTransmitter` `DataTransmitter` module of the VBS client.
`private FlowGenerator`	`myFlowGenerator` `FlowGenerator` module of the VBS client.
`private PacketCapturer`	`myPacketCapturer` `PacketCapturer` module of the VBS client.
`private PerformanceMonitor`	`myPerformanceMonitor` `PerformanceMonitor` module of the VBS client.
`private VbsClientShutdown`	`myShutDownHandler` `VbsClientShutdown` module of the VBS client.
`private SocketMonitor`	`mySocketMonitor` `SocketMonitor` module of the VBS client.
`private java.lang.String`	`networkName` Name of the network to which the client is connected.
`private int`	`registerServerPort` Default VBS server TCP port used to register the client or validate the client identifier.
`private java.lang.String`	`serverIP` IP address of the VBS server.
`private java.lang.String`	`SOFT_SETTINGS_FILE` File with settings which can be adjusted to our needs.
`private int`	`upgradeServerPort` Default VBS server TCP port used to upgrade the client.
`static int`	`VBS_CLIENT_VERSION` Version of the VBS client.
`static int`	`VBS_DATABASE_VERSION` Version of the structure of the SQLite database used by the VBS client.

Constructor Summary

Constructors
Constructor and Description

VbsClient()

Constructors
Constructor and Description
`VbsClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`private boolean`	`areThreadsAlive()` Checks if at least one module of the VBS client is running.
`private void`	`checkForUpgrade()` Checks for the VBS client upgrade on the server.
`private boolean`	`getClientIdFromServer()` Obtains the client identifier from the VBS server and writes it to an external settings file.
`private boolean`	`loadHardSettings()` Loads the hard, fixed settings from the config file.
`private void`	`loadSoftSettings()` Loads the soft, modifiable settings from the configuration file.
`static void`	`main(java.lang.String[] args)` Starts the client application.
`private java.lang.String`	`obtainNetworkName()` Obtain name of the network to which the client is collected.
`void`	`run()` Runs the VBS client.
`private void`	`setupDatabaseHandler()` Prepares the `DatabaseHandler` module of the VBS client.
`private void`	`setupDataTransmitter()` Prepares the `DataTransmitter` module of the VBS client.
`private void`	`setupFlowGenerator()` Prepares the `FlowGenerator` module of the VBS client.
`private boolean`	`setupFolder(java.lang.String directoryName)` Prepares a folder on a disk.
`private void`	`setupPacketCapturer()` Prepares the `PacketCapturer` module of the VBS client.
`private void`	`setupPerformanceMonitor()` Prepares the `PerformanceMonitor` module of the VBS client.
`private void`	`setupShutdown()` Prepares the `VbsClientShutdown` module of the VBS client.
`private void`	`setupSocketMonitor()` Prepares the `SocketMonitor` module of the VBS client.
`private boolean`	`startSystem()` Sequentially starts all the modules of the VBS client.
`private boolean`	`validateClientId()` Validates the client identifier on the server.

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.
  - VBS_CLIENT_VERSION
```
public static final int VBS_CLIENT_VERSION
```
    Version of the VBS client. It is used for upgrade purposes to check if a new version is available on the server.
    
    See Also:
    Constant Field Values
  - VBS_DATABASE_VERSION
```
public static final int VBS_DATABASE_VERSION
```
    Version of the structure of the SQLite database used by the VBS client. This version is included in each SQLite database file sent to the server and it is used to determine in which way the file needs to be processed.
    
    See Also:
    Constant Field Values
  - DEFAULT_FOLDER
```
private final java.lang.String DEFAULT_FOLDER
```
    Default folder for storing VBS client data.
    
    See Also:
    Constant Field Values
  - SOFT_SETTINGS_FILE
```
private final java.lang.String SOFT_SETTINGS_FILE
```
    File with settings which can be adjusted to our needs.
    
    See Also:
    Constant Field Values
  - DEFAULT_SOCKET_MONITOR_INTERVAL
```
private final int DEFAULT_SOCKET_MONITOR_INTERVAL
```
    Default interval between monitoring system sockets.
    
    See Also:
    Constant Field Values
  - DEFAULT_PERFORMANCE_MONITOR_INTERVAL
```
private final int DEFAULT_PERFORMANCE_MONITOR_INTERVAL
```
    Default interval between monitoring system performance.
    
    See Also:
    Constant Field Values
  - DEFAULT_DATABASE_HANDLER_INTERVAL
```
private final int DEFAULT_DATABASE_HANDLER_INTERVAL
```
    Default interval between looking for closed SQLite database files which can be sent to the server.
    
    See Also:
    Constant Field Values
  - DEFAULT_FLOW_TIMEOUT_INTERVAL
```
private final int DEFAULT_FLOW_TIMEOUT_INTERVAL
```
    Default time after which an unmodified flow is considered as closed.
    
    See Also:
    Constant Field Values
  - clientId
```
private java.lang.String clientId
```
    Identifier of the client.
  - serverIP
```
private java.lang.String serverIP
```
    IP address of the VBS server.
  - fdbServerPort
```
private int fdbServerPort
```
    Default VBS server TCP port used to transfer SQLite database files.
  - registerServerPort
```
private int registerServerPort
```
    Default VBS server TCP port used to register the client or validate the client identifier.
  - upgradeServerPort
```
private int upgradeServerPort
```
    Default VBS server TCP port used to upgrade the client.
  - globalIP
```
private java.lang.String globalIP
```
    Global IP address of the client.
  - networkName
```
private java.lang.String networkName
```
    Name of the network to which the client is connected. Taken from the CSV file.
  - myPacketCapturer
```
private PacketCapturer myPacketCapturer
```
    PacketCapturer module of the VBS client.
  - mySocketMonitor
```
private SocketMonitor mySocketMonitor
```
    SocketMonitor module of the VBS client.
  - myPerformanceMonitor
```
private PerformanceMonitor myPerformanceMonitor
```
    PerformanceMonitor module of the VBS client.
  - myFlowGenerator
```
private FlowGenerator myFlowGenerator
```
    FlowGenerator module of the VBS client.
  - myDatabaseHandler
```
private DatabaseHandler myDatabaseHandler
```
    DatabaseHandler module of the VBS client.
  - myDataTransmitter
```
private DataTransmitter myDataTransmitter
```
    DataTransmitter module of the VBS client.
  - myShutDownHandler
```
private VbsClientShutdown myShutDownHandler
```
    VbsClientShutdown module of the VBS client.
- Constructor Detail
  - VbsClient
```
public VbsClient()
```
- Method Detail
  - run
```
public void run()
```
    Runs the VBS client. Tasks done by this include:
    - loading hard settings (like the IP address of the server) from a file
    - load soft settings (like client identifier) from a file
    - check if the client identifier is set. If yes, validate it on the server. If not, ask the server to assign a new one
    - set up all modules of the VBS client
    - check if an upgrade is needed. If yes, download the upgrade from the VBS server and restart the VBS client to apply the upgrade
    - in loop monitor state of each module of the VBS client. If a module is crashed, restart the whole VBS client
    
    Specified by:
    
    run in interface java.lang.Runnable
  - startSystem
```
private boolean startSystem()
```
    Sequentially starts all the modules of the VBS client.
    
    Returns:
    true if the system is started successfully, false otherwise
  - areThreadsAlive
```
private boolean areThreadsAlive()
```
    Checks if at least one module of the VBS client is running. If yes, the system is considered to be alive.
    
    Returns:
    true if the system is alive, false otherwise
  - setupFolder
```
private boolean setupFolder(java.lang.String directoryName)
```
    Prepares a folder on a disk.
    
    Parameters:
    directoryName - path to the folder which needs to be prepared
    
    Returns:
    true if the folder was prepared successfully, false otherwise
  - setupFlowGenerator
```
private void setupFlowGenerator()
```
    Prepares the FlowGenerator module of the VBS client.
  - setupSocketMonitor
```
private void setupSocketMonitor()
```
    Prepares the SocketMonitor module of the VBS client.
  - setupPerformanceMonitor
```
private void setupPerformanceMonitor()
```
    Prepares the PerformanceMonitor module of the VBS client.
  - setupDatabaseHandler
```
private void setupDatabaseHandler()
```
    Prepares the DatabaseHandler module of the VBS client.
  - setupPacketCapturer
```
private void setupPacketCapturer()
```
    Prepares the PacketCapturer module of the VBS client.
  - setupDataTransmitter
```
private void setupDataTransmitter()
```
    Prepares the DataTransmitter module of the VBS client.
  - setupShutdown
```
private void setupShutdown()
```
    Prepares the VbsClientShutdown module of the VBS client.
  - loadHardSettings
```
private boolean loadHardSettings()
```
    Loads the hard, fixed settings from the config file.
    
    Returns:
    true if the settings were loaded, false otherwise
  - loadSoftSettings
```
private void loadSoftSettings()
```
    Loads the soft, modifiable settings from the configuration file.
  - getClientIdFromServer
```
private boolean getClientIdFromServer()
```
    Obtains the client identifier from the VBS server and writes it to an external settings file.
    
    Returns:
    true if the client identifier was obtained successfully, false otherwise
  - validateClientId
```
private boolean validateClientId()
```
    Validates the client identifier on the server.
    
    Returns:
    true if the client identifier was validated on the server, false if the client identifier was rejected or if any problem occured
  - checkForUpgrade
```
private void checkForUpgrade()
```
    Checks for the VBS client upgrade on the server. If the upgrade is available, it is downloaded by the client.
  - obtainNetworkName
```
private java.lang.String obtainNetworkName()
```
    Obtain name of the network to which the client is collected. It requires an external file with network names to be present in the program directory.
    
    Returns:
    name of the network
  - main
```
public static void main(java.lang.String[] args)
```
    Starts the client application.

Class VbsClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

VBS_CLIENT_VERSION

VBS_DATABASE_VERSION

DEFAULT_FOLDER

SOFT_SETTINGS_FILE

DEFAULT_SOCKET_MONITOR_INTERVAL

DEFAULT_PERFORMANCE_MONITOR_INTERVAL

DEFAULT_DATABASE_HANDLER_INTERVAL

DEFAULT_FLOW_TIMEOUT_INTERVAL

clientId

serverIP

fdbServerPort

registerServerPort

upgradeServerPort

globalIP

networkName

myPacketCapturer

mySocketMonitor

myPerformanceMonitor

myFlowGenerator

myDatabaseHandler

myDataTransmitter

myShutDownHandler

Constructor Detail

VbsClient

Method Detail

run

startSystem

areThreadsAlive

setupFolder

setupFlowGenerator

setupSocketMonitor

setupPerformanceMonitor

setupDatabaseHandler

setupPacketCapturer

setupDataTransmitter

setupShutdown

loadHardSettings

loadSoftSettings

getClientIdFromServer

validateClientId

checkForUpgrade

obtainNetworkName

main