vbsServer

Class UpgradeTransmitter

java.lang.Object

vbsServer.UpgradeTransmitter

All Implemented Interfaces:

java.lang.Runnable

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

The class UpgradeTransmitter is responsible for transmitting the upgrade file to the client.

It is intended to run in its own thread.

Author:

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 java.net.Socket	mySocket The socket used to communicate with the client.
private java.io.File	myUpgradeFolder The folder containing the upgrade file.
private java.lang.Thread	upgradeTransmitterThread Thread used by the class.

Constructor Summary

Constructors

Constructor and Description
UpgradeTransmitter(java.net.Socket mySocket, java.io.File myUpgradeFolder) Creates the class.

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	authenticateClient() Authenticates the client.
private boolean	receivedUpgradeRequest() Receives the information whether the client wants to download the upgrade from the server or not.
void	run() Runs the thread.
private void	sendVersionNumber() Sends version of the available upgrade to the client.
void	start() Starts the thread.
private boolean	transferFile() Transfers the upgrade file from the server to the client.

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.

upgradeTransmitterThread

private java.lang.Thread upgradeTransmitterThread

Thread used by the class.

myUpgradeFolder

private java.io.File myUpgradeFolder

The folder containing the upgrade file.

mySocket

private java.net.Socket mySocket

The socket used to communicate with the client.

Constructor Detail

UpgradeTransmitter

public UpgradeTransmitter(java.net.Socket mySocket,
                  java.io.File myUpgradeFolder)

Creates the class.

Parameters:

mySocket - socket used to communicate with the client

myUpgradeFolder - folder containing the upgrade file

Method Detail

start

public void start()

Starts the thread.

run

public void run()

Runs the thread. At first the client must be authenticated. Then, the version number of the upgrade is sent to the server. The client determines if it needs the upgrade or not. If yes, the client sends an upgrade request and the upgrade is transmitted to the client.

Specified by:

run in interface java.lang.Runnable

authenticateClient

private boolean authenticateClient()
                            throws java.io.IOException

Authenticates the client. The valid registration key must be sent upon the upgrade is transferred to the client.

Returns:

true if the client is authenticated, false otherwise

Throws:

java.io.IOException - if a communication problem occurs

sendVersionNumber

private void sendVersionNumber()
                        throws java.io.IOException

Sends version of the available upgrade to the client. The version is dynamically read from the config file and therefore it can be changed while the server runs.

Throws:

java.io.IOException - if a communication problem exists

receivedUpgradeRequest

private boolean receivedUpgradeRequest()
                                throws java.io.IOException

Receives the information whether the client wants to download the upgrade from the server or not.

Returns:

true if the client wants the upgrade, false otherwise

Throws:

java.io.IOException - if a communication problem occurs

transferFile

private boolean transferFile()

Transfers the upgrade file from the server to the client.

Returns:

true if the upgrade file was transferred successfully, false otherwise