Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix UserDetailsPasswordService JavaDoc 

* Fix typo
* Clarify that `newPassword` is already an encoded password
This commit is contained in:
Michael J. Simons 2019-08-16 10:19:39 +02:00 committed by Rob Winch
parent 4bc231872f
commit 5903f2dd9b
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
core/src/main/java/org/springframework/security/core/userdetails/UserDetailsPasswordService.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -25,10 +25,11 @@ public interface UserDetailsPasswordService {
/**
* Modify the specified user's password. This should change the user's password in the
* persistent user repository (datbase, LDAP etc).
* persistent user repository (database, LDAP etc).
*
* @param user the user to modify the password for
* @param newPassword the password to change to
* @param newPassword the password to change to,
* encoded by the configured {@code PasswordEncoder}
* @return the updated UserDetails with the new password
*/
UserDetails updatePassword(UserDetails user, String newPassword);