org.apache.marmotta.platform.user.api

Interface AuthenticationService

All Known Implementing Classes:

AuthenticationServiceImpl

public interface AuthenticationService

A service that abstracts simple user authentication. The standard backend implements authentication from the LMF configuration file using the following configuration properties: security.user..password - the plaintext password of the user with login security.user..roles - the roles of the user with login

Author: Sebastian Schaffert

Method Summary

Methods

Modifier and Type	Method and Description
void	addUserRole(String login, String role) Add the role with the given name to the user with the given login.
boolean	authenticateUser(String login, String password) Authenticate the user with the given login and password.
Set<String>	listAuthProviderNames() Returns a list of available AuthenticationProvider names.
Set<String>	listUserRoles(String login) Return the roles that are assigned to the user (a list of strings that can be chosen by the administrator as needed).
void	removeUserRole(String login, String role) Remove the role with the given name from the user with the given login.
void	setUserPassword(String login, String password) Change the password of the user with the given login to the given new password.

Method Detail

authenticateUser

boolean authenticateUser(String login,
                       String password)

Authenticate the user with the given login and password. Returns true on success, false if the user does not exist or the passwords do not match.

Parameters:

login - login of the user to authenticate

password - password of the user to authenticate

Returns:

true on success, false if the user does not exist or the passwords do not match.

setUserPassword

void setUserPassword(String login,
                   String password)

Change the password of the user with the given login to the given new password. The implementation may decide where to persist the password in a secure manner and whether to apply additional security like password hashing.

Parameters:

login -

password -

listUserRoles

Set<String> listUserRoles(String login)

Return the roles that are assigned to the user (a list of strings that can be chosen by the administrator as needed).

Parameters:

login - login name of the user for whom to return the roles

Returns:

a list of strings with the role names currently assigned to the user

addUserRole

void addUserRole(String login,
               String role)

Add the role with the given name to the user with the given login.

Parameters:

login - the login name of the user with whom to associate roles

role - the role name to associate with the user

removeUserRole

void removeUserRole(String login,
                  String role)

Remove the role with the given name from the user with the given login.

Parameters:

login - the login name of the user from whom to remove the role

role - the role name to remove from the list of roles of the user

listAuthProviderNames

Set<String> listAuthProviderNames()

Returns a list of available AuthenticationProvider names.