VbsServer

java.lang.Object
- vbsServer.VbsServer

All Implemented Interfaces:

java.lang.Runnable
```
public class VbsServer
extends java.lang.Object
implements java.lang.Runnable
```
The class VbsServer is the primary class of the server application. It starts a RegisterServer to allow clients to register and retrieve a clientId. It starts a FileTransferServer for transferring FDB files. It starts an UpgradeServer for upgrading clients, and it starts a DataExtracter for importing content of the FDB files into the database.

The application stops when it is externally terminated. When this happens a ServerAppShutdown is run as a shutdown hook, to shut down nicely.

It is intended to run in its own thread. The used database is MySQL Community Server: http://dev.mysql.com/downloads/mysql/

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`	`DEFAULT_FOLDER` Folder used to store FDB files received from clients.
`private int`	`DEFAULT_PACKET_SIZE_LIMIT` Flows containing less than `DEFAULT_PACKET_SIZE_LIMIT` packets will not be stored in the database.
`private int`	`fdbServerPort` Port on which the file transfer server listens to incoming request from clients.
`private static org.apache.log4j.Logger`	`log` Used to log different events.
`private DataExtracter`	`myDataExtracter` `DataExtracter` module of the VBS server.
`private FileTransferServer`	`myFdbServer` `FileTransferServer` module of the VBS server.
`private RegisterServer`	`myRegisterServer` `RegisterServer` module of the VBS server.
`private VbsServerShutdown`	`myShutdownHandler` `VbsServerShutdown` module of the VBS server.
`private UpgradeServer`	`myUpgradeServer` `UpgradeServer` module of the VBS server.
`private int`	`registerServerPort` Port on which the registration server listens to incoming request from clients.
`private java.lang.String`	`UPGRADE_FOLDER` Folder containing files needed to upgrade clients.
`private int`	`upgradeServerPort` Port on which the upgrade server listens to incoming request from clients.
`static int`	`VBS_SERVER_VERSION` Version of the VBS server.

Constructor Summary

Constructors
Constructor and Description

VbsServer()

Constructors
Constructor and Description
`VbsServer()`

Method Summary

Methods
Modifier and Type	Method and Description
`private boolean`	`areThreadsAlive()` Checks if at least one module of the VBS server is alive.
`private boolean`	`loadHardSettings()` Loads settings from the external XML file.
`static void`	`main(java.lang.String[] args)` Starts the server application.
`void`	`run()` Runs the thread.
`void`	`setup()` Prepares all the modules of the VBS server.
`private void`	`setupDataExtracter()` Prepares the `DataExtracter` module of the VBS server.
`private void`	`setupDefaultFolders()` Prepares folders needed by the VBS server.
`private void`	`setupFDBServer()` Prepares the `FileTransferServer` module of the VBS server.
`private void`	`setupRegisterServer()` Prepares the `RegisterServer` module of the VBS server.
`private void`	`setupShutdownHandler()` Prepares the shutdown handler.
`private void`	`setupUpgradeServer()` Prepares the `UpgradeServer` module of the VBS server.
`void`	`startSystem()` Starts all the modules of the system.

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_SERVER_VERSION
```
public static final int VBS_SERVER_VERSION
```
    Version of the VBS server.
    
    See Also:
    Constant Field Values
  - DEFAULT_FOLDER
```
private final java.lang.String DEFAULT_FOLDER
```
    Folder used to store FDB files received from clients.
    
    See Also:
    Constant Field Values
  - UPGRADE_FOLDER
```
private final java.lang.String UPGRADE_FOLDER
```
    Folder containing files needed to upgrade clients.
    
    See Also:
    Constant Field Values
  - DEFAULT_PACKET_SIZE_LIMIT
```
private final int DEFAULT_PACKET_SIZE_LIMIT
```
    Flows containing less than DEFAULT_PACKET_SIZE_LIMIT packets will not be stored in the database. 0 = limit is disabled.
    
    See Also:
    Constant Field Values
  - fdbServerPort
```
private int fdbServerPort
```
    Port on which the file transfer server listens to incoming request from clients.
  - registerServerPort
```
private int registerServerPort
```
    Port on which the registration server listens to incoming request from clients.
  - upgradeServerPort
```
private int upgradeServerPort
```
    Port on which the upgrade server listens to incoming request from clients.
  - myRegisterServer
```
private RegisterServer myRegisterServer
```
    RegisterServer module of the VBS server.
  - myUpgradeServer
```
private UpgradeServer myUpgradeServer
```
    UpgradeServer module of the VBS server.
  - myFdbServer
```
private FileTransferServer myFdbServer
```
    FileTransferServer module of the VBS server.
  - myDataExtracter
```
private DataExtracter myDataExtracter
```
    DataExtracter module of the VBS server.
  - myShutdownHandler
```
private VbsServerShutdown myShutdownHandler
```
    VbsServerShutdown module of the VBS server.
- Constructor Detail
  - VbsServer
```
public VbsServer()
```
- Method Detail
  - run
```
public void run()
```
    Runs the thread. The following steps are done:
    - load settings from the external XML settings file
    - set up all the modules
    - start all the modules
    - wait in loop until the VBS server is externally terminated
    
    Specified by:
    
    run in interface java.lang.Runnable
  - loadHardSettings
```
private boolean loadHardSettings()
```
    Loads settings from the external XML file.
    
    Returns:
    true if the settings were successfully loaded, false otherwise
  - setup
```
public void setup()
           throws java.io.IOException
```
    Prepares all the modules of the VBS server.
    
    Throws:
    
    java.io.IOException - when an IOException is thrown by any method invoked in this function
  - setupDefaultFolders
```
private void setupDefaultFolders()
                          throws java.io.IOException
```
    Prepares folders needed by the VBS server. Files with the extension FDT are the files which were incompletely received from clients, for example because of system breakdown, and therefore they must be deleted to clean up the disk space.
    
    Throws:
    
    java.io.IOException - when any problem with operation of files or directories occur
  - setupRegisterServer
```
private void setupRegisterServer()
                          throws java.io.IOException
```
    Prepares the RegisterServer module of the VBS server.
    
    Throws:
    
    java.io.IOException - if an IOException is thrown by the module
  - setupUpgradeServer
```
private void setupUpgradeServer()
                         throws java.io.IOException
```
    Prepares the UpgradeServer module of the VBS server.
    
    Throws:
    
    java.io.IOException - if an IOException is thrown by the module
  - setupFDBServer
```
private void setupFDBServer()
                     throws java.io.IOException
```
    Prepares the FileTransferServer module of the VBS server.
    
    Throws:
    
    java.io.IOException - if an IOException is thrown by the module
  - setupDataExtracter
```
private void setupDataExtracter()
                         throws java.io.IOException
```
    Prepares the DataExtracter module of the VBS server.
    
    Throws:
    
    java.io.IOException - if an IOException is thrown by the module
  - setupShutdownHandler
```
private void setupShutdownHandler()
```
    Prepares the shutdown handler.
  - startSystem
```
public void startSystem()
```
    Starts all the modules of the system.
  - areThreadsAlive
```
private boolean areThreadsAlive()
```
    Checks if at least one module of the VBS server is alive.
    
    Returns:
    true if at least one module of the VBS server is alive, false otherwise
  - main
```
public static void main(java.lang.String[] args)
```
    Starts the server application.

Class VbsServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

VBS_SERVER_VERSION

DEFAULT_FOLDER

UPGRADE_FOLDER

DEFAULT_PACKET_SIZE_LIMIT

fdbServerPort

registerServerPort

upgradeServerPort

myRegisterServer

myUpgradeServer

myFdbServer

myDataExtracter

myShutdownHandler

Constructor Detail

VbsServer

Method Detail

run

loadHardSettings

setup

setupDefaultFolders

setupRegisterServer

setupUpgradeServer

setupFDBServer

setupDataExtracter

setupShutdownHandler

startSystem

areThreadsAlive

main