com.github.brokenswing.comixaire.facades.auth

Class AuthFacade

java.lang.Object

com.github.brokenswing.comixaire.facades.Facade

com.github.brokenswing.comixaire.facades.auth.AuthFacade

public class AuthFacade
extends Facade

This class provides a simple API to use the authentication system of the application.

Field Summary

Fields inherited from class com.github.brokenswing.comixaire.facades.Facade

factory

Constructor Summary

Constructors

Constructor and Description
AuthFacade(DAOFactory daoFactory, PasswordAlgorithm passAlgo, Session session)

Method Summary

Modifier and Type	Method and Description
Client	getLoggedInClient()
StaffMember	getLoggedInStaff()
java.lang.String	hashPassword(java.lang.String plainTextPassword)
void	loginClient(java.lang.String cardId) Tries to connect a client with the given card ID.
void	loginStaff(java.lang.String username, java.lang.String password) Tries to login a staff member which has the given username and the given password.
void	logout() Logs out the currently logged in user of the system.
void	setLoggedInStaff(StaffMember member)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthFacade

public AuthFacade(DAOFactory daoFactory,
                  PasswordAlgorithm passAlgo,
                  Session session)

Parameters:

daoFactory - The factory to use to access users data

passAlgo - The password hashing algorithm to use to check users passwords

session - The session to change the state of when a method of the facade succeeds

Method Detail

loginStaff

public void loginStaff(java.lang.String username,
                       java.lang.String password)
                throws BadCredentialsException,
                       InternalException

Tries to login a staff member which has the given username and the given password. Given username and password are not trimmed before checking against persisted data. If this method does no throw any exception, it means the staff member is now logged in the system.
This method can be called when an user is already logged in the system : the success of this method call will just override logged in user.

Parameters:

username - the username of the staff member to log in

password - the plain password of the staff member to log in

Throws:

BadCredentialsException - when no staff member with the given username can be found or that the given password is invalid for the staff member with the given username

InternalException - when an expected error occurred

loginClient

public void loginClient(java.lang.String cardId)
                 throws BadCredentialsException,
                        InternalException

Tries to connect a client with the given card ID. Given card ID is not trimmed when checked against system data to retrieve concerned client. If this method does no throw any exception it means that the client with the given card ID is now logged in the system.
This method can be called when an other user is already called in the system, in the case, the success of this method call just overrides the user that is logged in the system.

Parameters:

cardId - the card ID of the client to login to the system

Throws:

BadCredentialsException - if no client with the given card ID can be found

InternalException - when an expected error occurred

logout

public void logout()

Logs out the currently logged in user of the system. If no user is logged in the system, this method just does nothing.

getLoggedInStaff

public StaffMember getLoggedInStaff()

setLoggedInStaff

public void setLoggedInStaff(StaffMember member)

getLoggedInClient

public Client getLoggedInClient()

hashPassword

public java.lang.String hashPassword(java.lang.String plainTextPassword)