vbsClient

Class VbsClientShutdown

java.lang.Object

vbsClient.VbsClientShutdown

All Implemented Interfaces:

java.lang.Runnable

public class VbsClientShutdown
extends java.lang.Object
implements java.lang.Runnable

The class VbsClientShutdown is responsible for shutting down the client application nicely. It does so by closing all threads with their own stop() methods.

The class VbsClientShutdown is meant to be run when the application is shut down and should therefore be added as a shutdown hook thread (Runtime.getRuntime().addShutdownHook()). Note: shutdown hooks cannot be tested in Eclipse!

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 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 SocketMonitor	mySocketMonitor SocketMonitor module of the VBS client.
private java.lang.Thread	shutdownThread Thread used by this class.

Constructor Summary

Constructors

Constructor and Description
VbsClientShutdown() Constructs the class

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAlive() Checks if VbsClientShutdown is alive.
void	run() Sequentially stops all the modules of the VBS client, then stores values to a XML file and exits.
void	setDatabaseHandler(DatabaseHandler myDatabaseHandler) Sets reference to the DatabaseHandler module.
void	setDataTransmitter(DataTransmitter myDataTransmitter) Sets reference to the DataTransmitter module.
void	setFlowGenerator(FlowGenerator myFlowGenerator) Sets reference to the FlowGenerator module.
void	setPacketCapturer(PacketCapturer myPacketCapturer) Sets reference to the PacketCapturer module.
void	setPerformanceMonitor(PerformanceMonitor myPerformanceMonitor) Sets reference to the PerformanceMonitor module.
void	setSocketMonitor(SocketMonitor mySocketMonitor) Sets reference to the SocketMonitor module.
void	start() Starts the thread.
private void	stopDatabaseHandler() Stops the DatabaseHandler module.
private void	stopDataTransmitter() Stops the DataTransmitter module.
private void	stopFlowGenerator() Stops the FlowGenerator module.
private void	stopPacketCapturer() Stops the PacketCapturer module.
private void	stopPerformanceMonitor() Stops the PerformanceMonitor module.
private void	stopSocketMonitor() Stops the SocketMonitor module.

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.

shutdownThread

private java.lang.Thread shutdownThread

Thread used by this class.

myPacketCapturer

private PacketCapturer myPacketCapturer

PacketCapturer module of the VBS client.

mySocketMonitor

private SocketMonitor mySocketMonitor

SocketMonitor 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.

myPerformanceMonitor

private PerformanceMonitor myPerformanceMonitor

PerformanceMonitor module of the VBS client.

Constructor Detail

VbsClientShutdown

public VbsClientShutdown()

Constructs the class

Method Detail

start

public void start()

Starts the thread.

isAlive

public boolean isAlive()

Checks if VbsClientShutdown is alive. It means that the thread must exist.

Returns:

true if the thread is operational, false otherwise

run

public void run()

Sequentially stops all the modules of the VBS client, then stores values to a XML file and exits.

Specified by:

run in interface java.lang.Runnable

setPacketCapturer

public void setPacketCapturer(PacketCapturer myPacketCapturer)

Sets reference to the PacketCapturer module.

Parameters:

myPacketCapturer - reference to the PacketCapturer module.

setSocketMonitor

public void setSocketMonitor(SocketMonitor mySocketMonitor)

Sets reference to the SocketMonitor module.

Parameters:

mySocketMonitor - reference to the SocketMonitor module.

setFlowGenerator

public void setFlowGenerator(FlowGenerator myFlowGenerator)

Sets reference to the FlowGenerator module.

Parameters:

myFlowGenerator - reference to the FlowGenerator module.

setDataTransmitter

public void setDataTransmitter(DataTransmitter myDataTransmitter)

Sets reference to the DataTransmitter module.

Parameters:

myDataTransmitter - reference to the DataTransmitter module.

setPerformanceMonitor

public void setPerformanceMonitor(PerformanceMonitor myPerformanceMonitor)

Sets reference to the PerformanceMonitor module.

Parameters:

myPerformanceMonitor - reference to the PerformanceMonitor module.

setDatabaseHandler

public void setDatabaseHandler(DatabaseHandler myDatabaseHandler)

Sets reference to the DatabaseHandler module.

Parameters:

myDatabaseHandler - reference to the DatabaseHandler module.

stopPacketCapturer

private void stopPacketCapturer()

Stops the PacketCapturer module.

stopSocketMonitor

private void stopSocketMonitor()

Stops the SocketMonitor module.

stopFlowGenerator

private void stopFlowGenerator()

Stops the FlowGenerator module.

stopDataTransmitter

private void stopDataTransmitter()

Stops the DataTransmitter module.

stopPerformanceMonitor

private void stopPerformanceMonitor()

Stops the PerformanceMonitor module.

stopDatabaseHandler

private void stopDatabaseHandler()

Stops the DatabaseHandler module.