Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.client

Class Client.Login

java.lang.Object

page.codeberg.friedolyn.util.Task<Boolean>

page.codeberg.friedolyn.client.FriedolinClient.Login

page.codeberg.friedolyn.client.Client.Login

All Implemented Interfaces:

Runnable

Enclosing class:

Client

public class Client.Login
extends 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 FriedolinClient.setConfiguration(Configuration) (or the constructor).

See Also:

• run()
• setFetchPersonalData(boolean, boolean)

Nested Class Summary

Nested classes/interfaces inherited from class page.codeberg.friedolyn.util.Task

Task.CancelListener, Task.FailureListener<ResultType>, Task.ProgressListener, Task.SuccessListener<ResultType>, Task.TaskListener<ResultType>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	fetchClearname	Whether the student's clear name should be found out while logging in.
private boolean	fetchEmailAddress	Whether the student's e-mail address should be found out while logging in.
private boolean	isCancelled	Whether the task has been prematurely terminated by outside intervention.
private final @NonNull HashSet<Task.TaskListener<Boolean>>	LISTENERS	The subscribers that will be notified about any status changes and progress updates of this task.
private Boolean	success	Whether the login was executed successfully.
static final int	TOTAL_WORK	The amount of steps to complete this task.

Constructor Summary

Constructors

Constructor	Description
Login()

Method Summary

Modifier and Type	Method	Description
void	cancel()	Prematurely terminates the action.
private void	cancelled()	Notifies all subscribers that the login process was terminated prematurely by outside intervention.
private void	extractStudentClearname(String html)	Uses the Parser to find out the student's clear name from the given HTML document retrieved from Friedolin.
private void	failed()	Notifies all subscribers that the login process finished unsuccessfully.
@NonNull Optional<Result<Boolean>>	getResult()
void	registerListener(@NonNull Task.TaskListener<Boolean> listener)	Adds a subscriber that is interested in status updates of the action's progress.
boolean	removeListener(@NonNull Task.TaskListener<Boolean> listener)	Removes a subscriber that was previously added to receive status updates of the action's progress.
void	run()	Logs in to Friedolin using the student's credentials specified in the Configuration previously set via FriedolinClient.setConfiguration(Configuration) (or the constructor).
void	setFetchPersonalData(boolean fetchClearname, boolean fetchEmailAddress)	Updates the setting whether the student's clear name and email address should be fetched from the University of Jena's Friedolin system along with the login.
private void	started()	Notifies all subscribers that the login process has begun.
private void	succeeded()	Notifies all subscribers that the login process was successful.
private void	updateProgress(int current, int total)	Notifies all subscribers about the amount of work that has already been done and the total amount of work that needs to be done to finish logging in.

Methods inherited from class page.codeberg.friedolyn.util.Task

setOnCancelled, setOnFailed, setOnProgressUpdate, setOnSucceeded

Methods inherited from class java.lang.Object

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

Field Details

TOTAL_WORK

public static final int TOTAL_WORK

The amount of steps to complete this task.

See Also:

• Task.ProgressListener.onProgressUpdate(int, int)
• Constant Field Values

LISTENERS

@NonNull
private final @NonNull HashSet<Task.TaskListener<Boolean>> LISTENERS

The subscribers that will be notified about any status changes and progress updates of this task.

fetchClearname

boolean fetchClearname

Whether the student's clear name should be found out while logging in.

fetchEmailAddress

private boolean fetchEmailAddress

Whether the student's e-mail address should be found out while logging in.

success

@Nullable
private Boolean success

Whether the login was executed successfully. null until the task has finished.

isCancelled

private boolean isCancelled

Whether the task has been prematurely terminated by outside intervention.

Constructor Details

Login

public Login()

Method Details

registerListener

public void registerListener(@NonNull
 @NonNull Task.TaskListener<Boolean> listener)

Adds a subscriber that is interested in status updates of the action's progress. Does NOT remove or replace any existing listeners.

Specified by:

registerListener in class Task<Boolean>

Parameters:

listener - The subscriber that wants to be informed about the progress of the action.

See Also:

• Task.removeListener(TaskListener)

removeListener

public boolean removeListener(@NonNull
 @NonNull Task.TaskListener<Boolean> listener)

Removes a subscriber that was previously added to receive status updates of the action's progress.

Specified by:

removeListener in class Task<Boolean>

Parameters:

listener - The subscriber that no longer wants to be informed about the progress of the action. Must be the exact same reference that was previously registered.

Returns:

true if the subscriber was removed, false if it hadn't been registered in the first place.

See Also:

• Task.registerListener(TaskListener)

updateProgress

private void updateProgress(int current,
 int total)

Notifies all subscribers about the amount of work that has already been done and the total amount of work that needs to be done to finish logging in.

started

private void started()

Notifies all subscribers that the login process has begun.

failed

private void failed()

Notifies all subscribers that the login process finished unsuccessfully.

cancelled

private void cancelled()

Notifies all subscribers that the login process was terminated prematurely by outside intervention.

succeeded

private void succeeded()

Notifies all subscribers that the login process was successful.

cancel

public void cancel()

Prematurely terminates the action. The action will be stopped as soon as possible, but it may not be immediate, depending on the implementation.

Specified by:

cancel in class Task<Boolean>

getResult

@NonNull
public @NonNull Optional<Result<Boolean>> getResult()

Specified by:

getResult in class Task<Boolean>

Returns:

The end product generated by the action. Empty if the action has not finished yet. The presence of Result.getResult() does NOT indicate success. Only Result.getSuccess() can be used to determine success or failure.

setFetchPersonalData

public void setFetchPersonalData(boolean fetchClearname,
 boolean fetchEmailAddress)

Updates the setting whether the student's clear name and email address should be fetched from the University of Jena's Friedolin system along with the login. May require additional network requests, slowing down the login process.

The results of the fetches will be stored in the configuration as Configuration.getClearname() and Configuration.getEmail().

Specified by:

setFetchPersonalData in class FriedolinClient.Login

Parameters:

fetchClearname - Whether the student's clear name should be found out. True by default.

fetchEmailAddress - Whether the student's email address should be found out. False by default.

extractStudentClearname

private void extractStudentClearname(String html)
                              throws IllegalArgumentException

Uses the Parser to find out the student's clear name from the given HTML document retrieved from Friedolin.

Parameters:

html - The body of the response to the HTTP request to Friedolin.

Throws:

IllegalArgumentException - If the student's clear name could not be extracted from the HTML document.

run

public void run()
         throws IllegalStateException

Logs in to Friedolin using the student's credentials specified in the Configuration previously set via FriedolinClient.setConfiguration(Configuration) (or the constructor).

Specified by:

run in interface Runnable

Specified by:

run in class Task<Boolean>

Throws:

IllegalStateException - If the login task has already been executed.