Package io.goobi.viewer.model.security.authentication

Class LocalAuthenticationProvider

java.lang.Object

io.goobi.viewer.model.security.authentication.LocalAuthenticationProvider

All Implemented Interfaces:

IAuthenticationProvider

public class LocalAuthenticationProvider
extends Object
implements IAuthenticationProvider

An authentication provider using the local login provided by the viewer database.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	addUserToGroups
static final String	TYPE_LOCAL	Constant TYPE_LOCAL="local".

Constructor Summary

Constructors

Constructor	Description
LocalAuthenticationProvider(String name)	Creates a new LocalAuthenticationProvider instance.

Method Summary

Modifier and Type	Method	Description
boolean	allowsEmailChange()	allowsEmailChange.
boolean	allowsNicknameChange()	allowsNicknameChange.
boolean	allowsPasswordChange()	Checks whether this authentication service allows user to edit their password or to reset it.
List<String>	getAddUserToGroups()	getAddUserToGroups.
String	getName()	Returns an unique name for the authentication provider implementation.
String	getRedirectUrl()
String	getType()	The provider type.
CompletableFuture<LoginResult>	login(String email, String password)	Returns a future containing the login result upon completion.
void	logout()	Logs the user out.
void	setAddUserToGroups(List<String> addUserToGroups)	setAddUserToGroups.
protected void	setBcrypt(BCrypt bcrypt)	Set custom bcrypt for testing.
void	setRedirectUrl(String redirectUrl)

Methods inherited from class java.lang.Object

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

Field Details

TYPE_LOCAL

public static final String TYPE_LOCAL

Constant TYPE_LOCAL="local".

See Also:

• Constant Field Values

addUserToGroups

protected List<String> addUserToGroups

Constructor Details

LocalAuthenticationProvider

public LocalAuthenticationProvider(String name)

Creates a new LocalAuthenticationProvider instance.

Parameters:

name - display name of this provider instance

Method Details

login

public CompletableFuture<LoginResult> login(String email,
 String password)
                                     throws AuthenticationProviderException

Returns a future containing the login result upon completion. The result optionally contains the logged in User as well as the HttpServletRequest and HttpServletResponse to be used to complete the login and possible request forwarding If an error occurs and the request can not be processed, an AuthenticationException must be thrown. If a login has been refused, the exact reasons can be determined using the methods User.isActive(), User.isSuspended() and LoginResult.isRefused()

Specified by:

login in interface IAuthenticationProvider

Parameters:

email - login name or identifier supplied by the user

password - A string to be used as a password or similar for login. If the provider does not require such a string, this can be left empty or null

Returns:

A CompletableFuture which is resolved once login is completed and contains a LoginResult

Throws:

AuthenticationProviderException - if any.

logout

public void logout()
            throws AuthenticationProviderException

Logs the user out.

Specified by:

logout in interface IAuthenticationProvider

Throws:

AuthenticationProviderException - if any.

allowsPasswordChange

public boolean allowsPasswordChange()

Checks whether this authentication service allows user to edit their password or to reset it.

Specified by:

allowsPasswordChange in interface IAuthenticationProvider

Returns:

true if the authentication service provides means to change or reset the user password

getName

public String getName()

Returns an unique name for the authentication provider implementation.

Specified by:

getName in interface IAuthenticationProvider

Returns:

The name of the provider

getType

public String getType()

The provider type. This should either be "local", "userpassword" or "openId". This value is used to determine where this provider is displayed.

Providers with the same type are displayed together

Specified by:

getType in interface IAuthenticationProvider

Returns:

The type of the provider

setBcrypt

protected void setBcrypt(BCrypt bcrypt)

Set custom bcrypt for testing.

allowsNicknameChange

public boolean allowsNicknameChange()

allowsNicknameChange.

Specified by:

allowsNicknameChange in interface IAuthenticationProvider

Returns:

true if the nickname may be changed and is not essential for user identification

allowsEmailChange

public boolean allowsEmailChange()

allowsEmailChange.

Specified by:

allowsEmailChange in interface IAuthenticationProvider

Returns:

true if the email may be changed and is not essential for user identification

getAddUserToGroups

public List<String> getAddUserToGroups()

getAddUserToGroups.

Specified by:

getAddUserToGroups in interface IAuthenticationProvider

Returns:

list of group names to add the user to on login

setAddUserToGroups

public void setAddUserToGroups(List<String> addUserToGroups)

setAddUserToGroups.

Specified by:

setAddUserToGroups in interface IAuthenticationProvider

Parameters:

addUserToGroups - group names to assign new or returning users to

getRedirectUrl

public String getRedirectUrl()

Specified by:

getRedirectUrl in interface IAuthenticationProvider

setRedirectUrl

public void setRedirectUrl(String redirectUrl)

Specified by:

setRedirectUrl in interface IAuthenticationProvider