vbsServer

Class FileReceiver

java.lang.Object

vbsServer.FileReceiver

All Implemented Interfaces:

java.lang.Runnable

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

The class FileReceiver is used for receiving any kind of file from the client. The file extension is specified in the constructor.

This is not a secure implementation because the transfer permission is granted when the client identifier looks correctly, but the client identifier is not checked if it was assigned to a client before or not.

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 int	bufferSize Size of the buffer used to receive a file.
private java.lang.String	clientId Identifier of the client requesting the transmission.
private java.lang.Thread	fileReceiverThread Thread used by the class.
private static org.apache.log4j.Logger	log Used to log different events.
private java.io.File	masterFolder The main folder of the VBS server.
private java.io.File	myFile File received from the client.
private java.lang.String	myFileExtension Extension which will be assigned to the received file.
private java.net.Socket	mySocket Socket used to communicate with the client.
static java.lang.String	PERMISSION_ACCEPT_MESSAGE Message sent to the server when the transfer is accepted.
static java.lang.String	PERMISSION_REJECT_MESSAGE Message sent to the server when the transfer is rejected.
private long	transferEndTime Timestamp when the file transfer finished.
private long	transferStartTime Timestamp when the file transfer started.

Constructor Summary

Constructors

Constructor and Description
FileReceiver(java.net.Socket mySocket, java.io.File masterFolder, java.lang.String myFileExtension) Constructs the object.

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	authenticateClient() Tries to authenticate the client by checking if the client identifier looks as valid.
private void	receiveFile() Receives the file from the client.
void	run() Runs the client.
void	start() Starts 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.

fileReceiverThread

private java.lang.Thread fileReceiverThread

Thread used by the class.

PERMISSION_ACCEPT_MESSAGE

public static final java.lang.String PERMISSION_ACCEPT_MESSAGE

Message sent to the server when the transfer is accepted.

See Also:

Constant Field Values

PERMISSION_REJECT_MESSAGE

public static final java.lang.String PERMISSION_REJECT_MESSAGE

Message sent to the server when the transfer is rejected.

See Also:

Constant Field Values

bufferSize

private int bufferSize

Size of the buffer used to receive a file.

masterFolder

private java.io.File masterFolder

The main folder of the VBS server.

myFileExtension

private java.lang.String myFileExtension

Extension which will be assigned to the received file.

mySocket

private java.net.Socket mySocket

Socket used to communicate with the client.

clientId

private java.lang.String clientId

Identifier of the client requesting the transmission.

transferStartTime

private long transferStartTime

Timestamp when the file transfer started.

transferEndTime

private long transferEndTime

Timestamp when the file transfer finished.

myFile

private java.io.File myFile

File received from the client.

Constructor Detail

FileReceiver

public FileReceiver(java.net.Socket mySocket,
            java.io.File masterFolder,
            java.lang.String myFileExtension)

Constructs the object.

Parameters:

mySocket - socket used to communicate with the client

masterFolder - main folder of the VBS server

myFileExtension - extension assigned to the received file

Method Detail

start

public void start()

Starts the thread.

run

public void run()

Runs the client. At first it tries to authenticate the client. If succeeded, the file transfer is performed.

Specified by:

run in interface java.lang.Runnable

authenticateClient

private boolean authenticateClient()
                            throws java.io.IOException

Tries to authenticate the client by checking if the client identifier looks as valid.

Returns:

true if the client was authenticated, false if they client was rejected

Throws:

java.io.IOException - if a communication problem occurs

receiveFile

private void receiveFile()
                  throws java.io.IOException

Receives the file from the client.

Throws:

java.io.IOException - if a communication problem occurs