Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.client

Class FriedolinClient

java.lang.Object

page.codeberg.friedolyn.client.FriedolinClient

Direct Known Subclasses:

Client, HeadlessBrowser

public abstract class FriedolinClient
extends Object

A client to automatically interact with the University of Jena's Friedolin system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FriedolinClient.FetchClearname	A Task that can be executed in a different Thread to fetch the student's real name (e.g.
static class	FriedolinClient.FetchEmailAddress	A Task that can be executed in a different Thread to fetch the student's email address (e.g.
static enum	FriedolinClient.HTTP_REQUEST_TYPE	The method to use for an HTTP request.
static enum	FriedolinClient.InternetConnectivityStatus	Indicates whether and how the device is able to connect to the internet.
static class	FriedolinClient.Login	A Task that can be executed in a different Thread to log in to Friedolin using the student's credentials specified in the Configuration previously set via setConfiguration(Configuration) (or the constructor).

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull Duration	SESSION_LIFETIME	The lifetime of a session in the University of Jena's Friedolin system.

Constructor Summary

Constructors

Constructor	Description
FriedolinClient()

Method Summary

Modifier and Type	Method	Description
static @NonNull String	buildURL(@NonNull String domain, @NonNull String path, @NonNull Map<@NonNull String,@NonNull String> parameters)	Creates a new URL from the given domain, path, and parameters.
abstract @NonNull FriedolinClient.InternetConnectivityStatus	checkInternetConnectivity()	Checks whether the device is able to reach the internet and resolve domain names.
static @NonNull LinkedHashMap<@NonNull String,@NonNull String>	decodeQuery(@NonNull String query)	Decodes the given query string into a map of keys and values.
static @NonNull String	encodeParameters(@NonNull Map<@NonNull String,@NonNull String> parameters)	Encodes the given parameters such that they can be used in a URL or in a POST request.
@NonNull jakarta.mail.internet.InternetAddress	fetchEmailAddress()	Fetches the student's email address from the University of Jena's Friedolin system and updates the configuration accordingly.
abstract boolean	fetchGrades(@NonNull String... degrees)	Fetches the student's grades from the University of Jena's Friedolin system, using the credentials specified in the Configuration previously set via setConfiguration(Configuration) (or the constructor).
@NonNull String	fetchStudentClearname()
abstract void	finish()	Exits the headless browser.
abstract @NonNull Configuration	getConfiguration()
abstract @NonNull FriedolinClient.FetchClearname	getFetchClearnameTask()
abstract @NonNull FriedolinClient.FetchEmailAddress	getFetchEmailAddressTask()
abstract @NonNull Expiring<Boolean>	getIsLoggedIn()
abstract @NonNull FriedolinClient.Login	getLoginTask()
boolean	login()	Logs in to Friedolin in a blocking manner.
protected boolean	saveResponse(@NonNull String filename, @NonNull String response)	Saves the given response to a file with the given filename in the responses directory.
abstract void	setConfiguration(@NonNull Configuration configuration)	Updates the preferences that determine the behaviour of this client with a deep copy of the given configuration (not the actual reference, for security reasons).
abstract void	setConfigurationReference(@NonNull Configuration configuration)	Updates the preferences that determine the behaviour of this client with the exact reference of the given Configuration (instead of just a deep copy).
static @NonNull URL	stripAnchor(@NonNull URL url)	Removes the HTML anchor from the given URL, if it has one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SESSION_LIFETIME

@NonNull
public static final @NonNull Duration SESSION_LIFETIME

The lifetime of a session in the University of Jena's Friedolin system. Currently, you have to log in again after 30 minutes.

Constructor Details

FriedolinClient

public FriedolinClient()

Method Details

getConfiguration

@NonNull
public abstract @NonNull Configuration getConfiguration()

Returns:

A deep copy of the preferences that determine the behaviour of this client (not the actual reference, for security reasons).

Implementation Note:

It is required that the returned object is a deep copy of the configuration.

setConfiguration

public abstract void setConfiguration(@NonNull
 @NonNull Configuration configuration)

Updates the preferences that determine the behaviour of this client with a deep copy of the given configuration (not the actual reference, for security reasons).

Parameters:

configuration - The new configuration to use.

See Also:

• setConfigurationReference(Configuration)

Implementation Note:

It is required that a deep copy of the given configuration is stored.

setConfigurationReference

public abstract void setConfigurationReference(@NonNull
 @NonNull Configuration configuration)

Updates the preferences that determine the behaviour of this client with the exact reference of the given Configuration (instead of just a deep copy).

Parameters:

configuration - The new configuration to use.

See Also:

• setConfiguration(Configuration)

Implementation Note:

It is required to store the exact object instance instead of calling copy().

login

public boolean login()

Logs in to Friedolin in a blocking manner. Due to the notoriously long response times of network requests, it is recommended to run the non-blocking getLoginTask() in a separate Thread instead of calling this method directly, in order not to block the rest of the application (e.g. the GUI).

Returns:

true if the login was successful, false otherwise

getLoginTask

@NonNull
public abstract @NonNull FriedolinClient.Login getLoginTask()

Returns:

A Task that can be executed in a different Thread to log in to Friedolin.

getFetchClearnameTask

@NonNull
public abstract @NonNull FriedolinClient.FetchClearname getFetchClearnameTask()

Returns:

A Task that can be executed in a different Thread to fetch the student's real name (e.g. Edward Snowden) from the University of Jena's Friedolin system.

getFetchEmailAddressTask

@NonNull
public abstract @NonNull FriedolinClient.FetchEmailAddress getFetchEmailAddressTask()

Returns:

A Task that can be executed in a different Thread to fetch the student's email address (e.g. edward.snowden@uni-jena.de).

fetchGrades

public abstract boolean fetchGrades(@NonNull
 @NonNull String... degrees)
                             throws IllegalArgumentException

Fetches the student's grades from the University of Jena's Friedolin system, using the credentials specified in the Configuration previously set via setConfiguration(Configuration) (or the constructor).

Parameters:

degrees - The academic degrees to fetch the grades for. If none are specified, all degrees present in

invalid reference

Configuration#getAcademicDegrees()

will be fetched.

Returns:

true if the grades were fetched successfully, false otherwise.

Throws:

IllegalArgumentException - If any of the given degrees is not present in the configuration.

fetchStudentClearname

@NonNull
public @NonNull String fetchStudentClearname()
                                      throws org.openqa.selenium.NotFoundException

Returns:

The student's clear name as indicated in the University of Jena's Friedolin system.

Throws:

org.openqa.selenium.NotFoundException - If the student's clear name could not be found.

fetchEmailAddress

@NonNull
public @NonNull jakarta.mail.internet.InternetAddress fetchEmailAddress()
                                                                 throws org.openqa.selenium.NotFoundException

Fetches the student's email address from the University of Jena's Friedolin system and updates the configuration accordingly.

Returns:

The student's email address as indicated in the University of Jena's Friedolin system.

Throws:

org.openqa.selenium.NotFoundException - If the student's email address could not be found.

finish

public abstract void finish()

Exits the headless browser. This method should be called when the headless browser is no longer needed but the application is still running, in order not to waste resources longer than necessary. Yes, Java has a garbage collector, but there may be situations where the parent of this object is still in use but does not need the headless browser anymore.

getIsLoggedIn

@NonNull
public abstract @NonNull Expiring<Boolean> getIsLoggedIn()

Returns:

Whether the student is currently logged in at the University of Jena's Friedolin system. The login status is only valid for the length of SESSION_LIFETIME.

checkInternetConnectivity

@NonNull
public abstract @NonNull FriedolinClient.InternetConnectivityStatus checkInternetConnectivity()

Checks whether the device is able to reach the internet and resolve domain names. Will connect to some well-known server. Blocks the current thread for a short time, depending on the implementation.

Returns:

The current internet status.

See Also:

• Client.checkInternetConnectivity()
• HeadlessBrowser.checkInternetConnectivity()

saveResponse

protected boolean saveResponse(@NonNull
 @NonNull String filename,
 @NonNull
 @NonNull String response)

Saves the given response to a file with the given filename in the responses directory.

Parameters:

filename - The name of the file to save the response to.

response - The response to save.

encodeParameters

@NonNull
public static @NonNull String encodeParameters(@NonNull
 @NonNull Map<@NonNull String,@NonNull String> parameters)

Encodes the given parameters such that they can be used in a URL or in a POST request.

Parameters:

parameters - The parameters to encode with keys and values.

Returns:

The encoded parameters as a String in the format key1=value1&key2=value2&...

buildURL

@NonNull
public static @NonNull String buildURL(@NonNull
 @NonNull String domain,
 @NonNull
 @NonNull String path,
 @NonNull
 @NonNull Map<@NonNull String,@NonNull String> parameters)

Creates a new URL from the given domain, path, and parameters.

Parameters:

domain - The domain to use in the URL, without the protocol. Default protocol is HTTPS.

path - The path to use in the URL, without the domain.

parameters - The parameters to add to the URL.

Returns:

The URL as a String.

stripAnchor

@NonNull
public static @NonNull URL stripAnchor(@NonNull
 @NonNull URL url)
                                throws MalformedURLException

Removes the HTML anchor from the given URL, if it has one.

Parameters:

url - The URL to remove the anchor from. Will not be modified.

Returns:

An entirely new URL without the anchor.

Throws:

MalformedURLException - If the URL is malformed (this is de facto impossible, because the given parameter is already a URL object).

decodeQuery

@NonNull
public static @NonNull LinkedHashMap<@NonNull String,@NonNull String> decodeQuery(@NonNull
 @NonNull String query)

Decodes the given query string into a map of keys and values.

Parameters:

query - The query string to decode, usually the parameters taken from a URL.

Returns:

The decoded query as a map of keys and values, in the same order as they appeared in the query string.