From 031a8d5afa840c2cd46ffb8cfae486fe8f14ac4e Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 8 Oct 2015 14:33:17 +0100 Subject: [PATCH] Polishing Add missing javadoc to AuthoritiesExtractor and FixedAuthoritiesExtractor --- .../security/oauth2/resource/AuthoritiesExtractor.java | 10 ++++++++++ .../oauth2/resource/FixedAuthoritiesExtractor.java | 5 +++++ 2 files changed, 15 insertions(+) diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/AuthoritiesExtractor.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/AuthoritiesExtractor.java index e06a07bdbb..4db5c9e9f1 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/AuthoritiesExtractor.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/AuthoritiesExtractor.java @@ -22,10 +22,20 @@ import java.util.Map; import org.springframework.security.core.GrantedAuthority; /** + * Strategy used by {@link UserInfoTokenServices} to extract authorities from the resource + * server's response. + * * @author Dave Syer + * @since 1.3.0 */ public interface AuthoritiesExtractor { + /** + * Extract the authorities from the resource server's response. + * + * @param map the response + * @return the extracted authorities + */ List extractAuthorities(Map map); } diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/FixedAuthoritiesExtractor.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/FixedAuthoritiesExtractor.java index 8a8bd85837..3d3045fd5d 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/FixedAuthoritiesExtractor.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/FixedAuthoritiesExtractor.java @@ -26,7 +26,12 @@ import org.springframework.util.ObjectUtils; import org.springframework.util.StringUtils; /** + * Default implementation of {@link AuthoritiesExtractor}. Extracts the authorities from + * the map with the key {@code authorities}. If no such value exists, a single + * {@code ROLE_USER} authority is returned. + * * @author Dave Syer + * @since 1.3.0 */ public class FixedAuthoritiesExtractor implements AuthoritiesExtractor {