xyz.thepathfinder.android

Class Authenticator

java.lang.Object

xyz.thepathfinder.android.Listenable<AuthenticationListener,JsonObject>

xyz.thepathfinder.android.Authenticator

public class Authenticator
extends Listenable<AuthenticationListener,JsonObject>

Handles all of the initial authentication sequence. The Authenticator is listenable with AuthenticationListeners. The methods available in the AuthenticationListener class allow developers to know whether or not the user was successfully authenticated.

Field Summary

Fields

Modifier and Type	Field and Description
private String	applicationIdentifier Application Identifier for the application accessing the pathfinder server.
private String	authenticationServerURL URL of the server that is responsible for authenticating the users.
private static org.slf4j.Logger	logger Logs actions performed by the class.
private PathfinderServices	services Access to the web socket connection.
private String	userCredential String version of a JWT for the user's credentials.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Authenticator(String applicationIdentifier, String userCredential, String authenticationServerURL, PathfinderServices services) Creates an authenticator responsible for authenticating the user.

Method Summary

Methods

Modifier and Type	Method and Description
private void	authenticationFailed(String reason) Tells the listeners that the authentication sequence failed.
protected boolean	notifyUpdate(String reason, JsonObject json) Method called when an update occurs.
protected void	sendToAuthenticationServer(String connectionId) Sends a post request to the authentication server with the connection id received from the pathfinder server to authenticate the user.

Methods inherited from class xyz.thepathfinder.android.Listenable

addListener, getListeners, removeListener

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

Logs actions performed by the class.

applicationIdentifier

private final String applicationIdentifier

Application Identifier for the application accessing the pathfinder server.

userCredential

private final String userCredential

String version of a JWT for the user's credentials.

authenticationServerURL

private final String authenticationServerURL

URL of the server that is responsible for authenticating the users.

services

private final PathfinderServices services

Access to the web socket connection.

Constructor Detail

Authenticator

protected Authenticator(String applicationIdentifier,
             String userCredential,
             String authenticationServerURL,
             PathfinderServices services)

Creates an authenticator responsible for authenticating the user.

Parameters:

applicationIdentifier - for the current application.

userCredential - JWT as a String.

authenticationServerURL - URL of the server that authenticates the user.

services - a pathfinder services object.

Method Detail

sendToAuthenticationServer

protected void sendToAuthenticationServer(String connectionId)

Sends a post request to the authentication server with the connection id received from the pathfinder server to authenticate the user.

Parameters:

connectionId - received from the pathfinder server.

authenticationFailed

private void authenticationFailed(String reason)

Tells the listeners that the authentication sequence failed.

Parameters:

reason - of why the authentication sequence failed.

notifyUpdate

protected boolean notifyUpdate(String reason,
                   JsonObject json)

Method called when an update occurs.

Specified by:

notifyUpdate in class Listenable<AuthenticationListener,JsonObject>

Parameters:

reason - for notifying the model.

json - object of the updated model.

Returns:

true if the model was updated, false otherwise.