org.apereo.cas.pm

Interface PasswordManagementService

All Known Implementing Classes:

BasePasswordManagementService, JsonResourcePasswordManagementService, NoOpPasswordManagementService

public interface PasswordManagementService

This is PasswordManagementService.

Since:

5.0.0

Method Summary

Modifier and Type	Method and Description
default boolean	change(org.apereo.cas.authentication.Credential c, PasswordChangeBean bean) Execute op to change password.
default java.lang.String	createToken(java.lang.String username) Create token string.
default java.lang.String	findEmail(java.lang.String username) Find email associated with username.
default java.util.Map<java.lang.String,java.lang.String>	getSecurityQuestions(java.lang.String username) Gets security questions.
default boolean	isValidSecurityQuestionAnswer(java.lang.String username, java.lang.String question, java.lang.String answer, java.lang.String input) Checks a security questions answer.
default java.lang.String	parseToken(java.lang.String token) Parse token string.

Method Detail

change

default boolean change(org.apereo.cas.authentication.Credential c,
                       PasswordChangeBean bean)
                throws InvalidPasswordException

Execute op to change password.

Parameters:

c - the credentials

bean - the bean

Returns:

true /false

Throws:

InvalidPasswordException - if new password fails downstream validation

findEmail

default java.lang.String findEmail(java.lang.String username)

Find email associated with username.

Parameters:

username - the username

Returns:

the string

createToken

default java.lang.String createToken(java.lang.String username)

Create token string.

Parameters:

username - the username

Returns:

the string

parseToken

default java.lang.String parseToken(java.lang.String token)

Parse token string.

Parameters:

token - the token

Returns:

the username

getSecurityQuestions

default java.util.Map<java.lang.String,java.lang.String> getSecurityQuestions(java.lang.String username)

Gets security questions. The return object must have predictable iteration (use LinkedHashMap instead of HashMap, for example).

Parameters:

username - the username

Returns:

the security questions

isValidSecurityQuestionAnswer

default boolean isValidSecurityQuestionAnswer(java.lang.String username,
                                              java.lang.String question,
                                              java.lang.String answer,
                                              java.lang.String input)

Checks a security questions answer.

Parameters:

username - the username

question - the text of the question

answer - stored answer

input - user response to question

Returns:

whether the answer is correct