spring-projects / spring-projects/spring-security
Deprecate Authentication#setAuthenticated
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
Authentication#setAuthenticated is not used by Spring Security other than inside of the constructors of Authentication implementations. Further, it's not a great look for an otherwise immutable authentication state to have it's validity be publicly mutable.
For this ticket:
- Mark
Authentication#setAuthenticatedas@Deprecated. - Add to the JavaDoc, indicating what folks should do (implement isAuthenticated instead)
- Add to the migration doc instructions to stop using
Authentication#setAuthenticated
Existing implementations will need to still call it in order to remain passive, so they should not change in this ticket. That will be in when setAuthenticated is removed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate Authentication#setAuthenticated and the migration documentation in the Spring Security repository. Add the deprecation and JavaDoc guidance requested, document the migration away from the method, and verify the relevant Java and documentation checks pass without changing existing implementations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- authentication, documentation, security
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100