Skip to content

Commit 021f84b

Browse files
chanjin23rwinch
authored andcommitted
Core: Fix Javadoc invalid references and improve clarity
- Update package-info to reference AuthorizationManager instead of AccessDecisionManager - Improve RoleHierarchyUtils documentation with fromHierarchy() and builder-based alternatives - Refine AuthenticationTrustResolver return description by removing redundant comma and symbol Signed-off-by: chanjin-lee <chanjin23@naver.com>
1 parent e5b934d commit 021f84b

3 files changed

Lines changed: 10 additions & 11 deletions

File tree

core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyUtils.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ private RoleHierarchyUtils() {
3636

3737
/**
3838
* Converts the supplied {@link Map} of role name to implied role name(s) to a string
39-
* representation understood by {@code RoleHierarchyImpl#setHierarchy(String)}. The
40-
* map key is the role name and the map value is a {@link List} of implied role
41-
* name(s).
42-
* @param roleHierarchyMap the mapping(s) of role name to implied role name(s)
39+
* representation understood by the role hierarchy parser.
40+
* The map key is the role name and the map value is a {@link List} of implied role name(s).
41+
* * @param roleHierarchyMap the mapping(s) of role name to implied role name(s)
4342
* @return a string representation of a role hierarchy
44-
* @throws IllegalArgumentException if roleHierarchyMap is null or empty or if a role
45-
* name is null or empty or if an implied role name(s) is null or empty
46-
* @deprecated please see {@code RoleHierarchyImpl#setHierarchy} deprecation notice
43+
* @throws IllegalArgumentException if roleHierarchyMap is null or empty, or if a role
44+
* name/implied role name is null or empty
45+
* @deprecated Use {@link RoleHierarchyImpl#fromHierarchy(String)} or the builder-based
46+
* approach instead of this manual conversion.
4747
*/
4848
@Deprecated
4949
public static String roleHierarchyFromMap(Map<String, List<String>> roleHierarchyMap) {

core/src/main/java/org/springframework/security/access/package-info.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@
1616

1717
/**
1818
* Core access-control related code, including security metadata related classes,
19-
* interception code, access control annotations, EL support and voter-based
20-
* implementations of the central
21-
* {@code AccessDecisionManager}
19+
* interception code, access control annotations, EL support, and implementations
20+
* of the central {@link org.springframework.security.authorization.AuthorizationManager AuthorizationManager}
2221
* interface.
2322
*/
2423
@NullMarked

core/src/main/java/org/springframework/security/authentication/AuthenticationTrustResolver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ default boolean isFullyAuthenticated(@Nullable Authentication authentication) {
7777
* Checks if the {@link Authentication} is not null, authenticated, and not anonymous.
7878
* @param authentication the {@link Authentication} to check.
7979
* @return true if the {@link Authentication} is not null,
80-
* {@link #isAnonymous(Authentication)} returns false, and
80+
* {@link #isAnonymous(Authentication)} returns false and
8181
* {@link Authentication#isAuthenticated()} is true.
8282
* @since 6.1.7
8383
*/

0 commit comments

Comments
 (0)