Uses of Class
page.codeberg.friedolyn.configuration.Configuration

Packages that use Configuration

Package	Description
page.codeberg.friedolyn
page.codeberg.friedolyn.client
page.codeberg.friedolyn.configuration
page.codeberg.friedolyn.configuration.client
page.codeberg.friedolyn.gui
page.codeberg.friedolyn.gui.controllers
page.codeberg.friedolyn.meta
page.codeberg.friedolyn.notifications

Uses of Configuration in page.codeberg.friedolyn

Fields in page.codeberg.friedolyn declared as Configuration

Modifier and Type	Field	Description
private @NonNull Configuration	Friedolyn.configuration	Various options that modify Friedolyn's behaviour.
private static Configuration	Main.configuration	The user's preferences for the behaviour of the application.

Methods in page.codeberg.friedolyn that return Configuration

Modifier and Type	Method	Description
@NonNull Configuration	Friedolyn.getConfiguration()
private static @NonNull Configuration	Main.getConfigurationFromCommandLine(@NonNull String[] arguments)	Parses the command-line arguments and creates a Configuration object from them.
private static @NonNull Configuration	Main.getConfigurationFromDirectory(@NonNull File folder)	Tries to read a configuration file from the given directory.
@NonNull Configuration	Friedolyn.getReferenceToConfiguration()

Methods in page.codeberg.friedolyn that return types with arguments of type Configuration

Modifier and Type	Method	Description
static @NonNull Optional<Configuration>	Main.getConfigurationFromDefaultLocation()	Tries to read the configuration file saved in the file Preference of the Friedolyn class or, if that fails, from the directory Preference or, if that fails, from the default directory, which is ~/.friedolyn.

Methods in page.codeberg.friedolyn with parameters of type Configuration

Modifier and Type	Method	Description
void	Friedolyn.setConfiguration(@NonNull Configuration configuration)	Updates the current Friedolyn.configuration with the deep copy of a new one (not the actual reference of it, for security reasons).

Constructors in page.codeberg.friedolyn with parameters of type Configuration

Modifier	Constructor	Description
	Friedolyn(@NonNull Configuration configuration)	Creates a new Friedolyn object with a deep copy of the given configuration.

Uses of Configuration in page.codeberg.friedolyn.client

Fields in page.codeberg.friedolyn.client declared as Configuration

Modifier and Type	Field	Description
private @NonNull Configuration	Client.configuration	Various options that modify Friedolyn's behaviour.
private @NonNull Configuration	HeadlessBrowser.configuration	The configuration with all parameters required to log in at the University of Jena's Friedolin system.

Methods in page.codeberg.friedolyn.client that return Configuration

Modifier and Type	Method	Description
@NonNull Configuration	Client.getConfiguration()
abstract @NonNull Configuration	FriedolinClient.getConfiguration()

Methods in page.codeberg.friedolyn.client with parameters of type Configuration

Modifier and Type	Method	Description
void	Client.setConfiguration(@NonNull Configuration configuration)	Updates the current Client.configuration with a deep copy of the given one (not the actual reference of it, for security reasons).
abstract void	FriedolinClient.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).
void	HeadlessBrowser.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).
void	Client.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).
abstract void	FriedolinClient.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).
void	HeadlessBrowser.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).

Constructors in page.codeberg.friedolyn.client with parameters of type Configuration

Modifier	Constructor	Description
	Client(@NonNull Configuration configuration)	Creates a new client that can be used immediately without further configuration or initialisation.
	HeadlessBrowser(@NonNull Configuration configuration)	Creates a new headless browser instance with the provided configuration.

Uses of Configuration in page.codeberg.friedolyn.configuration

Methods in page.codeberg.friedolyn.configuration that return Configuration

Modifier and Type	Method	Description
@NonNull Configuration	Configuration.copy()
static @NonNull Configuration	Configuration.fromFile(File file)	Creates a new Configuration from a given JSON file.
static @NonNull Configuration	Configuration.fromJSON(String json)	Creates a new Configuration from a given JSON.

Uses of Configuration in page.codeberg.friedolyn.configuration.client

Fields in page.codeberg.friedolyn.configuration.client declared as Configuration

Modifier and Type	Field	Description
private @NonNull Configuration	UserAgentManager.configuration	We need this in order to know where to store the user-agents file.

Constructors in page.codeberg.friedolyn.configuration.client with parameters of type Configuration

Modifier	Constructor	Description
	UserAgentManager(@NonNull Configuration configuration)	Creates a new user-agent manager and tries to import the user-agents.json file from the invalid reference Friedolyn directory specified in the given configuration.

Uses of Configuration in page.codeberg.friedolyn.gui

Methods in page.codeberg.friedolyn.gui with parameters of type Configuration

Modifier and Type	Method	Description
static @NonNull GUI.DialogResult<@NonNull ContactController.ContactResult>	GUI.openContactDialog(@NonNull Configuration configuration)	Opens the GUI.Window.CONTACT window to let the user send a message to the developers of the application.
static @NonNull GUI.DialogResult<@NonNull ContactController.ContactResult>	GUI.openContactDialog(@NonNull Configuration configuration, Friedolyn.ContactRequest contactRequest)	Opens the GUI.Window.CONTACT window to let the user send a message to the developers of the application.
static @NonNull GUI.DialogResult<@NonNull ContactMethods>	GUI.openContactReplyDialogWindow(@NonNull Configuration configuration)	Opens the GUI.Window.CONTACT_REPLY_METHOD_DIALOG window to let the user choose how the developers should reply to their contact request.
static void	GUI.openContactWindow(@NonNull Configuration configuration, boolean wait)	Opens the GUI.Window.CONTACT window to let the user contact the developers of the application.
static @NonNull GUI.DialogResult<@NonNull EMailNotifier>	GUI.openSetupEmailDialogWindow(@NonNull Configuration configuration)
static @NonNull GUI.DialogResult<@NonNull NtfyNotifier>	GUI.openSetupNtfyDialogWindow(@NonNull Configuration configuration)	Opens a dialog window that asks the user to configure a NtfyNotifier for push notifications.
static void	GUI.openSetupNtfyDialogWindow(@NonNull Configuration configuration, boolean wait)	Opens the GUI.Window.SETUP_NTFY_DIALOG window to let the user configure a NtfyNotifier for push notifications.
static @NonNull GUI.DialogResult<@NonNull UnifiedPushNotifier>	GUI.openSetupUnifiedPushDialogWindow(@NonNull Configuration configuration)	Opens a dialog window that asks the user to configure a UnifiedPushNotifier for push notifications.
static void	GUI.openSetupUnifiedPushDialogWindow(@NonNull Configuration configuration, boolean wait)	Opens the GUI.Window.SETUP_UNIFIED_PUSH_DIALOG window to let the user configure a UnifiedPushNotifier for push notifications.

Uses of Configuration in page.codeberg.friedolyn.gui.controllers

Fields in page.codeberg.friedolyn.gui.controllers declared as Configuration

Modifier and Type	Field	Description
private Configuration	ContactController.configuration	The configuration with the user's login credentials and contact information.
private final Configuration	ContactController.InitialisationParameters.configuration	The field for the configuration record component.
private Configuration	FirstLaunchController.configuration
private Configuration	SetupUnifiedPushDialogController.configuration	Will be set as the notifier's configuration.

Methods in page.codeberg.friedolyn.gui.controllers that return Configuration

Modifier and Type	Method	Description
Configuration	ContactController.InitialisationParameters.configuration()	Returns the value of the configuration record component.

Methods in page.codeberg.friedolyn.gui.controllers with parameters of type Configuration

Modifier and Type	Method	Description
void	ContactReplyMethodDialogController.prepare(@NonNull Configuration configuration)	Prepares the contact reply dialog for operation by creating a new ContactMethods object with the user name from the given configuration.
void	SetupEmailDialogController.prepare(@NonNull Configuration configuration)	Uses the given Configuration to insert the user's current e-mail setup into the dialog.
void	SetupNtfyDialogController.prepare(@NonNull Configuration configuration)	Uses the given Configuration to insert the user's current Ntfy setup into the dialog.
void	SetupUnifiedPushDialogController.prepare(@NonNull Configuration configuration)	Uses the given Configuration to insert the user's current UnifiedPush setup into the dialog.

Constructors in page.codeberg.friedolyn.gui.controllers with parameters of type Configuration

Modifier	Constructor	Description
	InitialisationParameters(Configuration configuration, Friedolyn.ContactRequest contactRequestType)	Creates an instance of a InitialisationParameters record class.

Uses of Configuration in page.codeberg.friedolyn.meta

Fields in page.codeberg.friedolyn.meta declared as Configuration

Modifier and Type	Field	Description
private @NonNull Configuration	PolledMetadata.configuration	Specifies the Configuration object that contains the directory where the metadata file is stored.

Methods in page.codeberg.friedolyn.meta with parameters of type Configuration

Modifier and Type	Method	Description
private @NonNull Optional<String>	BannedUser.decryptMessage(@NonNull Configuration configuration)	Decrypts the developers' BannedUser.message to the user, trying the user name, the e-mail address, and the clear name as the password.
Result<String>	BannedUser.matches(@NonNull Configuration configuration)	Checks if the user corresponding to the given Configuration matches this banned user.
private boolean	BannedUser.matchesClearName(@NonNull Configuration configuration)	Checks if the clear name's hash matches the BannedUser.clearName of this banned user.
private boolean	BannedUser.matchesEmail(@NonNull Configuration configuration)	Checks if the e-mail address's hash matches the BannedUser.email of this banned user.
private boolean	BannedUser.matchesUser(@NonNull Configuration configuration)	Checks if the user name's hash matches the BannedUser.username of this banned user.

Constructors in page.codeberg.friedolyn.meta with parameters of type Configuration

Modifier	Constructor	Description
	PolledMetadata(@NonNull Configuration configuration)	Creates a new PolledMetadata object and tries to import the metadata.json file from the invalid reference directory specified in the given Configuration.
	PolledMetadata(@NonNull Configuration configuration, boolean decryptPollURL)	Creates a new PolledMetadata object and tries to import the metadata.json file from the invalid reference directory specified in the given Configuration.

Uses of Configuration in page.codeberg.friedolyn.notifications

Fields in page.codeberg.friedolyn.notifications declared as Configuration

Modifier and Type	Field	Description
private @NonNull Configuration	EMailNotifier.configuration	The student's settings, including the e-mail address and password (both must be set) that will be used to authenticate with the university's SMTP server.
private Configuration	UnifiedPushNotifier.configuration	Provides the client configuration containing the invalid reference user agent and invalid reference DNT / invalid reference GPC settings that will be used when sending the notification.

Methods in page.codeberg.friedolyn.notifications that return Configuration

Modifier and Type	Method	Description
@NonNull Configuration	EMailNotifier.getConfiguration()
@NonNull Configuration	EMailNotifier.getReferenceToConfiguration()

Methods in page.codeberg.friedolyn.notifications with parameters of type Configuration

Modifier and Type	Method	Description
void	UnifiedPushNotifier.setConfiguration(@NonNull Configuration configuration)	Updates the UnifiedPushNotifier.configuration with the new Configuration object reference.

Constructors in page.codeberg.friedolyn.notifications with parameters of type Configuration

Modifier	Constructor	Description
	EMailNotifier(@NonNull Configuration configuration)	Creates a new EMailNotifier with the given Configuration providing the student's SMTP credentials.
	EMailNotifier(@NonNull Configuration configuration, boolean enablePgpEncryption)	Creates a new EMailNotifier with the given Configuration providing the student's SMTP credentials.
	UnifiedPushNotifier(@NonNull URL url, @NonNull Configuration configuration)	Creates a new UnifiedPushNotifier with the given URL used to send notifications and the client configuration.