OOP Lab Task 4

De la WikiLabs
Jump to navigationJump to search

Required Tutorials

Requirements

  1. Write a class called ServerConfig which has the role of reading configuration values from a text file. This class will be used later on during the development of the server application, and needs to meet the following requirements:
    • The class needs to have two constructors:
      1. One with an argument of type String, which represents the file to be read
      2. One without any arguments, which will implicitly consider the configuration file to be server.conf.
    • Objects of type ServerConfig have to read the file, line by line, and then expose the parameters that were read through methods.
    • The methods in class ServerConfig must throw exceptions if any issues arise when reading or parsing the file:
      1. IOException if the file is missing or it cannot be opened (this exception is already being thrown by stream related classes, so you only need to rethrow it further up the execution stack).
      2. InvalidFormatException if at least one line from the file doesn't match the expected pattern (this type of exception doesn't exist and it needs to be created).
      3. UnknownKeyException if an unknown property is present in the file (this type of exception doesn't exist and it needs to be created).
      4. MissingKeyException if one of the expected properties is missing from the file (this type of exception doesn't exist and it needs to be created).
    • The class must be immutable.
  2. The following properties are the only ones valid and must exist in the configuration file:
    • TCP_PORT - representing the TCP port on which the server will be listening on.
    • MAX_CLIENTS - the maximum number of clients that the server an serve.
  3. Write a test for this class (which should open a file, read its contents and print the read parameters on the screen) and add it to the main method in class Main.


The configuration file that class ServerConfig is reading is a text file, containing lines of the following form:

PROPERTY=value
  • Any line starting with thr character #, preceded or not by spaces or "tab" characters is considered to be a comment and it will be ignored.
  • Lines that do not contain any printable character but only spaces and/ or tabs will also be ignored.
  • Spaces or tabs from the beginning and end of lines are ignored.

An example of a configuration file:

#this is a config file for the chat server!
      #   this is made by ME!
MAX_CLIENT=100
       TCP_PORT=9000


Notes:

  • The three types of exceptions which must be defined have very simple implementations. You need to define them as classes that extend class Exception and they only need to contain a constructor with an argument of type String that only calls the constructor of the super-class of the same type.
  • The submitted files will be only Java implementations of the following classes: ServerConfig, Main, Message, PrivateMessage, InvalidFormatException, UnknownKeyException and MissingKeyException.
  • The following classes and methods may be of use in implementing this assignment. Look them up in the API documentation:
    • String.trim
    • String.charAt
    • String.contains
    • String.startsWith
    • String.equals
    • String.split
    • Integer.parseInt
    • BufferedReader.readLine
  • Because you can have two different objects of type String (with different references) which contain the same character sequence, and because operator == is used to compare references, the correct way to compare two Strings is by calling method equals:
String a = "abc";
String b = new String(a);
if(a == b) { // <- wrong, this is evaluated to false
  //...
}
if(a.equals(b)) { // <- correct, this is evaluated to true
  //...
}

Submitting

  • The assignment will be evaluated automatically by the Web-CAT platform.
  • You could access the Web-CAT platform using the username and the password with which you acces the electronica.curs.pub.ro intranet.
  • Select the OOP Lab Task 3 assignment.
  • Submit your work as a single .zip archive (give it whatever name you choose) containing only the Java source code files.
  • Attention Any deviation from these instructions may lead to the loss of the entire amount of points.