Assignment 3 - Full Stack

1    About the assignment

.  Deadline: Monday 22nd-April-2024 at 16:00 (UK time).

.  Late submissions policy: No late submissions allowed.

. What to submit: A single  .zip file as explained in Section 6

.  Learning outcome: Integrate a database, server, and front-end into a full software stack.

. Where has the skill been learned in the module:

– Weeks 1-2 covered front end interface creation using JavaFX.

– Weeks 3-7 covered SQL querying.

– Week 8 covered concepts and code on Threads’ creation, execution and termination.

– Week 9 covered concepts and code on Client-Server Architecture, in- cluding a lab exercise using TCP.

–  Week 10 covered concepts and code on JDBC.

.  Note:  As this assignment is being released a few days before the Week 10 lectures on JDBC, you have been given a long submission deadline in order to give you plenty of time to get familiar with the concepts.

2    Problem statement

In this assignment you will be implementing a complete full stack application by  “putting together” all the bits and pieces you have been studying over the course. The emphasis though is on JDBC and Java networking aspects, as the rest has been assessed in previous assignments.

In particular,  you will be  developing  a  3-tier  TCP-based networking multi-threaded client-server application to consult a database about vinyl records. The application features a client that offers a JavaFX based graph- ical user interface to request the service and communicate with a intermedi- ate server providing a query specific service.  The server, located in the local host, will be composed of two parts or classes; one being the main server which attend request as they arrive on an infinite loop, and the server’s service provider that are created to attend each service.  It is the server’s service provider which does connects to the database using JDBC, retrieves the outcome of the query and sends back the outcome to the client.

Although each service provider thread will only attend 1 request and then stop, the server will attend any number of request by creating new service threads.

The service provided is a fixed but parameterizable query;  Given  an artist’s last name and a record shop’s city, the query must retrieve the list of records available from the author at the indicated record shop.  For each record available, the query must retrieve, the record’s title, the music label, the genre and the recommended retailer’s price together with the number of copies available for that record at that record shop.  Records from the artist that are not available in the record shop (i.e.  0 copies) should NOT be listed. For artists that do not have a surname, e.g ‘Metallica’, the band name should be used.  In these cases, both the firstname and lastname in the database are set to the band name.

Both, the client and the server applications should be able to work with- out errors when the query returns no entries.  The server will be robust to SQL injection.

In all classes, you are requested to treat exceptions in the method that first can raise themi.e. do not rely in throws clauses to deal with exceptions at a later stage.  If some exceptions requires you to stop the execution of either the servers, or the client without a correct resolution of the request, make sure that in those cases you exit the program with code 1. Exit with code 0 if program execution is correct.

Feel free to use any IDE of your choice, but tests will be carried from the command line. The back end will be implemented in postgreSQL using postgresql-42.6.0.jar driver. Tests will be run in a Linux machine.

3    Setting up the database

For this assignment you will use the ’FSAD2024 Records’ database .  This is provided to you.  Download the file records.sql from Canvas.  Open as postgres shell window and connect with your own credentials.  First, you need to find the path on your own computer where you have the file. Then import this file is as follows:

\i  /path/to/database/records.sql

Once you have imported the tables, you can list them by performing the following command in PostgreSQL:

\dt

Note that this will list all of the tables you may have created in this database.

Run SQL commands to view the contents of each table by doing

SELECT  *  FROM  tablename;

replacing tablename with the name of the table you want to look at.

4    Templates

You are provided with templates for  all classes in canvas.   The  exercise requires you to fill the gaps clearly identified with;

//TO   BE   COMPLETED

The templates already contain all the atributes, methods, and correct signatures.  There is no need to create more attributes for the classes, nor additional methods,  nor to import new classes or libraries,  but you can declare local variables within the methods as you may need.  Do not alter the signature of the methods as the automarker will rely on these.

.  public  String[]  retrieveRequest():  Receives the  information corre- sponding to the client request. This method accepts the server’s service requests.  Upon receiving the service request, it parses the message to remove the termination character (‘#’) from the incoming message.  The message will arrive in the form of a string.  The remaining part of the incoming message contains the two parameters of the query; that is, the artist’s surname and the city of the record shop separated by a semicolon; e.g. ‘Sheeran;Cardiff’. This method must parse the message splitting this message content into its two components and return a String[] with two elements; the first one being the artist’s surname and the second being the record shop.

.  public boolean attendRequest():  This method provides the actual service.  It connects to the database, make the query, execute the query and retrieve the outcome and process the query.   It  should be robust to SQL injection.  The connection, statement and result set should be closed properly afterwards.   The  processing  of the query will transfer the contents of the ResultSet obtained from executing the query, into a CachedRowSet object that can survive the closing of the connection and can be sent over a socket (i.e.  it requires to be serializable).  The method returns a flag indicating whether the service has been attended sucessfully.   Finally,  to transfer the  contents of the ResultSet into a CachedRowSet object you can use;

RowSetFactory   aFactory  =   RowSetProvider. newFactory(); CachedRowSet   crs  =   aFactory. createCachedRowSet();

crs. populate(rs);  //with  rs  being   the   ResultSet

variable .

.  public void returnServiceOutcome(): Communicate the service out- come back to the client.  This method returns the outcome of the request to the client and closes the service’s socket. To send full objects through a socket you can use ObjectOutputStream. For instance;

ObjectOutputStream   outcomeStreamWriter  =  new

ObjectOutputStream (...);

outcomeStreamWriter. writeObject (...);

.  public void run (): Provided. No need to do anything. Execution.

5.4    RecordsDatabaseClient.java

This is the client or service consumer.  It is a JavaFX application with a simple GUI (See Figure 1) with 2 major parts;

7    Rubric

.  RecordsDatabaseServer.java: 25%

.  RecordsDatabaseService.java: 40%

.  RecordsDatabaseClient.java: 35%

8    Sample outputs

Your outputs should match the sample outputs.

8.1    Server output

All server output is reported via the console.  This combines the output of

both the RecordsDatabaseServer.java and the RecordsDatabaseService.java as they together both form the server application. An exemplary output of

the server application is shown in Figure 2.  The numbers accompanying the “Service thread” line prefixes corresponds to the thread id. These will vary in each run.

8.2    Client output

The client output is reported via both, the GUI and the console.  An exem- plary output of the client application in the console is shown in Figure 3. The corresponding two services requests in such execution are presented in Figures 4 and 5 respectively.  Also, Figure 1 shows how the output table should look when a query returns no records.   A  console output when a query returns no records will simply be empty e.g.

Client:  Requesting  records  database  service  for  user  command Franklin;Berlin

****  []

====================================

The lines preceded by **** list object identifiers in the outcome. These will vary in each run. It is optional to include these lines in the output.