Package eirb.pub.app.server

Class ServerAuthentication

java.lang.Object

eirb.pub.app.server.ServerAuthentication

public class ServerAuthentication
extends Object

Provide an authentication service to the server API After user authentication, provide a header to be added to every authenticated request

Constructor Summary

Constructors

Constructor	Description
ServerAuthentication(String login, String password)	Create an Authentication service for the server Use the login and the password to get an authentication token to the server
ServerAuthentication(String login, String password, URL hostname)

Method Summary

Modifier and Type	Method	Description
void	authenticate(String login, String password)	Authenticate the user to get an authentication token.
ServerUser	getAuthenticatedUser()	Get the authenticate user
org.apache.hc.core5.http.Header	getHeader()	Get Authorization header used for authentication
URL	getHostname()
KeyPair	getUserKeyPair()	Get authenticate user KeyPair (used for encryption and decryption purposes)
static ServerAuthentication	register(String mail, String password, String nickname, javafx.util.Callback<String,Integer> getCode)
static ServerAuthentication	register(String mail, String password, String nickname, javafx.util.Callback<String,Integer> retrieveCode, URL hostname)	Register a new user on the server
void	setHostname(URL url)

Methods inherited from class java.lang.Object

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

Constructor Details

ServerAuthentication

public ServerAuthentication(String login,
 String password,
 URL hostname)
                     throws AuthenticationException,
IOException,
TimeoutException

Throws:

AuthenticationException

IOException

TimeoutException

ServerAuthentication

public ServerAuthentication(String login,
 String password)
                     throws IOException,
AuthenticationException,
TimeoutException

Create an Authentication service for the server Use the login and the password to get an authentication token to the server

Parameters:

login - User login

password - User password

Throws:

IOException - if the connection with the server failed:

AuthenticationException - If the authentication failed

TimeoutException

Method Details

setHostname

public void setHostname(URL url)

authenticate

public void authenticate(String login,
 String password)
                  throws IOException,
AuthenticationException,
TimeoutException

Authenticate the user to get an authentication token. Use this method if the token expired and you get AuthenticationErrors

Parameters:

login - User login

password - User password

Throws:

IOException - if the request failed or the connection was interrupted

AuthenticationException - if the authentication failed (wrong user/login)

TimeoutException - if the request took too much time to complete

getHeader

public org.apache.hc.core5.http.Header getHeader()

Get Authorization header used for authentication

Returns:

Header with the right token

getHostname

public URL getHostname()

getUserKeyPair

public KeyPair getUserKeyPair()

Get authenticate user KeyPair (used for encryption and decryption purposes)

Returns:

KeyPair of the authenticated user

getAuthenticatedUser

public ServerUser getAuthenticatedUser()

Get the authenticate user

Returns:

Authenticated user

register

public static ServerAuthentication register(String mail,
 String password,
 String nickname,
 javafx.util.Callback<String,Integer> retrieveCode,
 URL hostname)
                                     throws ServerException,
IOException,
TimeoutException

Register a new user on the server

Parameters:

mail - user mail

password - user password

nickname - user nickname

retrieveCode - function to get the verification code received by mail. Can be called multiple times if the verification failed, make it return -1 to stop the verification code loop

hostname - server hostname

Returns:

a ServerAuth with the newly created user

Throws:

VerificationCodeException - if the code provided failed

ServerException - if the field provided are incorrect

TimeoutException - if the request took too much time to complete

IOException - If the connection with the server breaks

register

public static ServerAuthentication register(String mail,
 String password,
 String nickname,
 javafx.util.Callback<String,Integer> getCode)
                                     throws ServerException,
IOException,
TimeoutException

Throws:

ServerException

IOException

TimeoutException

See Also:

• register(String, String, String, Callback, URL)