org.hippoecm.hst.security

Interface AuthenticationProvider

public interface AuthenticationProvider

AuthenticationProvider

Configures an authentication provider.

Method Summary

Modifier and Type	Method and Description
User	authenticate(String userName, char[] password) Authenticate a user.
default Set<Role>	getRolesByUser(User user) Returns security roles of the given user
Set<Role>	getRolesByUsername(String username) Deprecated. since v14, will be removed in v15+. Use getRolesByUser(User) instead

Method Detail

authenticate

User authenticate(String userName,
                  char[] password)
           throws SecurityException

Authenticate a user.

Parameters:

userName - The user name.

password - The user password.

Returns:

the User

Throws:

SecurityException

getRolesByUsername

@Deprecated
Set<Role> getRolesByUsername(String username)
                                  throws SecurityException

Deprecated. since v14, will be removed in v15+. Use getRolesByUser(User) instead

Returns security roles of the given username

Parameters:

username -

Throws:

SecurityException

getRolesByUser

default Set<Role> getRolesByUser(User user)
                          throws SecurityException

Returns security roles of the given user

Note: this is a default method delegating to deprecated getRolesByUser(User) which will become required to be implemented when that method is removed in v15+

Parameters:

user -

Throws:

SecurityException