1   Objective

This assignment aims to achieve several objectives at the same time. The first objective is to learn the basic structure of a client-server application. The second objective is to learn the general form and requirements of programming assignments in this course. The third objective is to help you refresh your Java programming skills and setup your development environment for the rest of this course. Thus, while simple and straightforward, the expectation is that every student will try and complete this assignment.

2   Specification

2.1   Overview

In this assignment, you will implement a program called GzipClient. You have to write code to establish a TCP connection with a remote server, read the content of a given file from the local file system, send it to the server for GZIP compression, receive the compressed file content and save it to a new file in the local file system. While the server used in this assignment provides GZIP compression, the client implementation is in fact independent of that and can be used to obtain other services (e.g., encryption) by changing the server implementation.

2.2   Protocol

The protocol that the client and server use to communicate in this assignment is a custom pro- tocol (i.e., designed by the instructor). The high-level behavior of the sender side and client side of the protocol is presented in Programs 1 and 2, respectively:

2.3   Implementation

Let us start by discussing the server implementation, as the client implementation should com- ply with the server implementation. The following code snippet shows the actual implementa- tion of the read and write operations in the server.

The important thing to notice is that the server does not know how much data it has to read from the client. In this implementation, the server keeps reading from its socket input stream by repeatedly calling the read() method until it returns - 1 (indicating the end of file was reached or the connection was closed). Thus, at the client side, you have to signal to the server that the transmission is complete by closing the socket output stream at the client side.  This will cause subsequent calls to read() method to eventually return - 1. Unfortunately, the way Java sockets are implemented, closing the input or output stream of a socket closes the socket as well. To keep the socket open, e.g., to be able to read the compressed data coming from the server, while closing its output stream, the client side program should use shutdownOutput() method when it has transmitted the entire file.

The client implementation should have a similar structure. Specifically, as in the server, all read and write operations should operate over a chunk of data (i.e., using a buffer). The size of the buffer is a design decision but a multiple of TCP packet size is recommended for performance reasons (e.g., 32 KByte). While a program can use the version of read and write methods that operate over a single byte, its performance will suffer due to the overhead of single byte input and output operations. An important aspect of your design is how to implement Steps 4 and 5 (see Program 2) to avoid deadlock, i.e., a situation where the client and server are blocked by each other.  To this end, you must consider implementing sending and receiving operations of the client in separate threads that run independently from each other. Refer to the assignment notes and tutorialsfor more detail on this.

2.4   Design Requirements

Your client design should be based on the following principles:

• Block IO: Read and write operations must use a buffer to perform file and socket IO. As discussed earlier, this is to avoid poor performance.

• Parallel IO: Read and write operations on the socket must be implemented in separate threads, namely one thread to read from the socket and one tread to write to the socket. As discussed earlier, this is to avoid deadlock without any performance penalty.

3   Software Interfaces

3.1   Method Signatures

The required method signatures for class GzipClient are provided to you in the source file GzipClient . java. There are two methods that you need to implement, namely the construc- tor GzipClient() and method gzip(). A brief description of gzip() is provided below. For more information, refer to the Javadoc documentation provided in the source file.

• void  gzip(String  inFile,  String  outFile)

This is the main method that reads the local file and communicates with the remote server

to create a GZIP compressed version of the file. The parameter inFile specifies the name of the input file, while the parameter outFile specifies the name of the compressed file to be created.

3.2   Exception Handling

Your implementation should include exception handling code to deal with all checked excep- tions in your program.  Print exception messages (i.e., the stack trace) to the standard system output.