io.mangoo.routing.bindings

Class Authentication

java.lang.Object

io.mangoo.routing.bindings.Authentication

public class Authentication
extends Object

Convenient class for handling authentication

Author:

svenkubiak

Constructor Summary

Constructors

Constructor and Description
Authentication()
Authentication(LocalDateTime expires, String authenticatedUser)

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(String password, String hash) Creates a hashed value of a given clear text password and checks if the value matches a given, already hashed password
String	getAuthenticatedUser() Retrieves the current authenticated user
LocalDateTime	getExpires() Returns the LocalDateTime when the authentication expires
String	getHashedPassword(String password) Hashes a given clear text password using JBCrypt
OAuthUser	getOAuthUser() Retrieves the current OAuthUser from the authentication Note: This is only available during a OAuth authentication in a method that is annotated with @OAuthCallbackFilter
boolean	hasAuthenticatedUser() Checks if the authentication contains an authenticated user
boolean	isAuthenticated(String username) Checks if the given user name is authenticated
boolean	isLogout()
boolean	isRemember()
void	login(String username) Convenient method that calls login with remember set to false
void	login(String username, boolean remember) Performs a login for a given user name
void	logout() Performs a logout of the currently authenticated user
void	setOAuthUser(OAuthUser oAuthUser) Sets an OAuthUser to the current authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

Authentication

public Authentication()

Authentication

public Authentication(LocalDateTime expires,
                      String authenticatedUser)

Method Detail

getAuthenticatedUser

public String getAuthenticatedUser()

Retrieves the current authenticated user

Returns:

The username of the current authenticated user or null

getExpires

public LocalDateTime getExpires()

Returns the LocalDateTime when the authentication expires

Returns:

A LocalDateTime object or null if unset

isLogout

public boolean isLogout()

Returns:

True if the user wants to logout, false otherwise

isRemember

public boolean isRemember()

Returns:

True if the user wants to stay logged in, false otherwise

setOAuthUser

public void setOAuthUser(OAuthUser oAuthUser)

Sets an OAuthUser to the current authentication. Can only be set once!

Parameters:

oAuthUser - An OAuthUser

getOAuthUser

public OAuthUser getOAuthUser()

Retrieves the current OAuthUser from the authentication Note: This is only available during a OAuth authentication in a method that is annotated with @OAuthCallbackFilter

Returns:

The current OAuthUser instance or null if undefined

getHashedPassword

public String getHashedPassword(String password)

Hashes a given clear text password using JBCrypt

Parameters:

password - The clear text password

Returns:

The hashed password

authenticate

public boolean authenticate(String password,
                            String hash)

Creates a hashed value of a given clear text password and checks if the value matches a given, already hashed password

Parameters:

password - The clear text password

hash - The previously hashed password to check

Returns:

True if the new hashed password matches the hash, false otherwise

logout

public void logout()

Performs a logout of the currently authenticated user

login

public void login(String username,
                  boolean remember)

Performs a login for a given user name

Parameters:

username - The user name to login

remember - If true, the user will stay logged in for (default) 2 weeks

login

public void login(String username)

Convenient method that calls login with remember set to false

Parameters:

username - The user name to login

hasAuthenticatedUser

public boolean hasAuthenticatedUser()

Checks if the authentication contains an authenticated user

Returns:

True if authentication contains an authenticated user, false otherwise

isAuthenticated

public boolean isAuthenticated(String username)

Checks if the given user name is authenticated

Parameters:

username - The user name to check

Returns:

True if the given user name is authenticates