Configuration

Class diagram#

Instantiating a new Configuration#

Create a new Configuration object by passing the username and password of the Friedolin account you want to access.

While the KeePassXC class allows one to retrieve those credentials from the user’s KeePassXC password database, the Configuration won’t do that for you. In other words, it’s the caller’s responsibility to get the username and password from the user or from KeePassXC.

Configuration configuration = 
	new Configuration("es13nsa", "xkeyscore".toCharArray());

Serialising and deserialising a Configuration#

In order to preserve a configuration for later use after the program is closed, you can easily serialise it to a JSON string and deserialise a JSON file back to a Configuration object.

Configuration configuration = new Configuration("es13nsa", "xkeyscore".toCharArray());
String json;

try {
	json = configuration.toJSON();
} catch (JsonProcessingException e) {
	System.out.println("The configuration could not be serialised to JSON.");
}

File file = new File("friedolyn.json");
Configuration configuration;

try {
	configuration = Configuration.fromFile(file);
} catch (DatabindException e) {
	System.out.println("The JSON does not adhere to the configuration schema.");
} catch (IOException | SecurityException | OutOfMemoryError | InvalidPathException e) {
	System.out.println("The file could not be read.");
} catch (IllegalArgumentException e) {
	System.out.println("The configuration does not include a directory, but the file's parent directory and the default directory are both invalid.");
}

Settings#

User name#

The username of the Friedolin account. Required if use-keepassxc is false. Ignored if use-keepassxc is true.

Password#

The login secret of the Friedolin account. Required if use-keepassxc is false. Ignored if use-keepassxc is true.

Clearname#

The real name of the Friedolin user.

Academic degrees#

The academic degrees pursued by the Friedolin user.

Use KeePassXC#

Whether or not Friedolyn should use KeePassXC to store the password. If true, the user and password fields will be ignored.

E-mail address#

The user’s university e-mail address and, at the same time, the address that Friedolyn should use to send notifications.

Exam PDFs#

Which of the available PDF files that include the student’s grades should be downloaded from Friedolin.

Overwrite exam PDFs#

When re-downloading an already existing exams PDF file, should it be deleted and replaced with the new, update one? If false, the current date and time will be prepended to the file name.

Notifications#

How the user wants to be notified about new grades.

Interval#

The interval in minutes in which Friedolyn should check for new grades.

Type	int
JSON key	interval
Must be	minutes and minutes (7 days)
Default	60 minutes

Client#

Specifies the behaviour of the software part that connects to the Friedolin server.

Contact methods#

In case the user wants to contact the developers, their message is automatically encrypted. But how can the developers send their reply to the user, preferably in a secure way?

Headless mode#

Whether the application’s GUI should be hidden. This has nothing to do with the headless browser.

Debug level#

How verbose the application should be.

• DEBUG:
  When using the HeadlessBrowser, the browser will not be headless and instead show a graphical user interface. Also, all log messages will be printed to the console. Important: Sensitive data, such as PASSWORDS, WILL BE PRINTED TO THE CONSOLE! Use any other debug level if you want to avoid this.
• INFO:
  All log messages will be printed to the console. Less sensitive data, such as EMAIL ADDRESSES, USER NAMES, ACADEMIC DEGREES and GRADES, will be printed to the console.
• WARN:
  Only warnings and errors will be printed to the console. No sensitive data will be printed.
• ERROR:
  Only errors will be printed to the console. No sensitive data will be printed.