Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.client

Class HeadlessBrowser.Login

java.lang.Object

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

page.codeberg.friedolyn.client.FriedolinClient.Login

page.codeberg.friedolyn.client.HeadlessBrowser.Login

All Implemented Interfaces:

Runnable

Enclosing class:

HeadlessBrowser

public class HeadlessBrowser.Login
extends FriedolinClient.Login

See Also:

• FriedolinClient.Login

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
private boolean	fetchClearname	Whether the student's clear name should be fetched after logging in.
private boolean	fetchEmailAddress	Whether the student's email address should be fetched after logging in.
private boolean	isCancelled	Whether the task was prematurely finished by outside intervention.
private final @NonNull HashSet<Task.TaskListener<Boolean>>	LISTENERS	The subscribers interested in the progress and status updates of this task.
private Boolean	success	Whether logging in was successful.
static final int	TOTAL_WORK	The total number of steps required to log in.

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 logging in has been prematurely terminated by outside intervention.
private void	failed()	Notifies all subscribers that logging in has failed.
@NonNull Optional<Result<Boolean>>	getResult()
void	registerListener(@NonNull Task.TaskListener<Boolean> taskListener)	Adds a subscriber that is interested in status updates of the action's progress.
boolean	removeListener(@NonNull Task.TaskListener<Boolean> taskListener)	Removes a subscriber that was previously added to receive status updates of the action's progress.
void	run()	Begins the execution of the action.
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 logging in has begun.
private void	succeeded()	Notifies all subscribers that logging in has succeeded.
private void	updateProgress(int current, int total)	Notifies all subscribers about the progress of this task.

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 total number of steps required to log in.

See Also:

• Constant Field Values

LISTENERS

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

The subscribers interested in the progress and status updates of this task.

fetchClearname

private boolean fetchClearname

Whether the student's clear name should be fetched after logging in.

fetchEmailAddress

private boolean fetchEmailAddress

Whether the student's email address should be fetched after logging in.

success

@Nullable
private Boolean success

Whether logging in was successful.

isCancelled

private boolean isCancelled

Whether the task was prematurely finished by outside intervention.

Constructor Details

Login

public Login()

Method Details

updateProgress

private void updateProgress(int current,
 int total)

Notifies all subscribers about the progress of this task.

Parameters:

current - The amount of work that has been done so far.

total - The total number of steps required to complete this task.

started

private void started()

Notifies all subscribers that logging in has begun.

succeeded

private void succeeded()

Notifies all subscribers that logging in has succeeded.

failed

private void failed()

Notifies all subscribers that logging in has failed.

cancelled

private void cancelled()

Notifies all subscribers that logging in has been prematurely terminated by outside intervention.

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>

run

public void run()
         throws IllegalStateException

Begins the execution of the action. The action will run in the same thread that it was envoked from. Use Task.cancel() to prematurely terminate the action. The end product of the action can be retrieved using Task.getResult().

Specified by:

run in interface Runnable

Specified by:

run in class Task<Boolean>

Throws:

IllegalStateException - If the action had been started before (each task can only be run once).

registerListener

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

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:

taskListener - 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> taskListener)

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

Specified by:

removeListener in class Task<Boolean>

Parameters:

taskListener - 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)

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.