diff --git a/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedAnnotationAttributeFactory.java b/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedAnnotationAttributeFactory.java index e0f9266c7c..8e8d51b367 100644 --- a/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedAnnotationAttributeFactory.java +++ b/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedAnnotationAttributeFactory.java @@ -90,7 +90,7 @@ public class ExpressionBasedAnnotationAttributeFactory implements PrePostInvocat } /** - * Delay the lookup of the {@link ExpressionParser} to prevent SEC-2136 + * Delay the lookup of the {@link ExpressionParser} to prevent SEC-2136. * @return */ private ExpressionParser getParser() { diff --git a/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedPostInvocationAdvice.java b/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedPostInvocationAdvice.java index ad1465bf41..398cb873c9 100644 --- a/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedPostInvocationAdvice.java +++ b/access/src/main/java/org/springframework/security/access/expression/method/ExpressionBasedPostInvocationAdvice.java @@ -30,6 +30,9 @@ import org.springframework.security.access.prepost.PostInvocationAuthorizationAd import org.springframework.security.core.Authentication; /** + * A {@link PostInvocationAuthorizationAdvice} that applies {@code PostFilter} and + * {@code PostAuthorize} expressions. + * * @author Luke Taylor * @since 3.0 * @deprecated Use diff --git a/access/src/main/java/org/springframework/security/access/expression/method/PostInvocationExpressionAttribute.java b/access/src/main/java/org/springframework/security/access/expression/method/PostInvocationExpressionAttribute.java index 7cd59af109..f4ffb21a03 100644 --- a/access/src/main/java/org/springframework/security/access/expression/method/PostInvocationExpressionAttribute.java +++ b/access/src/main/java/org/springframework/security/access/expression/method/PostInvocationExpressionAttribute.java @@ -23,6 +23,8 @@ import org.springframework.expression.ParseException; import org.springframework.security.access.prepost.PostInvocationAttribute; /** + * A {@link PostInvocationAttribute} based on filter and authorize expressions. + * * @author Luke Taylor * @since 3.0 * @deprecated Use diff --git a/access/src/main/java/org/springframework/security/access/expression/method/PreInvocationExpressionAttribute.java b/access/src/main/java/org/springframework/security/access/expression/method/PreInvocationExpressionAttribute.java index 8379087d04..66585dd7ab 100644 --- a/access/src/main/java/org/springframework/security/access/expression/method/PreInvocationExpressionAttribute.java +++ b/access/src/main/java/org/springframework/security/access/expression/method/PreInvocationExpressionAttribute.java @@ -23,6 +23,8 @@ import org.springframework.expression.ParseException; import org.springframework.security.access.prepost.PreInvocationAttribute; /** + * A {@link PreInvocationAttribute} based on parsed {@link Expression}s. + * * @author Luke Taylor * @since 3.0 * @deprecated Use diff --git a/access/src/main/java/org/springframework/security/access/method/MapBasedMethodSecurityMetadataSource.java b/access/src/main/java/org/springframework/security/access/method/MapBasedMethodSecurityMetadataSource.java index 6bcda9f40f..bf25a33832 100644 --- a/access/src/main/java/org/springframework/security/access/method/MapBasedMethodSecurityMetadataSource.java +++ b/access/src/main/java/org/springframework/security/access/method/MapBasedMethodSecurityMetadataSource.java @@ -59,12 +59,12 @@ public class MapBasedMethodSecurityMetadataSource extends AbstractFallbackMethod private @Nullable ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader(); /** - * Map from RegisteredMethod to ConfigAttribute list + * Map from RegisteredMethod to ConfigAttribute list. */ protected final Map> methodMap = new HashMap<>(); /** - * Map from RegisteredMethod to name pattern used for registration + * Map from RegisteredMethod to name pattern used for registration. */ private final Map nameMap = new HashMap<>(); @@ -72,7 +72,7 @@ public class MapBasedMethodSecurityMetadataSource extends AbstractFallbackMethod } /** - * Creates the MapBasedMethodSecurityMetadataSource from a + * Creates the MapBasedMethodSecurityMetadataSource from a. * @param methodMap map of method names to ConfigAttributes. */ public MapBasedMethodSecurityMetadataSource(Map> methodMap) { @@ -236,6 +236,7 @@ public class MapBasedMethodSecurityMetadataSource extends AbstractFallbackMethod } /** + * Returns the size of the method map. * @return map size (for unit tests and diagnostics) */ public int getMethodMapSize() { diff --git a/access/src/main/java/org/springframework/security/access/method/P.java b/access/src/main/java/org/springframework/security/access/method/P.java index 319642fc93..ee0d746d76 100644 --- a/access/src/main/java/org/springframework/security/access/method/P.java +++ b/access/src/main/java/org/springframework/security/access/method/P.java @@ -41,7 +41,7 @@ import org.springframework.security.core.parameters.AnnotationParameterNameDisco public @interface P { /** - * The parameter name + * The parameter name. * @return */ String value(); diff --git a/access/src/main/java/org/springframework/security/access/prepost/PrePostAdviceReactiveMethodInterceptor.java b/access/src/main/java/org/springframework/security/access/prepost/PrePostAdviceReactiveMethodInterceptor.java index 9befbb0143..8c06f0cc50 100644 --- a/access/src/main/java/org/springframework/security/access/prepost/PrePostAdviceReactiveMethodInterceptor.java +++ b/access/src/main/java/org/springframework/security/access/prepost/PrePostAdviceReactiveMethodInterceptor.java @@ -74,7 +74,7 @@ public class PrePostAdviceReactiveMethodInterceptor implements MethodInterceptor private static final int RETURN_TYPE_METHOD_PARAMETER_INDEX = -1; /** - * Creates a new instance + * Creates a new instance. * @param attributeSource the {@link MethodSecurityMetadataSource} to use * @param preInvocationAdvice the {@link PreInvocationAuthorizationAdvice} to use * @param postInvocationAdvice the {@link PostInvocationAuthorizationAdvice} to use diff --git a/access/src/main/java/org/springframework/security/access/prepost/PrePostInvocationAttributeFactory.java b/access/src/main/java/org/springframework/security/access/prepost/PrePostInvocationAttributeFactory.java index 68715fc9e1..c917c450fd 100644 --- a/access/src/main/java/org/springframework/security/access/prepost/PrePostInvocationAttributeFactory.java +++ b/access/src/main/java/org/springframework/security/access/prepost/PrePostInvocationAttributeFactory.java @@ -22,6 +22,9 @@ import org.springframework.aop.framework.AopInfrastructureBean; import org.springframework.security.authorization.AuthorizationManager; /** + * A factory for creating {@link PreInvocationAttribute}s and + * {@link PostInvocationAttribute}s. + * * @author Luke Taylor * @since 3.0 * @see org.springframework.security.authorization.method.AuthorizationManagerBeforeMethodInterceptor diff --git a/access/src/main/java/org/springframework/security/messaging/access/expression/EvaluationContextPostProcessor.java b/access/src/main/java/org/springframework/security/messaging/access/expression/EvaluationContextPostProcessor.java index 31f89de36d..a9e7ec3bf5 100644 --- a/access/src/main/java/org/springframework/security/messaging/access/expression/EvaluationContextPostProcessor.java +++ b/access/src/main/java/org/springframework/security/messaging/access/expression/EvaluationContextPostProcessor.java @@ -19,7 +19,7 @@ package org.springframework.security.messaging.access.expression; import org.springframework.expression.EvaluationContext; /** - * Allows post processing the {@link EvaluationContext} + * Allows post processing the {@link EvaluationContext}. * *

* This API is intentionally kept package scope as it may evolve over time. diff --git a/access/src/main/java/org/springframework/security/messaging/access/expression/MessageExpressionConfigAttribute.java b/access/src/main/java/org/springframework/security/messaging/access/expression/MessageExpressionConfigAttribute.java index fa525de63d..908952fd15 100644 --- a/access/src/main/java/org/springframework/security/messaging/access/expression/MessageExpressionConfigAttribute.java +++ b/access/src/main/java/org/springframework/security/messaging/access/expression/MessageExpressionConfigAttribute.java @@ -46,7 +46,7 @@ class MessageExpressionConfigAttribute implements ConfigAttribute, EvaluationCon private final MessageMatcher matcher; /** - * Creates a new instance + * Creates a new instance. * @param authorizeExpression the {@link Expression} to use. Cannot be null * @param matcher the {@link MessageMatcher} used to match the messages. */ diff --git a/access/src/main/java/org/springframework/security/messaging/access/intercept/ChannelSecurityInterceptor.java b/access/src/main/java/org/springframework/security/messaging/access/intercept/ChannelSecurityInterceptor.java index 9e6fc2aae6..cd45a0a27b 100644 --- a/access/src/main/java/org/springframework/security/messaging/access/intercept/ChannelSecurityInterceptor.java +++ b/access/src/main/java/org/springframework/security/messaging/access/intercept/ChannelSecurityInterceptor.java @@ -48,7 +48,7 @@ public final class ChannelSecurityInterceptor extends AbstractSecurityIntercepto private final MessageSecurityMetadataSource metadataSource; /** - * Creates a new instance + * Creates a new instance. * @param metadataSource the MessageSecurityMetadataSource to use. Cannot be null. * * @see DefaultMessageSecurityMetadataSource diff --git a/access/src/main/java/org/springframework/security/messaging/access/intercept/MessageSecurityMetadataSource.java b/access/src/main/java/org/springframework/security/messaging/access/intercept/MessageSecurityMetadataSource.java index 0187b7274b..fbe0d6635a 100644 --- a/access/src/main/java/org/springframework/security/messaging/access/intercept/MessageSecurityMetadataSource.java +++ b/access/src/main/java/org/springframework/security/messaging/access/intercept/MessageSecurityMetadataSource.java @@ -20,7 +20,7 @@ import org.springframework.messaging.Message; import org.springframework.security.access.SecurityMetadataSource; /** - * A {@link SecurityMetadataSource} that is used for securing {@link Message} + * A {@link SecurityMetadataSource} that is used for securing {@link Message}. * * @author Rob Winch * @since 4.0 diff --git a/access/src/main/java/org/springframework/security/web/access/channel/AbstractRetryEntryPoint.java b/access/src/main/java/org/springframework/security/web/access/channel/AbstractRetryEntryPoint.java index 73f8ea5d5a..8f658e70d7 100644 --- a/access/src/main/java/org/springframework/security/web/access/channel/AbstractRetryEntryPoint.java +++ b/access/src/main/java/org/springframework/security/web/access/channel/AbstractRetryEntryPoint.java @@ -32,6 +32,8 @@ import org.springframework.security.web.RedirectStrategy; import org.springframework.util.Assert; /** + * A {@link ChannelEntryPoint} that retries the request on a different scheme and port. + * * @author Luke Taylor * @deprecated please use * {@link org.springframework.security.web.transport.HttpsRedirectFilter} and its @@ -45,12 +47,12 @@ public abstract class AbstractRetryEntryPoint implements ChannelEntryPoint { private PortMapper portMapper = new PortMapperImpl(); /** - * The scheme ("http://" or "https://") + * The scheme ("http://" or "https://"). */ private final String scheme; /** - * The standard port for the scheme (80 for http, 443 for https) + * The standard port for the scheme (80 for http, 443 for https). */ private final int standardPort; diff --git a/access/src/main/java/org/springframework/security/web/access/expression/DefaultWebSecurityExpressionHandler.java b/access/src/main/java/org/springframework/security/web/access/expression/DefaultWebSecurityExpressionHandler.java index 40b6eb3283..ea0e74d13d 100644 --- a/access/src/main/java/org/springframework/security/web/access/expression/DefaultWebSecurityExpressionHandler.java +++ b/access/src/main/java/org/springframework/security/web/access/expression/DefaultWebSecurityExpressionHandler.java @@ -28,6 +28,8 @@ import org.springframework.security.core.Authentication; import org.springframework.security.web.FilterInvocation; /** + * The default implementation of {@link SecurityExpressionHandler} for web security. + * * @author Luke Taylor * @author Eddú Meléndez * @author Steve Riesenberg diff --git a/access/src/main/java/org/springframework/security/web/access/intercept/FilterSecurityInterceptor.java b/access/src/main/java/org/springframework/security/web/access/intercept/FilterSecurityInterceptor.java index 3d13141544..39f3601dda 100644 --- a/access/src/main/java/org/springframework/security/web/access/intercept/FilterSecurityInterceptor.java +++ b/access/src/main/java/org/springframework/security/web/access/intercept/FilterSecurityInterceptor.java @@ -54,7 +54,7 @@ public class FilterSecurityInterceptor extends AbstractSecurityInterceptor imple private boolean observeOncePerRequest = false; /** - * Not used (we rely on IoC container lifecycle services instead) + * Not used (we rely on IoC container lifecycle services instead). * @param arg0 ignored * */ @@ -63,7 +63,7 @@ public class FilterSecurityInterceptor extends AbstractSecurityInterceptor imple } /** - * Not used (we rely on IoC container lifecycle services instead) + * Not used (we rely on IoC container lifecycle services instead). */ @Override public void destroy() { diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java b/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java index b47ea993ab..ba63f9e3b9 100644 --- a/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java +++ b/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java @@ -141,7 +141,7 @@ public class BasicLookupStrategy implements LookupStrategy { private AclClassIdUtils aclClassIdUtils; /** - * Constructor accepting mandatory arguments + * Constructor accepting mandatory arguments. * @param dataSource to access the database * @param aclCache the cache where fully-loaded elements can be stored * @param aclAuthorizationStrategy authorization strategy (required) @@ -152,7 +152,7 @@ public class BasicLookupStrategy implements LookupStrategy { } /** - * Creates a new instance + * Creates a new instance. * @param dataSource to access the database * @param aclCache the cache where fully-loaded elements can be stored * @param aclAuthorizationStrategy authorization strategy (required) @@ -565,7 +565,7 @@ public class BasicLookupStrategy implements LookupStrategy { /** * Accepts the current ResultSet row, and converts it into an - * AclImpl that contains a StubAclParent + * AclImpl that contains a StubAclParent. * @param acls the Map we should add the converted Acl to * @param rs the ResultSet focused on a current row * @throws SQLException if something goes wrong converting values diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcMutableAclService.java b/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcMutableAclService.java index c1b5475bed..7c76b0f747 100644 --- a/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcMutableAclService.java +++ b/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcMutableAclService.java @@ -479,6 +479,7 @@ public class JdbcMutableAclService extends JdbcAclService implements MutableAclS } /** + * Sets whether the database enforces foreign key constraints. * @param foreignKeysInDatabase if false this class will perform additional FK * constrain checking, which may cause deadlocks (the default is true, so deadlocks * are avoided but the database is expected to enforce FKs) diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java b/acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java index 75bb46cdbc..419c049139 100644 --- a/acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java +++ b/acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java @@ -15,7 +15,7 @@ */ /** - * JDBC-based persistence of ACL information + * JDBC-based persistence of ACL information. */ @NullMarked package org.springframework.security.acls.jdbc; diff --git a/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentity.java b/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentity.java index 72216e8316..5f5b620d1d 100644 --- a/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentity.java +++ b/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentity.java @@ -37,6 +37,7 @@ import org.jspecify.annotations.Nullable; public interface ObjectIdentity extends Serializable { /** + * Compares this ObjectIdentity to the given object for equality. * @param obj to be compared * @return true if the objects are equal, false otherwise * @see Object#equals(Object) @@ -67,6 +68,7 @@ public interface ObjectIdentity extends Serializable { String getType(); /** + * Returns a hash code representation of the ObjectIdentity. * @return a hash code representation of the ObjectIdentity * @see Object#hashCode() */ diff --git a/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityGenerator.java b/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityGenerator.java index 3bcbf45100..e607394f97 100644 --- a/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityGenerator.java +++ b/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityGenerator.java @@ -31,6 +31,8 @@ import java.io.Serializable; public interface ObjectIdentityGenerator { /** + * Creates an {@link ObjectIdentity} using the supplied identifier and type + * information. * @param id the identifier of the domain object, not null * @param type the type of the object (often a class name), not null * @return the identity constructed using the supplied identifier and type diff --git a/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityRetrievalStrategy.java b/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityRetrievalStrategy.java index 3838443a5d..0b18b81821 100644 --- a/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityRetrievalStrategy.java +++ b/acl/src/main/java/org/springframework/security/acls/model/ObjectIdentityRetrievalStrategy.java @@ -18,7 +18,7 @@ package org.springframework.security.acls.model; /** * Strategy interface that provides the ability to determine which {@link ObjectIdentity} - * will be returned for a particular domain object + * will be returned for a particular domain object. * * @author Ben Alex */ diff --git a/cas/src/main/java/org/springframework/security/cas/authentication/CasAuthenticationToken.java b/cas/src/main/java/org/springframework/security/cas/authentication/CasAuthenticationToken.java index 7557728b07..4f9f68880d 100644 --- a/cas/src/main/java/org/springframework/security/cas/authentication/CasAuthenticationToken.java +++ b/cas/src/main/java/org/springframework/security/cas/authentication/CasAuthenticationToken.java @@ -72,7 +72,7 @@ public class CasAuthenticationToken extends AbstractAuthenticationToken implemen } /** - * Private constructor for Jackson Deserialization support + * Private constructor for Jackson Deserialization support. * @param keyHash hashCode of provided key to identify if this object made by a given * {@link CasAuthenticationProvider} * @param principal typically the UserDetails object (cannot be null) @@ -182,7 +182,7 @@ public class CasAuthenticationToken extends AbstractAuthenticationToken implemen } /** - * A builder of {@link CasAuthenticationToken} instances + * A builder of {@link CasAuthenticationToken} instances. * * @since 7.0 */ @@ -208,7 +208,7 @@ public class CasAuthenticationToken extends AbstractAuthenticationToken implemen } /** - * Use this key + * Use this key. * @param key the key to use * @return the {@link Builder} for further configurations */ @@ -232,7 +232,7 @@ public class CasAuthenticationToken extends AbstractAuthenticationToken implemen } /** - * Use this {@link UserDetails} + * Use this {@link UserDetails}. * @param userDetails the {@link UserDetails} to use * @return the {@link Builder} for further configurations */ @@ -242,7 +242,7 @@ public class CasAuthenticationToken extends AbstractAuthenticationToken implemen } /** - * Use this {@link Assertion} + * Use this {@link Assertion}. * @param assertion the {@link Assertion} to use * @return the {@link Builder} for further configurations */ diff --git a/cas/src/main/java/org/springframework/security/cas/authentication/CasServiceTicketAuthenticationToken.java b/cas/src/main/java/org/springframework/security/cas/authentication/CasServiceTicketAuthenticationToken.java index 0337bafaf9..ab5c0b206e 100644 --- a/cas/src/main/java/org/springframework/security/cas/authentication/CasServiceTicketAuthenticationToken.java +++ b/cas/src/main/java/org/springframework/security/cas/authentication/CasServiceTicketAuthenticationToken.java @@ -121,7 +121,7 @@ public class CasServiceTicketAuthenticationToken extends AbstractAuthenticationT } /** - * A builder of {@link CasServiceTicketAuthenticationToken} instances + * A builder of {@link CasServiceTicketAuthenticationToken} instances. * * @since 7.0 */ diff --git a/cas/src/main/java/org/springframework/security/cas/authentication/NullStatelessTicketCache.java b/cas/src/main/java/org/springframework/security/cas/authentication/NullStatelessTicketCache.java index 6a28d77af2..469eab1f68 100644 --- a/cas/src/main/java/org/springframework/security/cas/authentication/NullStatelessTicketCache.java +++ b/cas/src/main/java/org/springframework/security/cas/authentication/NullStatelessTicketCache.java @@ -32,6 +32,7 @@ import org.jspecify.annotations.Nullable; public final class NullStatelessTicketCache implements StatelessTicketCache { /** + * Always returns {@code null} since tickets are not stored. * @return null since we are not storing any tickets. */ @Override diff --git a/cas/src/main/java/org/springframework/security/cas/jackson/AssertionImplMixin.java b/cas/src/main/java/org/springframework/security/cas/jackson/AssertionImplMixin.java index 6191108cb1..6684412008 100644 --- a/cas/src/main/java/org/springframework/security/cas/jackson/AssertionImplMixin.java +++ b/cas/src/main/java/org/springframework/security/cas/jackson/AssertionImplMixin.java @@ -20,9 +20,11 @@ import java.util.Date; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.apereo.cas.client.authentication.AttributePrincipal; /** @@ -36,14 +38,14 @@ import org.apereo.cas.client.authentication.AttributePrincipal; * @see CasJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) class AssertionImplMixin { /** * Mixin Constructor helps in deserialize - * {@link org.apereo.cas.client.validation.AssertionImpl} + * {@link org.apereo.cas.client.validation.AssertionImpl}. * @param principal the Principal to associate with the Assertion. * @param validFromDate when the assertion is valid from. * @param validUntilDate when the assertion is valid to. diff --git a/cas/src/main/java/org/springframework/security/cas/jackson/AttributePrincipalImplMixin.java b/cas/src/main/java/org/springframework/security/cas/jackson/AttributePrincipalImplMixin.java index f5d88a6051..f4da882a27 100644 --- a/cas/src/main/java/org/springframework/security/cas/jackson/AttributePrincipalImplMixin.java +++ b/cas/src/main/java/org/springframework/security/cas/jackson/AttributePrincipalImplMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.cas.jackson; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.apereo.cas.client.proxy.ProxyRetriever; /** @@ -35,14 +37,14 @@ import org.apereo.cas.client.proxy.ProxyRetriever; * @see CasJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) class AttributePrincipalImplMixin { /** * Mixin Constructor helps in deserialize - * {@link org.apereo.cas.client.authentication.AttributePrincipalImpl} + * {@link org.apereo.cas.client.authentication.AttributePrincipalImpl}. * @param name the unique identifier for the principal. * @param attributes the key/value pairs for this principal. * @param proxyGrantingTicket the ticket associated with this principal. diff --git a/cas/src/main/java/org/springframework/security/cas/jackson/CasAuthenticationTokenMixin.java b/cas/src/main/java/org/springframework/security/cas/jackson/CasAuthenticationTokenMixin.java index adfc583810..dc1ef255d6 100644 --- a/cas/src/main/java/org/springframework/security/cas/jackson/CasAuthenticationTokenMixin.java +++ b/cas/src/main/java/org/springframework/security/cas/jackson/CasAuthenticationTokenMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.cas.jackson; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.apereo.cas.client.validation.Assertion; import org.springframework.security.cas.authentication.CasAuthenticationProvider; @@ -38,13 +40,13 @@ import org.springframework.security.core.userdetails.UserDetails; * @see CasJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, isGetterVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, isGetterVisibility = Visibility.NONE, + getterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) class CasAuthenticationTokenMixin { /** - * Mixin Constructor helps in deserialize {@link CasAuthenticationToken} + * Mixin Constructor helps in deserialize {@link CasAuthenticationToken}. * @param keyHash hashCode of provided key to identify if this object made by a given * {@link CasAuthenticationProvider} * @param principal typically the UserDetails object (cannot be null) diff --git a/cas/src/main/java/org/springframework/security/cas/jackson2/AssertionImplMixin.java b/cas/src/main/java/org/springframework/security/cas/jackson2/AssertionImplMixin.java index 6bbd918781..ead543d892 100644 --- a/cas/src/main/java/org/springframework/security/cas/jackson2/AssertionImplMixin.java +++ b/cas/src/main/java/org/springframework/security/cas/jackson2/AssertionImplMixin.java @@ -20,10 +20,13 @@ import java.util.Date; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.apereo.cas.client.authentication.AttributePrincipal; /** @@ -49,15 +52,15 @@ import org.apereo.cas.client.authentication.AttributePrincipal; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) class AssertionImplMixin { /** * Mixin Constructor helps in deserialize - * {@link org.apereo.cas.client.validation.AssertionImpl} + * {@link org.apereo.cas.client.validation.AssertionImpl}. * @param principal the Principal to associate with the Assertion. * @param validFromDate when the assertion is valid from. * @param validUntilDate when the assertion is valid to. diff --git a/cas/src/main/java/org/springframework/security/cas/jackson2/AttributePrincipalImplMixin.java b/cas/src/main/java/org/springframework/security/cas/jackson2/AttributePrincipalImplMixin.java index 5fc85372d8..cbd6d7b29d 100644 --- a/cas/src/main/java/org/springframework/security/cas/jackson2/AttributePrincipalImplMixin.java +++ b/cas/src/main/java/org/springframework/security/cas/jackson2/AttributePrincipalImplMixin.java @@ -19,10 +19,13 @@ package org.springframework.security.cas.jackson2; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.apereo.cas.client.proxy.ProxyRetriever; /** @@ -47,15 +50,15 @@ import org.apereo.cas.client.proxy.ProxyRetriever; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) class AttributePrincipalImplMixin { /** * Mixin Constructor helps in deserialize - * {@link org.apereo.cas.client.authentication.AttributePrincipalImpl} + * {@link org.apereo.cas.client.authentication.AttributePrincipalImpl}. * @param name the unique identifier for the principal. * @param attributes the key/value pairs for this principal. * @param proxyGrantingTicket the ticket associated with this principal. diff --git a/cas/src/main/java/org/springframework/security/cas/jackson2/CasAuthenticationTokenMixin.java b/cas/src/main/java/org/springframework/security/cas/jackson2/CasAuthenticationTokenMixin.java index d8f472ffba..7ae4a4ee09 100644 --- a/cas/src/main/java/org/springframework/security/cas/jackson2/CasAuthenticationTokenMixin.java +++ b/cas/src/main/java/org/springframework/security/cas/jackson2/CasAuthenticationTokenMixin.java @@ -19,10 +19,13 @@ package org.springframework.security.cas.jackson2; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.apereo.cas.client.validation.Assertion; import org.springframework.security.cas.authentication.CasAuthenticationProvider; @@ -55,14 +58,14 @@ import org.springframework.security.core.userdetails.UserDetails; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, isGetterVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, isGetterVisibility = Visibility.NONE, + getterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) @JsonIgnoreProperties(ignoreUnknown = true) class CasAuthenticationTokenMixin { /** - * Mixin Constructor helps in deserialize {@link CasAuthenticationToken} + * Mixin Constructor helps in deserialize {@link CasAuthenticationToken}. * @param keyHash hashCode of provided key to identify if this object made by a given * {@link CasAuthenticationProvider} * @param principal typically the UserDetails object (cannot be null) diff --git a/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationEntryPoint.java b/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationEntryPoint.java index 0039302bc9..ea3208aef8 100644 --- a/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationEntryPoint.java +++ b/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationEntryPoint.java @@ -155,7 +155,7 @@ public class CasAuthenticationEntryPoint implements AuthenticationEntryPoint, In } /** - * Sets the {@link RedirectStrategy} to use + * Sets the {@link RedirectStrategy} to use. * @param redirectStrategy the {@link RedirectStrategy} to use * @since 6.3 */ diff --git a/cas/src/main/java/org/springframework/security/cas/web/CasGatewayAuthenticationRedirectFilter.java b/cas/src/main/java/org/springframework/security/cas/web/CasGatewayAuthenticationRedirectFilter.java index 3d1950bbeb..1eeaae4396 100644 --- a/cas/src/main/java/org/springframework/security/cas/web/CasGatewayAuthenticationRedirectFilter.java +++ b/cas/src/main/java/org/springframework/security/cas/web/CasGatewayAuthenticationRedirectFilter.java @@ -69,7 +69,7 @@ public final class CasGatewayAuthenticationRedirectFilter extends GenericFilterB private RedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); /** - * Constructs a new instance of this class + * Constructs a new instance of this class. * @param serviceProperties the {@link ServiceProperties} */ public CasGatewayAuthenticationRedirectFilter(String casLoginUrl, ServiceProperties serviceProperties) { diff --git a/cas/src/main/java/org/springframework/security/cas/web/authentication/DefaultServiceAuthenticationDetails.java b/cas/src/main/java/org/springframework/security/cas/web/authentication/DefaultServiceAuthenticationDetails.java index 24dff8d49b..aafc081bee 100644 --- a/cas/src/main/java/org/springframework/security/cas/web/authentication/DefaultServiceAuthenticationDetails.java +++ b/cas/src/main/java/org/springframework/security/cas/web/authentication/DefaultServiceAuthenticationDetails.java @@ -44,7 +44,7 @@ final class DefaultServiceAuthenticationDetails extends WebAuthenticationDetails private final String serviceUrl; /** - * Creates a new instance + * Creates a new instance. * @param request the current {@link HttpServletRequest} to obtain the * {@link #getServiceUrl()} from. * @param artifactPattern the {@link Pattern} that will be used to clean up the query diff --git a/cas/src/main/java/org/springframework/security/cas/web/authentication/ServiceAuthenticationDetailsSource.java b/cas/src/main/java/org/springframework/security/cas/web/authentication/ServiceAuthenticationDetailsSource.java index fd88dbd3d2..f83aa64549 100644 --- a/cas/src/main/java/org/springframework/security/cas/web/authentication/ServiceAuthenticationDetailsSource.java +++ b/cas/src/main/java/org/springframework/security/cas/web/authentication/ServiceAuthenticationDetailsSource.java @@ -53,7 +53,7 @@ public class ServiceAuthenticationDetailsSource } /** - * Creates an implementation that uses the specified artifactParameterName + * Creates an implementation that uses the specified artifactParameterName. * @param serviceProperties The ServiceProperties to use to construct the serviceUrl. * @param artifactParameterName the artifactParameterName that is removed from the * current URL. The result becomes the service url. Cannot be null and cannot be an @@ -66,6 +66,7 @@ public class ServiceAuthenticationDetailsSource } /** + * Builds the {@code ServiceAuthenticationDetails} from the given request. * @param context the {@code HttpServletRequest} object. * @return the {@code ServiceAuthenticationDetails} containing information about the * current request diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/authentication/ldap/NamespaceLdapAuthenticationProviderTestsConfigs.java b/config/src/integration-test/java/org/springframework/security/config/annotation/authentication/ldap/NamespaceLdapAuthenticationProviderTestsConfigs.java index 3580957622..f53f2d0cfa 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/authentication/ldap/NamespaceLdapAuthenticationProviderTestsConfigs.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/authentication/ldap/NamespaceLdapAuthenticationProviderTestsConfigs.java @@ -25,6 +25,8 @@ import org.springframework.security.ldap.userdetails.LdapAuthoritiesPopulator; import org.springframework.security.ldap.userdetails.PersonContextMapper; /** + * Test configurations for namespace-based LDAP {@code AuthenticationProvider} setup. + * * @author Rob Winch * */ diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/AnonymousAuthenticationITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/AnonymousAuthenticationITests.java index 9a08ea0c5b..298d91b334 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/AnonymousAuthenticationITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/AnonymousAuthenticationITests.java @@ -50,6 +50,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for anonymous authentication over RSocket. + * * @author Andrey Litvitski */ @ContextConfiguration diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketITests.java index b20294d532..dc59ba7bee 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketITests.java @@ -50,6 +50,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for securing RSocket requests and responses. + * * @author Rob Winch */ @ContextConfiguration diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketObservationITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketObservationITests.java index 754ad41c20..f5f7f2649c 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketObservationITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketObservationITests.java @@ -60,6 +60,8 @@ import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; /** + * Integration tests for RSocket security observations. + * * @author Rob Winch */ @ContextConfiguration diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketWithWebFluxITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketWithWebFluxITests.java index 8289ab9fed..e14f50bb7a 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketWithWebFluxITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/HelloRSocketWithWebFluxITests.java @@ -50,6 +50,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for RSocket security combined with WebFlux security. + * * @author Rob Winch */ @ContextConfiguration diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/JwtITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/JwtITests.java index dba19e5eb8..5c84222a91 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/JwtITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/JwtITests.java @@ -59,6 +59,8 @@ import static org.mockito.BDDMockito.given; import static org.mockito.Mockito.mock; /** + * Integration tests for RSocket JWT authentication. + * * @author Rob Winch */ @ContextConfiguration diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerConnectionITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerConnectionITests.java index f77dc720a7..6f3a1a1268 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerConnectionITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerConnectionITests.java @@ -53,6 +53,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for connecting to an {@link RSocketMessageHandler} secured server. + * * @author Rob Winch * @author Luis Felipe Vega * @author Jesús Ascama Arias diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerITests.java index ad1a993e63..58d60ae1bd 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/RSocketMessageHandlerITests.java @@ -55,6 +55,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for securing an {@link RSocketMessageHandler}. + * * @author Rob Winch */ @ContextConfiguration diff --git a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/SimpleAuthenticationITests.java b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/SimpleAuthenticationITests.java index 2bf04f3b38..0d94b338ca 100644 --- a/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/SimpleAuthenticationITests.java +++ b/config/src/integration-test/java/org/springframework/security/config/annotation/rsocket/SimpleAuthenticationITests.java @@ -55,6 +55,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for securing RSocket requests using simple authentication metadata. + * * @author Rob Winch */ @ContextConfiguration diff --git a/config/src/integration-test/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParserTests.java b/config/src/integration-test/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParserTests.java index 71e6512623..82d3e06ca2 100644 --- a/config/src/integration-test/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParserTests.java +++ b/config/src/integration-test/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParserTests.java @@ -32,6 +32,8 @@ import org.springframework.test.util.ReflectionTestUtils; import static org.assertj.core.api.Assertions.assertThat; /** + * Tests for the {@code ldap-server} XML namespace element. + * * @author Luke Taylor * @author Rob Winch */ diff --git a/config/src/integration-test/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParserTests.java b/config/src/integration-test/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParserTests.java index f88b868f03..9a20adee23 100644 --- a/config/src/integration-test/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParserTests.java +++ b/config/src/integration-test/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParserTests.java @@ -39,6 +39,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.mock; /** + * Tests for the {@code ldap-user-service} bean definition parser. + * * @author Luke Taylor * @author Rob Winch * @author Eddú Meléndez diff --git a/config/src/main/java/org/springframework/security/config/BeanIds.java b/config/src/main/java/org/springframework/security/config/BeanIds.java index 9556b9a978..f10e69d197 100644 --- a/config/src/main/java/org/springframework/security/config/BeanIds.java +++ b/config/src/main/java/org/springframework/security/config/BeanIds.java @@ -31,7 +31,7 @@ public abstract class BeanIds { /** * The "global" AuthenticationManager instance, registered by the - * <authentication-manager> element + * <authentication-manager> element. */ public static final String AUTHENTICATION_MANAGER = PREFIX + "authenticationManager"; diff --git a/config/src/main/java/org/springframework/security/config/DebugBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/DebugBeanDefinitionParser.java index 6158953db0..b31f66d91f 100644 --- a/config/src/main/java/org/springframework/security/config/DebugBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/DebugBeanDefinitionParser.java @@ -25,6 +25,9 @@ import org.springframework.beans.factory.xml.ParserContext; import org.springframework.security.config.debug.SecurityDebugBeanFactoryPostProcessor; /** + * Parses the {@code debug} element to register a + * {@link SecurityDebugBeanFactoryPostProcessor}. + * * @author Luke Taylor */ public class DebugBeanDefinitionParser implements BeanDefinitionParser { diff --git a/config/src/main/java/org/springframework/security/config/annotation/AbstractConfiguredSecurityBuilder.java b/config/src/main/java/org/springframework/security/config/annotation/AbstractConfiguredSecurityBuilder.java index 527eb84759..5436cea736 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/AbstractConfiguredSecurityBuilder.java +++ b/config/src/main/java/org/springframework/security/config/annotation/AbstractConfiguredSecurityBuilder.java @@ -187,7 +187,7 @@ public abstract class AbstractConfiguredSecurityBuilder, Object> getSharedObjects() { @@ -315,7 +315,7 @@ public abstract class AbstractConfiguredSecurityBuilder *
  • Invokes {@link #beforeInit()} for any subclass to hook into
  • @@ -406,7 +406,7 @@ public abstract class AbstractConfiguredSecurityBuilder The type of the Object being built * @author Rob Winch diff --git a/config/src/main/java/org/springframework/security/config/annotation/SecurityConfigurerAdapter.java b/config/src/main/java/org/springframework/security/config/annotation/SecurityConfigurerAdapter.java index 965ee12301..7744165cfc 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/SecurityConfigurerAdapter.java +++ b/config/src/main/java/org/springframework/security/config/annotation/SecurityConfigurerAdapter.java @@ -115,7 +115,7 @@ public abstract class SecurityConfigurerAdapter> } /** - * Adds an {@link ObjectPostProcessor} to use + * Adds an {@link ObjectPostProcessor} to use. * @param objectPostProcessor the {@link ObjectPostProcessor} to add * @return true if the {@link ObjectPostProcessor} was added, else false */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/ProviderManagerBuilder.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/ProviderManagerBuilder.java index 23fd15c421..0598cd0ab8 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/ProviderManagerBuilder.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/ProviderManagerBuilder.java @@ -22,7 +22,7 @@ import org.springframework.security.authentication.ProviderManager; import org.springframework.security.config.annotation.SecurityBuilder; /** - * Interface for operating on a SecurityBuilder that creates a {@link ProviderManager} + * Interface for operating on a SecurityBuilder that creates a {@link ProviderManager}. * * @param the type of the {@link SecurityBuilder} * @author Rob Winch diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/builders/AuthenticationManagerBuilder.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/builders/AuthenticationManagerBuilder.java index 3bf0769668..208fd7ceb7 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/builders/AuthenticationManagerBuilder.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/builders/AuthenticationManagerBuilder.java @@ -66,7 +66,7 @@ public class AuthenticationManagerBuilder private AuthenticationEventPublisher eventPublisher; /** - * Creates a new instance + * Creates a new instance. * @param objectPostProcessor the {@link ObjectPostProcessor} instance to use. */ public AuthenticationManagerBuilder(ObjectPostProcessor objectPostProcessor) { @@ -92,7 +92,7 @@ public class AuthenticationManagerBuilder } /** - * Sets the {@link AuthenticationEventPublisher} + * Sets the {@link AuthenticationEventPublisher}. * @param eventPublisher the {@link AuthenticationEventPublisher} to use * @return the {@link AuthenticationManagerBuilder} for further customizations */ @@ -103,6 +103,7 @@ public class AuthenticationManagerBuilder } /** + * Sets whether the {@link AuthenticationManager} should clear the credentials. * @param eraseCredentials true if {@link AuthenticationManager} should clear the * credentials from the {@link Authentication} object after authenticating * @return the {@link AuthenticationManagerBuilder} for further customizations diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/AuthenticationConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/AuthenticationConfiguration.java index 29921d6fc3..c0e1207da3 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/AuthenticationConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/AuthenticationConfiguration.java @@ -54,7 +54,7 @@ import org.springframework.security.crypto.password.PasswordEncoder; import org.springframework.util.Assert; /** - * Exports the authentication {@link Configuration} + * Exports the authentication {@link Configuration}. * * @author Rob Winch * @author Ngoc Nhan @@ -265,7 +265,7 @@ public class AuthenticationConfiguration { private PasswordEncoder defaultPasswordEncoder; /** - * Creates a new instance + * Creates a new instance. * @param objectPostProcessor the {@link ObjectPostProcessor} instance to use. */ DefaultPasswordEncoderAuthenticationManagerBuilder(ObjectPostProcessor objectPostProcessor, diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeAuthenticationProviderBeanManagerConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeAuthenticationProviderBeanManagerConfigurer.java index 62abca45a3..5bc466ee0b 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeAuthenticationProviderBeanManagerConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeAuthenticationProviderBeanManagerConfigurer.java @@ -42,6 +42,7 @@ class InitializeAuthenticationProviderBeanManagerConfigurer extends GlobalAuthen private final ApplicationContext context; /** + * Creates a new instance. * @param context the ApplicationContext to look up beans. */ InitializeAuthenticationProviderBeanManagerConfigurer(ApplicationContext context) { diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeUserDetailsBeanManagerConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeUserDetailsBeanManagerConfigurer.java index 6f3d714144..1e6ebd2ed5 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeUserDetailsBeanManagerConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configuration/InitializeUserDetailsBeanManagerConfigurer.java @@ -49,6 +49,7 @@ class InitializeUserDetailsBeanManagerConfigurer extends GlobalAuthenticationCon private final ApplicationContext context; /** + * Creates a new instance using the given {@link ApplicationContext}. * @param context */ InitializeUserDetailsBeanManagerConfigurer(ApplicationContext context) { @@ -112,6 +113,8 @@ class InitializeUserDetailsBeanManagerConfigurer extends GlobalAuthenticationCon } /** + * Returns a bean of the requested class if there's just a single registered + * component, null otherwise. * @return a bean of the requested class if there's just a single registered * component, null otherwise. */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/ldap/LdapAuthenticationProviderConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/ldap/LdapAuthenticationProviderConfigurer.java index 80a32e285a..e83b63e517 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/ldap/LdapAuthenticationProviderConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/ldap/LdapAuthenticationProviderConfigurer.java @@ -136,7 +136,7 @@ public class LdapAuthenticationProviderConfigurer and() { @@ -547,7 +548,7 @@ public class LdapAuthenticationProviderConfigurer> { /** - * Creates a new instance + * Creates a new instance. */ public InMemoryUserDetailsManagerConfigurer() { super(new InMemoryUserDetailsManager(new ArrayList<>())); diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/provisioning/JdbcUserDetailsManagerConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/provisioning/JdbcUserDetailsManagerConfigurer.java index ff20747fa2..6574a9bb12 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/provisioning/JdbcUserDetailsManagerConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/provisioning/JdbcUserDetailsManagerConfigurer.java @@ -140,7 +140,7 @@ public class JdbcUserDetailsManagerConfigurer, C private final C builder; /** - * Creates a new instance + * Creates a new instance. * @param builder the builder to return */ private UserDetailsBuilder(C builder) { diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/AbstractDaoAuthenticationConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/AbstractDaoAuthenticationConfigurer.java index 723f89165a..d9971b9a92 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/AbstractDaoAuthenticationConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/AbstractDaoAuthenticationConfigurer.java @@ -25,7 +25,7 @@ import org.springframework.security.core.userdetails.UserDetailsService; import org.springframework.security.crypto.password.PasswordEncoder; /** - * Allows configuring a {@link DaoAuthenticationProvider} + * Allows configuring a {@link DaoAuthenticationProvider}. * * @param the type of the {@link SecurityBuilder} * @param the type of {@link AbstractDaoAuthenticationConfigurer} this is @@ -41,7 +41,7 @@ public abstract class AbstractDaoAuthenticationConfigurer The type of {@link ProviderManagerBuilder} this is * @param The type of {@link UserDetailsService} that is being used @@ -32,7 +32,7 @@ public class DaoAuthenticationConfigurer, U extends AbstractDaoAuthenticationConfigurer, U> { /** - * Creates a new instance + * Creates a new instance. * @param userDetailsService */ public DaoAuthenticationConfigurer(U userDetailsService) { diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsAwareConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsAwareConfigurer.java index a91ceef7c5..718f6f4264 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsAwareConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsAwareConfigurer.java @@ -34,7 +34,7 @@ public abstract class UserDetailsAwareConfigurer { /** - * Gets the {@link UserDetailsService} or null if it is not available + * Gets the {@link UserDetailsService} or null if it is not available. * @return the {@link UserDetailsService} or null if it is not available */ public abstract U getUserDetailsService(); diff --git a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsServiceConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsServiceConfigurer.java index 21f201328f..1500f8a1fa 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsServiceConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsServiceConfigurer.java @@ -35,7 +35,7 @@ public class UserDetailsServiceConfigurer, C extends AbstractDaoAuthenticationConfigurer { /** - * Creates a new instance + * Creates a new instance. * @param userDetailsService the {@link UserDetailsService} that should be used */ public UserDetailsServiceConfigurer(U userDetailsService) { diff --git a/config/src/main/java/org/springframework/security/config/annotation/method/configuration/EnableReactiveMethodSecurity.java b/config/src/main/java/org/springframework/security/config/annotation/method/configuration/EnableReactiveMethodSecurity.java index bbb0d70836..8b559cbd54 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/method/configuration/EnableReactiveMethodSecurity.java +++ b/config/src/main/java/org/springframework/security/config/annotation/method/configuration/EnableReactiveMethodSecurity.java @@ -28,6 +28,8 @@ import org.springframework.core.Ordered; import org.springframework.security.authorization.ReactiveAuthorizationManager; /** + * Enables Spring Security reactive method security. + * * @author Rob Winch * @since 5.0 */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecurityConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecurityConfiguration.java index 6dcea7466d..fceee5c969 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecurityConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecurityConfiguration.java @@ -39,6 +39,8 @@ import org.springframework.security.access.prepost.PrePostAnnotationSecurityMeta import org.springframework.security.config.core.GrantedAuthorityDefaults; /** + * Configures the infrastructure beans for reactive method security. + * * @author Rob Winch * @author Tadaya Tsuyukubo * @since 5.0 diff --git a/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecuritySelector.java b/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecuritySelector.java index 8f29e10a55..47f145a11d 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecuritySelector.java +++ b/config/src/main/java/org/springframework/security/config/annotation/method/configuration/ReactiveMethodSecuritySelector.java @@ -30,6 +30,8 @@ import org.springframework.util.Assert; import org.springframework.util.ClassUtils; /** + * Selects the imports to register for {@link EnableReactiveMethodSecurity}. + * * @author Rob Winch * @author Evgeniy Cheban * @since 5.0 diff --git a/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurity.java b/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurity.java index 071c03f718..5d2fe4bc68 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurity.java +++ b/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurity.java @@ -154,7 +154,7 @@ public class RSocketSecurity { /** * Adds support for validating a username and password using Simple - * Authentication + * Authentication. * @param simple a customizer * @return RSocketSecurity for additional configuration * @since 5.3 @@ -168,7 +168,7 @@ public class RSocketSecurity { } /** - * Adds anonymous authentication + * Adds anonymous authentication. * @param anonymous a customizer * @return this instance * @since 7.0 @@ -265,6 +265,9 @@ public class RSocketSecurity { } /** + * Specifies the {@link ReactiveAuthenticationManager} to use for simple + * authentication. + * * @since 5.3 */ public final class SimpleAuthenticationSpec { @@ -286,7 +289,7 @@ public class RSocketSecurity { return this.authenticationManager; } - protected AuthenticationPayloadInterceptor build() { + AuthenticationPayloadInterceptor build() { ReactiveAuthenticationManager manager = getAuthenticationManager(); AuthenticationPayloadInterceptor result = new AuthenticationPayloadInterceptor(manager); result.setAuthenticationConverter(new AuthenticationPayloadExchangeConverter()); @@ -304,7 +307,7 @@ public class RSocketSecurity { this.parent = parent; } - protected AnonymousPayloadInterceptor build() { + AnonymousPayloadInterceptor build() { AnonymousPayloadInterceptor result = new AnonymousPayloadInterceptor("anonymousUser"); result.setOrder(PayloadInterceptorOrder.ANONYMOUS.getOrder()); return result; @@ -335,7 +338,7 @@ public class RSocketSecurity { return this.authenticationManager; } - protected AuthenticationPayloadInterceptor build() { + AuthenticationPayloadInterceptor build() { ReactiveAuthenticationManager manager = getAuthenticationManager(); AuthenticationPayloadInterceptor result = new AuthenticationPayloadInterceptor(manager); result.setOrder(PayloadInterceptorOrder.AUTHENTICATION.getOrder()); @@ -368,7 +371,7 @@ public class RSocketSecurity { return RSocketSecurity.this.authenticationManager; } - protected List build() { + List build() { ReactiveAuthenticationManager manager = getAuthenticationManager(); AuthenticationPayloadInterceptor legacy = new AuthenticationPayloadInterceptor(manager); legacy.setAuthenticationConverter(new BearerPayloadExchangeConverter()); @@ -393,7 +396,7 @@ public class RSocketSecurity { /** * Matches if * {@link org.springframework.security.rsocket.api.PayloadExchangeType#isRequest()} - * is true, else not a match + * is true, else not a match. * @return the Access to set up the authorization rule. */ public Access anyRequest() { @@ -401,7 +404,7 @@ public class RSocketSecurity { } /** - * Always matches + * Always matches. * @return the Access to set up the authorization rule. */ public Access anyExchange() { diff --git a/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurityConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurityConfiguration.java index e4d315f0b4..bb183c0b9e 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurityConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/rsocket/RSocketSecurityConfiguration.java @@ -30,6 +30,8 @@ import org.springframework.security.core.userdetails.ReactiveUserDetailsService; import org.springframework.security.crypto.password.PasswordEncoder; /** + * {@link Configuration} for RSocket security infrastructure beans. + * * @author Rob Winch * @since 5.2 */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/rsocket/SecuritySocketAcceptorInterceptorConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/rsocket/SecuritySocketAcceptorInterceptorConfiguration.java index 4773a04de9..a023177442 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/rsocket/SecuritySocketAcceptorInterceptorConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/rsocket/SecuritySocketAcceptorInterceptorConfiguration.java @@ -26,6 +26,8 @@ import org.springframework.security.rsocket.core.SecuritySocketAcceptorIntercept import org.springframework.security.rsocket.util.matcher.PayloadExchangeMatcher.MatchResult; /** + * {@link Configuration} that exposes a {@link SecuritySocketAcceptorInterceptor} bean. + * * @author Rob Winch * @since 5.2 */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.java b/config/src/main/java/org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.java index 2b77896291..2a7425af2a 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.java @@ -61,7 +61,7 @@ public abstract class AbstractRequestMatcherRegistry { } /** - * Gets the {@link ApplicationContext} + * Gets the {@link ApplicationContext}. * @return the {@link ApplicationContext} */ protected final ApplicationContext getApplicationContext() { @@ -111,7 +111,7 @@ public abstract class AbstractRequestMatcherRegistry { /** * Associates a list of {@link RequestMatcher} instances with the - * {@link AbstractRequestMatcherRegistry} + * {@link AbstractRequestMatcherRegistry}. * @param requestMatchers the {@link RequestMatcher} instances * @return the object that is chained after creating the {@link RequestMatcher} */ @@ -203,6 +203,7 @@ public abstract class AbstractRequestMatcherRegistry { * If a specific {@link RequestMatcher} must be specified, use * {@link #requestMatchers(RequestMatcher...)} instead *

    + * . * @param method the {@link HttpMethod} to use or {@code null} for any * {@link HttpMethod}. * @return the object that is chained after creating the {@link RequestMatcher}. diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/HttpSecurityBuilder.java b/config/src/main/java/org/springframework/security/config/annotation/web/HttpSecurityBuilder.java index 89ff01fbcf..6bdc11bf49 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/HttpSecurityBuilder.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/HttpSecurityBuilder.java @@ -53,6 +53,9 @@ import org.springframework.security.web.session.SessionManagementFilter; import org.springframework.web.filter.CorsFilter; /** + * A builder for a {@link DefaultSecurityFilterChain} that allows configuring and ordering + * the standard Spring Security {@link Filter} instances. + * * @param * @author Rob Winch */ @@ -89,14 +92,14 @@ public interface HttpSecurityBuilder> C getSharedObject(Class sharedType); /** - * Allows adding an additional {@link AuthenticationProvider} to be used + * Allows adding an additional {@link AuthenticationProvider} to be used. * @param authenticationProvider the {@link AuthenticationProvider} to be added * @return the {@link HttpSecurity} for further customizations */ H authenticationProvider(AuthenticationProvider authenticationProvider); /** - * Allows adding an additional {@link UserDetailsService} to be used + * Allows adding an additional {@link UserDetailsService} to be used. * @param userDetailsService the {@link UserDetailsService} to be added * @return the {@link HttpSecurity} for further customizations */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/builders/HttpSecurity.java b/config/src/main/java/org/springframework/security/config/annotation/web/builders/HttpSecurity.java index 0a16993345..6d48be0516 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/builders/HttpSecurity.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/builders/HttpSecurity.java @@ -159,7 +159,7 @@ public final class HttpSecurity extends AbstractConfiguredSecurityBuilder * @Configuration diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/HttpSecurityConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/HttpSecurityConfiguration.java index 81e6c8f034..39df88f213 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/HttpSecurityConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/HttpSecurityConfiguration.java @@ -256,7 +256,7 @@ class HttpSecurityConfiguration { private PasswordEncoder defaultPasswordEncoder; /** - * Creates a new instance + * Creates a new instance. * @param objectPostProcessor the {@link ObjectPostProcessor} instance to use. */ DefaultPasswordEncoderAuthenticationManagerBuilder(ObjectPostProcessor objectPostProcessor, diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ClientConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ClientConfiguration.java index e97329b3ff..61d76c6e20 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ClientConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ClientConfiguration.java @@ -101,6 +101,8 @@ final class OAuth2ClientConfiguration { } /** + * Configures the infrastructure beans for the {@code OAuth2AuthorizedClientManager}. + * * @author Joe Grandja * @since 6.2.0 */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ImportSelector.java b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ImportSelector.java index e9fb3e5b39..e2ff2b534c 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ImportSelector.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ImportSelector.java @@ -25,7 +25,7 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** - * Used by {@link EnableWebSecurity} to conditionally import: + * Used by {@link EnableWebSecurity} to conditionally import:. * *
      *
    • {@link OAuth2ClientConfiguration} when the {@code spring-security-oauth2-client} diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/SecurityReactorContextConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/SecurityReactorContextConfiguration.java index 11e5595418..2170691612 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/SecurityReactorContextConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/SecurityReactorContextConfiguration.java @@ -200,7 +200,7 @@ class SecurityReactorContextConfiguration { } /** - * A map that computes each value when {@link #get} is invoked + * A map that computes each value when {@link #get} is invoked. */ static class LoadingMap implements Map { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebMvcSecurityConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebMvcSecurityConfiguration.java index 37870e0aca..ef59bef41b 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebMvcSecurityConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebMvcSecurityConfiguration.java @@ -118,14 +118,14 @@ class WebMvcSecurityConfiguration implements WebMvcConfigurer, ApplicationContex static class CompositeFilterChainProxy extends FilterChainProxy { /** - * Used for {@link #doFilter(ServletRequest, ServletResponse, FilterChain)} + * Used for {@link #doFilter(ServletRequest, ServletResponse, FilterChain)}. */ private final Filter doFilterDelegate; private final FilterChainProxy springSecurityFilterChain; /** - * Creates a new instance + * Creates a new instance. * @param filters the Filters to delegate to. One of which must be * FilterChainProxy. */ @@ -197,7 +197,7 @@ class WebMvcSecurityConfiguration implements WebMvcConfigurer, ApplicationContex } /** - * Creates the Filter to delegate to for doFilter + * Creates the Filter to delegate to for doFilter. * @param filters the Filters to delegate to. * @return the Filter for doFilter */ @@ -208,7 +208,7 @@ class WebMvcSecurityConfiguration implements WebMvcConfigurer, ApplicationContex } /** - * Find the FilterChainProxy in a List of Filter + * Find the FilterChainProxy in a List of Filter. * @param filters * @return non-null FilterChainProxy * @throws IllegalStateException if the FilterChainProxy cannot be found diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebSecurityConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebSecurityConfiguration.java index 7e506d8d02..f96c8195fb 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebSecurityConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebSecurityConfiguration.java @@ -106,7 +106,7 @@ public class WebSecurityConfiguration implements ImportAware { } /** - * Creates the Spring Security Filter Chain + * Creates the Spring Security Filter Chain. * @return the {@link Filter} that represents the security filter chain * @throws Exception */ @@ -133,7 +133,7 @@ public class WebSecurityConfiguration implements ImportAware { /** * Creates the {@link WebInvocationPrivilegeEvaluator} that is necessary to evaluate - * privileges for a given web URI + * privileges for a given web URI. * @return the {@link WebInvocationPrivilegeEvaluator} */ @Bean @@ -290,14 +290,14 @@ public class WebSecurityConfiguration implements ImportAware { static class CompositeFilterChainProxy extends FilterChainProxy { /** - * Used for {@link #doFilter(ServletRequest, ServletResponse, FilterChain)} + * Used for {@link #doFilter(ServletRequest, ServletResponse, FilterChain)}. */ private final Filter doFilterDelegate; private final FilterChainProxy springSecurityFilterChain; /** - * Creates a new instance + * Creates a new instance. * @param filters the Filters to delegate to. One of which must be * FilterChainProxy. */ @@ -369,7 +369,7 @@ public class WebSecurityConfiguration implements ImportAware { } /** - * Creates the Filter to delegate to for doFilter + * Creates the Filter to delegate to for doFilter. * @param filters the Filters to delegate to. * @return the Filter for doFilter */ @@ -380,7 +380,7 @@ public class WebSecurityConfiguration implements ImportAware { } /** - * Find the FilterChainProxy in a List of Filter + * Find the FilterChainProxy in a List of Filter. * @param filters * @return non-null FilterChainProxy * @throws IllegalStateException if the FilterChainProxy cannot be found diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AbstractAuthenticationFilterConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AbstractAuthenticationFilterConfigurer.java index 3cf0cd6dda..cda32a27dd 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AbstractAuthenticationFilterConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AbstractAuthenticationFilterConfigurer.java @@ -85,14 +85,14 @@ public abstract class AbstractAuthenticationFilterConfigurer extends A /** * Creates the mapping of {@link RequestMatcher} to {@link Collection} of - * {@link ConfigAttribute} instances + * {@link ConfigAttribute} instances. * @return the mapping of {@link RequestMatcher} to {@link Collection} of * {@link ConfigAttribute} instances. Cannot be null. */ @@ -123,7 +123,7 @@ public abstract class AbstractConfigAttributeRequestMatcherRegistry extends A /** * A mapping of {@link RequestMatcher} to {@link Collection} of - * {@link ConfigAttribute} instances + * {@link ConfigAttribute} instances. */ static final class UrlMapping { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AnonymousConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AnonymousConfigurer.java index cfaef882e6..c38b3485e7 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AnonymousConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AnonymousConfigurer.java @@ -58,7 +58,7 @@ public final class AnonymousConfigurer> private String computedKey; /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#anonymous(Customizer) */ public AnonymousConfigurer() { @@ -78,7 +78,7 @@ public final class AnonymousConfigurer> } /** - * Sets the principal for {@link Authentication} objects of anonymous users + * Sets the principal for {@link Authentication} objects of anonymous users. * @param principal used for the {@link Authentication} object of anonymous users * @return the {@link AnonymousConfigurer} for further customization of anonymous * authentication @@ -90,7 +90,7 @@ public final class AnonymousConfigurer> /** * Sets the {@link org.springframework.security.core.Authentication#getAuthorities()} - * for anonymous users + * for anonymous users. * @param authorities Sets the * {@link org.springframework.security.core.Authentication#getAuthorities()} for * anonymous users @@ -104,7 +104,7 @@ public final class AnonymousConfigurer> /** * Sets the {@link org.springframework.security.core.Authentication#getAuthorities()} - * for anonymous users + * for anonymous users. * @param authorities Sets the * {@link org.springframework.security.core.Authentication#getAuthorities()} for * anonymous users (i.e. "ROLE_ANONYMOUS") diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AuthorizeHttpRequestsConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AuthorizeHttpRequestsConfigurer.java index 4f61c93055..340ba25570 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AuthorizeHttpRequestsConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/AuthorizeHttpRequestsConfigurer.java @@ -414,7 +414,7 @@ public final class AuthorizeHttpRequestsConfigurer * For example,
       			 * requestMatchers("/user/{username}").hasVariable("username").equalTo(Authentication::getName));
      -			 * 
      + * . * @param function a function to get value from {@link Authentication}. * @return the {@link AuthorizationManagerRequestMatcherRegistry} for further * customization. diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ChannelSecurityConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ChannelSecurityConfigurer.java index 4130f4fa0c..61bb244627 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ChannelSecurityConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ChannelSecurityConfigurer.java @@ -92,7 +92,7 @@ public final class ChannelSecurityConfigurer> private final ChannelRequestMatcherRegistry REGISTRY; /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#requiresChannel(Customizer) */ public ChannelSecurityConfigurer(ApplicationContext context) { @@ -147,6 +147,9 @@ public final class ChannelSecurityConfigurer> } /** + * Allows registering {@link RequestMatcher}s that should be mapped to a channel + * requirement. + * * @deprecated no replacement planned */ @Deprecated @@ -174,7 +177,7 @@ public final class ChannelSecurityConfigurer> /** * Sets the {@link ChannelProcessor} instances to use in - * {@link ChannelDecisionManagerImpl} + * {@link ChannelDecisionManagerImpl}. * @param channelProcessors * @return the {@link ChannelSecurityConfigurer} for further customizations */ @@ -185,7 +188,7 @@ public final class ChannelSecurityConfigurer> /** * Sets the {@link RedirectStrategy} instances to use in - * {@link RetryWithHttpEntryPoint} and {@link RetryWithHttpsEntryPoint} + * {@link RetryWithHttpEntryPoint} and {@link RetryWithHttpsEntryPoint}. * @param redirectStrategy * @return the {@link ChannelSecurityConfigurer} for further customizations */ @@ -197,6 +200,9 @@ public final class ChannelSecurityConfigurer> } /** + * Allows registering a channel requirement for the previously specified + * {@link RequestMatcher}s. + * * @deprecated no replacement planned */ @Deprecated diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CorsConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CorsConfigurer.java index 34c2b8a95c..6ee23ebf85 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CorsConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CorsConfigurer.java @@ -49,7 +49,7 @@ public class CorsConfigurer> extends AbstractHt private PreFlightRequestHandler preFlightRequestHandler; /** - * Creates a new instance + * Creates a new instance. * * @see HttpSecurity#cors(Customizer) */ @@ -148,7 +148,7 @@ public class CorsConfigurer> extends AbstractHt /** * This needs to be isolated into a separate class as Spring MVC is an optional - * dependency and will potentially cause ClassLoading issues + * dependency and will potentially cause ClassLoading issues. * @param context * @return */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CsrfConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CsrfConfigurer.java index 57f1edddc3..3f67e91280 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CsrfConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/CsrfConfigurer.java @@ -103,7 +103,7 @@ public final class CsrfConfigurer> private final ApplicationContext context; /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#csrf(Customizer) */ public CsrfConfigurer(ApplicationContext context) { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ExceptionHandlingConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ExceptionHandlingConfigurer.java index dd093e8141..cc84abfeab 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ExceptionHandlingConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ExceptionHandlingConfigurer.java @@ -83,7 +83,7 @@ public final class ExceptionHandlingConfigurer> private DelegatingMissingAuthorityAccessDeniedHandler.@Nullable Builder missingAuthoritiesHandlerBuilder; /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#exceptionHandling(Customizer) */ public ExceptionHandlingConfigurer() { @@ -91,7 +91,7 @@ public final class ExceptionHandlingConfigurer> /** * Shortcut to specify the {@link AccessDeniedHandler} to be used is a specific error - * page + * page. * @param accessDeniedUrl the URL to the access denied page (i.e. /errors/401) * @return the {@link ExceptionHandlingConfigurer} for further customization * @see AccessDeniedHandlerImpl @@ -104,7 +104,7 @@ public final class ExceptionHandlingConfigurer> } /** - * Specifies the {@link AccessDeniedHandler} to be used + * Specifies the {@link AccessDeniedHandler} to be used. * @param accessDeniedHandler the {@link AccessDeniedHandler} to be used * @return the {@link ExceptionHandlingConfigurer} for further customization */ @@ -213,7 +213,7 @@ public final class ExceptionHandlingConfigurer> } /** - * Gets any explicitly configured {@link AuthenticationEntryPoint} + * Gets any explicitly configured {@link AuthenticationEntryPoint}. * @return */ AuthenticationEntryPoint getAuthenticationEntryPoint() { @@ -242,7 +242,7 @@ public final class ExceptionHandlingConfigurer> /** * Gets the {@link AccessDeniedHandler} according to the rules specified by - * {@link #accessDeniedHandler(AccessDeniedHandler)} + * {@link #accessDeniedHandler(AccessDeniedHandler)}. * @param http the {@link HttpSecurity} used to look up shared * {@link AccessDeniedHandler} * @return the {@link AccessDeniedHandler} to use @@ -257,7 +257,7 @@ public final class ExceptionHandlingConfigurer> /** * Gets the {@link AuthenticationEntryPoint} according to the rules specified by - * {@link #authenticationEntryPoint(AuthenticationEntryPoint)} + * {@link #authenticationEntryPoint(AuthenticationEntryPoint)}. * @param http the {@link HttpSecurity} used to look up shared * {@link AuthenticationEntryPoint} * @return the {@link AuthenticationEntryPoint} to use diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/FormLoginConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/FormLoginConfigurer.java index 8665b002c9..95a1a096c4 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/FormLoginConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/FormLoginConfigurer.java @@ -74,7 +74,7 @@ public final class FormLoginConfigurer> extends AbstractAuthenticationFilterConfigurer, UsernamePasswordAuthenticationFilter> { /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#formLogin(Customizer) */ public FormLoginConfigurer() { @@ -209,7 +209,7 @@ public final class FormLoginConfigurer> extends } /** - * Forward Authentication Failure Handler + * Forward Authentication Failure Handler. * @param forwardUrl the target URL in case of failure * @return the {@link FormLoginConfigurer} for additional customization */ @@ -219,7 +219,7 @@ public final class FormLoginConfigurer> extends } /** - * Forward Authentication Success Handler + * Forward Authentication Success Handler. * @param forwardUrl the target URL in case of success * @return the {@link FormLoginConfigurer} for additional customization */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java index dd9338eb65..9c3d47ee9e 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java @@ -109,7 +109,7 @@ public class HeadersConfigurer> private final CrossOriginResourcePolicyConfig crossOriginResourcePolicy = new CrossOriginResourcePolicyConfig(); /** - * Creates a new instance + * Creates a new instance. * * @see HttpSecurity#headers(Customizer) */ @@ -117,7 +117,7 @@ public class HeadersConfigurer> } /** - * Adds a {@link HeaderWriter} instance + * Adds a {@link HeaderWriter} instance. * @param headerWriter the {@link HeaderWriter} instance to add * @return the {@link HeadersConfigurer} for additional customizations */ @@ -130,7 +130,7 @@ public class HeadersConfigurer> /** * Configures the {@link XContentTypeOptionsHeaderWriter} which inserts the * X-Content-Type-Options: + * >X-Content-Type-Options:. * *
       	 * X-Content-Type-Options: nosniff
      @@ -145,7 +145,7 @@ public class HeadersConfigurer>
       	}
       
       	/**
      -	 * Note this is not comprehensive XSS protection!
      +	 * Note this is not comprehensive XSS protection!.
       	 *
       	 * 

      * Allows customizing the {@link XXssProtectionHeaderWriter} which adds the > } /** - * Creates the {@link HeaderWriter} + * Creates the {@link HeaderWriter}. * @return the {@link HeaderWriter} */ private HeaderWriterFilter createHeaderWriterFilter() { @@ -504,7 +504,7 @@ public class HeadersConfigurer> } /** - * Ensures that Content Type Options is enabled + * Ensures that Content Type Options is enabled. * @return the {@link ContentTypeOptionsConfig} for additional customization */ private ContentTypeOptionsConfig enable() { @@ -559,7 +559,7 @@ public class HeadersConfigurer> } /** - * Disables X-XSS-Protection header (does not include it) + * Disables X-XSS-Protection header (does not include it). * @return the {@link HeadersConfigurer} for additional configuration */ public HeadersConfigurer disable() { @@ -589,7 +589,7 @@ public class HeadersConfigurer> } /** - * Disables Cache Control + * Disables Cache Control. * @return the {@link HeadersConfigurer} for additional configuration */ public HeadersConfigurer disable() { @@ -686,7 +686,7 @@ public class HeadersConfigurer> } /** - * Disables Strict Transport Security + * Disables Strict Transport Security. * @return the {@link HeadersConfigurer} for additional configuration */ public HeadersConfigurer disable() { @@ -695,7 +695,7 @@ public class HeadersConfigurer> } /** - * Ensures that Strict-Transport-Security is enabled if it is not already + * Ensures that Strict-Transport-Security is enabled if it is not already. * @return the {@link HstsConfig} for additional customization */ private HstsConfig enable() { @@ -761,6 +761,8 @@ public class HeadersConfigurer> } /** + * Configures the HTTP Public Key Pinning (HPKP) header. + * * @deprecated see Certificate * and Public Key Pinning for more context @@ -921,7 +923,7 @@ public class HeadersConfigurer> /** * Ensures that Public-Key-Pins or Public-Key-Pins-Report-Only is enabled if it is - * not already + * not already. * @return the {@link HstsConfig} for additional customization */ private HpkpConfig enable() { @@ -1029,7 +1031,7 @@ public class HeadersConfigurer> } /** - * Sets the policy to be used in the {@code Cross-Origin-Opener-Policy} header + * Sets the policy to be used in the {@code Cross-Origin-Opener-Policy} header. * @param openerPolicy a {@code Cross-Origin-Opener-Policy} * @return the {@link CrossOriginOpenerPolicyConfig} for additional configuration * @throws IllegalArgumentException if openerPolicy is null @@ -1050,7 +1052,7 @@ public class HeadersConfigurer> } /** - * Sets the policy to be used in the {@code Cross-Origin-Embedder-Policy} header + * Sets the policy to be used in the {@code Cross-Origin-Embedder-Policy} header. * @param embedderPolicy a {@code Cross-Origin-Embedder-Policy} * @return the {@link CrossOriginEmbedderPolicyConfig} for additional * configuration @@ -1072,7 +1074,7 @@ public class HeadersConfigurer> } /** - * Sets the policy to be used in the {@code Cross-Origin-Resource-Policy} header + * Sets the policy to be used in the {@code Cross-Origin-Resource-Policy} header. * @param resourcePolicy a {@code Cross-Origin-Resource-Policy} * @return the {@link CrossOriginResourcePolicyConfig} for additional * configuration diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HttpBasicConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HttpBasicConfigurer.java index c8f0b4dc3e..d1de6cb20d 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HttpBasicConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HttpBasicConfigurer.java @@ -98,7 +98,7 @@ public final class HttpBasicConfigurer> private SecurityContextRepository securityContextRepository; /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#httpBasic(Customizer) */ public HttpBasicConfigurer() { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/JeeConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/JeeConfigurer.java index 8ac1a4b087..8e916094ce 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/JeeConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/JeeConfigurer.java @@ -78,7 +78,7 @@ public final class JeeConfigurer> extends Abstr private Set mappableRoles = new HashSet<>(); /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#jee(Customizer) */ public JeeConfigurer() { @@ -185,7 +185,7 @@ public final class JeeConfigurer> extends Abstr * Populates a {@link PreAuthenticatedAuthenticationProvider} into * {@link HttpSecurity#authenticationProvider(org.springframework.security.authentication.AuthenticationProvider)} * and a {@link Http403ForbiddenEntryPoint} into - * {@link HttpSecurityBuilder#setSharedObject(Class, Object)} + * {@link HttpSecurityBuilder#setSharedObject(Class, Object)}. * * @see SecurityConfigurer#init(org.springframework.security.config.annotation.SecurityBuilder) */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/LogoutConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/LogoutConfigurer.java index f4e9cf6e9f..a5a6af80b6 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/LogoutConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/LogoutConfigurer.java @@ -92,7 +92,7 @@ public final class LogoutConfigurer> private LinkedHashMap defaultLogoutSuccessHandlerMappings = new LinkedHashMap<>(); /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#logout(Customizer) */ public LogoutConfigurer() { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PermitAllSupport.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PermitAllSupport.java index d61fecb327..ad5b9f4324 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PermitAllSupport.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PermitAllSupport.java @@ -24,7 +24,7 @@ import org.springframework.security.web.util.matcher.RequestMatcher; import org.springframework.util.Assert; /** - * Configures non-null URL's to grant access to every URL + * Configures non-null URL's to grant access to every URL. * * @author Rob Winch * @since 3.2 diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PortMapperConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PortMapperConfigurer.java index bec44994c2..855d5acf04 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PortMapperConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/PortMapperConfigurer.java @@ -40,7 +40,7 @@ public final class PortMapperConfigurer> private Map httpsPortMappings = new HashMap<>(); /** - * Creates a new instance + * Creates a new instance. */ public PortMapperConfigurer() { } @@ -56,7 +56,7 @@ public final class PortMapperConfigurer> } /** - * Adds a port mapping + * Adds a port mapping. * @param httpPort the HTTP port that maps to a specific HTTPS port. * @return {@link HttpPortMapping} to define the HTTPS port */ @@ -96,7 +96,7 @@ public final class PortMapperConfigurer> private final int httpPort; /** - * Creates a new instance + * Creates a new instance. * @param httpPort * @see PortMapperConfigurer#http(int) */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/RememberMeConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/RememberMeConfigurer.java index 60b5050e80..529c207f56 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/RememberMeConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/RememberMeConfigurer.java @@ -85,7 +85,7 @@ public final class RememberMeConfigurer> extends AbstractHttpConfigurer, H> { /** - * The default name for remember me parameter name and remember me cookie name + * The default name for remember me parameter name and remember me cookie name. */ private static final String DEFAULT_REMEMBER_ME_NAME = "remember-me"; @@ -114,13 +114,13 @@ public final class RememberMeConfigurer> private Boolean alwaysRemember; /** - * Creates a new instance + * Creates a new instance. */ public RememberMeConfigurer() { } /** - * Allows specifying how long (in seconds) a token is valid for + * Allows specifying how long (in seconds) a token is valid for. * @param tokenValiditySeconds * @return {@link RememberMeConfigurer} for further customization * @see AbstractRememberMeServices#setTokenValiditySeconds(int) @@ -388,7 +388,7 @@ public final class RememberMeConfigurer> } /** - * Creates {@link TokenBasedRememberMeServices} + * Creates {@link TokenBasedRememberMeServices}. * @param http the {@link HttpSecurity} to lookup shared objects * @param key the {@link #key(String)} * @return the {@link TokenBasedRememberMeServices} @@ -399,7 +399,7 @@ public final class RememberMeConfigurer> } /** - * Creates {@link PersistentTokenBasedRememberMeServices} + * Creates {@link PersistentTokenBasedRememberMeServices}. * @param http the {@link HttpSecurity} to lookup shared objects * @param key the {@link #key(String)} * @return the {@link PersistentTokenBasedRememberMeServices} diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SecurityContextConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SecurityContextConfigurer.java index 8f77866c01..0576c0a454 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SecurityContextConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SecurityContextConfigurer.java @@ -70,14 +70,14 @@ public final class SecurityContextConfigurer> private boolean requireExplicitSave = true; /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#securityContext(Customizer) */ public SecurityContextConfigurer() { } /** - * Specifies the shared {@link SecurityContextRepository} that is to be used + * Specifies the shared {@link SecurityContextRepository} that is to be used. * @param securityContextRepository the {@link SecurityContextRepository} to use * @return the {@link HttpSecurity} for further customizations */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ServletApiConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ServletApiConfigurer.java index e90d09e40e..6320f6f8fa 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ServletApiConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ServletApiConfigurer.java @@ -66,7 +66,7 @@ public final class ServletApiConfigurer> private SecurityContextHolderAwareRequestFilter securityContextRequestFilter = new SecurityContextHolderAwareRequestFilter(); /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#servletApi(Customizer) */ public ServletApiConfigurer() { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SessionManagementConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SessionManagementConfigurer.java index 8e75d47e89..a9e6c18490 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SessionManagementConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/SessionManagementConfigurer.java @@ -151,7 +151,7 @@ public final class SessionManagementConfigurer> private SecurityContextRepository sessionManagementSecurityContextRepository = new HttpSessionSecurityContextRepository(); /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#sessionManagement(Customizer) */ public SessionManagementConfigurer() { @@ -254,7 +254,7 @@ public final class SessionManagementConfigurer> } /** - * Allows specifying the {@link SessionCreationPolicy} + * Allows specifying the {@link SessionCreationPolicy}. * @param sessionCreationPolicy the {@link SessionCreationPolicy} to use. Cannot be * null. * @return the {@link SessionManagementConfigurer} for further customizations @@ -530,7 +530,7 @@ public final class SessionManagementConfigurer> /** * Returns true if the {@link SessionCreationPolicy} allows session creation, else - * false + * false. * @return true if the {@link SessionCreationPolicy} allows session creation */ private boolean isAllowSessionCreation() { @@ -539,7 +539,7 @@ public final class SessionManagementConfigurer> } /** - * Returns true if the {@link SessionCreationPolicy} is stateless + * Returns true if the {@link SessionCreationPolicy} is stateless. * @return */ private boolean isStateless() { @@ -619,7 +619,7 @@ public final class SessionManagementConfigurer> } /** - * Creates the default {@link SessionAuthenticationStrategy} for session fixation + * Creates the default {@link SessionAuthenticationStrategy} for session fixation. * @return the default {@link SessionAuthenticationStrategy} for session fixation */ private static SessionAuthenticationStrategy createDefaultSessionFixationProtectionStrategy() { @@ -636,7 +636,7 @@ public final class SessionManagementConfigurer> } /** - * Allows configuring SessionFixation protection + * Allows configuring SessionFixation protection. * * @author Rob Winch */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/WebAuthnConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/WebAuthnConfigurer.java index cb534a38f3..2b30bfbd65 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/WebAuthnConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/WebAuthnConfigurer.java @@ -54,7 +54,7 @@ import org.springframework.security.web.webauthn.registration.WebAuthnRegistrati import org.springframework.util.Assert; /** - * Configures WebAuthn for Spring Security applications + * Configures WebAuthn for Spring Security applications. * * @param the type of builder * @author Rob Winch @@ -87,7 +87,7 @@ public class WebAuthnConfigurer> } /** - * Sets the relying party name + * Sets the relying party name. * @param rpName the relying party name * @return the {@link WebAuthnConfigurer} for further customization */ @@ -98,7 +98,7 @@ public class WebAuthnConfigurer> } /** - * Convenience method for {@link #allowedOrigins(Set)} + * Convenience method for {@link #allowedOrigins(Set)}. * @param allowedOrigins the allowed origins * @return the {@link WebAuthnConfigurer} for further customization * @see #allowedOrigins(Set) @@ -144,7 +144,7 @@ public class WebAuthnConfigurer> } /** - * Sets PublicKeyCredentialCreationOptionsRepository + * Sets PublicKeyCredentialCreationOptionsRepository. * @param creationOptionsRepository the creationOptionsRepository * @return the {@link WebAuthnConfigurer} for further customization */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/X509Configurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/X509Configurer.java index 0c09707889..4314aee58f 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/X509Configurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/X509Configurer.java @@ -91,7 +91,7 @@ public final class X509Configurer> private AuthenticationDetailsSource authenticationDetailsSource; /** - * Creates a new instance + * Creates a new instance. * * @see HttpSecurity#x509(Customizer) */ @@ -111,7 +111,7 @@ public final class X509Configurer> } /** - * Specifies the {@link X509PrincipalExtractor} + * Specifies the {@link X509PrincipalExtractor}. * @param x509PrincipalExtractor the {@link X509PrincipalExtractor} to use * @return the {@link X509Configurer} to use */ @@ -121,7 +121,7 @@ public final class X509Configurer> } /** - * Specifies the {@link AuthenticationDetailsSource} + * Specifies the {@link AuthenticationDetailsSource}. * @param authenticationDetailsSource the {@link AuthenticationDetailsSource} to use * @return the {@link X509Configurer} to use */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OAuth2LoginConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OAuth2LoginConfigurer.java index 4470a7211e..e070e2a2f5 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OAuth2LoginConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OAuth2LoginConfigurer.java @@ -247,7 +247,7 @@ public final class OAuth2LoginConfigurer> } /** - * Sets the registry for managing the OIDC client-provider session link + * Sets the registry for managing the OIDC client-provider session link. * @param oidcSessionRegistry the {@link OidcSessionRegistry} to use * @return the {@link OAuth2LoginConfigurer} for further configuration * @since 6.2 diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthentication.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthentication.java index 2c5e4eef6e..83e92194ce 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthentication.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthentication.java @@ -45,7 +45,7 @@ class OidcBackChannelLogoutAuthentication extends AbstractAuthenticationToken { private final ClientRegistration clientRegistration; /** - * Construct an {@link OidcBackChannelLogoutAuthentication} + * Construct an {@link OidcBackChannelLogoutAuthentication}. * @param logoutToken a deserialized, verified OIDC Logout Token */ OidcBackChannelLogoutAuthentication(OidcLogoutToken logoutToken, ClientRegistration clientRegistration) { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthenticationProvider.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthenticationProvider.java index 29ad8e8100..9f46dbffe5 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthenticationProvider.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutAuthenticationProvider.java @@ -60,7 +60,7 @@ final class OidcBackChannelLogoutAuthenticationProvider implements Authenticatio private JwtDecoderFactory logoutTokenDecoderFactory; /** - * Construct an {@link OidcBackChannelLogoutAuthenticationProvider} + * Construct an {@link OidcBackChannelLogoutAuthenticationProvider}. */ OidcBackChannelLogoutAuthenticationProvider() { JwtTypeValidator type = new JwtTypeValidator("JWT", "logout+jwt"); diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutFilter.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutFilter.java index 18b1a31506..9d722f552d 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutFilter.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcBackChannelLogoutFilter.java @@ -40,7 +40,7 @@ import org.springframework.util.Assert; import org.springframework.web.filter.OncePerRequestFilter; /** - * A filter for the Client-side OIDC Back-Channel Logout endpoint + * A filter for the Client-side OIDC Back-Channel Logout endpoint. * * @author Josh Cummings * @since 6.2 @@ -61,7 +61,7 @@ class OidcBackChannelLogoutFilter extends OncePerRequestFilter { private final LogoutHandler logoutHandler; /** - * Construct an {@link OidcBackChannelLogoutFilter} + * Construct an {@link OidcBackChannelLogoutFilter}. * @param authenticationConverter the {@link AuthenticationConverter} for deriving * Logout Token authentication * @param authenticationManager the {@link AuthenticationManager} for authenticating diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationConverter.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationConverter.java index 8930598810..93ae4b60cd 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationConverter.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationConverter.java @@ -33,7 +33,7 @@ import org.springframework.util.Assert; /** * An {@link AuthenticationConverter} that extracts the OIDC Logout Token authentication - * request + * request. * * @author Josh Cummings * @since 6.2 diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationToken.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationToken.java index 934abd05cb..70085b4a27 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationToken.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutAuthenticationToken.java @@ -39,7 +39,7 @@ class OidcLogoutAuthenticationToken extends AbstractAuthenticationToken { private final ClientRegistration clientRegistration; /** - * Construct an {@link OidcLogoutAuthenticationToken} + * Construct an {@link OidcLogoutAuthenticationToken}. * @param logoutToken a signed, serialized OIDC Logout token * @param clientRegistration the {@link ClientRegistration client} associated with * this token; this is usually derived from material in the logout HTTP request @@ -67,7 +67,7 @@ class OidcLogoutAuthenticationToken extends AbstractAuthenticationToken { } /** - * Get the signed, serialized OIDC Logout token + * Get the signed, serialized OIDC Logout token. * @return the logout token */ String getLogoutToken() { @@ -75,7 +75,7 @@ class OidcLogoutAuthenticationToken extends AbstractAuthenticationToken { } /** - * Get the {@link ClientRegistration} associated with this logout token + * Get the {@link ClientRegistration} associated with this logout token. * @return the {@link ClientRegistration} */ ClientRegistration getClientRegistration() { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutConfigurer.java index 4947669a2e..49153f3a49 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OidcLogoutConfigurer.java @@ -89,7 +89,7 @@ public final class OidcLogoutConfigurer> } /** - * Sets the registry for managing the OIDC client-provider session link + * Sets the registry for managing the OIDC client-provider session link. * @param oidcSessionRegistry the {@link OidcSessionRegistry} to use * @return the {@link OAuth2LoginConfigurer} for further configuration */ @@ -100,7 +100,7 @@ public final class OidcLogoutConfigurer> } /** - * Configure OIDC Back-Channel Logout using the provided {@link Consumer} + * Configure OIDC Back-Channel Logout using the provided {@link Consumer}. * @return the {@link OidcLogoutConfigurer} for further configuration */ public OidcLogoutConfigurer backChannel(Customizer backChannelLogoutConfigurer) { @@ -119,7 +119,7 @@ public final class OidcLogoutConfigurer> } /** - * A configurer for configuring OIDC Back-Channel Logout + * A configurer for configuring OIDC Back-Channel Logout. */ public final class BackChannelLogoutConfigurer { diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/server/authorization/DefaultOAuth2TokenCustomizers.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/server/authorization/DefaultOAuth2TokenCustomizers.java index d909848d85..b99f878b8e 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/server/authorization/DefaultOAuth2TokenCustomizers.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/server/authorization/DefaultOAuth2TokenCustomizers.java @@ -43,6 +43,9 @@ import org.springframework.security.oauth2.server.authorization.token.OAuth2Toke import org.springframework.util.CollectionUtils; /** + * Default {@link OAuth2TokenCustomizer} implementations for the OAuth2 Authorization + * Server. + * * @author Joe Grandja * @author Steve Riesenberg * @since 7.0 diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ott/OneTimeTokenLoginConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ott/OneTimeTokenLoginConfigurer.java index 99591adad9..112a3b898b 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ott/OneTimeTokenLoginConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/ott/OneTimeTokenLoginConfigurer.java @@ -304,7 +304,7 @@ public final class OneTimeTokenLoginConfigurer> /** * Configures the {@link OneTimeTokenService} used to generate and consume - * {@link OneTimeToken} + * {@link OneTimeToken}. * @param oneTimeTokenService */ public OneTimeTokenLoginConfigurer tokenService(OneTimeTokenService oneTimeTokenService) { @@ -394,6 +394,7 @@ public final class OneTimeTokenLoginConfigurer> } /** + * Returns the {@link ApplicationContext}. * @deprecated Use this.context instead */ @Deprecated diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/saml2/Saml2LogoutConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/saml2/Saml2LogoutConfigurer.java index 1c519e786c..5ab684fd7a 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/saml2/Saml2LogoutConfigurer.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/saml2/Saml2LogoutConfigurer.java @@ -128,7 +128,7 @@ public final class Saml2LogoutConfigurer> private LogoutResponseConfigurer logoutResponseConfigurer; /** - * Creates a new instance + * Creates a new instance. * @see HttpSecurity#logout(Customizer) */ public Saml2LogoutConfigurer(ApplicationContext context) { @@ -340,7 +340,7 @@ public final class Saml2LogoutConfigurer> /** * Use this {@link LogoutHandler} for processing a logout request from the - * asserting party + * asserting party. * @param authenticator the {@link Saml2LogoutRequestValidator} to use * @return the {@link LogoutRequestConfigurer} for further customizations */ @@ -351,7 +351,7 @@ public final class Saml2LogoutConfigurer> /** * Use this {@link Saml2LogoutRequestResolver} for producing a logout request to - * send to the asserting party + * send to the asserting party. * @param logoutRequestResolver the {@link Saml2LogoutRequestResolver} to use * @return the {@link LogoutRequestConfigurer} for further customizations */ @@ -361,7 +361,7 @@ public final class Saml2LogoutConfigurer> } /** - * Use this {@link Saml2LogoutRequestRepository} for storing logout requests + * Use this {@link Saml2LogoutRequestRepository} for storing logout requests. * @param logoutRequestRepository the {@link Saml2LogoutRequestRepository} to use * @return the {@link LogoutRequestConfigurer} for further customizations */ @@ -422,7 +422,7 @@ public final class Saml2LogoutConfigurer> /** * Use this {@link LogoutHandler} for processing a logout response from the - * asserting party + * asserting party. * @param authenticator the {@link AuthenticationManager} to use * @return the {@link LogoutRequestConfigurer} for further customizations */ @@ -433,7 +433,7 @@ public final class Saml2LogoutConfigurer> /** * Use this {@link Saml2LogoutRequestResolver} for producing a logout response to - * send to the asserting party + * send to the asserting party. * @param logoutResponseResolver the {@link Saml2LogoutResponseResolver} to use * @return the {@link LogoutRequestConfigurer} for further customizations */ diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/reactive/ServerHttpSecurityConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/web/reactive/ServerHttpSecurityConfiguration.java index 60b9346059..07736ee9cd 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/reactive/ServerHttpSecurityConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/reactive/ServerHttpSecurityConfiguration.java @@ -51,6 +51,9 @@ import org.springframework.web.reactive.result.method.annotation.ArgumentResolve import static org.springframework.security.config.Customizer.withDefaults; /** + * Configuration that exposes a {@link ServerHttpSecurity} bean for use in WebFlux + * security configuration. + * * @author Rob Winch * @author Dan Zheng * @since 5.0 diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/reactive/WebFluxSecurityConfiguration.java b/config/src/main/java/org/springframework/security/config/annotation/web/reactive/WebFluxSecurityConfiguration.java index 466db488c2..e586ac5afb 100644 --- a/config/src/main/java/org/springframework/security/config/annotation/web/reactive/WebFluxSecurityConfiguration.java +++ b/config/src/main/java/org/springframework/security/config/annotation/web/reactive/WebFluxSecurityConfiguration.java @@ -42,6 +42,8 @@ import org.springframework.web.reactive.result.view.AbstractView; import static org.springframework.security.config.Customizer.withDefaults; /** + * Configures the infrastructure beans for WebFlux security. + * * @author Rob Winch * @author Yanming Zhou * @since 5.0 diff --git a/config/src/main/java/org/springframework/security/config/aot/hint/OAuth2LoginRuntimeHints.java b/config/src/main/java/org/springframework/security/config/aot/hint/OAuth2LoginRuntimeHints.java index 86d794dfd0..f8fe8c38fa 100644 --- a/config/src/main/java/org/springframework/security/config/aot/hint/OAuth2LoginRuntimeHints.java +++ b/config/src/main/java/org/springframework/security/config/aot/hint/OAuth2LoginRuntimeHints.java @@ -22,7 +22,7 @@ import org.springframework.aot.hint.RuntimeHintsRegistrar; /** * {@link RuntimeHintsRegistrar} for - * {@link org.springframework.security.config.web.server.ServerHttpSecurity} + * {@link org.springframework.security.config.web.server.ServerHttpSecurity}. * * @author Marcus Da Coregio * @since 6.0.2 diff --git a/config/src/main/java/org/springframework/security/config/aot/hint/WebMvcSecurityConfigurationRuntimeHints.java b/config/src/main/java/org/springframework/security/config/aot/hint/WebMvcSecurityConfigurationRuntimeHints.java index 4af9449a6d..48cba2488e 100644 --- a/config/src/main/java/org/springframework/security/config/aot/hint/WebMvcSecurityConfigurationRuntimeHints.java +++ b/config/src/main/java/org/springframework/security/config/aot/hint/WebMvcSecurityConfigurationRuntimeHints.java @@ -23,7 +23,7 @@ import org.springframework.aot.hint.TypeReference; /** * Runtime hints for - * {@link org.springframework.security.config.annotation.web.configuration.WebMvcSecurityConfiguration} + * {@link org.springframework.security.config.annotation.web.configuration.WebMvcSecurityConfiguration}. * * @author Marcus da Coregio */ diff --git a/config/src/main/java/org/springframework/security/config/aot/hint/WebSecurityConfigurationRuntimeHints.java b/config/src/main/java/org/springframework/security/config/aot/hint/WebSecurityConfigurationRuntimeHints.java index 290d6f4230..33d80023a1 100644 --- a/config/src/main/java/org/springframework/security/config/aot/hint/WebSecurityConfigurationRuntimeHints.java +++ b/config/src/main/java/org/springframework/security/config/aot/hint/WebSecurityConfigurationRuntimeHints.java @@ -23,7 +23,7 @@ import org.springframework.aot.hint.TypeReference; /** * Runtime hints for - * {@link org.springframework.security.config.annotation.web.configuration.WebSecurityConfiguration} + * {@link org.springframework.security.config.annotation.web.configuration.WebSecurityConfiguration}. * * @author Marcus da Coregio */ diff --git a/config/src/main/java/org/springframework/security/config/authentication/AbstractUserDetailsServiceBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/authentication/AbstractUserDetailsServiceBeanDefinitionParser.java index 19edc2ca01..848b8f1844 100644 --- a/config/src/main/java/org/springframework/security/config/authentication/AbstractUserDetailsServiceBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/authentication/AbstractUserDetailsServiceBeanDefinitionParser.java @@ -33,6 +33,8 @@ import org.springframework.security.config.BeanIds; import org.springframework.util.StringUtils; /** + * Base class for parsers which create a {@code UserDetailsService} bean definition. + * * @author Luke Taylor */ public abstract class AbstractUserDetailsServiceBeanDefinitionParser implements BeanDefinitionParser { diff --git a/config/src/main/java/org/springframework/security/config/authentication/JdbcUserServiceBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/authentication/JdbcUserServiceBeanDefinitionParser.java index 8958a92b15..5b6a68ba7a 100644 --- a/config/src/main/java/org/springframework/security/config/authentication/JdbcUserServiceBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/authentication/JdbcUserServiceBeanDefinitionParser.java @@ -24,6 +24,9 @@ import org.springframework.security.config.Elements; import org.springframework.util.StringUtils; /** + * Parses the {@code jdbc-user-service} element to configure a + * {@code JdbcUserDetailsManager}. + * * @author Luke Taylor */ public class JdbcUserServiceBeanDefinitionParser extends AbstractUserDetailsServiceBeanDefinitionParser { diff --git a/config/src/main/java/org/springframework/security/config/authentication/UserServiceBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/authentication/UserServiceBeanDefinitionParser.java index f08599a353..c445947da0 100644 --- a/config/src/main/java/org/springframework/security/config/authentication/UserServiceBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/authentication/UserServiceBeanDefinitionParser.java @@ -37,6 +37,8 @@ import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** + * Parses the {@code user-service} element. + * * @author Luke Taylor * @author Ben Alex */ diff --git a/config/src/main/java/org/springframework/security/config/core/GrantedAuthorityDefaults.java b/config/src/main/java/org/springframework/security/config/core/GrantedAuthorityDefaults.java index 453ecbdc96..d87721e866 100644 --- a/config/src/main/java/org/springframework/security/config/core/GrantedAuthorityDefaults.java +++ b/config/src/main/java/org/springframework/security/config/core/GrantedAuthorityDefaults.java @@ -19,7 +19,7 @@ package org.springframework.security.config.core; import org.springframework.security.core.GrantedAuthority; /** - * Allows providing defaults for {@link GrantedAuthority} + * Allows providing defaults for {@link GrantedAuthority}. * * @author Eddú Meléndez * @since 4.2.0 diff --git a/config/src/main/java/org/springframework/security/config/core/userdetails/UserDetailsResourceFactoryBean.java b/config/src/main/java/org/springframework/security/config/core/userdetails/UserDetailsResourceFactoryBean.java index 00977f10b7..b572ff98fb 100644 --- a/config/src/main/java/org/springframework/security/config/core/userdetails/UserDetailsResourceFactoryBean.java +++ b/config/src/main/java/org/springframework/security/config/core/userdetails/UserDetailsResourceFactoryBean.java @@ -133,7 +133,7 @@ public class UserDetailsResourceFactoryBean implements ResourceLoaderAware, Fact } /** - * Creates a UserDetailsResourceFactoryBean with a resource from the provided String + * Creates a UserDetailsResourceFactoryBean with a resource from the provided String. * @param users the string representing the users * @return the UserDetailsResourceFactoryBean */ diff --git a/config/src/main/java/org/springframework/security/config/crypto/RsaKeyConversionServicePostProcessor.java b/config/src/main/java/org/springframework/security/config/crypto/RsaKeyConversionServicePostProcessor.java index 8163efa2c8..5769bac662 100644 --- a/config/src/main/java/org/springframework/security/config/crypto/RsaKeyConversionServicePostProcessor.java +++ b/config/src/main/java/org/springframework/security/config/crypto/RsaKeyConversionServicePostProcessor.java @@ -42,7 +42,7 @@ import org.springframework.util.StringUtils; /** * Adds {@link RsaKeyConverters} to the configured {@link ConversionService} or - * {@link PropertyEditor}s + * {@link PropertyEditor}s. * * @author Josh Cummings * @since 5.2 @@ -117,7 +117,7 @@ public class RsaKeyConversionServicePostProcessor implements BeanFactoryPostProc private final Converter delegate; /** - * Construct a {@link ResourceKeyConverterAdapter} with the provided parameters + * Construct a {@link ResourceKeyConverterAdapter} with the provided parameters. * @param delegate converts a stream of key material into a {@link Key} */ ResourceKeyConverterAdapter(Converter delegate) { @@ -133,7 +133,7 @@ public class RsaKeyConversionServicePostProcessor implements BeanFactoryPostProc } /** - * Use this {@link ResourceLoader} to read the key material + * Use this {@link ResourceLoader} to read the key material. * @param resourceLoader the {@link ResourceLoader} to use */ void setResourceLoader(ResourceLoader resourceLoader) { diff --git a/config/src/main/java/org/springframework/security/config/debug/SecurityDebugBeanFactoryPostProcessor.java b/config/src/main/java/org/springframework/security/config/debug/SecurityDebugBeanFactoryPostProcessor.java index 6e5b3d9929..8ccccd3d32 100644 --- a/config/src/main/java/org/springframework/security/config/debug/SecurityDebugBeanFactoryPostProcessor.java +++ b/config/src/main/java/org/springframework/security/config/debug/SecurityDebugBeanFactoryPostProcessor.java @@ -29,6 +29,9 @@ import org.springframework.security.config.BeanIds; import org.springframework.security.web.debug.DebugFilter; /** + * Wraps the {@code FilterChainProxy} bean definition with a {@link DebugFilter} to enable + * security debugging. + * * @author Luke Taylor * @author Rob Winch */ diff --git a/config/src/main/java/org/springframework/security/config/http/CsrfBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/CsrfBeanDefinitionParser.java index 236e47a556..142229a8a8 100644 --- a/config/src/main/java/org/springframework/security/config/http/CsrfBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/CsrfBeanDefinitionParser.java @@ -128,7 +128,7 @@ public class CsrfBeanDefinitionParser implements BeanDefinitionParser { } /** - * Populate the AccessDeniedHandler on the {@link CsrfFilter} + * Populate the AccessDeniedHandler on the {@link CsrfFilter}. * @param invalidSessionStrategy the {@link InvalidSessionStrategy} to use * @param defaultDeniedHandler the {@link AccessDeniedHandler} to use */ diff --git a/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java b/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java index fb88f14b3a..f33ae2ad35 100644 --- a/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java +++ b/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java @@ -152,7 +152,7 @@ public class DefaultFilterChainValidator implements FilterChainProxy.FilterChain } /** - * Checks the filter list for possible errors and logs them + * Checks the filter list for possible errors and logs them. */ private void checkFilterStack(List filters) { checkForDuplicates(SecurityContextPersistenceFilter.class, filters); diff --git a/config/src/main/java/org/springframework/security/config/http/FilterChainBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/FilterChainBeanDefinitionParser.java index 63f787e40c..6ec1655a05 100644 --- a/config/src/main/java/org/springframework/security/config/http/FilterChainBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/FilterChainBeanDefinitionParser.java @@ -31,6 +31,9 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** + * Parses a {@code filter-chain} element into a {@link DefaultSecurityFilterChain} bean + * definition. + * * @author Luke Taylor */ public class FilterChainBeanDefinitionParser implements BeanDefinitionParser { diff --git a/config/src/main/java/org/springframework/security/config/http/FormLoginBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/FormLoginBeanDefinitionParser.java index 8fda2683c1..82ec2df625 100644 --- a/config/src/main/java/org/springframework/security/config/http/FormLoginBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/FormLoginBeanDefinitionParser.java @@ -34,6 +34,8 @@ import org.springframework.security.web.authentication.ui.DefaultLoginPageGenera import org.springframework.util.StringUtils; /** + * Parses the {@code form-login} element. + * * @author Luke Taylor * @author Ben Alex * @author Rob Winch diff --git a/config/src/main/java/org/springframework/security/config/http/GrantedAuthorityDefaultsParserUtils.java b/config/src/main/java/org/springframework/security/config/http/GrantedAuthorityDefaultsParserUtils.java index f6f31d149a..e6b634c693 100644 --- a/config/src/main/java/org/springframework/security/config/http/GrantedAuthorityDefaultsParserUtils.java +++ b/config/src/main/java/org/springframework/security/config/http/GrantedAuthorityDefaultsParserUtils.java @@ -24,6 +24,9 @@ import org.springframework.context.ApplicationContextAware; import org.springframework.security.config.core.GrantedAuthorityDefaults; /** + * Utilities for registering bean definitions that need the configured + * {@link GrantedAuthorityDefaults}. + * * @author Rob Winch * @author Ngoc Nhan * @since 4.2 diff --git a/config/src/main/java/org/springframework/security/config/http/LogoutBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/LogoutBeanDefinitionParser.java index 855f5a2367..758018a60b 100644 --- a/config/src/main/java/org/springframework/security/config/http/LogoutBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/LogoutBeanDefinitionParser.java @@ -33,6 +33,8 @@ import org.springframework.security.web.authentication.logout.SecurityContextLog import org.springframework.util.StringUtils; /** + * Parses the {@code logout} element to configure a {@code LogoutFilter}. + * * @author Luke Taylor * @author Ben Alex * @author Onur Kagan Ozcan diff --git a/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParser.java index 404c76b25a..3268ce0c73 100644 --- a/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParser.java @@ -33,6 +33,8 @@ import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** + * Parses OAuth2 Client XML configuration elements. + * * @author Joe Grandja * @since 5.3 */ diff --git a/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParserUtils.java b/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParserUtils.java index 24659db784..19c301e28f 100644 --- a/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParserUtils.java +++ b/config/src/main/java/org/springframework/security/config/http/OAuth2ClientBeanDefinitionParserUtils.java @@ -26,6 +26,8 @@ import org.springframework.security.oauth2.client.registration.ClientRegistratio import org.springframework.util.StringUtils; /** + * Utility methods used by OAuth2 client XML namespace bean definition parsers. + * * @author Joe Grandja * @since 5.4 */ diff --git a/config/src/main/java/org/springframework/security/config/http/OAuth2ClientWebMvcSecurityPostProcessor.java b/config/src/main/java/org/springframework/security/config/http/OAuth2ClientWebMvcSecurityPostProcessor.java index fa3a2feff7..c95bf7a55f 100644 --- a/config/src/main/java/org/springframework/security/config/http/OAuth2ClientWebMvcSecurityPostProcessor.java +++ b/config/src/main/java/org/springframework/security/config/http/OAuth2ClientWebMvcSecurityPostProcessor.java @@ -35,6 +35,9 @@ import org.springframework.security.oauth2.client.web.method.annotation.OAuth2Au import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter; /** + * Registers an {@link OAuth2AuthorizedClientArgumentResolver} with the + * {@link RequestMappingHandlerAdapter} when OAuth2 client beans are present. + * * @author Joe Grandja * @since 5.4 */ diff --git a/config/src/main/java/org/springframework/security/config/http/OAuth2LoginBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/OAuth2LoginBeanDefinitionParser.java index 42b79f903e..2be6614c5a 100644 --- a/config/src/main/java/org/springframework/security/config/http/OAuth2LoginBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/OAuth2LoginBeanDefinitionParser.java @@ -70,6 +70,8 @@ import org.springframework.web.accept.ContentNegotiationStrategy; import org.springframework.web.accept.HeaderContentNegotiationStrategy; /** + * Parses the {@code oauth2-login} element. + * * @author Ruby Hartono * @since 5.3 */ @@ -417,7 +419,7 @@ final class OAuth2LoginBeanDefinitionParser implements BeanDefinitionParser { } /** - * Wrapper bean class to provide configuration from applicationContext + * Wrapper bean class to provide configuration from applicationContext. */ private static class OAuth2LoginBeanConfig implements ApplicationContextAware { diff --git a/config/src/main/java/org/springframework/security/config/http/OAuth2ResourceServerBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/OAuth2ResourceServerBeanDefinitionParser.java index 7ca787ec79..f7b41fa5ca 100644 --- a/config/src/main/java/org/springframework/security/config/http/OAuth2ResourceServerBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/OAuth2ResourceServerBeanDefinitionParser.java @@ -105,7 +105,7 @@ final class OAuth2ResourceServerBeanDefinitionParser implements BeanDefinitionPa /** * Parse a <oauth2-resource-server> element and return the corresponding - * {@link BearerTokenAuthenticationFilter} + * {@link BearerTokenAuthenticationFilter}. * @param oauth2ResourceServer the <oauth2-resource-server> element. * @param pc the {@link ParserContext} * @return a {@link BeanDefinition} representing a diff --git a/config/src/main/java/org/springframework/security/config/http/RememberMeBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/RememberMeBeanDefinitionParser.java index 6d4ec68f11..6a2bf20155 100644 --- a/config/src/main/java/org/springframework/security/config/http/RememberMeBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/RememberMeBeanDefinitionParser.java @@ -38,6 +38,8 @@ import org.springframework.security.web.authentication.rememberme.TokenBasedReme import org.springframework.util.StringUtils; /** + * Parses the {@code remember-me} element. + * * @author Luke Taylor * @author Ben Alex * @author Rob Winch diff --git a/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParser.java index 5930766cb4..e88067d539 100644 --- a/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParser.java @@ -286,7 +286,7 @@ final class Saml2LoginBeanDefinitionParser implements BeanDefinitionParser { } /** - * Wrapper bean class to provide configuration from applicationContext + * Wrapper bean class to provide configuration from applicationContext. */ public static class Saml2LoginBeanConfig implements ApplicationContextAware { diff --git a/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParserUtils.java b/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParserUtils.java index 3089d2af3c..28fd962824 100644 --- a/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParserUtils.java +++ b/config/src/main/java/org/springframework/security/config/http/Saml2LoginBeanDefinitionParserUtils.java @@ -33,6 +33,8 @@ import org.springframework.security.saml2.provider.service.web.authentication.Op import org.springframework.util.StringUtils; /** + * Utility methods shared by the SAML 2.0 login bean definition parsers. + * * @author Marcus da Coregio * @since 5.7 */ diff --git a/config/src/main/java/org/springframework/security/config/http/Saml2LogoutBeanDefinitionParserUtils.java b/config/src/main/java/org/springframework/security/config/http/Saml2LogoutBeanDefinitionParserUtils.java index 0ef506fde9..d07e2c5d83 100644 --- a/config/src/main/java/org/springframework/security/config/http/Saml2LogoutBeanDefinitionParserUtils.java +++ b/config/src/main/java/org/springframework/security/config/http/Saml2LogoutBeanDefinitionParserUtils.java @@ -31,6 +31,8 @@ import org.springframework.security.saml2.provider.service.web.authentication.lo import org.springframework.util.StringUtils; /** + * Utility methods for parsing SAML 2.0 logout XML configuration elements. + * * @author Marcus da Coregio * @since 5.7 */ diff --git a/config/src/main/java/org/springframework/security/config/http/SessionCreationPolicy.java b/config/src/main/java/org/springframework/security/config/http/SessionCreationPolicy.java index d5447029e6..6b48e5955c 100644 --- a/config/src/main/java/org/springframework/security/config/http/SessionCreationPolicy.java +++ b/config/src/main/java/org/springframework/security/config/http/SessionCreationPolicy.java @@ -29,24 +29,24 @@ import org.springframework.security.core.context.SecurityContext; public enum SessionCreationPolicy { /** - * Always create an {@link HttpSession} + * Always create an {@link HttpSession}. */ ALWAYS, /** * Spring Security will never create an {@link HttpSession}, but will use the - * {@link HttpSession} if it already exists + * {@link HttpSession} if it already exists. */ NEVER, /** - * Spring Security will only create an {@link HttpSession} if required + * Spring Security will only create an {@link HttpSession} if required. */ IF_REQUIRED, /** * Spring Security will never create an {@link HttpSession} and it will never use it - * to obtain the {@link SecurityContext} + * to obtain the {@link SecurityContext}. */ STATELESS diff --git a/config/src/main/java/org/springframework/security/config/ldap/ContextSourceSettingPostProcessor.java b/config/src/main/java/org/springframework/security/config/ldap/ContextSourceSettingPostProcessor.java index 14a9502987..73b248640f 100644 --- a/config/src/main/java/org/springframework/security/config/ldap/ContextSourceSettingPostProcessor.java +++ b/config/src/main/java/org/springframework/security/config/ldap/ContextSourceSettingPostProcessor.java @@ -41,7 +41,7 @@ public class ContextSourceSettingPostProcessor implements BeanFactoryPostProcess /** * If set to true, a bean parser has indicated that the default context source name - * needs to be set + * needs to be set. */ private boolean defaultNameRequired; diff --git a/config/src/main/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParser.java index 177d9ce334..d8a8fc63a0 100644 --- a/config/src/main/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/ldap/LdapServerBeanDefinitionParser.java @@ -38,6 +38,9 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** + * Parses the {@code } element to register an embedded or a + * context-source-based LDAP server. + * * @author Luke Taylor * @author Eddú Meléndez * @author Evgeniy Cheban @@ -71,7 +74,7 @@ public class LdapServerBeanDefinitionParser implements BeanDefinitionParser { private static final String OPT_DEFAULT_LDIF_FILE = "classpath*:*.ldif"; - /** Defines the port the LDAP_PROVIDER server should run on */ + /** Defines the port the LDAP_PROVIDER server should run on. */ public static final String ATT_PORT = "port"; private static final String RANDOM_PORT = "0"; diff --git a/config/src/main/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParser.java index 40d16522a5..edba457a62 100644 --- a/config/src/main/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/ldap/LdapUserServiceBeanDefinitionParser.java @@ -30,6 +30,9 @@ import org.springframework.security.config.authentication.AbstractUserDetailsSer import org.springframework.util.StringUtils; /** + * Parses the {@code ldap-user-service} element into a {@code UserDetailsService} bean + * definition. + * * @author Luke Taylor * @since 2.0 */ diff --git a/config/src/main/java/org/springframework/security/config/method/InterceptMethodsBeanDefinitionDecorator.java b/config/src/main/java/org/springframework/security/config/method/InterceptMethodsBeanDefinitionDecorator.java index d9d7ec0739..f87a08ce11 100644 --- a/config/src/main/java/org/springframework/security/config/method/InterceptMethodsBeanDefinitionDecorator.java +++ b/config/src/main/java/org/springframework/security/config/method/InterceptMethodsBeanDefinitionDecorator.java @@ -45,6 +45,8 @@ import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** + * Decorates a bean definition with the {@code intercept-methods} element. + * * @author Luke Taylor * @author Ben Alex * diff --git a/config/src/main/java/org/springframework/security/config/method/MethodSecurityMetadataSourceBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/method/MethodSecurityMetadataSourceBeanDefinitionParser.java index 74698c9bf2..34a9dbfa1d 100644 --- a/config/src/main/java/org/springframework/security/config/method/MethodSecurityMetadataSourceBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/method/MethodSecurityMetadataSourceBeanDefinitionParser.java @@ -34,6 +34,8 @@ import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** + * Parses the {@code method-security-metadata-source} element. + * * @author Luke Taylor * @since 3.1 * @deprecated Use {@code }, {@code }, or diff --git a/config/src/main/java/org/springframework/security/config/method/ProtectPointcutPostProcessor.java b/config/src/main/java/org/springframework/security/config/method/ProtectPointcutPostProcessor.java index 04b788ad86..8e34bd4090 100644 --- a/config/src/main/java/org/springframework/security/config/method/ProtectPointcutPostProcessor.java +++ b/config/src/main/java/org/springframework/security/config/method/ProtectPointcutPostProcessor.java @@ -183,6 +183,8 @@ final class ProtectPointcutPostProcessor implements BeanPostProcessor { } /** + * Replaces the textual boolean operators in the given pointcut expression with their + * symbolic equivalents. * @see org.springframework.aop.aspectj.AspectJExpressionPointcut#replaceBooleanOperators */ private String replaceBooleanOperators(String pcExpr) { diff --git a/config/src/main/java/org/springframework/security/config/oauth2/client/ClientRegistrationsBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/oauth2/client/ClientRegistrationsBeanDefinitionParser.java index f1b715ecc0..f1afc73b7f 100644 --- a/config/src/main/java/org/springframework/security/config/oauth2/client/ClientRegistrationsBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/oauth2/client/ClientRegistrationsBeanDefinitionParser.java @@ -41,6 +41,8 @@ import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** + * Parses the {@code client-registrations} element. + * * @author Ruby Hartono * @author Evgeniy Cheban * @since 5.3 diff --git a/config/src/main/java/org/springframework/security/config/observation/SecurityObservationSettings.java b/config/src/main/java/org/springframework/security/config/observation/SecurityObservationSettings.java index 334ea8c98d..7050c718b9 100644 --- a/config/src/main/java/org/springframework/security/config/observation/SecurityObservationSettings.java +++ b/config/src/main/java/org/springframework/security/config/observation/SecurityObservationSettings.java @@ -45,7 +45,7 @@ public final class SecurityObservationSettings { } /** - * Make no Spring Security observations + * Make no Spring Security observations. * @return a {@link SecurityObservationSettings} with all exclusions turned on */ public static SecurityObservationSettings noObservations() { @@ -53,7 +53,7 @@ public final class SecurityObservationSettings { } /** - * Begin the configuration of a {@link SecurityObservationSettings} + * Begin the configuration of a {@link SecurityObservationSettings}. * @return a {@link Builder} where filter chain observations are off and authn/authz * observations are on */ @@ -74,7 +74,7 @@ public final class SecurityObservationSettings { } /** - * A builder for configuring a {@link SecurityObservationSettings} + * A builder for configuring a {@link SecurityObservationSettings}. */ public static final class Builder { diff --git a/config/src/main/java/org/springframework/security/config/saml2/RelyingPartyRegistrationsBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/saml2/RelyingPartyRegistrationsBeanDefinitionParser.java index 9b6ee38830..1e4bbcc79d 100644 --- a/config/src/main/java/org/springframework/security/config/saml2/RelyingPartyRegistrationsBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/saml2/RelyingPartyRegistrationsBeanDefinitionParser.java @@ -48,6 +48,9 @@ import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** + * Parses {@code } elements into + * {@link RelyingPartyRegistration} bean definitions. + * * @author Marcus da Coregio * @since 5.7 */ diff --git a/config/src/main/java/org/springframework/security/config/web/PathPatternRequestMatcherBuilderFactoryBean.java b/config/src/main/java/org/springframework/security/config/web/PathPatternRequestMatcherBuilderFactoryBean.java index 3c8dbc5816..6611c54f8b 100644 --- a/config/src/main/java/org/springframework/security/config/web/PathPatternRequestMatcherBuilderFactoryBean.java +++ b/config/src/main/java/org/springframework/security/config/web/PathPatternRequestMatcherBuilderFactoryBean.java @@ -107,7 +107,7 @@ public final class PathPatternRequestMatcherBuilderFactoryBean implements /** * Use this as the base path for patterns built by the resulting - * {@link PathPatternRequestMatcher.Builder} instance + * {@link PathPatternRequestMatcher.Builder} instance. * @param basePath the base path to use * @since 7.0 * @see PathPatternRequestMatcher.Builder#basePath(String) diff --git a/config/src/main/java/org/springframework/security/config/web/messaging/PathPatternMessageMatcherBuilderFactoryBean.java b/config/src/main/java/org/springframework/security/config/web/messaging/PathPatternMessageMatcherBuilderFactoryBean.java index e21dd18ece..dff8584b8b 100644 --- a/config/src/main/java/org/springframework/security/config/web/messaging/PathPatternMessageMatcherBuilderFactoryBean.java +++ b/config/src/main/java/org/springframework/security/config/web/messaging/PathPatternMessageMatcherBuilderFactoryBean.java @@ -36,14 +36,15 @@ public final class PathPatternMessageMatcherBuilderFactoryBean /** * Create {@link PathPatternMessageMatcher}s using - * {@link PathPatternParser#defaultInstance} + * {@link PathPatternParser#defaultInstance}. */ public PathPatternMessageMatcherBuilderFactoryBean() { } /** - * Create {@link PathPatternMessageMatcher}s using the given {@link PathPatternParser} + * Create {@link PathPatternMessageMatcher}s using the given + * {@link PathPatternParser}. * @param parser the {@link PathPatternParser} to use */ public PathPatternMessageMatcherBuilderFactoryBean(PathPatternParser parser) { diff --git a/config/src/main/java/org/springframework/security/config/web/server/AbstractServerWebExchangeMatcherRegistry.java b/config/src/main/java/org/springframework/security/config/web/server/AbstractServerWebExchangeMatcherRegistry.java index 1b20b54d4d..9bf05caa45 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/AbstractServerWebExchangeMatcherRegistry.java +++ b/config/src/main/java/org/springframework/security/config/web/server/AbstractServerWebExchangeMatcherRegistry.java @@ -28,6 +28,10 @@ import org.springframework.web.util.pattern.PathPattern; import org.springframework.web.util.pattern.PathPatternParser; /** + * A base class for registering {@link ServerWebExchangeMatcher}s. For example, it might + * allow for specifying which {@link ServerWebExchangeMatcher} require a certain level of + * authorization. + * * @author Rob Winch * @since 5.0 */ @@ -94,7 +98,7 @@ public abstract class AbstractServerWebExchangeMatcherRegistry { } /** - * Associates a list of {@link ServerWebExchangeMatcher} instances + * Associates a list of {@link ServerWebExchangeMatcher} instances. * @param matchers the {@link ServerWebExchangeMatcher} instances * @return the object that is chained after creating the * {@link ServerWebExchangeMatcher} @@ -117,7 +121,7 @@ public abstract class AbstractServerWebExchangeMatcherRegistry { } /** - * Associates a {@link ServerWebExchangeMatcher} instances + * Associates a {@link ServerWebExchangeMatcher} instances. * @param matcher the {@link ServerWebExchangeMatcher} instance * @return the object that is chained after creating the * {@link ServerWebExchangeMatcher} diff --git a/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutAuthentication.java b/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutAuthentication.java index 8fca6fed71..daa81eab73 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutAuthentication.java +++ b/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutAuthentication.java @@ -45,7 +45,7 @@ class OidcBackChannelLogoutAuthentication extends AbstractAuthenticationToken { private final ClientRegistration clientRegistration; /** - * Construct an {@link OidcBackChannelLogoutAuthentication} + * Construct an {@link OidcBackChannelLogoutAuthentication}. * @param logoutToken a deserialized, verified OIDC Logout Token */ OidcBackChannelLogoutAuthentication(OidcLogoutToken logoutToken, ClientRegistration clientRegistration) { diff --git a/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutReactiveAuthenticationManager.java b/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutReactiveAuthenticationManager.java index d32efbde17..457e661f8d 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutReactiveAuthenticationManager.java +++ b/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutReactiveAuthenticationManager.java @@ -66,7 +66,7 @@ final class OidcBackChannelLogoutReactiveAuthenticationManager implements Reacti private ReactiveJwtDecoderFactory logoutTokenDecoderFactory; /** - * Construct an {@link OidcBackChannelLogoutReactiveAuthenticationManager} + * Construct an {@link OidcBackChannelLogoutReactiveAuthenticationManager}. */ OidcBackChannelLogoutReactiveAuthenticationManager() { JwtTypeValidator type = new JwtTypeValidator("JWT", "logout+jwt"); diff --git a/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutWebFilter.java b/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutWebFilter.java index b961f33dfc..823b480152 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutWebFilter.java +++ b/config/src/main/java/org/springframework/security/config/web/server/OidcBackChannelLogoutWebFilter.java @@ -44,7 +44,7 @@ import org.springframework.web.server.WebFilter; import org.springframework.web.server.WebFilterChain; /** - * A filter for the Client-side OIDC Back-Channel Logout endpoint + * A filter for the Client-side OIDC Back-Channel Logout endpoint. * * @author Josh Cummings * @author Andrey Litvitski @@ -67,7 +67,7 @@ class OidcBackChannelLogoutWebFilter implements WebFilter { new OAuth2ErrorEncoder()); /** - * Construct an {@link OidcBackChannelLogoutWebFilter} + * Construct an {@link OidcBackChannelLogoutWebFilter}. * @param authenticationConverter the {@link AuthenticationConverter} for deriving * Logout Token authentication * @param authenticationManager the {@link AuthenticationManager} for authenticating diff --git a/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutAuthenticationToken.java b/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutAuthenticationToken.java index 7fa9be6973..0537f3e9fc 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutAuthenticationToken.java +++ b/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutAuthenticationToken.java @@ -39,7 +39,7 @@ class OidcLogoutAuthenticationToken extends AbstractAuthenticationToken { private final ClientRegistration clientRegistration; /** - * Construct an {@link OidcLogoutAuthenticationToken} + * Construct an {@link OidcLogoutAuthenticationToken}. * @param logoutToken a signed, serialized OIDC Logout token * @param clientRegistration the {@link ClientRegistration client} associated with * this token; this is usually derived from material in the logout HTTP request @@ -67,7 +67,7 @@ class OidcLogoutAuthenticationToken extends AbstractAuthenticationToken { } /** - * Get the signed, serialized OIDC Logout token + * Get the signed, serialized OIDC Logout token. * @return the logout token */ String getLogoutToken() { @@ -75,7 +75,7 @@ class OidcLogoutAuthenticationToken extends AbstractAuthenticationToken { } /** - * Get the {@link ClientRegistration} associated with this logout token + * Get the {@link ClientRegistration} associated with this logout token. * @return the {@link ClientRegistration} */ ClientRegistration getClientRegistration() { diff --git a/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutServerAuthenticationConverter.java b/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutServerAuthenticationConverter.java index 76cb3c5063..419e6f3734 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutServerAuthenticationConverter.java +++ b/config/src/main/java/org/springframework/security/config/web/server/OidcLogoutServerAuthenticationConverter.java @@ -34,7 +34,7 @@ import org.springframework.web.server.ServerWebExchange; /** * An {@link AuthenticationConverter} that extracts the OIDC Logout Token authentication - * request + * request. * * @author Josh Cummings * @since 6.2 diff --git a/config/src/main/java/org/springframework/security/config/web/server/SecurityWebFiltersOrder.java b/config/src/main/java/org/springframework/security/config/web/server/SecurityWebFiltersOrder.java index 912c05bb97..8c073d9f39 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/SecurityWebFiltersOrder.java +++ b/config/src/main/java/org/springframework/security/config/web/server/SecurityWebFiltersOrder.java @@ -17,6 +17,8 @@ package org.springframework.security.config.web.server; /** + * The default order of filters used in WebFlux security configuration. + * * @author Rob Winch * @since 5.0 */ @@ -27,37 +29,41 @@ public enum SecurityWebFiltersOrder { HTTP_HEADERS_WRITER, /** + * Instance of HttpsRedirectWebFilter. * {@link org.springframework.security.web.server.transport.HttpsRedirectWebFilter} */ HTTPS_REDIRECT, /** + * Instance of CorsWebFilter. * {@link org.springframework.web.cors.reactive.CorsWebFilter} */ CORS, /** + * Instance of CsrfWebFilter. * {@link org.springframework.security.web.server.csrf.CsrfWebFilter} */ CSRF, /** + * Instance of ReactorContextWebFilter. * {@link org.springframework.security.web.server.context.ReactorContextWebFilter} */ REACTOR_CONTEXT, /** - * Instance of AuthenticationWebFilter + * Instance of AuthenticationWebFilter. */ HTTP_BASIC, /** - * Instance of AuthenticationWebFilter + * Instance of AuthenticationWebFilter. */ FORM_LOGIN, AUTHENTICATION, /** - * Instance of AnonymousAuthenticationWebFilter + * Instance of AnonymousAuthenticationWebFilter. */ ANONYMOUS_AUTHENTICATION, @@ -68,21 +74,25 @@ public enum SecurityWebFiltersOrder { LOGOUT_PAGE_GENERATING, /** + * Instance of GenerateOneTimeTokenWebFilter. * {@link org.springframework.security.web.server.authentication.ott.GenerateOneTimeTokenWebFilter} */ ONE_TIME_TOKEN, /** + * Instance of OneTimeTokenSubmitPageGeneratingWebFilter. * {@link org.springframework.security.web.server.ui.OneTimeTokenSubmitPageGeneratingWebFilter} */ ONE_TIME_TOKEN_SUBMIT_PAGE_GENERATING, /** + * Instance of SecurityContextServerWebExchangeWebFilter. * {@link org.springframework.security.web.server.context.SecurityContextServerWebExchangeWebFilter} */ SECURITY_CONTEXT_SERVER_WEB_EXCHANGE, /** + * Instance of ServerRequestCacheWebFilter. * {@link org.springframework.security.web.server.savedrequest.ServerRequestCacheWebFilter} */ SERVER_REQUEST_CACHE, diff --git a/config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java b/config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java index 6dff6f207e..7ba9c7bed1 100644 --- a/config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java +++ b/config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java @@ -1070,7 +1070,7 @@ public class ServerHttpSecurity { } /** - * Builds the {@link SecurityWebFilterChain} + * Builds the {@link SecurityWebFilterChain}. * @return the {@link SecurityWebFilterChain} */ public SecurityWebFilterChain build() { @@ -1325,7 +1325,7 @@ public class ServerHttpSecurity { } /** - * Configures authorization + * Configures authorization. * * @author Rob Winch * @since 5.0 @@ -1407,7 +1407,7 @@ public class ServerHttpSecurity { public final class Access { /** - * Allow access for anyone + * Allow access for anyone. * @return the {@link AuthorizeExchangeSpec} to configure */ public AuthorizeExchangeSpec permitAll() { @@ -1415,7 +1415,7 @@ public class ServerHttpSecurity { } /** - * Deny access for everyone + * Deny access for everyone. * @return the {@link AuthorizeExchangeSpec} to configure */ public AuthorizeExchangeSpec denyAll() { @@ -1453,7 +1453,7 @@ public class ServerHttpSecurity { } /** - * Require any authority + * Require any authority. * @param authorities the authorities to require (i.e. "USER" would require * authority of "USER"). * @return the {@link AuthorizeExchangeSpec} to configure @@ -1463,7 +1463,7 @@ public class ServerHttpSecurity { } /** - * Require an authenticated user + * Require an authenticated user. * @return the {@link AuthorizeExchangeSpec} to configure */ public AuthorizeExchangeSpec authenticated() { @@ -1483,7 +1483,7 @@ public class ServerHttpSecurity { } /** - * Allows plugging in a custom authorization strategy + * Allows plugging in a custom authorization strategy. * @param manager the authorization manager to use * @return the {@link AuthorizeExchangeSpec} to configure */ @@ -1763,7 +1763,7 @@ public class ServerHttpSecurity { } /** - * Configures HTTPS redirection rules + * Configures HTTPS redirection rules. * * @author Josh Cummings * @since 5.1 @@ -1776,7 +1776,7 @@ public class ServerHttpSecurity { private PortMapper portMapper; /** - * Configures when this filter should redirect to https + * Configures when this filter should redirect to https. * * By default, the filter will redirect whenever an exchange's scheme is not https * @param matchers the list of conditions that, when any are met, the filter @@ -1789,7 +1789,7 @@ public class ServerHttpSecurity { } /** - * Configures when this filter should redirect to https + * Configures when this filter should redirect to https. * * By default, the filter will redirect whenever an exchange's scheme is not https * @param when determines when to redirect to https @@ -1802,7 +1802,7 @@ public class ServerHttpSecurity { } /** - * Configures a custom HTTPS port to redirect to + * Configures a custom HTTPS port to redirect to. * @param portMapper the {@link PortMapper} to use * @return the {@link HttpsRedirectSpec} for additional configuration */ @@ -1827,7 +1827,7 @@ public class ServerHttpSecurity { /** * Configures CSRF - * Protection + * Protection. * * @author Rob Winch * @since 5.0 @@ -1902,7 +1902,7 @@ public class ServerHttpSecurity { return ServerHttpSecurity.this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { if (this.csrfTokenRepository != null) { this.filter.setCsrfTokenRepository(this.csrfTokenRepository); if (ServerHttpSecurity.this.logout != null) { @@ -1916,7 +1916,7 @@ public class ServerHttpSecurity { } /** - * Configures exception handling + * Configures exception handling. * * @author Rob Winch * @since 5.0 @@ -1928,7 +1928,7 @@ public class ServerHttpSecurity { } /** - * Configures what to do when the application request authentication + * Configures what to do when the application request authentication. * @param authenticationEntryPoint the entry point to use * @return the {@link ExceptionHandlingSpec} to configure */ @@ -1939,7 +1939,7 @@ public class ServerHttpSecurity { /** * Configures what to do when an authenticated user does not hold a required - * authority + * authority. * @param accessDeniedHandler the access denied handler to use * @return the {@link ExceptionHandlingSpec} to configure * @@ -1968,7 +1968,7 @@ public class ServerHttpSecurity { } /** - * Configures the cache used + * Configures the cache used. * @param requestCache the request cache * @return the {@link RequestCacheSpec} to configure */ @@ -1978,14 +1978,14 @@ public class ServerHttpSecurity { return this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ServerRequestCacheWebFilter filter = new ServerRequestCacheWebFilter(); filter.setRequestCache(this.requestCache); http.addFilterAt(filter, SecurityWebFiltersOrder.SERVER_REQUEST_CACHE); } /** - * Disables the {@link RequestCacheSpec} + * Disables the {@link RequestCacheSpec}. * @return the {@link ServerHttpSecurity} to continue configuring */ public ServerHttpSecurity disable() { @@ -1996,7 +1996,7 @@ public class ServerHttpSecurity { } /** - * Configures HTTP Basic Authentication + * Configures HTTP Basic Authentication. * * @author Rob Winch * @since 5.0 @@ -2120,7 +2120,7 @@ public class ServerHttpSecurity { return ServerHttpSecurity.this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { MediaTypeServerWebExchangeMatcher restMatcher = new MediaTypeServerWebExchangeMatcher( MediaType.APPLICATION_ATOM_XML, MediaType.APPLICATION_FORM_URLENCODED, MediaType.APPLICATION_JSON, MediaType.APPLICATION_OCTET_STREAM, MediaType.APPLICATION_XML, MediaType.MULTIPART_FORM_DATA, @@ -2184,7 +2184,7 @@ public class ServerHttpSecurity { return this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ExchangeMatcherRedirectWebFilter changePasswordWebFilter = new ExchangeMatcherRedirectWebFilter( new PathPatternParserServerWebExchangeMatcher(WELL_KNOWN_CHANGE_PASSWORD_PATTERN), this.changePasswordPage); @@ -2197,7 +2197,7 @@ public class ServerHttpSecurity { } /** - * Configures Form Based authentication + * Configures Form Based authentication. * * @author Rob Winch * @since 5.0 @@ -2366,7 +2366,7 @@ public class ServerHttpSecurity { return ServerHttpSecurity.this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { if (this.authenticationEntryPoint == null) { this.isEntryPointExplicit = false; loginPage("/login"); @@ -2408,7 +2408,7 @@ public class ServerHttpSecurity { private LoginPageSpec() { } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { if (http.authenticationEntryPoint != null) { return; } @@ -2491,7 +2491,7 @@ public class ServerHttpSecurity { } /** - * Disables http response headers + * Disables http response headers. * @return the {@link ServerHttpSecurity} to continue configuring */ public ServerHttpSecurity disable() { @@ -2500,7 +2500,7 @@ public class ServerHttpSecurity { } /** - * Configures cache control headers + * Configures cache control headers. * @param cacheCustomizer the {@link Customizer} to provide more options for the * {@link CacheSpec} * @return the {@link HeaderSpec} to customize @@ -2511,7 +2511,7 @@ public class ServerHttpSecurity { } /** - * Configures content type response headers + * Configures content type response headers. * @param contentTypeOptionsCustomizer the {@link Customizer} to provide more * options for the {@link ContentTypeOptionsSpec} * @return the {@link HeaderSpec} to customize @@ -2522,7 +2522,7 @@ public class ServerHttpSecurity { } /** - * Configures frame options response headers + * Configures frame options response headers. * @param frameOptionsCustomizer the {@link Customizer} to provide more options * for the {@link FrameOptionsSpec} * @return the {@link HeaderSpec} to customize @@ -2533,7 +2533,7 @@ public class ServerHttpSecurity { } /** - * Configures custom headers writer + * Configures custom headers writer. * @param serverHttpHeadersWriter the {@link ServerHttpHeadersWriter} to provide * custom headers writer * @return the {@link HeaderSpec} to customize @@ -2546,7 +2546,7 @@ public class ServerHttpSecurity { } /** - * Configures the Strict Transport Security response headers + * Configures the Strict Transport Security response headers. * @param hstsCustomizer the {@link Customizer} to provide more options for the * {@link HstsSpec} * @return the {@link HeaderSpec} to customize @@ -2556,7 +2556,7 @@ public class ServerHttpSecurity { return this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ServerHttpHeadersWriter writer = new CompositeServerHttpHeadersWriter(this.writers); HttpHeaderWriterWebFilter result = new HttpHeaderWriterWebFilter(writer); http.addFilterAt(result, SecurityWebFiltersOrder.HTTP_HEADERS_WRITER); @@ -2661,7 +2661,7 @@ public class ServerHttpSecurity { } /** - * Configures cache control headers + * Configures cache control headers. * * @see HeaderSpec#cache(Customizer) */ @@ -2671,7 +2671,7 @@ public class ServerHttpSecurity { } /** - * Disables cache control response headers + * Disables cache control response headers. * @return the {@link HeaderSpec} to configure */ public HeaderSpec disable() { @@ -2682,7 +2682,7 @@ public class ServerHttpSecurity { } /** - * The content type headers + * The content type headers. * * @see HeaderSpec#contentTypeOptions(Customizer) */ @@ -2692,7 +2692,7 @@ public class ServerHttpSecurity { } /** - * Disables the content type options response header + * Disables the content type options response header. * @return the {@link HeaderSpec} to configure */ public HeaderSpec disable() { @@ -2703,7 +2703,7 @@ public class ServerHttpSecurity { } /** - * Configures frame options response header + * Configures frame options response header. * * @see HeaderSpec#frameOptions(Customizer) */ @@ -2724,7 +2724,7 @@ public class ServerHttpSecurity { } /** - * Disables frame options response header + * Disables frame options response header. * @return the {@link HeaderSpec} to continue configuring */ public HeaderSpec disable() { @@ -2735,7 +2735,7 @@ public class ServerHttpSecurity { } /** - * Configures Strict Transport Security response header + * Configures Strict Transport Security response header. * * @see HeaderSpec#hsts(Customizer) */ @@ -2783,7 +2783,7 @@ public class ServerHttpSecurity { } /** - * Disables strict transport security response header + * Disables strict transport security response header. * @return the {@link HeaderSpec} to continue configuring */ public HeaderSpec disable() { @@ -2794,7 +2794,7 @@ public class ServerHttpSecurity { } /** - * Configures x-xss-protection response header + * Configures x-xss-protection response header. * * @see HeaderSpec#xssProtection(Customizer) */ @@ -2804,7 +2804,7 @@ public class ServerHttpSecurity { } /** - * Disables the x-xss-protection response header + * Disables the x-xss-protection response header. * @return the {@link HeaderSpec} to continue configuring */ public HeaderSpec disable() { @@ -2944,7 +2944,7 @@ public class ServerHttpSecurity { } /** - * Configures the Cross-Origin-Opener-Policy header + * Configures the Cross-Origin-Opener-Policy header. * * @since 5.7 */ @@ -2954,7 +2954,7 @@ public class ServerHttpSecurity { } /** - * Sets the value to be used in the `Cross-Origin-Opener-Policy` header + * Sets the value to be used in the `Cross-Origin-Opener-Policy` header. * @param openerPolicy a opener policy * @return the {@link CrossOriginOpenerPolicySpec} to continue configuring */ @@ -2966,7 +2966,7 @@ public class ServerHttpSecurity { } /** - * Configures the Cross-Origin-Embedder-Policy header + * Configures the Cross-Origin-Embedder-Policy header. * * @since 5.7 */ @@ -2976,7 +2976,7 @@ public class ServerHttpSecurity { } /** - * Sets the value to be used in the `Cross-Origin-Embedder-Policy` header + * Sets the value to be used in the `Cross-Origin-Embedder-Policy` header. * @param embedderPolicy a opener policy * @return the {@link CrossOriginEmbedderPolicySpec} to continue configuring */ @@ -2988,7 +2988,7 @@ public class ServerHttpSecurity { } /** - * Configures the Cross-Origin-Resource-Policy header + * Configures the Cross-Origin-Resource-Policy header. * * @since 5.7 */ @@ -2998,7 +2998,7 @@ public class ServerHttpSecurity { } /** - * Sets the value to be used in the `Cross-Origin-Resource-Policy` header + * Sets the value to be used in the `Cross-Origin-Resource-Policy` header. * @param resourcePolicy a opener policy * @return the {@link CrossOriginResourcePolicySpec} to continue configuring */ @@ -3012,7 +3012,7 @@ public class ServerHttpSecurity { } /** - * Configures log out + * Configures log out. * * @author Shazin Sadakath * @since 5.0 @@ -3089,7 +3089,7 @@ public class ServerHttpSecurity { } /** - * Disables log out + * Disables log out. * @return the {@link ServerHttpSecurity} to continue configuring */ public ServerHttpSecurity disable() { @@ -3111,7 +3111,7 @@ public class ServerHttpSecurity { return new DelegatingServerLogoutHandler(this.logoutHandlers); } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ServerLogoutHandler logoutHandler = createLogoutHandler(); if (logoutHandler != null) { this.logoutWebFilter.setLogoutHandler(logoutHandler); @@ -3173,7 +3173,7 @@ public class ServerHttpSecurity { } /** - * Configures the {@link CorsConfigurationSource} to be used + * Configures the {@link CorsConfigurationSource} to be used. * @param source the source to use * @return the {@link CorsSpec} for additional configuration */ @@ -3191,7 +3191,7 @@ public class ServerHttpSecurity { return ServerHttpSecurity.this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { CorsWebFilter corsFilter = getCorsFilter(); if (corsFilter != null) { http.addFilterAt(this.corsFilter, SecurityWebFiltersOrder.CORS); @@ -3217,7 +3217,7 @@ public class ServerHttpSecurity { } /** - * Configures X509 authentication + * Configures X509 authentication. * * @author Alexey Nesterov * @since 5.2 @@ -3249,7 +3249,7 @@ public class ServerHttpSecurity { return this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ReactiveAuthenticationManager authenticationManager = getAuthenticationManager(); X509PrincipalExtractor principalExtractor = getPrincipalExtractor(); ServerAuthenticationConverter converter = getServerAuthenticationConverter(principalExtractor); @@ -3446,7 +3446,7 @@ public class ServerHttpSecurity { } /** - * Sets the converter to use + * Sets the converter to use. * @param authenticationConverter the converter to use * @return the {@link OAuth2LoginSpec} to customize */ @@ -3557,7 +3557,7 @@ public class ServerHttpSecurity { return this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ReactiveClientRegistrationRepository clientRegistrationRepository = getClientRegistrationRepository(); ServerOAuth2AuthorizedClientRepository authorizedClientRepository = getAuthorizedClientRepository(); OAuth2AuthorizationRequestRedirectWebFilter oauthRedirectFilter = getRedirectWebFilter(); @@ -3939,7 +3939,7 @@ public class ServerHttpSecurity { } /** - * Sets the converter to use + * Sets the converter to use. * @param authenticationConverter the converter to use * @return the {@link OAuth2ClientSpec} to customize */ @@ -4075,7 +4075,7 @@ public class ServerHttpSecurity { return this.authorizationRedirectStrategy; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ServerOAuth2AuthorizedClientRepository authorizedClientRepository = getAuthorizedClientRepository(); ServerAuthenticationConverter authenticationConverter = getAuthenticationConverter(); ReactiveAuthenticationManager authenticationManager = getAuthenticationManager(); @@ -4130,7 +4130,7 @@ public class ServerHttpSecurity { } /** - * Configures OAuth2 Resource Server Support + * Configures OAuth2 Resource Server Support. */ public class OAuth2ResourceServerSpec { @@ -4202,7 +4202,7 @@ public class ServerHttpSecurity { } /** - * Configures the {@link ReactiveAuthenticationManagerResolver} + * Configures the {@link ReactiveAuthenticationManagerResolver}. * @param authenticationManagerResolver the * {@link ReactiveAuthenticationManagerResolver} * @return the {@link OAuth2ResourceServerSpec} for additional configuration @@ -4314,7 +4314,7 @@ public class ServerHttpSecurity { } /** - * Configures JWT Resource Server Support + * Configures JWT Resource Server Support. */ public class JwtSpec { @@ -4325,7 +4325,7 @@ public class ServerHttpSecurity { private Converter> jwtAuthenticationConverter; /** - * Configures the {@link ReactiveAuthenticationManager} to use + * Configures the {@link ReactiveAuthenticationManager} to use. * @param authenticationManager the authentication manager to use * @return the {@code JwtSpec} for additional configuration */ @@ -4350,7 +4350,7 @@ public class ServerHttpSecurity { } /** - * Configures the {@link ReactiveJwtDecoder} to use + * Configures the {@link ReactiveJwtDecoder} to use. * @param jwtDecoder the decoder to use * @return the {@code JwtSpec} for additional configuration */ @@ -4361,7 +4361,7 @@ public class ServerHttpSecurity { /** * Configures a {@link ReactiveJwtDecoder} that leverages the provided - * {@link RSAPublicKey} + * {@link RSAPublicKey}. * @param publicKey the public key to use. * @return the {@code JwtSpec} for additional configuration */ @@ -4373,7 +4373,7 @@ public class ServerHttpSecurity { /** * Configures a {@link ReactiveJwtDecoder} using * JSON Web Key - * (JWK) URL + * (JWK) URL. * @param jwkSetUri the URL to use. * @return the {@code JwtSpec} for additional configuration */ @@ -4422,7 +4422,7 @@ public class ServerHttpSecurity { } /** - * Configures Opaque Token Resource Server support + * Configures Opaque Token Resource Server support. * * @author Josh Cummings * @since 5.2 @@ -4443,7 +4443,7 @@ public class ServerHttpSecurity { } /** - * Configures the URI of the Introspection endpoint + * Configures the URI of the Introspection endpoint. * @param introspectionUri The URI of the Introspection endpoint * @return the {@code OpaqueTokenSpec} for additional configuration */ @@ -4459,7 +4459,7 @@ public class ServerHttpSecurity { } /** - * Configures the credentials for Introspection endpoint + * Configures the credentials for Introspection endpoint. * @param clientId The clientId part of the credentials * @param clientSecret The clientSecret part of the credentials * @return the {@code OpaqueTokenSpec} for additional configuration @@ -4490,7 +4490,7 @@ public class ServerHttpSecurity { return this; } - protected ReactiveAuthenticationManager getAuthenticationManager() { + ReactiveAuthenticationManager getAuthenticationManager() { OpaqueTokenReactiveAuthenticationManager authenticationManager = new OpaqueTokenReactiveAuthenticationManager( getIntrospector()); ReactiveOpaqueTokenAuthenticationConverter authenticationConverter = getAuthenticationConverter(); @@ -4500,21 +4500,21 @@ public class ServerHttpSecurity { return authenticationManager; } - protected ReactiveOpaqueTokenIntrospector getIntrospector() { + ReactiveOpaqueTokenIntrospector getIntrospector() { if (this.introspector != null) { return this.introspector.get(); } return getBean(ReactiveOpaqueTokenIntrospector.class); } - protected ReactiveOpaqueTokenAuthenticationConverter getAuthenticationConverter() { + ReactiveOpaqueTokenAuthenticationConverter getAuthenticationConverter() { if (this.authenticationConverter != null) { return this.authenticationConverter; } return getBeanOrNull(ReactiveOpaqueTokenAuthenticationConverter.class); } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { ReactiveAuthenticationManager authenticationManager = getAuthenticationManager(); AuthenticationWebFilter oauth2 = new AuthenticationWebFilter(authenticationManager); oauth2.setServerAuthenticationConverter(OAuth2ResourceServerSpec.this.bearerTokenConverter); @@ -4567,7 +4567,7 @@ public class ServerHttpSecurity { } /** - * Configure OIDC Back-Channel Logout using the provided {@link Consumer} + * Configure OIDC Back-Channel Logout using the provided {@link Consumer}. * @return the {@link OidcLogoutSpec} for further configuration */ public OidcLogoutSpec backChannel(Customizer backChannelLogoutConfigurer) { @@ -4602,7 +4602,7 @@ public class ServerHttpSecurity { } /** - * A configurer for configuring OIDC Back-Channel Logout + * A configurer for configuring OIDC Back-Channel Logout. */ public final class BackChannelLogoutConfigurer { @@ -4795,7 +4795,7 @@ public class ServerHttpSecurity { } /** - * Configures anonymous authentication + * Configures anonymous authentication. * * @since 5.2.0 */ @@ -4823,7 +4823,7 @@ public class ServerHttpSecurity { } /** - * Sets the principal for {@link Authentication} objects of anonymous users + * Sets the principal for {@link Authentication} objects of anonymous users. * @param principal used for the {@link Authentication} object of anonymous users * @return the {@link AnonymousSpec} for further customization of anonymous * authentication @@ -4836,7 +4836,7 @@ public class ServerHttpSecurity { /** * Sets the * {@link org.springframework.security.core.Authentication#getAuthorities()} for - * anonymous users + * anonymous users. * @param authorities Sets the * {@link org.springframework.security.core.Authentication#getAuthorities()} for * anonymous users @@ -4851,7 +4851,7 @@ public class ServerHttpSecurity { /** * Sets the * {@link org.springframework.security.core.Authentication#getAuthorities()} for - * anonymous users + * anonymous users. * @param authorities Sets the * {@link org.springframework.security.core.Authentication#getAuthorities()} for * anonymous users (i.e. "ROLE_ANONYMOUS") @@ -4885,7 +4885,7 @@ public class ServerHttpSecurity { return ServerHttpSecurity.this; } - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { if (this.authenticationFilter == null) { this.authenticationFilter = new AnonymousAuthenticationWebFilter(getKey(), this.principal, this.authorities); @@ -4906,7 +4906,7 @@ public class ServerHttpSecurity { } /** - * Configures One-Time Token Login Support + * Configures One-Time Token Login Support. * * @author Max Batischev * @since 6.4 @@ -4946,7 +4946,7 @@ public class ServerHttpSecurity { private String loginPage; - protected void configure(ServerHttpSecurity http) { + void configure(ServerHttpSecurity http) { configureSubmitPage(http); configureOttGenerateFilter(http); configureOttAuthenticationFilter(http); @@ -5027,7 +5027,7 @@ public class ServerHttpSecurity { } /** - * Specifies the {@link ServerAuthenticationSuccessHandler} + * Specifies the {@link ServerAuthenticationSuccessHandler}. * @param authenticationSuccessHandler the * {@link ServerAuthenticationSuccessHandler}. */ @@ -5090,7 +5090,7 @@ public class ServerHttpSecurity { /** * Configures the {@link ReactiveOneTimeTokenService} used to generate and consume - * {@link OneTimeToken} + * {@link OneTimeToken}. * @param oneTimeTokenService */ public OneTimeTokenLoginSpec tokenService(ReactiveOneTimeTokenService oneTimeTokenService) { diff --git a/config/src/main/java/org/springframework/security/config/websocket/WebSocketMessageBrokerSecurityBeanDefinitionParser.java b/config/src/main/java/org/springframework/security/config/websocket/WebSocketMessageBrokerSecurityBeanDefinitionParser.java index f8ad403e73..1117f6d603 100644 --- a/config/src/main/java/org/springframework/security/config/websocket/WebSocketMessageBrokerSecurityBeanDefinitionParser.java +++ b/config/src/main/java/org/springframework/security/config/websocket/WebSocketMessageBrokerSecurityBeanDefinitionParser.java @@ -129,6 +129,7 @@ public final class WebSocketMessageBrokerSecurityBeanDefinitionParser implements private static final String MESSAGE_MATCHER_BUILDER_BEAN_NAME = "HttpConfigurationBuilder-pathPatternMessageMatcherBuilder"; /** + * Parses the element into a {@link BeanDefinition}. * @param element * @param parserContext * @return the {@link BeanDefinition} diff --git a/core/src/main/java/org/springframework/security/access/PermissionCacheOptimizer.java b/core/src/main/java/org/springframework/security/access/PermissionCacheOptimizer.java index 4896f5450e..155cbc626e 100644 --- a/core/src/main/java/org/springframework/security/access/PermissionCacheOptimizer.java +++ b/core/src/main/java/org/springframework/security/access/PermissionCacheOptimizer.java @@ -22,7 +22,7 @@ import org.springframework.aop.framework.AopInfrastructureBean; import org.springframework.security.core.Authentication; /** - * Allows permissions to be pre-cached when using pre or post filtering with expressions + * Allows permissions to be pre-cached when using pre or post filtering with expressions. * * @author Luke Taylor * @since 3.1 diff --git a/core/src/main/java/org/springframework/security/access/PermissionEvaluator.java b/core/src/main/java/org/springframework/security/access/PermissionEvaluator.java index 08687e3f6c..592ad464f9 100644 --- a/core/src/main/java/org/springframework/security/access/PermissionEvaluator.java +++ b/core/src/main/java/org/springframework/security/access/PermissionEvaluator.java @@ -33,6 +33,7 @@ import org.springframework.security.core.Authentication; public interface PermissionEvaluator extends AopInfrastructureBean { /** + * Determines whether the user has the given permission for the given domain object. * @param authentication represents the user in question. Should not be null. * @param targetDomainObject the domain object for which permissions should be * checked. May be null in which case implementations should return false, as the null diff --git a/core/src/main/java/org/springframework/security/access/expression/AbstractSecurityExpressionHandler.java b/core/src/main/java/org/springframework/security/access/expression/AbstractSecurityExpressionHandler.java index eaae28f93a..e3a90aa964 100644 --- a/core/src/main/java/org/springframework/security/access/expression/AbstractSecurityExpressionHandler.java +++ b/core/src/main/java/org/springframework/security/access/expression/AbstractSecurityExpressionHandler.java @@ -145,6 +145,7 @@ public abstract class AbstractSecurityExpressionHandler } /** + * Returns the {@link RoleHierarchy} to use. * @deprecated Use {@link #getDefaultAuthorizationManagerFactory()} instead */ @Deprecated(since = "7.0") @@ -153,6 +154,7 @@ public abstract class AbstractSecurityExpressionHandler } /** + * Sets the {@link RoleHierarchy} to use. * @deprecated Use * {@link #setAuthorizationManagerFactory(AuthorizationManagerFactory)} instead */ diff --git a/core/src/main/java/org/springframework/security/access/expression/DenyAllPermissionEvaluator.java b/core/src/main/java/org/springframework/security/access/expression/DenyAllPermissionEvaluator.java index c9fabe57b5..de24ac6e4b 100644 --- a/core/src/main/java/org/springframework/security/access/expression/DenyAllPermissionEvaluator.java +++ b/core/src/main/java/org/springframework/security/access/expression/DenyAllPermissionEvaluator.java @@ -38,6 +38,7 @@ public class DenyAllPermissionEvaluator implements PermissionEvaluator { private final Log logger = LogFactory.getLog(getClass()); /** + * Always denies permission. * @return false always */ @Override @@ -48,6 +49,7 @@ public class DenyAllPermissionEvaluator implements PermissionEvaluator { } /** + * Always denies permission. * @return false always */ @Override diff --git a/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionHandler.java b/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionHandler.java index f9c26d515f..0abc03fc17 100644 --- a/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionHandler.java +++ b/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionHandler.java @@ -27,7 +27,7 @@ import org.springframework.security.core.Authentication; /** * Facade which isolates Spring Security's requirements for evaluating security - * expressions from the implementation of the underlying expression objects + * expressions from the implementation of the underlying expression objects. * * @author Luke Taylor * @author Evgeniy Cheban @@ -36,6 +36,7 @@ import org.springframework.security.core.Authentication; public interface SecurityExpressionHandler extends AopInfrastructureBean { /** + * Returns an expression parser for the expressions used by the implementation. * @return an expression parser for the expressions used by the implementation. */ ExpressionParser getExpressionParser(); diff --git a/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionOperations.java b/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionOperations.java index a40020722f..570311da4c 100644 --- a/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionOperations.java +++ b/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionOperations.java @@ -28,7 +28,7 @@ import org.springframework.security.core.Authentication; public interface SecurityExpressionOperations { /** - * Gets the {@link Authentication} used for evaluating the expressions + * Gets the {@link Authentication} used for evaluating the expressions. * @return the {@link Authentication} for evaluating the expressions */ Authentication getAuthentication(); @@ -88,25 +88,25 @@ public interface SecurityExpressionOperations { boolean permitAll(); /** - * Always denies access + * Always denies access. * @return false */ boolean denyAll(); /** - * Determines if the {@link #getAuthentication()} is anonymous + * Determines if the {@link #getAuthentication()} is anonymous. * @return true if the user is anonymous, else false */ boolean isAnonymous(); /** - * Determines if the {@link #getAuthentication()} is authenticated + * Determines if the {@link #getAuthentication()} is authenticated. * @return true if the {@link #getAuthentication()} is authenticated, else false */ boolean isAuthenticated(); /** - * Determines if the {@link #getAuthentication()} was authenticated using remember me + * Determines if the {@link #getAuthentication()} was authenticated using remember me. * @return true if the {@link #getAuthentication()} authenticated using remember me, * else false */ @@ -114,7 +114,7 @@ public interface SecurityExpressionOperations { /** * Determines if the {@link #getAuthentication()} authenticated without the use of - * remember me + * remember me. * @return true if the {@link #getAuthentication()} authenticated without the use of * remember me, else false */ @@ -122,7 +122,7 @@ public interface SecurityExpressionOperations { /** * Determines if the {@link #getAuthentication()} has permission to access the target - * given the permission + * given the permission. * @param target the target domain object to check permission on * @param permission the permission to check on the domain object (i.e. "read", * "write", etc.). diff --git a/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionRoot.java b/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionRoot.java index da590e2881..4dd96820ba 100644 --- a/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionRoot.java +++ b/core/src/main/java/org/springframework/security/access/expression/SecurityExpressionRoot.java @@ -52,12 +52,12 @@ public abstract class SecurityExpressionRoot impleme private AuthorizationManagerFactory authorizationManagerFactory = new DefaultAuthorizationManagerFactory<>(); /** - * Allows "permitAll" expression + * Allows "permitAll" expression. */ public final boolean permitAll = true; /** - * Allows "denyAll" expression + * Allows "denyAll" expression. */ public final boolean denyAll = false; @@ -74,7 +74,7 @@ public abstract class SecurityExpressionRoot impleme public final String admin = "administration"; /** - * Creates a new instance + * Creates a new instance. * @param authentication the {@link Authentication} to use. Cannot be null. * @deprecated Use {@link #SecurityExpressionRoot(Supplier, Object)} instead */ @@ -217,6 +217,7 @@ public abstract class SecurityExpressionRoot impleme } /** + * Sets the {@link AuthenticationTrustResolver} to use. * @deprecated Use * {@link #setAuthorizationManagerFactory(AuthorizationManagerFactory)} instead */ @@ -226,6 +227,7 @@ public abstract class SecurityExpressionRoot impleme } /** + * Sets the {@link RoleHierarchy} to use. * @deprecated Use * {@link #setAuthorizationManagerFactory(AuthorizationManagerFactory)} instead */ diff --git a/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java b/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java index f560a66b1a..9c37a1b412 100644 --- a/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java +++ b/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java @@ -247,6 +247,7 @@ public class DefaultMethodSecurityExpressionHandler extends AbstractSecurityExpr } /** + * Returns the current {@link AuthenticationTrustResolver}. * @return The current {@link AuthenticationTrustResolver} * @deprecated Use * {@link #setAuthorizationManagerFactory(AuthorizationManagerFactory)} instead @@ -266,6 +267,7 @@ public class DefaultMethodSecurityExpressionHandler extends AbstractSecurityExpr } /** + * Returns the current {@link ParameterNameDiscoverer}. * @return The current {@link ParameterNameDiscoverer} */ protected ParameterNameDiscoverer getParameterNameDiscoverer() { @@ -313,6 +315,7 @@ public class DefaultMethodSecurityExpressionHandler extends AbstractSecurityExpr } /** + * Returns the default role prefix. * @return The default role prefix * @deprecated Use * {@link #setAuthorizationManagerFactory(AuthorizationManagerFactory)} instead diff --git a/core/src/main/java/org/springframework/security/access/hierarchicalroles/CycleInRoleHierarchyException.java b/core/src/main/java/org/springframework/security/access/hierarchicalroles/CycleInRoleHierarchyException.java index 2811616357..65f64e17f9 100755 --- a/core/src/main/java/org/springframework/security/access/hierarchicalroles/CycleInRoleHierarchyException.java +++ b/core/src/main/java/org/springframework/security/access/hierarchicalroles/CycleInRoleHierarchyException.java @@ -17,7 +17,7 @@ package org.springframework.security.access.hierarchicalroles; /** - * Exception that is thrown because of a cycle in the role hierarchy definition + * Exception that is thrown because of a cycle in the role hierarchy definition. * * @author Michael Mayr */ diff --git a/core/src/main/java/org/springframework/security/access/hierarchicalroles/NullRoleHierarchy.java b/core/src/main/java/org/springframework/security/access/hierarchicalroles/NullRoleHierarchy.java index b41b5085e5..ba8edf7a28 100644 --- a/core/src/main/java/org/springframework/security/access/hierarchicalroles/NullRoleHierarchy.java +++ b/core/src/main/java/org/springframework/security/access/hierarchicalroles/NullRoleHierarchy.java @@ -21,6 +21,9 @@ import java.util.Collection; import org.springframework.security.core.GrantedAuthority; /** + * A {@link RoleHierarchy} that performs no mapping, returning the given authorities + * unchanged. + * * @author Luke Taylor * @since 3.0 */ diff --git a/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyAuthoritiesMapper.java b/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyAuthoritiesMapper.java index 66b5bf6577..1b308664d3 100644 --- a/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyAuthoritiesMapper.java +++ b/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyAuthoritiesMapper.java @@ -22,6 +22,9 @@ import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.authority.mapping.GrantedAuthoritiesMapper; /** + * A {@link GrantedAuthoritiesMapper} that maps authorities to their reachable authorities + * using a {@link RoleHierarchy}. + * * @author Luke Taylor */ public class RoleHierarchyAuthoritiesMapper implements GrantedAuthoritiesMapper { diff --git a/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyImpl.java b/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyImpl.java index a316ec4f73..a1e3a089b5 100755 --- a/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyImpl.java +++ b/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyImpl.java @@ -84,7 +84,7 @@ public final class RoleHierarchyImpl implements RoleHierarchy { /** * {@code rolesReachableInOneOrMoreStepsMap} is a Map that under the key of a specific - * role name contains a set of all roles reachable from this role in 1 or more steps + * role name contains a set of all roles reachable from this role in 1 or more steps. */ private final Map> rolesReachableInOneOrMoreStepsMap; @@ -94,7 +94,7 @@ public final class RoleHierarchyImpl implements RoleHierarchy { /** * Create a role hierarchy instance with the given definition, similar to the - * following: + * following:. * *

       	 *     ROLE_A > ROLE_B
      @@ -110,7 +110,7 @@ public final class RoleHierarchyImpl implements RoleHierarchy {
       
       	/**
       	 * Factory method that creates a {@link Builder} instance with the default role prefix
      -	 * "ROLE_"
      +	 * "ROLE_".
       	 * @return a {@link Builder} instance with the default role prefix "ROLE_"
       	 * @since 6.3
       	 */
      diff --git a/core/src/main/java/org/springframework/security/access/prepost/PostAuthorize.java b/core/src/main/java/org/springframework/security/access/prepost/PostAuthorize.java
      index 397eaac5b8..a2819fc122 100644
      --- a/core/src/main/java/org/springframework/security/access/prepost/PostAuthorize.java
      +++ b/core/src/main/java/org/springframework/security/access/prepost/PostAuthorize.java
      @@ -37,6 +37,8 @@ import java.lang.annotation.Target;
       public @interface PostAuthorize {
       
       	/**
      +	 * Returns the Spring-EL expression to be evaluated after invoking the protected
      +	 * method.
       	 * @return the Spring-EL expression to be evaluated after invoking the protected
       	 * method
       	 */
      diff --git a/core/src/main/java/org/springframework/security/access/prepost/PostFilter.java b/core/src/main/java/org/springframework/security/access/prepost/PostFilter.java
      index 23d25cebc6..e5f3648a5b 100644
      --- a/core/src/main/java/org/springframework/security/access/prepost/PostFilter.java
      +++ b/core/src/main/java/org/springframework/security/access/prepost/PostFilter.java
      @@ -37,6 +37,8 @@ import java.lang.annotation.Target;
       public @interface PostFilter {
       
       	/**
      +	 * Returns the Spring-EL expression to be evaluated after invoking the protected
      +	 * method.
       	 * @return the Spring-EL expression to be evaluated after invoking the protected
       	 * method
       	 */
      diff --git a/core/src/main/java/org/springframework/security/access/prepost/PreAuthorize.java b/core/src/main/java/org/springframework/security/access/prepost/PreAuthorize.java
      index f2cfe9ff94..9faa5e99e2 100644
      --- a/core/src/main/java/org/springframework/security/access/prepost/PreAuthorize.java
      +++ b/core/src/main/java/org/springframework/security/access/prepost/PreAuthorize.java
      @@ -37,6 +37,7 @@ import java.lang.annotation.Target;
       public @interface PreAuthorize {
       
       	/**
      +	 * Returns the Spring-EL expression to be evaluated.
       	 * @return the Spring-EL expression to be evaluated before invoking the protected
       	 * method
       	 */
      diff --git a/core/src/main/java/org/springframework/security/access/prepost/PreFilter.java b/core/src/main/java/org/springframework/security/access/prepost/PreFilter.java
      index a97236c604..1480d6b6a1 100644
      --- a/core/src/main/java/org/springframework/security/access/prepost/PreFilter.java
      +++ b/core/src/main/java/org/springframework/security/access/prepost/PreFilter.java
      @@ -49,12 +49,14 @@ import java.lang.annotation.Target;
       public @interface PreFilter {
       
       	/**
      +	 * Returns the Spring-EL expression to be evaluated.
       	 * @return the Spring-EL expression to be evaluated before invoking the protected
       	 * method
       	 */
       	String value();
       
       	/**
      +	 * Returns the name of the parameter to filter.
       	 * @return the name of the parameter which should be filtered (must be a non-null
       	 * collection instance) If the method contains a single collection argument, then this
       	 * attribute can be omitted.
      diff --git a/core/src/main/java/org/springframework/security/aot/hint/AuthorizeReturnObjectHintsRegistrar.java b/core/src/main/java/org/springframework/security/aot/hint/AuthorizeReturnObjectHintsRegistrar.java
      index 7624409869..5ecbc5f88d 100644
      --- a/core/src/main/java/org/springframework/security/aot/hint/AuthorizeReturnObjectHintsRegistrar.java
      +++ b/core/src/main/java/org/springframework/security/aot/hint/AuthorizeReturnObjectHintsRegistrar.java
      @@ -83,7 +83,7 @@ public final class AuthorizeReturnObjectHintsRegistrar implements SecurityHintsR
       	}
       
       	/**
      -	 * Construct this registrar
      +	 * Construct this registrar.
       	 * @param proxyFactory the proxy factory to use to produce the proxy class
       	 * implementations to be registered
       	 * @param classes the classes to proxy
      diff --git a/core/src/main/java/org/springframework/security/aot/hint/CoreSecurityRuntimeHints.java b/core/src/main/java/org/springframework/security/aot/hint/CoreSecurityRuntimeHints.java
      index fce8006f74..fc9a5c637c 100644
      --- a/core/src/main/java/org/springframework/security/aot/hint/CoreSecurityRuntimeHints.java
      +++ b/core/src/main/java/org/springframework/security/aot/hint/CoreSecurityRuntimeHints.java
      @@ -51,7 +51,7 @@ import org.springframework.security.core.userdetails.UsernameNotFoundException;
       import org.springframework.security.core.userdetails.jdbc.JdbcDaoImpl;
       
       /**
      - * {@link RuntimeHintsRegistrar} for core classes
      + * {@link RuntimeHintsRegistrar} for core classes.
        *
        * @author Marcus Da Coregio
        * @since 6.0
      diff --git a/core/src/main/java/org/springframework/security/aot/hint/SecurityHintsRegistrar.java b/core/src/main/java/org/springframework/security/aot/hint/SecurityHintsRegistrar.java
      index abab8ba23a..f5ed19444e 100644
      --- a/core/src/main/java/org/springframework/security/aot/hint/SecurityHintsRegistrar.java
      +++ b/core/src/main/java/org/springframework/security/aot/hint/SecurityHintsRegistrar.java
      @@ -57,7 +57,7 @@ import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
       public interface SecurityHintsRegistrar {
       
       	/**
      -	 * Register hints after preparing them through Security's infrastructural beans
      +	 * Register hints after preparing them through Security's infrastructural beans.
       	 * @param hints the registration target for any AOT hints
       	 * @param beanFactory the bean factory
       	 */
      diff --git a/core/src/main/java/org/springframework/security/aot/hint/package-info.java b/core/src/main/java/org/springframework/security/aot/hint/package-info.java
      index c555d9569a..23bd401d09 100644
      --- a/core/src/main/java/org/springframework/security/aot/hint/package-info.java
      +++ b/core/src/main/java/org/springframework/security/aot/hint/package-info.java
      @@ -14,6 +14,9 @@
        * limitations under the License.
        */
       
      +/**
      + * Ahead-of-time hints for Spring Security's core classes.
      + */
       @NullMarked
       package org.springframework.security.aot.hint;
       
      diff --git a/core/src/main/java/org/springframework/security/authentication/AbstractUserDetailsReactiveAuthenticationManager.java b/core/src/main/java/org/springframework/security/authentication/AbstractUserDetailsReactiveAuthenticationManager.java
      index f7a392c4e5..9416bce217 100644
      --- a/core/src/main/java/org/springframework/security/authentication/AbstractUserDetailsReactiveAuthenticationManager.java
      +++ b/core/src/main/java/org/springframework/security/authentication/AbstractUserDetailsReactiveAuthenticationManager.java
      @@ -189,6 +189,7 @@ public abstract class AbstractUserDetailsReactiveAuthenticationManager
       	}
       
       	/**
      +	 * Sets the {@link MessageSource} used to resolve exception messages.
       	 * @since 5.5
       	 */
       	@Override
      diff --git a/core/src/main/java/org/springframework/security/authentication/AccountStatusUserDetailsChecker.java b/core/src/main/java/org/springframework/security/authentication/AccountStatusUserDetailsChecker.java
      index 98e6f973ee..84e8461d6e 100644
      --- a/core/src/main/java/org/springframework/security/authentication/AccountStatusUserDetailsChecker.java
      +++ b/core/src/main/java/org/springframework/security/authentication/AccountStatusUserDetailsChecker.java
      @@ -28,6 +28,9 @@ import org.springframework.security.core.userdetails.UserDetailsChecker;
       import org.springframework.util.Assert;
       
       /**
      + * A {@link UserDetailsChecker} that verifies the account status flags on a
      + * {@link UserDetails}.
      + *
        * @author Luke Taylor
        */
       public class AccountStatusUserDetailsChecker implements UserDetailsChecker, MessageSourceAware {
      @@ -61,6 +64,7 @@ public class AccountStatusUserDetailsChecker implements UserDetailsChecker, Mess
       	}
       
       	/**
      +	 * Sets the {@link MessageSource} used to resolve exception messages.
       	 * @since 5.2
       	 */
       	@Override
      diff --git a/core/src/main/java/org/springframework/security/authentication/AnonymousAuthenticationToken.java b/core/src/main/java/org/springframework/security/authentication/AnonymousAuthenticationToken.java
      index 4338f37b48..715d33b700 100644
      --- a/core/src/main/java/org/springframework/security/authentication/AnonymousAuthenticationToken.java
      +++ b/core/src/main/java/org/springframework/security/authentication/AnonymousAuthenticationToken.java
      @@ -50,7 +50,7 @@ public class AnonymousAuthenticationToken extends AbstractAuthenticationToken im
       	}
       
       	/**
      -	 * Constructor helps in Jackson Deserialization
      +	 * Constructor helps in Jackson Deserialization.
       	 * @param keyHash hashCode of provided Key, constructed by above constructor
       	 * @param principal the principal (typically a UserDetails)
       	 * @param authorities the authorities granted to the principal
      @@ -90,7 +90,7 @@ public class AnonymousAuthenticationToken extends AbstractAuthenticationToken im
       	}
       
       	/**
      -	 * Always returns an empty String
      +	 * Always returns an empty String.
       	 * @return an empty String
       	 */
       	@Override
      diff --git a/core/src/main/java/org/springframework/security/authentication/AuthenticationEventPublisher.java b/core/src/main/java/org/springframework/security/authentication/AuthenticationEventPublisher.java
      index 00abd9a97a..9ecb7fc322 100644
      --- a/core/src/main/java/org/springframework/security/authentication/AuthenticationEventPublisher.java
      +++ b/core/src/main/java/org/springframework/security/authentication/AuthenticationEventPublisher.java
      @@ -20,6 +20,8 @@ import org.springframework.security.core.Authentication;
       import org.springframework.security.core.AuthenticationException;
       
       /**
      + * Publishes {@link Authentication} success and failure events.
      + *
        * @author Luke Taylor
        * @since 3.0
        */
      diff --git a/core/src/main/java/org/springframework/security/authentication/AuthenticationManagerResolver.java b/core/src/main/java/org/springframework/security/authentication/AuthenticationManagerResolver.java
      index 936890a865..319a53c869 100644
      --- a/core/src/main/java/org/springframework/security/authentication/AuthenticationManagerResolver.java
      +++ b/core/src/main/java/org/springframework/security/authentication/AuthenticationManagerResolver.java
      @@ -18,7 +18,7 @@ package org.springframework.security.authentication;
       
       /**
        * An interface for resolving an {@link AuthenticationManager} based on the provided
      - * context
      + * context.
        *
        * @author Josh Cummings
        * @since 5.2
      @@ -26,7 +26,7 @@ package org.springframework.security.authentication;
       public interface AuthenticationManagerResolver {
       
       	/**
      -	 * Resolve an {@link AuthenticationManager} from a provided context
      +	 * Resolve an {@link AuthenticationManager} from a provided context.
       	 * @param context
       	 * @return the {@link AuthenticationManager} to use
       	 */
      diff --git a/core/src/main/java/org/springframework/security/authentication/AuthenticationObservationContext.java b/core/src/main/java/org/springframework/security/authentication/AuthenticationObservationContext.java
      index cd4ec6488d..3cf3e70cf1 100644
      --- a/core/src/main/java/org/springframework/security/authentication/AuthenticationObservationContext.java
      +++ b/core/src/main/java/org/springframework/security/authentication/AuthenticationObservationContext.java
      @@ -23,7 +23,7 @@ import org.springframework.security.core.Authentication;
       import org.springframework.util.Assert;
       
       /**
      - * An {@link Observation.Context} used during authentications
      + * An {@link Observation.Context} used during authentications.
        *
        * @author Josh Cummings
        * @since 6.0
      @@ -37,7 +37,7 @@ public class AuthenticationObservationContext extends Observation.Context {
       	private @Nullable Authentication authenticationResult;
       
       	/**
      -	 * Get the {@link Authentication} request that was observed
      +	 * Get the {@link Authentication} request that was observed.
       	 * @return the observed {@link Authentication} request
       	 */
       	public @Nullable Authentication getAuthenticationRequest() {
      @@ -45,7 +45,7 @@ public class AuthenticationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Set the {@link Authentication} request that was observed
      +	 * Set the {@link Authentication} request that was observed.
       	 * @param authenticationRequest the observed {@link Authentication} request
       	 */
       	public void setAuthenticationRequest(Authentication authenticationRequest) {
      @@ -66,7 +66,7 @@ public class AuthenticationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Set the {@link Authentication} result that was observed
      +	 * Set the {@link Authentication} result that was observed.
       	 * @param authenticationResult the observed {@link Authentication} result
       	 */
       	public void setAuthenticationResult(Authentication authenticationResult) {
      @@ -74,7 +74,7 @@ public class AuthenticationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Get the {@link AuthenticationManager} class that processed the authentication
      +	 * Get the {@link AuthenticationManager} class that processed the authentication.
       	 * @return the observed {@link AuthenticationManager} class
       	 */
       	public @Nullable Class getAuthenticationManagerClass() {
      @@ -82,7 +82,7 @@ public class AuthenticationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Set the {@link AuthenticationManager} class that processed the authentication
      +	 * Set the {@link AuthenticationManager} class that processed the authentication.
       	 * @param authenticationManagerClass the observed {@link AuthenticationManager} class
       	 */
       	public void setAuthenticationManagerClass(Class authenticationManagerClass) {
      diff --git a/core/src/main/java/org/springframework/security/authentication/AuthenticationTrustResolver.java b/core/src/main/java/org/springframework/security/authentication/AuthenticationTrustResolver.java
      index 7a33ba11ab..9120d39265 100644
      --- a/core/src/main/java/org/springframework/security/authentication/AuthenticationTrustResolver.java
      +++ b/core/src/main/java/org/springframework/security/authentication/AuthenticationTrustResolver.java
      @@ -22,7 +22,7 @@ import org.springframework.lang.Contract;
       import org.springframework.security.core.Authentication;
       
       /**
      - * Evaluates Authentication tokens
      + * Evaluates Authentication tokens.
        *
        * @author Ben Alex
        */
      diff --git a/core/src/main/java/org/springframework/security/authentication/DelegatingReactiveAuthenticationManager.java b/core/src/main/java/org/springframework/security/authentication/DelegatingReactiveAuthenticationManager.java
      index c30fcbae3e..b987baf0a9 100644
      --- a/core/src/main/java/org/springframework/security/authentication/DelegatingReactiveAuthenticationManager.java
      +++ b/core/src/main/java/org/springframework/security/authentication/DelegatingReactiveAuthenticationManager.java
      @@ -65,7 +65,7 @@ public class DelegatingReactiveAuthenticationManager implements ReactiveAuthenti
       	}
       
       	/**
      -	 * Continue iterating when a delegate errors, defaults to {@code false}
      +	 * Continue iterating when a delegate errors, defaults to {@code false}.
       	 * @param continueOnError whether to continue when a delegate errors
       	 * @since 6.3
       	 */
      diff --git a/core/src/main/java/org/springframework/security/authentication/ObservationAuthenticationManager.java b/core/src/main/java/org/springframework/security/authentication/ObservationAuthenticationManager.java
      index 0d514f126b..50ce3c99a2 100644
      --- a/core/src/main/java/org/springframework/security/authentication/ObservationAuthenticationManager.java
      +++ b/core/src/main/java/org/springframework/security/authentication/ObservationAuthenticationManager.java
      @@ -25,7 +25,7 @@ import org.springframework.security.core.AuthenticationException;
       import org.springframework.util.Assert;
       
       /**
      - * An {@link AuthenticationManager} that observes the authentication
      + * An {@link AuthenticationManager} that observes the authentication.
        *
        * @author Josh Cummings
        * @since 6.0
      @@ -59,7 +59,7 @@ public final class ObservationAuthenticationManager implements AuthenticationMan
       	}
       
       	/**
      -	 * Use the provided convention for reporting observation data
      +	 * Use the provided convention for reporting observation data.
       	 * @param convention The provided convention
       	 *
       	 * @since 6.1
      diff --git a/core/src/main/java/org/springframework/security/authentication/ObservationReactiveAuthenticationManager.java b/core/src/main/java/org/springframework/security/authentication/ObservationReactiveAuthenticationManager.java
      index 6d97597531..9a15752024 100644
      --- a/core/src/main/java/org/springframework/security/authentication/ObservationReactiveAuthenticationManager.java
      +++ b/core/src/main/java/org/springframework/security/authentication/ObservationReactiveAuthenticationManager.java
      @@ -27,7 +27,7 @@ import org.springframework.security.core.AuthenticationException;
       import org.springframework.util.Assert;
       
       /**
      - * An {@link ReactiveAuthenticationManager} that observes the authentication
      + * An {@link ReactiveAuthenticationManager} that observes the authentication.
        *
        * @author Josh Cummings
        * @since 6.0
      @@ -66,7 +66,7 @@ public class ObservationReactiveAuthenticationManager implements ReactiveAuthent
       	}
       
       	/**
      -	 * Use the provided convention for reporting observation data
      +	 * Use the provided convention for reporting observation data.
       	 * @param convention The provided convention
       	 *
       	 * @since 6.1
      diff --git a/core/src/main/java/org/springframework/security/authentication/ProviderManager.java b/core/src/main/java/org/springframework/security/authentication/ProviderManager.java
      index d90bfe5bad..cc564e3014 100644
      --- a/core/src/main/java/org/springframework/security/authentication/ProviderManager.java
      +++ b/core/src/main/java/org/springframework/security/authentication/ProviderManager.java
      @@ -103,7 +103,8 @@ public class ProviderManager implements AuthenticationManager, MessageSourceAwar
       	private boolean eraseCredentialsAfterAuthentication = true;
       
       	/**
      -	 * Construct a {@link ProviderManager} using the given {@link AuthenticationProvider}s
      +	 * Construct a {@link ProviderManager} using the given
      +	 * {@link AuthenticationProvider}s.
       	 * @param providers the {@link AuthenticationProvider}s to use
       	 */
       	public ProviderManager(AuthenticationProvider... providers) {
      @@ -111,7 +112,8 @@ public class ProviderManager implements AuthenticationManager, MessageSourceAwar
       	}
       
       	/**
      -	 * Construct a {@link ProviderManager} using the given {@link AuthenticationProvider}s
      +	 * Construct a {@link ProviderManager} using the given
      +	 * {@link AuthenticationProvider}s.
       	 * @param providers the {@link AuthenticationProvider}s to use
       	 */
       	public ProviderManager(List providers) {
      @@ -119,7 +121,7 @@ public class ProviderManager implements AuthenticationManager, MessageSourceAwar
       	}
       
       	/**
      -	 * Construct a {@link ProviderManager} using the provided parameters
      +	 * Construct a {@link ProviderManager} using the provided parameters.
       	 * @param providers the {@link AuthenticationProvider}s to use
       	 * @param parent a parent {@link AuthenticationManager} to fall back to
       	 */
      diff --git a/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManager.java b/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManager.java
      index 11bc670104..f1637e2090 100644
      --- a/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManager.java
      +++ b/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManager.java
      @@ -30,7 +30,7 @@ import org.springframework.security.core.Authentication;
       public interface ReactiveAuthenticationManager {
       
       	/**
      -	 * Attempts to authenticate the provided {@link Authentication}
      +	 * Attempts to authenticate the provided {@link Authentication}.
       	 * @param authentication the {@link Authentication} to test
       	 * @return if authentication is successful an {@link Authentication} is returned. If
       	 * authentication cannot be determined, an empty Mono is returned. If authentication
      diff --git a/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManagerResolver.java b/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManagerResolver.java
      index 578221a611..0c32f1ae6d 100644
      --- a/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManagerResolver.java
      +++ b/core/src/main/java/org/springframework/security/authentication/ReactiveAuthenticationManagerResolver.java
      @@ -20,7 +20,7 @@ import reactor.core.publisher.Mono;
       
       /**
        * An interface for resolving a {@link ReactiveAuthenticationManager} based on the
      - * provided context
      + * provided context.
        *
        * @author Rafiullah Hamedy
        * @since 5.2
      diff --git a/core/src/main/java/org/springframework/security/authentication/RememberMeAuthenticationToken.java b/core/src/main/java/org/springframework/security/authentication/RememberMeAuthenticationToken.java
      index 6c951fdcfe..a19d9b5ac6 100644
      --- a/core/src/main/java/org/springframework/security/authentication/RememberMeAuthenticationToken.java
      +++ b/core/src/main/java/org/springframework/security/authentication/RememberMeAuthenticationToken.java
      @@ -80,7 +80,7 @@ public class RememberMeAuthenticationToken extends AbstractAuthenticationToken {
       	}
       
       	/**
      -	 * Always returns an empty String
      +	 * Always returns an empty String.
       	 * @return an empty String
       	 */
       	@Override
      @@ -121,7 +121,7 @@ public class RememberMeAuthenticationToken extends AbstractAuthenticationToken {
       	}
       
       	/**
      -	 * A builder of {@link RememberMeAuthenticationToken} instances
      +	 * A builder of {@link RememberMeAuthenticationToken} instances.
       	 *
       	 * @since 7.0
       	 */
      @@ -145,7 +145,7 @@ public class RememberMeAuthenticationToken extends AbstractAuthenticationToken {
       		}
       
       		/**
      -		 * Use this key
      +		 * Use this key.
       		 * @param key the key to use
       		 * @return the {@link Builder} for further configurations
       		 */
      diff --git a/core/src/main/java/org/springframework/security/authentication/TestingAuthenticationToken.java b/core/src/main/java/org/springframework/security/authentication/TestingAuthenticationToken.java
      index d9da7e8421..dc1979a4fd 100644
      --- a/core/src/main/java/org/springframework/security/authentication/TestingAuthenticationToken.java
      +++ b/core/src/main/java/org/springframework/security/authentication/TestingAuthenticationToken.java
      @@ -91,7 +91,7 @@ public class TestingAuthenticationToken extends AbstractAuthenticationToken {
       	}
       
       	/**
      -	 * A builder of {@link TestingAuthenticationToken} instances
      +	 * A builder of {@link TestingAuthenticationToken} instances.
       	 *
       	 * @since 7.0
       	 */
      diff --git a/core/src/main/java/org/springframework/security/authentication/UsernamePasswordAuthenticationToken.java b/core/src/main/java/org/springframework/security/authentication/UsernamePasswordAuthenticationToken.java
      index c63e5dfb34..044881a04f 100644
      --- a/core/src/main/java/org/springframework/security/authentication/UsernamePasswordAuthenticationToken.java
      +++ b/core/src/main/java/org/springframework/security/authentication/UsernamePasswordAuthenticationToken.java
      @@ -136,7 +136,7 @@ public class UsernamePasswordAuthenticationToken extends AbstractAuthenticationT
       	}
       
       	/**
      -	 * A builder of {@link UsernamePasswordAuthenticationToken} instances
      +	 * A builder of {@link UsernamePasswordAuthenticationToken} instances.
       	 *
       	 * @since 7.0
       	 */
      diff --git a/core/src/main/java/org/springframework/security/authentication/event/LoggerListener.java b/core/src/main/java/org/springframework/security/authentication/event/LoggerListener.java
      index 92fda0f52d..24e615c0c8 100644
      --- a/core/src/main/java/org/springframework/security/authentication/event/LoggerListener.java
      +++ b/core/src/main/java/org/springframework/security/authentication/event/LoggerListener.java
      @@ -36,7 +36,7 @@ public class LoggerListener implements ApplicationListener implements Authoriz
       	}
       
       	/**
      -	 * Creates a new {@link Builder}
      +	 * Creates a new {@link Builder}.
       	 * @return
       	 */
       	public static  Builder builder() {
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthenticatedReactiveAuthorizationManager.java b/core/src/main/java/org/springframework/security/authorization/AuthenticatedReactiveAuthorizationManager.java
      index fa0d874b91..a94a9e0548 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthenticatedReactiveAuthorizationManager.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthenticatedReactiveAuthorizationManager.java
      @@ -60,7 +60,7 @@ public class AuthenticatedReactiveAuthorizationManager implements ReactiveAut
       	}
       
       	/**
      -	 * Gets an instance of {@link AuthenticatedReactiveAuthorizationManager}
      +	 * Gets an instance of {@link AuthenticatedReactiveAuthorizationManager}.
       	 * @param 
       	 * @return
       	 */
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthorityAuthorizationDecision.java b/core/src/main/java/org/springframework/security/authorization/AuthorityAuthorizationDecision.java
      index d5f461caec..b3d05ed01f 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthorityAuthorizationDecision.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthorityAuthorizationDecision.java
      @@ -22,7 +22,7 @@ import java.util.Collection;
       import org.springframework.security.core.GrantedAuthority;
       
       /**
      - * Represents an {@link AuthorizationDecision} based on a collection of authorities
      + * Represents an {@link AuthorizationDecision} based on a collection of authorities.
        *
        * @author Marcus Da Coregio
        * @since 5.6
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthorizationDecision.java b/core/src/main/java/org/springframework/security/authorization/AuthorizationDecision.java
      index 64b3e488bb..c122d1b0f1 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthorizationDecision.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthorizationDecision.java
      @@ -19,6 +19,8 @@ package org.springframework.security.authorization;
       import java.io.Serial;
       
       /**
      + * The result of an authorization decision indicating whether access is granted.
      + *
        * @author Rob Winch
        * @since 5.0
        */
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthorizationDeniedException.java b/core/src/main/java/org/springframework/security/authorization/AuthorizationDeniedException.java
      index 65ed2cc54e..3deb2bceeb 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthorizationDeniedException.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthorizationDeniedException.java
      @@ -22,7 +22,7 @@ import org.springframework.security.access.AccessDeniedException;
       import org.springframework.util.Assert;
       
       /**
      - * An {@link AccessDeniedException} that contains the {@link AuthorizationResult}
      + * An {@link AccessDeniedException} that contains the {@link AuthorizationResult}.
        *
        * @author Marcus da Coregio
        * @since 6.3
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthorizationEventPublisher.java b/core/src/main/java/org/springframework/security/authorization/AuthorizationEventPublisher.java
      index 5a9c2c705f..b82a3e9f01 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthorizationEventPublisher.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthorizationEventPublisher.java
      @@ -25,7 +25,7 @@ import org.springframework.security.authorization.event.AuthorizationGrantedEven
       import org.springframework.security.core.Authentication;
       
       /**
      - * A contract for publishing authorization events
      + * A contract for publishing authorization events.
        *
        * @author Parikshit Dutta
        * @author Josh Cummings
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthorizationObservationContext.java b/core/src/main/java/org/springframework/security/authorization/AuthorizationObservationContext.java
      index 0d84e13be6..bfc501b268 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthorizationObservationContext.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthorizationObservationContext.java
      @@ -23,7 +23,7 @@ import org.springframework.security.core.Authentication;
       import org.springframework.util.Assert;
       
       /**
      - * An {@link Observation.Context} used during authorizations
      + * An {@link Observation.Context} used during authorizations.
        *
        * @author Josh Cummings
        * @since 6.0
      @@ -56,7 +56,7 @@ public class AuthorizationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Set the observed {@link Authentication} for this authorization
      +	 * Set the observed {@link Authentication} for this authorization.
       	 * @param authentication the observed {@link Authentication}
       	 */
       	public void setAuthentication(Authentication authentication) {
      @@ -64,7 +64,7 @@ public class AuthorizationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Get the object for which access was requested
      +	 * Get the object for which access was requested.
       	 * @return the requested object
       	 */
       	public T getObject() {
      @@ -72,7 +72,7 @@ public class AuthorizationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Get the observed {@link AuthorizationResult}
      +	 * Get the observed {@link AuthorizationResult}.
       	 * @return the observed {@link AuthorizationResult}
       	 * @since 6.4
       	 */
      @@ -81,7 +81,7 @@ public class AuthorizationObservationContext extends Observation.Context {
       	}
       
       	/**
      -	 * Set the observed {@link AuthorizationResult}
      +	 * Set the observed {@link AuthorizationResult}.
       	 * @param authorizationResult the observed {@link AuthorizationResult}
       	 * @since 6.4
       	 */
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthorizationProxyFactory.java b/core/src/main/java/org/springframework/security/authorization/AuthorizationProxyFactory.java
      index 3d37f2725f..b9cf2b44ee 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthorizationProxyFactory.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthorizationProxyFactory.java
      @@ -19,7 +19,7 @@ package org.springframework.security.authorization;
       import org.jspecify.annotations.Nullable;
       
       /**
      - * A factory for wrapping arbitrary objects in authorization-related advice
      + * A factory for wrapping arbitrary objects in authorization-related advice.
        *
        * @author Josh Cummings
        * @author daewon kim
      diff --git a/core/src/main/java/org/springframework/security/authorization/AuthorizationResult.java b/core/src/main/java/org/springframework/security/authorization/AuthorizationResult.java
      index 2dc6ba502a..2679c56b42 100644
      --- a/core/src/main/java/org/springframework/security/authorization/AuthorizationResult.java
      +++ b/core/src/main/java/org/springframework/security/authorization/AuthorizationResult.java
      @@ -19,7 +19,7 @@ package org.springframework.security.authorization;
       import java.io.Serializable;
       
       /**
      - * Represents an authorization result
      + * Represents an authorization result.
        *
        * @author Marcus da Coregio
        * @since 6.3
      @@ -27,6 +27,7 @@ import java.io.Serializable;
       public interface AuthorizationResult extends Serializable {
       
       	/**
      +	 * Returns whether the access has been granted.
       	 * @return whether the access has been granted
       	 */
       	boolean isGranted();
      diff --git a/core/src/main/java/org/springframework/security/authorization/DefaultAuthorizationManagerFactory.java b/core/src/main/java/org/springframework/security/authorization/DefaultAuthorizationManagerFactory.java
      index e7f9f89a5f..bcfa1ba9f1 100644
      --- a/core/src/main/java/org/springframework/security/authorization/DefaultAuthorizationManagerFactory.java
      +++ b/core/src/main/java/org/springframework/security/authorization/DefaultAuthorizationManagerFactory.java
      @@ -75,7 +75,7 @@ public final class DefaultAuthorizationManagerFactory
       	 * 
    • {@link #hasRole(String)}
    • diff --git a/core/src/main/java/org/springframework/security/authorization/ExpressionAuthorizationDecision.java b/core/src/main/java/org/springframework/security/authorization/ExpressionAuthorizationDecision.java index 303970d76d..40e12f0c91 100644 --- a/core/src/main/java/org/springframework/security/authorization/ExpressionAuthorizationDecision.java +++ b/core/src/main/java/org/springframework/security/authorization/ExpressionAuthorizationDecision.java @@ -19,7 +19,7 @@ package org.springframework.security.authorization; import org.springframework.expression.Expression; /** - * Represents an {@link AuthorizationDecision} based on a {@link Expression} + * Represents an {@link AuthorizationDecision} based on a {@link Expression}. * * @author Marcus Da Coregio * @since 5.8 diff --git a/core/src/main/java/org/springframework/security/authorization/FactorAuthorizationDecision.java b/core/src/main/java/org/springframework/security/authorization/FactorAuthorizationDecision.java index b26e48a97f..d4739761ea 100644 --- a/core/src/main/java/org/springframework/security/authorization/FactorAuthorizationDecision.java +++ b/core/src/main/java/org/springframework/security/authorization/FactorAuthorizationDecision.java @@ -47,7 +47,7 @@ public class FactorAuthorizationDecision implements AuthorizationResult { } /** - * The specified {@link RequiredFactorError}s + * The specified {@link RequiredFactorError}s. * @return the errors. Cannot be null or contain null values. */ public List getFactorErrors() { diff --git a/core/src/main/java/org/springframework/security/authorization/ObservationAuthorizationManager.java b/core/src/main/java/org/springframework/security/authorization/ObservationAuthorizationManager.java index 9291d3e9a1..c9743fd95c 100644 --- a/core/src/main/java/org/springframework/security/authorization/ObservationAuthorizationManager.java +++ b/core/src/main/java/org/springframework/security/authorization/ObservationAuthorizationManager.java @@ -36,7 +36,7 @@ import org.springframework.security.core.SpringSecurityMessageSource; import org.springframework.util.Assert; /** - * An {@link AuthorizationManager} that observes the authorization + * An {@link AuthorizationManager} that observes the authorization. * * @author Josh Cummings * @since 6.0 @@ -90,7 +90,7 @@ public final class ObservationAuthorizationManager } /** - * Use the provided convention for reporting observation data + * Use the provided convention for reporting observation data. * @param convention The provided convention * * @since 6.1 diff --git a/core/src/main/java/org/springframework/security/authorization/ObservationReactiveAuthorizationManager.java b/core/src/main/java/org/springframework/security/authorization/ObservationReactiveAuthorizationManager.java index 0470726e1a..79b317a63e 100644 --- a/core/src/main/java/org/springframework/security/authorization/ObservationReactiveAuthorizationManager.java +++ b/core/src/main/java/org/springframework/security/authorization/ObservationReactiveAuthorizationManager.java @@ -32,7 +32,7 @@ import org.springframework.security.core.Authentication; import org.springframework.util.Assert; /** - * An {@link ReactiveAuthorizationManager} that observes the authentication + * An {@link ReactiveAuthorizationManager} that observes the authentication. * * @author Josh Cummings * @since 6.0 @@ -83,7 +83,7 @@ public final class ObservationReactiveAuthorizationManager } /** - * Use the provided convention for reporting observation data + * Use the provided convention for reporting observation data. * @param convention The provided convention * * @since 6.1 diff --git a/core/src/main/java/org/springframework/security/authorization/ReactiveAuthorizationManager.java b/core/src/main/java/org/springframework/security/authorization/ReactiveAuthorizationManager.java index 1d0c1d1b35..c58427a2a9 100644 --- a/core/src/main/java/org/springframework/security/authorization/ReactiveAuthorizationManager.java +++ b/core/src/main/java/org/springframework/security/authorization/ReactiveAuthorizationManager.java @@ -33,7 +33,7 @@ import org.springframework.security.core.Authentication; public interface ReactiveAuthorizationManager<@Nullable T> { /** - * Determines if access should be granted for a specific authentication and object + * Determines if access should be granted for a specific authentication and object. * @param authentication the Authentication to check * @param object the object to check * @return an empty Mono if authorization is granted or a Mono error if access is diff --git a/core/src/main/java/org/springframework/security/authorization/RequiredAuthoritiesRepository.java b/core/src/main/java/org/springframework/security/authorization/RequiredAuthoritiesRepository.java index 186763cc0a..3de994f7fc 100644 --- a/core/src/main/java/org/springframework/security/authorization/RequiredAuthoritiesRepository.java +++ b/core/src/main/java/org/springframework/security/authorization/RequiredAuthoritiesRepository.java @@ -22,7 +22,8 @@ import org.springframework.security.core.Authentication; import org.springframework.security.core.GrantedAuthority; /** - * Finds additional required authorities for the provided {@link Authentication#getName()} + * Finds additional required authorities for the provided + * {@link Authentication#getName()}. * * @author Rob Winch * @since 7.0 diff --git a/core/src/main/java/org/springframework/security/authorization/SpringAuthorizationEventPublisher.java b/core/src/main/java/org/springframework/security/authorization/SpringAuthorizationEventPublisher.java index 6ed7cd0b41..eb803ecb53 100644 --- a/core/src/main/java/org/springframework/security/authorization/SpringAuthorizationEventPublisher.java +++ b/core/src/main/java/org/springframework/security/authorization/SpringAuthorizationEventPublisher.java @@ -46,7 +46,7 @@ public final class SpringAuthorizationEventPublisher implements AuthorizationEve private Predicate shouldPublishResult = (result) -> !result.isGranted(); /** - * Construct this publisher using Spring's {@link ApplicationEventPublisher} + * Construct this publisher using Spring's {@link ApplicationEventPublisher}. * @param eventPublisher */ public SpringAuthorizationEventPublisher(ApplicationEventPublisher eventPublisher) { diff --git a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java index 5d6f1e98c9..633876f0cd 100644 --- a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java +++ b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java @@ -35,6 +35,8 @@ import org.springframework.security.core.Authentication; public class AuthorizationDeniedEvent extends AuthorizationEvent implements ResolvableTypeProvider { /** + * Creates a new instance using the given authentication, object, and authorization + * result. * @since 6.4 */ public AuthorizationDeniedEvent(Supplier authentication, T object, AuthorizationResult result) { @@ -42,7 +44,7 @@ public class AuthorizationDeniedEvent extends AuthorizationEvent implements R } /** - * Get the object to which access was requested + * Get the object to which access was requested. * @return the object to which access was requested * @since 5.8 */ diff --git a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java index 46abe4d7ef..1cc4c3a447 100644 --- a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java +++ b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java @@ -43,7 +43,7 @@ public class AuthorizationEvent extends ApplicationEvent { private final AuthorizationResult result; /** - * Construct an {@link AuthorizationEvent} + * Construct an {@link AuthorizationEvent}. * @param authentication the principal requiring access * @param object the object to which access was requested * @param result whether authorization was granted or denied @@ -56,7 +56,7 @@ public class AuthorizationEvent extends ApplicationEvent { } /** - * Construct an {@link AuthorizationEvent} + * Construct an {@link AuthorizationEvent}. * @param authentication the principal requiring access * @param object the object to which access was requested * @param result whether authorization was granted or denied @@ -69,7 +69,7 @@ public class AuthorizationEvent extends ApplicationEvent { } /** - * Get the principal requiring access + * Get the principal requiring access. * @return the principal requiring access */ public Supplier getAuthentication() { @@ -77,7 +77,7 @@ public class AuthorizationEvent extends ApplicationEvent { } /** - * Get the object to which access was requested + * Get the object to which access was requested. * @return the object to which access was requested */ public Object getObject() { @@ -85,7 +85,7 @@ public class AuthorizationEvent extends ApplicationEvent { } /** - * Get the response to the principal's request + * Get the response to the principal's request. * @return the response to the principal's request * @since 6.4 */ diff --git a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java index 99cf92179a..b73f517dce 100644 --- a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java +++ b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java @@ -38,6 +38,7 @@ public class AuthorizationGrantedEvent extends AuthorizationEvent implements private static final long serialVersionUID = -8690818228055810339L; /** + * Creates a new instance. * @since 6.4 */ public AuthorizationGrantedEvent(Supplier authentication, T object, AuthorizationResult result) { @@ -45,7 +46,7 @@ public class AuthorizationGrantedEvent extends AuthorizationEvent implements } /** - * Get the object to which access was requested + * Get the object to which access was requested. * @return the object to which access was requested * @since 5.8 */ diff --git a/core/src/main/java/org/springframework/security/authorization/event/package-info.java b/core/src/main/java/org/springframework/security/authorization/event/package-info.java index 3761bfb6bc..fba8a1bf22 100644 --- a/core/src/main/java/org/springframework/security/authorization/event/package-info.java +++ b/core/src/main/java/org/springframework/security/authorization/event/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Events published during authorization decisions. + */ @NullMarked package org.springframework.security.authorization.event; diff --git a/core/src/main/java/org/springframework/security/authorization/method/AbstractAuthorizationManagerRegistry.java b/core/src/main/java/org/springframework/security/authorization/method/AbstractAuthorizationManagerRegistry.java index b918ad6ef9..107c057a7f 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AbstractAuthorizationManagerRegistry.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AbstractAuthorizationManagerRegistry.java @@ -27,7 +27,7 @@ import org.springframework.core.MethodClassKey; import org.springframework.security.authorization.AuthorizationManager; /** - * For internal use only, as this contract is likely to change + * For internal use only, as this contract is likely to change. * * @author Evgeniy Cheban */ diff --git a/core/src/main/java/org/springframework/security/authorization/method/AbstractExpressionAttributeRegistry.java b/core/src/main/java/org/springframework/security/authorization/method/AbstractExpressionAttributeRegistry.java index c1e93c51d9..9d82791422 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AbstractExpressionAttributeRegistry.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AbstractExpressionAttributeRegistry.java @@ -30,7 +30,7 @@ import org.springframework.security.core.annotation.AnnotationTemplateExpression import org.springframework.util.Assert; /** - * For internal use only, as this contract is likely to change + * For internal use only, as this contract is likely to change. * * @author Evgeniy Cheban * @author DingHao diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisor.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisor.java index 6d278af1f0..5c06b2716e 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisor.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisor.java @@ -23,7 +23,7 @@ import org.springframework.aop.framework.AopInfrastructureBean; import org.springframework.core.Ordered; /** - * An interface that indicates method security advice + * An interface that indicates method security advice. * * @author Josh Cummings * @since 6.3 diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisorProxyFactory.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisorProxyFactory.java index 248e687421..a55396fb08 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisorProxyFactory.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationAdvisorProxyFactory.java @@ -317,7 +317,7 @@ public final class AuthorizationAdvisorProxyFactory implements AuthorizationProx * The default {@link TargetVisitor}, which will proxy {@link Class} instances as * well as instances contained in reactive types (if reactor is present), * collection types, and other container types like {@link Optional} and - * {@link Supplier} + * {@link Supplier}. */ static TargetVisitor defaults() { return AuthorizationAdvisorProxyFactory.DEFAULT_VISITOR; diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationInterceptorsOrder.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationInterceptorsOrder.java index 9af1303ee3..570552f1b5 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationInterceptorsOrder.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationInterceptorsOrder.java @@ -19,7 +19,7 @@ package org.springframework.security.authorization.method; import org.springframework.aop.Advisor; /** - * Ordering of Spring Security's authorization {@link Advisor}s + * Ordering of Spring Security's authorization {@link Advisor}s. * * @author Josh Cummings * @since 5.6 @@ -33,7 +33,7 @@ public enum AuthorizationInterceptorsOrder { FIRST(Integer.MIN_VALUE), /** - * {@link PreFilterAuthorizationMethodInterceptor} + * The order for the {@link PreFilterAuthorizationMethodInterceptor}. */ PRE_FILTER, @@ -48,7 +48,7 @@ public enum AuthorizationInterceptorsOrder { POST_AUTHORIZE(500), /** - * {@link PostFilterAuthorizationMethodInterceptor} + * The order for the {@link PostFilterAuthorizationMethodInterceptor}. */ POST_FILTER(600), diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerAfterMethodInterceptor.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerAfterMethodInterceptor.java index 5abee0c7a2..a2d6a0acbb 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerAfterMethodInterceptor.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerAfterMethodInterceptor.java @@ -41,7 +41,7 @@ import org.springframework.util.Assert; /** * A {@link MethodInterceptor} which can determine if an {@link Authentication} has access - * to the result of an {@link MethodInvocation} using an {@link AuthorizationManager} + * to the result of an {@link MethodInvocation} using an {@link AuthorizationManager}. * * @author Evgeniy Cheban * @author Josh Cummings @@ -77,7 +77,7 @@ public final class AuthorizationManagerAfterMethodInterceptor implements Authori } /** - * Creates an interceptor for the {@link PostAuthorize} annotation + * Creates an interceptor for the {@link PostAuthorize} annotation. * @return the interceptor */ public static AuthorizationManagerAfterMethodInterceptor postAuthorize() { @@ -85,7 +85,7 @@ public final class AuthorizationManagerAfterMethodInterceptor implements Authori } /** - * Creates an interceptor for the {@link PostAuthorize} annotation + * Creates an interceptor for the {@link PostAuthorize} annotation. * @param authorizationManager the {@link PostAuthorizeAuthorizationManager} to use * @return the interceptor */ @@ -98,7 +98,7 @@ public final class AuthorizationManagerAfterMethodInterceptor implements Authori } /** - * Creates an interceptor for the {@link PostAuthorize} annotation + * Creates an interceptor for the {@link PostAuthorize} annotation. * @param authorizationManager the {@link AuthorizationManager} to use * @return the interceptor * @since 6.0 diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerBeforeMethodInterceptor.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerBeforeMethodInterceptor.java index ffee1b5d1f..bf6be81a8f 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerBeforeMethodInterceptor.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationManagerBeforeMethodInterceptor.java @@ -45,7 +45,7 @@ import org.springframework.util.Assert; /** * A {@link MethodInterceptor} which uses a {@link AuthorizationManager} to determine if - * an {@link Authentication} may invoke the given {@link MethodInvocation} + * an {@link Authentication} may invoke the given {@link MethodInvocation}. * * @author Evgeniy Cheban * @author Josh Cummings @@ -81,7 +81,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the {@link PreAuthorize} annotation + * Creates an interceptor for the {@link PreAuthorize} annotation. * @return the interceptor */ public static AuthorizationManagerBeforeMethodInterceptor preAuthorize() { @@ -89,7 +89,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the {@link PreAuthorize} annotation + * Creates an interceptor for the {@link PreAuthorize} annotation. * @param authorizationManager the {@link PreAuthorizeAuthorizationManager} to use * @return the interceptor */ @@ -102,7 +102,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the {@link PreAuthorize} annotation + * Creates an interceptor for the {@link PreAuthorize} annotation. * @param authorizationManager the {@link AuthorizationManager} to use * @return the interceptor * @since 6.0 @@ -116,7 +116,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the {@link Secured} annotation + * Creates an interceptor for the {@link Secured} annotation. * @return the interceptor */ public static AuthorizationManagerBeforeMethodInterceptor secured() { @@ -124,7 +124,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the {@link Secured} annotation + * Creates an interceptor for the {@link Secured} annotation. * @param authorizationManager the {@link SecuredAuthorizationManager} to use * @return the interceptor */ @@ -137,7 +137,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the {@link Secured} annotation + * Creates an interceptor for the {@link Secured} annotation. * @param authorizationManager the {@link AuthorizationManager} to use * @return the interceptor * @since 6.0 @@ -151,7 +151,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the JSR-250 annotations + * Creates an interceptor for the JSR-250 annotations. * @return the interceptor */ public static AuthorizationManagerBeforeMethodInterceptor jsr250() { @@ -159,7 +159,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the JSR-250 annotations + * Creates an interceptor for the JSR-250 annotations. * @param authorizationManager the {@link Jsr250AuthorizationManager} to use * @return the interceptor */ @@ -172,7 +172,7 @@ public final class AuthorizationManagerBeforeMethodInterceptor implements Author } /** - * Creates an interceptor for the JSR-250 annotations + * Creates an interceptor for the JSR-250 annotations. * @param authorizationManager the {@link AuthorizationManager} to use * @return the interceptor * @since 6.0 diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationMethodPointcuts.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationMethodPointcuts.java index 28df7156a7..b1b27e5375 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationMethodPointcuts.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationMethodPointcuts.java @@ -29,6 +29,8 @@ import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.security.access.prepost.PreFilter; /** + * Provides {@link Pointcut}s for Spring Security's method authorization annotations. + * * @author Josh Cummings * @author Evgeniy Cheban */ diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationProxy.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationProxy.java index 36818e5f4d..79d18afd55 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizationProxy.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizationProxy.java @@ -48,7 +48,7 @@ import org.springframework.aop.RawTargetAccess; public interface AuthorizationProxy extends RawTargetAccess { /** - * Access underlying target object + * Access underlying target object. * @return the target object */ Object toAuthorizedTarget(); diff --git a/core/src/main/java/org/springframework/security/authorization/method/AuthorizeReturnObjectMethodInterceptor.java b/core/src/main/java/org/springframework/security/authorization/method/AuthorizeReturnObjectMethodInterceptor.java index 59af4ef032..734d739df2 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/AuthorizeReturnObjectMethodInterceptor.java +++ b/core/src/main/java/org/springframework/security/authorization/method/AuthorizeReturnObjectMethodInterceptor.java @@ -32,7 +32,7 @@ import org.springframework.util.ClassUtils; /** * A method interceptor that applies the given {@link AuthorizationProxyFactory} to any - * return value annotated with {@link AuthorizeReturnObject} + * return value annotated with {@link AuthorizeReturnObject}. * * @author Josh Cummings * @since 6.3 @@ -50,7 +50,7 @@ public final class AuthorizeReturnObjectMethodInterceptor implements Authorizati private int order = AuthorizationInterceptorsOrder.SECURE_RESULT.getOrder(); /** - * Construct the interceptor + * Construct the interceptor. * *

      * Using this constructor requires you to specify @@ -78,7 +78,7 @@ public final class AuthorizeReturnObjectMethodInterceptor implements Authorizati } /** - * Use this {@link AuthorizationProxyFactory} + * Use this {@link AuthorizationProxyFactory}. * @param authorizationProxyFactory the proxy factory to use * @since 6.5 */ diff --git a/core/src/main/java/org/springframework/security/authorization/method/HandleAuthorizationDenied.java b/core/src/main/java/org/springframework/security/authorization/method/HandleAuthorizationDenied.java index d191e3dae1..3c4ca1d731 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/HandleAuthorizationDenied.java +++ b/core/src/main/java/org/springframework/security/authorization/method/HandleAuthorizationDenied.java @@ -27,7 +27,7 @@ import java.lang.annotation.Target; * Annotation for specifying handling behavior when an authorization denied happens in * method security or an * {@link org.springframework.security.authorization.AuthorizationDeniedException} is - * thrown during method invocation + * thrown during method invocation. * * @author Marcus da Coregio * @since 6.3 @@ -42,7 +42,7 @@ public @interface HandleAuthorizationDenied { /** * The {@link MethodAuthorizationDeniedHandler} used to handle denied authorization - * results + * results. * @return */ Class handlerClass() default ThrowingMethodAuthorizationDeniedHandler.class; diff --git a/core/src/main/java/org/springframework/security/authorization/method/MethodAuthorizationDeniedHandler.java b/core/src/main/java/org/springframework/security/authorization/method/MethodAuthorizationDeniedHandler.java index 12f8910a6b..81791c6ba6 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/MethodAuthorizationDeniedHandler.java +++ b/core/src/main/java/org/springframework/security/authorization/method/MethodAuthorizationDeniedHandler.java @@ -22,7 +22,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.authorization.AuthorizationResult; /** - * An interface used to define a strategy to handle denied method invocations + * An interface used to define a strategy to handle denied method invocations. * * @author Marcus da Coregio * @since 6.3 diff --git a/core/src/main/java/org/springframework/security/authorization/method/MethodInvocationResult.java b/core/src/main/java/org/springframework/security/authorization/method/MethodInvocationResult.java index fcf4518717..74a649eb4f 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/MethodInvocationResult.java +++ b/core/src/main/java/org/springframework/security/authorization/method/MethodInvocationResult.java @@ -35,7 +35,7 @@ public class MethodInvocationResult { private final @Nullable Object result; /** - * Construct a {@link MethodInvocationResult} with the provided parameters + * Construct a {@link MethodInvocationResult} with the provided parameters. * @param methodInvocation the already-invoked {@link MethodInvocation} * @param result the value returned from the {@link MethodInvocation} */ @@ -46,7 +46,7 @@ public class MethodInvocationResult { } /** - * Return the already-invoked {@link MethodInvocation} + * Return the already-invoked {@link MethodInvocation}. * @return the already-invoked {@link MethodInvocation} */ public MethodInvocation getMethodInvocation() { @@ -54,7 +54,7 @@ public class MethodInvocationResult { } /** - * Return the result of the already-invoked {@link MethodInvocation} + * Return the result of the already-invoked {@link MethodInvocation}. * @return the result */ public @Nullable Object getResult() { diff --git a/core/src/main/java/org/springframework/security/authorization/method/PostAuthorizeExpressionAttributeRegistry.java b/core/src/main/java/org/springframework/security/authorization/method/PostAuthorizeExpressionAttributeRegistry.java index 9803158c03..1121821011 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/PostAuthorizeExpressionAttributeRegistry.java +++ b/core/src/main/java/org/springframework/security/authorization/method/PostAuthorizeExpressionAttributeRegistry.java @@ -81,7 +81,7 @@ final class PostAuthorizeExpressionAttributeRegistry extends AbstractExpressionA /** * Uses the provided {@link ApplicationContext} to resolve the - * {@link MethodAuthorizationDeniedHandler} from {@link PostAuthorize} + * {@link MethodAuthorizationDeniedHandler} from {@link PostAuthorize}. * @param context the {@link ApplicationContext} to use */ void setApplicationContext(ApplicationContext context) { diff --git a/core/src/main/java/org/springframework/security/authorization/method/PostFilterAuthorizationMethodInterceptor.java b/core/src/main/java/org/springframework/security/authorization/method/PostFilterAuthorizationMethodInterceptor.java index 0080f8da92..3a0ed79f5c 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/PostFilterAuthorizationMethodInterceptor.java +++ b/core/src/main/java/org/springframework/security/authorization/method/PostFilterAuthorizationMethodInterceptor.java @@ -54,7 +54,7 @@ public final class PostFilterAuthorizationMethodInterceptor implements Authoriza /** * Creates a {@link PostFilterAuthorizationMethodInterceptor} using the provided - * parameters + * parameters. */ public PostFilterAuthorizationMethodInterceptor() { this.pointcut = AuthorizationMethodPointcuts.forAnnotations(PostFilter.class); diff --git a/core/src/main/java/org/springframework/security/authorization/method/PreFilterAuthorizationMethodInterceptor.java b/core/src/main/java/org/springframework/security/authorization/method/PreFilterAuthorizationMethodInterceptor.java index c60615a2d3..a1f4f8f3cb 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/PreFilterAuthorizationMethodInterceptor.java +++ b/core/src/main/java/org/springframework/security/authorization/method/PreFilterAuthorizationMethodInterceptor.java @@ -55,14 +55,14 @@ public final class PreFilterAuthorizationMethodInterceptor implements Authorizat /** * Creates a {@link PreFilterAuthorizationMethodInterceptor} using the provided - * parameters + * parameters. */ public PreFilterAuthorizationMethodInterceptor() { this.pointcut = AuthorizationMethodPointcuts.forAnnotations(PreFilter.class); } /** - * Use this {@link MethodSecurityExpressionHandler} + * Use this {@link MethodSecurityExpressionHandler}. * @param expressionHandler the {@link MethodSecurityExpressionHandler} to use */ public void setExpressionHandler(MethodSecurityExpressionHandler expressionHandler) { diff --git a/core/src/main/java/org/springframework/security/authorization/method/ThrowingMethodAuthorizationDeniedHandler.java b/core/src/main/java/org/springframework/security/authorization/method/ThrowingMethodAuthorizationDeniedHandler.java index 60c0ebdd00..8799284b21 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/ThrowingMethodAuthorizationDeniedHandler.java +++ b/core/src/main/java/org/springframework/security/authorization/method/ThrowingMethodAuthorizationDeniedHandler.java @@ -23,7 +23,7 @@ import org.springframework.security.authorization.AuthorizationResult; /** * An implementation of {@link MethodAuthorizationDeniedHandler} that throws - * {@link AuthorizationDeniedException} + * {@link AuthorizationDeniedException}. * * @author Marcus da Coregio * @since 6.3 diff --git a/core/src/main/java/org/springframework/security/authorization/method/package-info.java b/core/src/main/java/org/springframework/security/authorization/method/package-info.java index 235a0cbec9..a035100e35 100644 --- a/core/src/main/java/org/springframework/security/authorization/method/package-info.java +++ b/core/src/main/java/org/springframework/security/authorization/method/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Support for enforcing authorization rules on method invocations. + */ @NullMarked package org.springframework.security.authorization.method; diff --git a/core/src/main/java/org/springframework/security/authorization/package-info.java b/core/src/main/java/org/springframework/security/authorization/package-info.java index 917efcd797..1092ede08e 100644 --- a/core/src/main/java/org/springframework/security/authorization/package-info.java +++ b/core/src/main/java/org/springframework/security/authorization/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Core authorization support, including AuthorizationManager implementations. + */ @NullMarked package org.springframework.security.authorization; diff --git a/core/src/main/java/org/springframework/security/concurrent/AbstractDelegatingSecurityContextSupport.java b/core/src/main/java/org/springframework/security/concurrent/AbstractDelegatingSecurityContextSupport.java index 5e57c78a2a..790c739a57 100644 --- a/core/src/main/java/org/springframework/security/concurrent/AbstractDelegatingSecurityContextSupport.java +++ b/core/src/main/java/org/springframework/security/concurrent/AbstractDelegatingSecurityContextSupport.java @@ -28,7 +28,7 @@ import org.springframework.util.Assert; /** * An internal support class that wraps {@link Callable} with * {@link DelegatingSecurityContextCallable} and {@link Runnable} with - * {@link DelegatingSecurityContextRunnable} + * {@link DelegatingSecurityContextRunnable}. * * @author Rob Winch * @since 3.2 diff --git a/core/src/main/java/org/springframework/security/concurrent/DelegatingSecurityContextCallable.java b/core/src/main/java/org/springframework/security/concurrent/DelegatingSecurityContextCallable.java index cb7fc115cb..737f45277c 100644 --- a/core/src/main/java/org/springframework/security/concurrent/DelegatingSecurityContextCallable.java +++ b/core/src/main/java/org/springframework/security/concurrent/DelegatingSecurityContextCallable.java @@ -132,7 +132,7 @@ public final class DelegatingSecurityContextCallable implements Callable { * Creates a {@link DelegatingSecurityContextCallable} and with the given * {@link Callable} and {@link SecurityContext}, but if the securityContext is null * will default to the current {@link SecurityContext} on the - * {@link SecurityContextHolder} + * {@link SecurityContextHolder}. * @param delegate the delegate {@link DelegatingSecurityContextCallable} to run with * the specified {@link SecurityContext}. Cannot be null. * @param securityContext the {@link SecurityContext} to establish for the delegate diff --git a/core/src/main/java/org/springframework/security/concurrent/package-info.java b/core/src/main/java/org/springframework/security/concurrent/package-info.java index 3326b3190b..914961e0c4 100644 --- a/core/src/main/java/org/springframework/security/concurrent/package-info.java +++ b/core/src/main/java/org/springframework/security/concurrent/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Support for propagating the SecurityContext to concurrent tasks. + */ @NullMarked package org.springframework.security.concurrent; diff --git a/core/src/main/java/org/springframework/security/context/package-info.java b/core/src/main/java/org/springframework/security/context/package-info.java index 54e36be4dd..16adefbec0 100644 --- a/core/src/main/java/org/springframework/security/context/package-info.java +++ b/core/src/main/java/org/springframework/security/context/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Support for delegating application events to listeners registered at runtime. + */ @NullMarked package org.springframework.security.context; diff --git a/core/src/main/java/org/springframework/security/converter/RsaKeyConverters.java b/core/src/main/java/org/springframework/security/converter/RsaKeyConverters.java index 30dc96ad50..e144231f0b 100644 --- a/core/src/main/java/org/springframework/security/converter/RsaKeyConverters.java +++ b/core/src/main/java/org/springframework/security/converter/RsaKeyConverters.java @@ -40,7 +40,7 @@ import org.springframework.core.convert.converter.Converter; import org.springframework.util.Assert; /** - * Used for creating {@link java.security.Key} converter instances + * Used for creating {@link java.security.Key} converter instances. * * @author Josh Cummings * @author Shazin Sadakath diff --git a/core/src/main/java/org/springframework/security/converter/package-info.java b/core/src/main/java/org/springframework/security/converter/package-info.java index 16d9edb9bd..3055482019 100644 --- a/core/src/main/java/org/springframework/security/converter/package-info.java +++ b/core/src/main/java/org/springframework/security/converter/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Converters for reading RSA keys. + */ @NullMarked package org.springframework.security.converter; diff --git a/core/src/main/java/org/springframework/security/core/Authentication.java b/core/src/main/java/org/springframework/security/core/Authentication.java index af581bc9ba..37967a6c00 100644 --- a/core/src/main/java/org/springframework/security/core/Authentication.java +++ b/core/src/main/java/org/springframework/security/core/Authentication.java @@ -160,7 +160,7 @@ public interface Authentication extends Principal, Serializable { } /** - * A builder based on a given {@link Authentication} instance + * A builder based on a given {@link Authentication} instance. * * @author Josh Cummings * @since 7.0 @@ -227,7 +227,7 @@ public interface Authentication extends Principal, Serializable { B principal(@Nullable Object principal); /** - * Mark this authentication as authenticated or not + * Mark this authentication as authenticated or not. * @param authenticated whether this is an authenticated {@link Authentication} * instance * @return the {@link Builder} for additional configuration @@ -236,7 +236,7 @@ public interface Authentication extends Principal, Serializable { B authenticated(boolean authenticated); /** - * Build an {@link Authentication} instance + * Build an {@link Authentication} instance. * @return the {@link Authentication} instance */ Authentication build(); diff --git a/core/src/main/java/org/springframework/security/core/SpringSecurityCoreVersion.java b/core/src/main/java/org/springframework/security/core/SpringSecurityCoreVersion.java index 5e2405aeaf..b34c66754c 100644 --- a/core/src/main/java/org/springframework/security/core/SpringSecurityCoreVersion.java +++ b/core/src/main/java/org/springframework/security/core/SpringSecurityCoreVersion.java @@ -61,7 +61,7 @@ public final class SpringSecurityCoreVersion { } /** - * Perform version checks with specific min Spring Version + * Perform version checks with specific min Spring Version. * @param minSpringVersion */ private static void performVersionChecks(@Nullable String minSpringVersion) { diff --git a/core/src/main/java/org/springframework/security/core/Transient.java b/core/src/main/java/org/springframework/security/core/Transient.java index 62e8ba1cde..302c679b92 100644 --- a/core/src/main/java/org/springframework/security/core/Transient.java +++ b/core/src/main/java/org/springframework/security/core/Transient.java @@ -25,7 +25,7 @@ import java.lang.annotation.Target; /** * A marker for {@link Authentication}s that should never be stored across requests, for - * example a bearer token authentication + * example a bearer token authentication. * * @author Josh Cummings * @since 5.1 diff --git a/core/src/main/java/org/springframework/security/core/annotation/AnnotationTemplateExpressionDefaults.java b/core/src/main/java/org/springframework/security/core/annotation/AnnotationTemplateExpressionDefaults.java index 451bf92fc5..9a3935afcd 100644 --- a/core/src/main/java/org/springframework/security/core/annotation/AnnotationTemplateExpressionDefaults.java +++ b/core/src/main/java/org/springframework/security/core/annotation/AnnotationTemplateExpressionDefaults.java @@ -18,7 +18,7 @@ package org.springframework.security.core.annotation; /** * A component for configuring the expression attribute template of the parsed Spring - * Security annotation + * Security annotation. * * @author DingHao * @since 6.4 diff --git a/core/src/main/java/org/springframework/security/core/annotation/package-info.java b/core/src/main/java/org/springframework/security/core/annotation/package-info.java index 5d94b2ad89..36f9d54d13 100644 --- a/core/src/main/java/org/springframework/security/core/annotation/package-info.java +++ b/core/src/main/java/org/springframework/security/core/annotation/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Support for scanning and synthesizing Spring Security parameter annotations. + */ @NullMarked package org.springframework.security.core.annotation; diff --git a/core/src/main/java/org/springframework/security/core/authority/mapping/MapBasedAttributes2GrantedAuthoritiesMapper.java b/core/src/main/java/org/springframework/security/core/authority/mapping/MapBasedAttributes2GrantedAuthoritiesMapper.java index 5f0215b510..74dc86e95a 100755 --- a/core/src/main/java/org/springframework/security/core/authority/mapping/MapBasedAttributes2GrantedAuthoritiesMapper.java +++ b/core/src/main/java/org/springframework/security/core/authority/mapping/MapBasedAttributes2GrantedAuthoritiesMapper.java @@ -71,6 +71,7 @@ public class MapBasedAttributes2GrantedAuthoritiesMapper } /** + * Returns the attributes2grantedAuthoritiesMap. * @return Returns the attributes2grantedAuthoritiesMap. */ public Map> getAttributes2grantedAuthoritiesMap() { @@ -78,6 +79,7 @@ public class MapBasedAttributes2GrantedAuthoritiesMapper } /** + * Sets the attributes2grantedAuthoritiesMap to use. * @param attributes2grantedAuthoritiesMap The attributes2grantedAuthoritiesMap to * set. */ @@ -89,7 +91,7 @@ public class MapBasedAttributes2GrantedAuthoritiesMapper } /** - * Preprocess the given map to convert all the values to GrantedAuthority collections + * Preprocess the given map to convert all the values to GrantedAuthority collections. * @param orgMap The map to process * @return the processed Map */ @@ -104,7 +106,7 @@ public class MapBasedAttributes2GrantedAuthoritiesMapper } /** - * Convert the given value to a collection of Granted Authorities + * Convert the given value to a collection of Granted Authorities. * @param value The value to convert to a GrantedAuthority Collection * @return Collection containing the GrantedAuthority Collection */ @@ -163,7 +165,7 @@ public class MapBasedAttributes2GrantedAuthoritiesMapper } /** - * + * Returns the mappable attributes. * @see org.springframework.security.core.authority.mapping.MappableAttributesRetriever#getMappableAttributes() */ @Override @@ -172,6 +174,7 @@ public class MapBasedAttributes2GrantedAuthoritiesMapper } /** + * Returns the stringSeparator. * @return Returns the stringSeparator. */ public String getStringSeparator() { @@ -179,6 +182,7 @@ public class MapBasedAttributes2GrantedAuthoritiesMapper } /** + * Sets the stringSeparator to use. * @param stringSeparator The stringSeparator to set. */ public void setStringSeparator(String stringSeparator) { diff --git a/core/src/main/java/org/springframework/security/core/authority/mapping/NullAuthoritiesMapper.java b/core/src/main/java/org/springframework/security/core/authority/mapping/NullAuthoritiesMapper.java index 2922f19791..e5f6b86f1e 100644 --- a/core/src/main/java/org/springframework/security/core/authority/mapping/NullAuthoritiesMapper.java +++ b/core/src/main/java/org/springframework/security/core/authority/mapping/NullAuthoritiesMapper.java @@ -21,6 +21,9 @@ import java.util.Collection; import org.springframework.security.core.GrantedAuthority; /** + * A {@link GrantedAuthoritiesMapper} that performs no mapping, returning the given + * authorities unchanged. + * * @author Luke Taylor */ public class NullAuthoritiesMapper implements GrantedAuthoritiesMapper { diff --git a/core/src/main/java/org/springframework/security/core/authority/mapping/SimpleAuthorityMapper.java b/core/src/main/java/org/springframework/security/core/authority/mapping/SimpleAuthorityMapper.java index 218e760d92..e999b05281 100644 --- a/core/src/main/java/org/springframework/security/core/authority/mapping/SimpleAuthorityMapper.java +++ b/core/src/main/java/org/springframework/security/core/authority/mapping/SimpleAuthorityMapper.java @@ -90,7 +90,7 @@ public final class SimpleAuthorityMapper implements GrantedAuthoritiesMapper, In /** * Sets the prefix which should be added to the authority name (if it doesn't already - * exist) + * exist). * @param prefix the prefix, typically to satisfy the behaviour of an * {@code AccessDecisionVoter}. */ @@ -116,7 +116,7 @@ public final class SimpleAuthorityMapper implements GrantedAuthoritiesMapper, In } /** - * Sets a default authority to be assigned to all users + * Sets a default authority to be assigned to all users. * @param authority the name of the authority to be assigned to all users. */ public void setDefaultAuthority(String authority) { diff --git a/core/src/main/java/org/springframework/security/core/context/ListeningSecurityContextHolderStrategy.java b/core/src/main/java/org/springframework/security/core/context/ListeningSecurityContextHolderStrategy.java index 771684c786..12f19fa2c0 100644 --- a/core/src/main/java/org/springframework/security/core/context/ListeningSecurityContextHolderStrategy.java +++ b/core/src/main/java/org/springframework/security/core/context/ListeningSecurityContextHolderStrategy.java @@ -66,7 +66,7 @@ public final class ListeningSecurityContextHolderStrategy implements SecurityCon /** * Construct a {@link ListeningSecurityContextHolderStrategy} based on - * {@link ThreadLocalSecurityContextHolderStrategy} + * {@link ThreadLocalSecurityContextHolderStrategy}. * @param listeners the listeners that should be notified when the * {@link SecurityContext} is {@link #setContext(SecurityContext) set} or * {@link #clearContext() cleared} @@ -79,7 +79,7 @@ public final class ListeningSecurityContextHolderStrategy implements SecurityCon /** * Construct a {@link ListeningSecurityContextHolderStrategy} based on - * {@link ThreadLocalSecurityContextHolderStrategy} + * {@link ThreadLocalSecurityContextHolderStrategy}. * @param listeners the listeners that should be notified when the * {@link SecurityContext} is {@link #setContext(SecurityContext) set} or * {@link #clearContext() cleared} @@ -91,7 +91,7 @@ public final class ListeningSecurityContextHolderStrategy implements SecurityCon } /** - * Construct a {@link ListeningSecurityContextHolderStrategy} + * Construct a {@link ListeningSecurityContextHolderStrategy}. * @param listeners the listeners that should be notified when the * {@link SecurityContext} is {@link #setContext(SecurityContext) set} or * {@link #clearContext() cleared} @@ -108,7 +108,7 @@ public final class ListeningSecurityContextHolderStrategy implements SecurityCon } /** - * Construct a {@link ListeningSecurityContextHolderStrategy} + * Construct a {@link ListeningSecurityContextHolderStrategy}. * @param listeners the listeners that should be notified when the * {@link SecurityContext} is {@link #setContext(SecurityContext) set} or * {@link #clearContext() cleared} diff --git a/core/src/main/java/org/springframework/security/core/context/ObservationSecurityContextChangedListener.java b/core/src/main/java/org/springframework/security/core/context/ObservationSecurityContextChangedListener.java index 5cd4adc10c..2ef776a7ef 100644 --- a/core/src/main/java/org/springframework/security/core/context/ObservationSecurityContextChangedListener.java +++ b/core/src/main/java/org/springframework/security/core/context/ObservationSecurityContextChangedListener.java @@ -43,7 +43,7 @@ public final class ObservationSecurityContextChangedListener implements Security private final ObservationRegistry registry; /** - * Create a {@link ObservationSecurityContextChangedListener} + * Create a {@link ObservationSecurityContextChangedListener}. * @param registry the {@link ObservationRegistry} for looking up the surrounding * {@link Observation} */ diff --git a/core/src/main/java/org/springframework/security/core/context/ReactiveSecurityContextHolder.java b/core/src/main/java/org/springframework/security/core/context/ReactiveSecurityContextHolder.java index 48e80807e4..a97097fa72 100644 --- a/core/src/main/java/org/springframework/security/core/context/ReactiveSecurityContextHolder.java +++ b/core/src/main/java/org/springframework/security/core/context/ReactiveSecurityContextHolder.java @@ -37,7 +37,7 @@ public final class ReactiveSecurityContextHolder { } /** - * Gets the {@code Mono} from Reactor {@link Context} + * Gets the {@code Mono} from Reactor {@link Context}. * @return the {@code Mono} */ public static Mono getContext() { @@ -58,7 +58,7 @@ public final class ReactiveSecurityContextHolder { } /** - * Clears the {@code Mono} from Reactor {@link Context} + * Clears the {@code Mono} from Reactor {@link Context}. * @return Return a {@code Mono} which only replays complete and error signals * from clearing the context. */ @@ -68,7 +68,7 @@ public final class ReactiveSecurityContextHolder { /** * Creates a Reactor {@link Context} that contains the {@code Mono} - * that can be merged into another {@link Context} + * that can be merged into another {@link Context}. * @param securityContext the {@code Mono} to set in the returned * Reactor {@link Context} * @return a Reactor {@link Context} that contains the {@code Mono} @@ -78,7 +78,7 @@ public final class ReactiveSecurityContextHolder { } /** - * A shortcut for {@link #withSecurityContext(Mono)} + * A shortcut for {@link #withSecurityContext(Mono)}. * @param authentication the {@link Authentication} to be used * @return a Reactor {@link Context} that contains the {@code Mono} */ diff --git a/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedEvent.java b/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedEvent.java index 0fb996e837..97ae24fe16 100644 --- a/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedEvent.java +++ b/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedEvent.java @@ -21,7 +21,7 @@ import java.util.function.Supplier; import org.springframework.context.ApplicationEvent; /** - * An event that represents a change in {@link SecurityContext} + * An event that represents a change in {@link SecurityContext}. * * @author Josh Cummings * @since 5.6 @@ -36,7 +36,7 @@ public class SecurityContextChangedEvent extends ApplicationEvent { private final Supplier newContext; /** - * Construct an event + * Construct an event. * @param oldContext the old security context * @param newContext the new security context, use * {@link SecurityContextChangedEvent#NO_CONTEXT} for if the context is cleared @@ -49,7 +49,7 @@ public class SecurityContextChangedEvent extends ApplicationEvent { } /** - * Construct an event + * Construct an event. * @param oldContext the old security context * @param newContext the new security context */ @@ -59,7 +59,7 @@ public class SecurityContextChangedEvent extends ApplicationEvent { /** * Get the {@link SecurityContext} set on the {@link SecurityContextHolder} - * immediately previous to this event + * immediately previous to this event. * @return the previous {@link SecurityContext} */ public SecurityContext getOldContext() { @@ -68,7 +68,7 @@ public class SecurityContextChangedEvent extends ApplicationEvent { /** * Get the {@link SecurityContext} set on the {@link SecurityContextHolder} as of this - * event + * event. * @return the current {@link SecurityContext} */ public SecurityContext getNewContext() { diff --git a/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedListener.java b/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedListener.java index 2f48932bbf..9e525f3bb7 100644 --- a/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedListener.java +++ b/core/src/main/java/org/springframework/security/core/context/SecurityContextChangedListener.java @@ -17,7 +17,7 @@ package org.springframework.security.core.context; /** - * A listener for {@link SecurityContextChangedEvent}s + * A listener for {@link SecurityContextChangedEvent}s. * * @author Josh Cummings * @since 5.6 diff --git a/core/src/main/java/org/springframework/security/core/parameters/AnnotationParameterNameDiscoverer.java b/core/src/main/java/org/springframework/security/core/parameters/AnnotationParameterNameDiscoverer.java index 6426fcc01a..3b63edd342 100644 --- a/core/src/main/java/org/springframework/security/core/parameters/AnnotationParameterNameDiscoverer.java +++ b/core/src/main/java/org/springframework/security/core/parameters/AnnotationParameterNameDiscoverer.java @@ -179,7 +179,7 @@ public class AnnotationParameterNameDiscoverer implements ParameterNameDiscovere private interface ParameterNameFactory { /** - * Gets the {@link Annotation}s at a specified index + * Gets the {@link Annotation}s at a specified index. * @param t * @return */ diff --git a/core/src/main/java/org/springframework/security/core/parameters/P.java b/core/src/main/java/org/springframework/security/core/parameters/P.java index 1d2adf53b5..708eaca017 100644 --- a/core/src/main/java/org/springframework/security/core/parameters/P.java +++ b/core/src/main/java/org/springframework/security/core/parameters/P.java @@ -37,7 +37,7 @@ import java.lang.annotation.Target; public @interface P { /** - * The parameter name + * The parameter name. * @return */ String value(); diff --git a/core/src/main/java/org/springframework/security/core/parameters/package-info.java b/core/src/main/java/org/springframework/security/core/parameters/package-info.java index d800174178..8759d0cf68 100644 --- a/core/src/main/java/org/springframework/security/core/parameters/package-info.java +++ b/core/src/main/java/org/springframework/security/core/parameters/package-info.java @@ -14,6 +14,10 @@ * limitations under the License. */ +/** + * Support for discovering parameter names annotated with Spring Security parameter + * annotations. + */ @NullMarked package org.springframework.security.core.parameters; diff --git a/core/src/main/java/org/springframework/security/core/session/ReactiveSessionRegistry.java b/core/src/main/java/org/springframework/security/core/session/ReactiveSessionRegistry.java index f47d4a35ec..1e63ff52c5 100644 --- a/core/src/main/java/org/springframework/security/core/session/ReactiveSessionRegistry.java +++ b/core/src/main/java/org/springframework/security/core/session/ReactiveSessionRegistry.java @@ -37,7 +37,7 @@ public interface ReactiveSessionRegistry { Flux getAllSessions(Object principal); /** - * Saves the {@link ReactiveSessionInformation} + * Saves the {@link ReactiveSessionInformation}. * @param information the {@link ReactiveSessionInformation} to save * @return a {@link Mono} that completes when the session is saved */ @@ -58,7 +58,7 @@ public interface ReactiveSessionRegistry { Mono removeSessionInformation(String sessionId); /** - * Updates the last accessed time of the {@link ReactiveSessionInformation} + * Updates the last accessed time of the {@link ReactiveSessionInformation}. * @param sessionId the session identifier * @return a {@link Mono} that completes when the session is updated */ diff --git a/core/src/main/java/org/springframework/security/core/session/SessionDestroyedEvent.java b/core/src/main/java/org/springframework/security/core/session/SessionDestroyedEvent.java index d390e09fa1..f0f17c5fdb 100644 --- a/core/src/main/java/org/springframework/security/core/session/SessionDestroyedEvent.java +++ b/core/src/main/java/org/springframework/security/core/session/SessionDestroyedEvent.java @@ -42,6 +42,7 @@ public abstract class SessionDestroyedEvent extends AbstractSessionEvent { public abstract List getSecurityContexts(); /** + * Provides the identifier associated with the destroyed session. * @return the identifier associated with the destroyed session. */ public abstract String getId(); diff --git a/core/src/main/java/org/springframework/security/core/token/KeyBasedPersistenceTokenService.java b/core/src/main/java/org/springframework/security/core/token/KeyBasedPersistenceTokenService.java index 8f214b0147..adc7e8e000 100644 --- a/core/src/main/java/org/springframework/security/core/token/KeyBasedPersistenceTokenService.java +++ b/core/src/main/java/org/springframework/security/core/token/KeyBasedPersistenceTokenService.java @@ -137,6 +137,7 @@ public class KeyBasedPersistenceTokenService implements TokenService, Initializi } /** + * Generates a pseudo random number. * @return a pseudo random number (hex encoded) */ private String generatePseudoRandomNumber() { @@ -150,6 +151,7 @@ public class KeyBasedPersistenceTokenService implements TokenService, Initializi } /** + * Sets the server secret to use. * @param serverSecret the new secret, which can contain a ":" if desired (never being * sent to the client) */ @@ -162,6 +164,7 @@ public class KeyBasedPersistenceTokenService implements TokenService, Initializi } /** + * Sets the number of bytes to use for the pseudo random number. * @param pseudoRandomNumberBytes changes the number of bytes issued (must be >= 0; * defaults to 256) */ diff --git a/core/src/main/java/org/springframework/security/core/userdetails/AuthenticationUserDetailsService.java b/core/src/main/java/org/springframework/security/core/userdetails/AuthenticationUserDetailsService.java index 662ec45b27..e1f8cdc559 100644 --- a/core/src/main/java/org/springframework/security/core/userdetails/AuthenticationUserDetailsService.java +++ b/core/src/main/java/org/springframework/security/core/userdetails/AuthenticationUserDetailsService.java @@ -28,6 +28,7 @@ import org.springframework.security.core.Authentication; public interface AuthenticationUserDetailsService { /** + * Loads the {@link UserDetails} for the given authentication token. * @param token The pre-authenticated authentication token * @return UserDetails for the given authentication token, never null. * @throws UsernameNotFoundException if no user details can be found for the given diff --git a/core/src/main/java/org/springframework/security/core/userdetails/MapReactiveUserDetailsService.java b/core/src/main/java/org/springframework/security/core/userdetails/MapReactiveUserDetailsService.java index 4760100ab1..7ddb6fe95f 100644 --- a/core/src/main/java/org/springframework/security/core/userdetails/MapReactiveUserDetailsService.java +++ b/core/src/main/java/org/springframework/security/core/userdetails/MapReactiveUserDetailsService.java @@ -28,7 +28,7 @@ import reactor.core.publisher.Mono; import org.springframework.util.Assert; /** - * A {@link Map} based implementation of {@link ReactiveUserDetailsService} + * A {@link Map} based implementation of {@link ReactiveUserDetailsService}. * * @author Rob Winch * @since 5.0 @@ -46,7 +46,7 @@ public class MapReactiveUserDetailsService implements ReactiveUserDetailsService } /** - * Creates a new instance + * Creates a new instance. * @param users the {@link UserDetails} to use */ public MapReactiveUserDetailsService(UserDetails... users) { @@ -54,7 +54,7 @@ public class MapReactiveUserDetailsService implements ReactiveUserDetailsService } /** - * Creates a new instance + * Creates a new instance. * @param users the {@link UserDetails} to use */ public MapReactiveUserDetailsService(Collection users) { diff --git a/core/src/main/java/org/springframework/security/core/userdetails/User.java b/core/src/main/java/org/springframework/security/core/userdetails/User.java index 3d613d05ad..34cefc22c9 100644 --- a/core/src/main/java/org/springframework/security/core/userdetails/User.java +++ b/core/src/main/java/org/springframework/security/core/userdetails/User.java @@ -207,7 +207,7 @@ public class User implements UserDetails, CredentialsContainer { } /** - * Creates a UserBuilder with a specified username + * Creates a UserBuilder with a specified username. * @param username the username to use * @return the UserBuilder */ @@ -216,7 +216,7 @@ public class User implements UserDetails, CredentialsContainer { } /** - * Creates a UserBuilder + * Creates a UserBuilder. * @return the UserBuilder */ public static UserBuilder builder() { @@ -344,7 +344,7 @@ public class User implements UserDetails, CredentialsContainer { private Function<@Nullable String, @Nullable String> passwordEncoder = (password) -> password; /** - * Creates a new instance + * Creates a new instance. */ private UserBuilder() { } diff --git a/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsByNameServiceWrapper.java b/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsByNameServiceWrapper.java index 13ae7e24a1..6ebcba195a 100755 --- a/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsByNameServiceWrapper.java +++ b/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsByNameServiceWrapper.java @@ -65,7 +65,7 @@ public class UserDetailsByNameServiceWrapper } /** - * Get the UserDetails object from the wrapped UserDetailsService implementation + * Get the UserDetails object from the wrapped UserDetailsService implementation. */ @Override public UserDetails loadUserDetails(T authentication) throws UsernameNotFoundException { @@ -73,7 +73,7 @@ public class UserDetailsByNameServiceWrapper } /** - * Set the wrapped UserDetailsService implementation + * Set the wrapped UserDetailsService implementation. * @param aUserDetailsService The wrapped UserDetailsService to set */ public void setUserDetailsService(UserDetailsService aUserDetailsService) { diff --git a/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsChecker.java b/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsChecker.java index bb5ddcea13..3eb401b72e 100644 --- a/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsChecker.java +++ b/core/src/main/java/org/springframework/security/core/userdetails/UserDetailsChecker.java @@ -35,7 +35,7 @@ package org.springframework.security.core.userdetails; public interface UserDetailsChecker { /** - * Examines the User + * Examines the User. * @param toCheck the UserDetails instance whose status should be checked. */ void check(UserDetails toCheck); diff --git a/core/src/main/java/org/springframework/security/core/userdetails/UsernameNotFoundException.java b/core/src/main/java/org/springframework/security/core/userdetails/UsernameNotFoundException.java index 76422593fb..8211006d98 100644 --- a/core/src/main/java/org/springframework/security/core/userdetails/UsernameNotFoundException.java +++ b/core/src/main/java/org/springframework/security/core/userdetails/UsernameNotFoundException.java @@ -68,7 +68,7 @@ public class UsernameNotFoundException extends AuthenticationException { } /** - * Construct an exception based on a specific username + * Construct an exception based on a specific username. * @param username the invalid username * @return the {@link UsernameNotFoundException} * @since 7.0 @@ -78,7 +78,7 @@ public class UsernameNotFoundException extends AuthenticationException { } /** - * Construct an exception based on a specific username + * Construct an exception based on a specific username. * @param username the invalid username * @param cause any underlying cause * @return the {@link UsernameNotFoundException} @@ -89,7 +89,7 @@ public class UsernameNotFoundException extends AuthenticationException { } /** - * Get the username that couldn't be found + * Get the username that couldn't be found. * @return the username * @since 7.0 */ diff --git a/core/src/main/java/org/springframework/security/core/userdetails/jdbc/JdbcDaoImpl.java b/core/src/main/java/org/springframework/security/core/userdetails/jdbc/JdbcDaoImpl.java index 47f691ca6a..7be547ce52 100644 --- a/core/src/main/java/org/springframework/security/core/userdetails/jdbc/JdbcDaoImpl.java +++ b/core/src/main/java/org/springframework/security/core/userdetails/jdbc/JdbcDaoImpl.java @@ -154,6 +154,7 @@ public class JdbcDaoImpl extends JdbcDaoSupport implements UserDetailsService, M } /** + * Returns the messages. * @return the messages */ protected MessageSourceAccessor getMessages() { diff --git a/core/src/main/java/org/springframework/security/jackson/AnonymousAuthenticationTokenMixin.java b/core/src/main/java/org/springframework/security/jackson/AnonymousAuthenticationTokenMixin.java index 98044d5e42..2a16957ccd 100644 --- a/core/src/main/java/org/springframework/security/jackson/AnonymousAuthenticationTokenMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/AnonymousAuthenticationTokenMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.jackson; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.GrantedAuthority; @@ -35,9 +37,9 @@ import org.springframework.security.core.GrantedAuthority; * @see CoreJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, isGetterVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, isGetterVisibility = Visibility.NONE, + getterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) class AnonymousAuthenticationTokenMixin { /** diff --git a/core/src/main/java/org/springframework/security/jackson/BadCredentialsExceptionMixin.java b/core/src/main/java/org/springframework/security/jackson/BadCredentialsExceptionMixin.java index 2b64bed3ed..dd747ff7eb 100644 --- a/core/src/main/java/org/springframework/security/jackson/BadCredentialsExceptionMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/BadCredentialsExceptionMixin.java @@ -20,6 +20,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * This mixin class helps in serialize/deserialize @@ -30,7 +31,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @since 7.0 * @see CoreJacksonModule */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonIgnoreProperties({ "cause", "stackTrace", "authenticationRequest" }) class BadCredentialsExceptionMixin { diff --git a/core/src/main/java/org/springframework/security/jackson/FactorGrantedAuthorityMixin.java b/core/src/main/java/org/springframework/security/jackson/FactorGrantedAuthorityMixin.java index 3e1db9cc6a..b08da9d7bf 100644 --- a/core/src/main/java/org/springframework/security/jackson/FactorGrantedAuthorityMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/FactorGrantedAuthorityMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.jackson; import java.time.Instant; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson Mixin class helps in serialize/deserialize @@ -33,9 +35,9 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @see CoreJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.PUBLIC_ONLY, isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.NONE, getterVisibility = Visibility.PUBLIC_ONLY, + isGetterVisibility = Visibility.NONE) abstract class FactorGrantedAuthorityMixin { /** diff --git a/core/src/main/java/org/springframework/security/jackson/RememberMeAuthenticationTokenMixin.java b/core/src/main/java/org/springframework/security/jackson/RememberMeAuthenticationTokenMixin.java index 7def13e632..f9e29365d3 100644 --- a/core/src/main/java/org/springframework/security/jackson/RememberMeAuthenticationTokenMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/RememberMeAuthenticationTokenMixin.java @@ -19,10 +19,13 @@ package org.springframework.security.jackson; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.GrantedAuthority; @@ -37,9 +40,9 @@ import org.springframework.security.core.GrantedAuthority; * @see CoreJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) @JsonIgnoreProperties(ignoreUnknown = true) class RememberMeAuthenticationTokenMixin { diff --git a/core/src/main/java/org/springframework/security/jackson/SecurityJacksonModules.java b/core/src/main/java/org/springframework/security/jackson/SecurityJacksonModules.java index 5869e9f53a..40aef768e1 100644 --- a/core/src/main/java/org/springframework/security/jackson/SecurityJacksonModules.java +++ b/core/src/main/java/org/springframework/security/jackson/SecurityJacksonModules.java @@ -196,6 +196,7 @@ public final class SecurityJacksonModules { } /** + * Instantiates the named class and adds it to the given list of modules. * @param loader the ClassLoader to use * @param modules list of the modules to add * @param className name of the class to instantiate diff --git a/core/src/main/java/org/springframework/security/jackson/SimpleGrantedAuthorityMixin.java b/core/src/main/java/org/springframework/security/jackson/SimpleGrantedAuthorityMixin.java index 17434689ba..57db4358ab 100644 --- a/core/src/main/java/org/springframework/security/jackson/SimpleGrantedAuthorityMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/SimpleGrantedAuthorityMixin.java @@ -17,9 +17,11 @@ package org.springframework.security.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson Mixin class helps in serialize/deserialize @@ -31,9 +33,9 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @see CoreJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.PUBLIC_ONLY, isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.NONE, getterVisibility = Visibility.PUBLIC_ONLY, + isGetterVisibility = Visibility.NONE) public abstract class SimpleGrantedAuthorityMixin { /** diff --git a/core/src/main/java/org/springframework/security/jackson/TestingAuthenticationTokenMixin.java b/core/src/main/java/org/springframework/security/jackson/TestingAuthenticationTokenMixin.java index 1ffd231793..afe2790a1d 100644 --- a/core/src/main/java/org/springframework/security/jackson/TestingAuthenticationTokenMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/TestingAuthenticationTokenMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.jackson; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.GrantedAuthority; @@ -35,9 +37,9 @@ import org.springframework.security.core.GrantedAuthority; * @see CoreJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, isGetterVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, isGetterVisibility = Visibility.NONE, + getterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) class TestingAuthenticationTokenMixin { /** diff --git a/core/src/main/java/org/springframework/security/jackson/UserMixin.java b/core/src/main/java/org/springframework/security/jackson/UserMixin.java index f0bede4e2d..e6eecf9664 100644 --- a/core/src/main/java/org/springframework/security/jackson/UserMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/UserMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import tools.jackson.databind.annotation.JsonDeserialize; /** @@ -32,10 +34,10 @@ import tools.jackson.databind.annotation.JsonDeserialize; * @see CoreJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonDeserialize(using = UserDeserializer.class) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class UserMixin { } diff --git a/core/src/main/java/org/springframework/security/jackson/UsernamePasswordAuthenticationTokenMixin.java b/core/src/main/java/org/springframework/security/jackson/UsernamePasswordAuthenticationTokenMixin.java index 92b79eaac3..11878b727a 100644 --- a/core/src/main/java/org/springframework/security/jackson/UsernamePasswordAuthenticationTokenMixin.java +++ b/core/src/main/java/org/springframework/security/jackson/UsernamePasswordAuthenticationTokenMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import tools.jackson.databind.annotation.JsonDeserialize; /** @@ -32,9 +34,9 @@ import tools.jackson.databind.annotation.JsonDeserialize; * @see CoreJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonDeserialize(using = UsernamePasswordAuthenticationTokenDeserializer.class) abstract class UsernamePasswordAuthenticationTokenMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/AnonymousAuthenticationTokenMixin.java b/core/src/main/java/org/springframework/security/jackson2/AnonymousAuthenticationTokenMixin.java index fbb29afa3c..3c5614356e 100644 --- a/core/src/main/java/org/springframework/security/jackson2/AnonymousAuthenticationTokenMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/AnonymousAuthenticationTokenMixin.java @@ -19,10 +19,13 @@ package org.springframework.security.jackson2; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.GrantedAuthority; @@ -48,9 +51,9 @@ import org.springframework.security.core.GrantedAuthority; * Jackson 3 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, isGetterVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, isGetterVisibility = Visibility.NONE, + getterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) @JsonIgnoreProperties(ignoreUnknown = true) @Deprecated(forRemoval = true) class AnonymousAuthenticationTokenMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/BadCredentialsExceptionMixin.java b/core/src/main/java/org/springframework/security/jackson2/BadCredentialsExceptionMixin.java index ff02e33f9f..4ec28b9d97 100644 --- a/core/src/main/java/org/springframework/security/jackson2/BadCredentialsExceptionMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/BadCredentialsExceptionMixin.java @@ -20,6 +20,8 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * This mixin class helps in serialize/deserialize @@ -43,7 +45,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * Jackson 3 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) @JsonIgnoreProperties(ignoreUnknown = true, value = { "cause", "stackTrace", "authenticationRequest" }) @Deprecated(forRemoval = true) class BadCredentialsExceptionMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/FactorGrantedAuthorityMixin.java b/core/src/main/java/org/springframework/security/jackson2/FactorGrantedAuthorityMixin.java index 42227d0e49..721b13325c 100644 --- a/core/src/main/java/org/springframework/security/jackson2/FactorGrantedAuthorityMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/FactorGrantedAuthorityMixin.java @@ -19,10 +19,13 @@ package org.springframework.security.jackson2; import java.time.Instant; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson Mixin class helps in serialize/deserialize @@ -44,9 +47,9 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.PUBLIC_ONLY, isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.NONE, getterVisibility = Visibility.PUBLIC_ONLY, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class FactorGrantedAuthorityMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/RememberMeAuthenticationTokenMixin.java b/core/src/main/java/org/springframework/security/jackson2/RememberMeAuthenticationTokenMixin.java index c3ec6a231a..a8e310ce4b 100644 --- a/core/src/main/java/org/springframework/security/jackson2/RememberMeAuthenticationTokenMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/RememberMeAuthenticationTokenMixin.java @@ -19,10 +19,13 @@ package org.springframework.security.jackson2; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.GrantedAuthority; @@ -55,9 +58,9 @@ import org.springframework.security.core.GrantedAuthority; * on Jackson 3 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) @JsonIgnoreProperties(ignoreUnknown = true) @Deprecated(forRemoval = true) class RememberMeAuthenticationTokenMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/SecurityJackson2Modules.java b/core/src/main/java/org/springframework/security/jackson2/SecurityJackson2Modules.java index d9b16e997d..4f9daaba09 100644 --- a/core/src/main/java/org/springframework/security/jackson2/SecurityJackson2Modules.java +++ b/core/src/main/java/org/springframework/security/jackson2/SecurityJackson2Modules.java @@ -145,6 +145,7 @@ public final class SecurityJackson2Modules { } /** + * Returns the list of available security modules in classpath. * @param loader the ClassLoader to use * @return List of available security modules in classpath. */ @@ -175,6 +176,7 @@ public final class SecurityJackson2Modules { } /** + * Loads the given class and adds an instance of it to the given list of modules. * @param loader the ClassLoader to use * @param modules list of the modules to add * @param className name of the class to instantiate @@ -201,7 +203,7 @@ public final class SecurityJackson2Modules { /** * An implementation of {@link ObjectMapper.DefaultTypeResolverBuilder} that inserts * an {@code allow all} {@link PolymorphicTypeValidator} and overrides the - * {@code TypeIdResolver} + * {@code TypeIdResolver}. * * @author Rob Winch */ diff --git a/core/src/main/java/org/springframework/security/jackson2/SimpleGrantedAuthorityMixin.java b/core/src/main/java/org/springframework/security/jackson2/SimpleGrantedAuthorityMixin.java index a0c6a010bb..2d5f143b8b 100644 --- a/core/src/main/java/org/springframework/security/jackson2/SimpleGrantedAuthorityMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/SimpleGrantedAuthorityMixin.java @@ -17,10 +17,13 @@ package org.springframework.security.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson Mixin class helps in serialize/deserialize @@ -40,9 +43,9 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * Jackson 3 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, - getterVisibility = JsonAutoDetect.Visibility.PUBLIC_ONLY, isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.NONE, getterVisibility = Visibility.PUBLIC_ONLY, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) @Deprecated(forRemoval = true) public abstract class SimpleGrantedAuthorityMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableListMixin.java b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableListMixin.java index 34572e98b0..64aa1342eb 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableListMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableListMixin.java @@ -20,6 +20,8 @@ import java.util.Set; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** @@ -39,13 +41,13 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; * @deprecated as of 7.0 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) @JsonDeserialize(using = UnmodifiableListDeserializer.class) @Deprecated(forRemoval = true) class UnmodifiableListMixin { /** - * Mixin Constructor + * Mixin Constructor. * @param s the Set */ @JsonCreator diff --git a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableMapMixin.java b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableMapMixin.java index 8292ed2cc5..6468eac469 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableMapMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableMapMixin.java @@ -20,6 +20,7 @@ import java.util.Map; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** @@ -39,7 +40,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; * @deprecated as of 7.0 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonDeserialize(using = UnmodifiableMapDeserializer.class) @Deprecated(forRemoval = true) class UnmodifiableMapMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java index a6e75c0cca..635450d821 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java @@ -20,6 +20,8 @@ import java.util.Set; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** @@ -39,13 +41,13 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; * @deprecated as of 7.0 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) @JsonDeserialize(using = UnmodifiableSetDeserializer.class) @Deprecated(forRemoval = true) class UnmodifiableSetMixin { /** - * Mixin Constructor + * Mixin Constructor. * @param s the Set */ @JsonCreator diff --git a/core/src/main/java/org/springframework/security/jackson2/UserMixin.java b/core/src/main/java/org/springframework/security/jackson2/UserMixin.java index fbf6bede1d..d1ca826c2d 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UserMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/UserMixin.java @@ -17,8 +17,11 @@ package org.springframework.security.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** @@ -45,10 +48,10 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; * {@code org.springframework.security.jackson.UserMixin} based on Jackson 3 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) @JsonDeserialize(using = UserDeserializer.class) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) @Deprecated(forRemoval = true) abstract class UserMixin { diff --git a/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenMixin.java b/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenMixin.java index acc0316b2f..bbd7867d20 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenMixin.java @@ -17,7 +17,10 @@ package org.springframework.security.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** @@ -47,9 +50,9 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; * based on Jackson 3 */ @SuppressWarnings("removal") -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class") -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY, property = "@class") +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonDeserialize(using = UsernamePasswordAuthenticationTokenDeserializer.class) @Deprecated(forRemoval = true) abstract class UsernamePasswordAuthenticationTokenMixin { diff --git a/core/src/main/java/org/springframework/security/provisioning/GroupManager.java b/core/src/main/java/org/springframework/security/provisioning/GroupManager.java index 140ab795a0..443fe8b479 100644 --- a/core/src/main/java/org/springframework/security/provisioning/GroupManager.java +++ b/core/src/main/java/org/springframework/security/provisioning/GroupManager.java @@ -40,7 +40,7 @@ public interface GroupManager { List findAllGroups(); /** - * Locates the users who are members of a group + * Locates the users who are members of a group. * @param groupName the group whose members are required * @return the usernames of the group members */ @@ -89,7 +89,7 @@ public interface GroupManager { void addGroupAuthority(String groupName, GrantedAuthority authority); /** - * Deletes an authority from those assigned to a group + * Deletes an authority from those assigned to a group. */ void removeGroupAuthority(String groupName, GrantedAuthority authority); diff --git a/core/src/main/java/org/springframework/security/provisioning/MutableUser.java b/core/src/main/java/org/springframework/security/provisioning/MutableUser.java index c56a03c4b4..4b7e078d53 100644 --- a/core/src/main/java/org/springframework/security/provisioning/MutableUser.java +++ b/core/src/main/java/org/springframework/security/provisioning/MutableUser.java @@ -24,6 +24,9 @@ import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.userdetails.UserDetails; /** + * A {@link MutableUserDetails} implementation that delegates to another + * {@link UserDetails}. + * * @author Luke Taylor * @since 3.1 */ diff --git a/core/src/main/java/org/springframework/security/provisioning/MutableUserDetails.java b/core/src/main/java/org/springframework/security/provisioning/MutableUserDetails.java index cc3854f5ba..0d7240ad51 100644 --- a/core/src/main/java/org/springframework/security/provisioning/MutableUserDetails.java +++ b/core/src/main/java/org/springframework/security/provisioning/MutableUserDetails.java @@ -21,6 +21,8 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.core.userdetails.UserDetails; /** + * A {@link UserDetails} whose password can be changed. + * * @author Luke Taylor * @since 3.1 */ diff --git a/core/src/main/java/org/springframework/security/scheduling/package-info.java b/core/src/main/java/org/springframework/security/scheduling/package-info.java index e4cee0dedf..335ca79bf7 100644 --- a/core/src/main/java/org/springframework/security/scheduling/package-info.java +++ b/core/src/main/java/org/springframework/security/scheduling/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Support for propagating the SecurityContext to Spring's task scheduling abstraction. + */ @NullMarked package org.springframework.security.scheduling; diff --git a/core/src/main/java/org/springframework/security/task/package-info.java b/core/src/main/java/org/springframework/security/task/package-info.java index 403455361e..4b524cb0df 100644 --- a/core/src/main/java/org/springframework/security/task/package-info.java +++ b/core/src/main/java/org/springframework/security/task/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Support for propagating the SecurityContext to Spring's TaskExecutor abstraction. + */ @NullMarked package org.springframework.security.task; diff --git a/core/src/test/java/org/springframework/security/jackson/SecurityJacksonModulesTests.java b/core/src/test/java/org/springframework/security/jackson/SecurityJacksonModulesTests.java index b8cf960588..109cdf89a8 100644 --- a/core/src/test/java/org/springframework/security/jackson/SecurityJacksonModulesTests.java +++ b/core/src/test/java/org/springframework/security/jackson/SecurityJacksonModulesTests.java @@ -19,6 +19,7 @@ package org.springframework.security.jackson; import java.util.List; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.junit.jupiter.api.Test; import tools.jackson.databind.JacksonModule; import tools.jackson.databind.json.JsonMapper; @@ -72,7 +73,7 @@ public class SecurityJacksonModulesTests { assertThat(deserializedUer).isEqualTo(user); } - @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) + @JsonTypeInfo(use = Id.CLASS) private static class TestGrantedAuthority implements GrantedAuthority { @Override diff --git a/core/src/test/java/org/springframework/security/jackson2/SecurityJackson2ModulesTests.java b/core/src/test/java/org/springframework/security/jackson2/SecurityJackson2ModulesTests.java index f5e6f65a8b..112951a984 100644 --- a/core/src/test/java/org/springframework/security/jackson2/SecurityJackson2ModulesTests.java +++ b/core/src/test/java/org/springframework/security/jackson2/SecurityJackson2ModulesTests.java @@ -24,9 +24,12 @@ import java.lang.annotation.Target; import java.util.HashMap; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreType; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.ObjectMapper; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -130,9 +133,9 @@ public class SecurityJackson2ModulesTests { } - @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) - @JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) + @JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) + @JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class NotAllowlistedMixin { diff --git a/crypto/src/main/java/org/springframework/security/crypto/argon2/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/argon2/package-info.java index 2b9627c75d..8484ed73af 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/argon2/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/argon2/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Argon2 password encoding support. + */ @NullMarked package org.springframework.security.crypto.argon2; diff --git a/crypto/src/main/java/org/springframework/security/crypto/bcrypt/BCryptPasswordEncoder.java b/crypto/src/main/java/org/springframework/security/crypto/bcrypt/BCryptPasswordEncoder.java index 95199a1fbc..d18d3bf168 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/bcrypt/BCryptPasswordEncoder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/bcrypt/BCryptPasswordEncoder.java @@ -52,6 +52,7 @@ public class BCryptPasswordEncoder extends AbstractValidatingPasswordEncoder { } /** + * Creates a new instance using the given strength. * @param strength the log rounds to use, between 4 and 31 */ public BCryptPasswordEncoder(int strength) { @@ -59,6 +60,7 @@ public class BCryptPasswordEncoder extends AbstractValidatingPasswordEncoder { } /** + * Creates a new instance using the given bcrypt version. * @param version the version of bcrypt, can be 2a,2b,2y */ public BCryptPasswordEncoder(BCryptVersion version) { @@ -66,6 +68,7 @@ public class BCryptPasswordEncoder extends AbstractValidatingPasswordEncoder { } /** + * Creates a new instance using the given bcrypt version and secure random instance. * @param version the version of bcrypt, can be 2a,2b,2y * @param random the secure random instance to use */ @@ -74,6 +77,7 @@ public class BCryptPasswordEncoder extends AbstractValidatingPasswordEncoder { } /** + * Creates a new instance using the given strength and secure random instance. * @param strength the log rounds to use, between 4 and 31 * @param random the secure random instance to use */ @@ -82,6 +86,7 @@ public class BCryptPasswordEncoder extends AbstractValidatingPasswordEncoder { } /** + * Creates a new instance using the given bcrypt version and strength. * @param version the version of bcrypt, can be 2a,2b,2y * @param strength the log rounds to use, between 4 and 31 */ @@ -90,6 +95,8 @@ public class BCryptPasswordEncoder extends AbstractValidatingPasswordEncoder { } /** + * Creates a new instance using the given bcrypt version, strength, and secure random + * instance. * @param version the version of bcrypt, can be 2a,2b,2y * @param strength the log rounds to use, between 4 and 31 * @param random the secure random instance to use diff --git a/crypto/src/main/java/org/springframework/security/crypto/bcrypt/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/bcrypt/package-info.java index c6fd0b67c8..b394b5a059 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/bcrypt/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/bcrypt/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * BCrypt password encoding support. + */ @NullMarked package org.springframework.security.crypto.bcrypt; diff --git a/crypto/src/main/java/org/springframework/security/crypto/encrypt/KeyStoreKeyFactory.java b/crypto/src/main/java/org/springframework/security/crypto/encrypt/KeyStoreKeyFactory.java index 806dbe43a3..584b99252e 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/encrypt/KeyStoreKeyFactory.java +++ b/crypto/src/main/java/org/springframework/security/crypto/encrypt/KeyStoreKeyFactory.java @@ -31,6 +31,8 @@ import org.springframework.core.io.Resource; import org.springframework.util.StringUtils; /** + * A factory for reading key pairs and secret keys from a Java {@link KeyStore}. + * * @author Dave Syer * @author Tim Ysewyn * @since 6.3 diff --git a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaAlgorithm.java b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaAlgorithm.java index 64c1e28bcf..07b7e98fbd 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaAlgorithm.java +++ b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaAlgorithm.java @@ -17,6 +17,8 @@ package org.springframework.security.crypto.encrypt; /** + * The RSA algorithm and padding scheme to use when encrypting or decrypting. + * * @author Dave Syer * @since 6.3 */ diff --git a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaKeyHolder.java b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaKeyHolder.java index ee78c7868c..1f6acdb518 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaKeyHolder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaKeyHolder.java @@ -17,6 +17,8 @@ package org.springframework.security.crypto.encrypt; /** + * A holder for an RSA public key. + * * @author Dave Syer * @since 6.3 */ diff --git a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaRawEncryptor.java b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaRawEncryptor.java index af458def03..7abb7fbcc4 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaRawEncryptor.java +++ b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaRawEncryptor.java @@ -31,6 +31,8 @@ import javax.crypto.Cipher; import org.jspecify.annotations.Nullable; /** + * An encryptor that uses RSA keys directly, without wrapping via a keystore. + * * @author Dave Syer * @since 6.3 */ diff --git a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaSecretEncryptor.java b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaSecretEncryptor.java index c6ecab9ac3..433be72abe 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaSecretEncryptor.java +++ b/crypto/src/main/java/org/springframework/security/crypto/encrypt/RsaSecretEncryptor.java @@ -34,6 +34,8 @@ import org.springframework.security.crypto.codec.Hex; import org.springframework.security.crypto.keygen.KeyGenerators; /** + * An encryptor that uses RSA public/private key pairs to encrypt and decrypt data. + * * @author Dave Syer * @since 6.3 */ diff --git a/crypto/src/main/java/org/springframework/security/crypto/encrypt/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/encrypt/package-info.java index 69ec19fa0e..34b87e97af 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/encrypt/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/encrypt/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Symmetric and asymmetric encryption support. + */ @NullMarked package org.springframework.security.crypto.encrypt; diff --git a/crypto/src/main/java/org/springframework/security/crypto/factory/PasswordEncoderFactories.java b/crypto/src/main/java/org/springframework/security/crypto/factory/PasswordEncoderFactories.java index b6c6f2f3e5..59fcc62593 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/factory/PasswordEncoderFactories.java +++ b/crypto/src/main/java/org/springframework/security/crypto/factory/PasswordEncoderFactories.java @@ -27,7 +27,7 @@ import org.springframework.security.crypto.password.Pbkdf2PasswordEncoder; import org.springframework.security.crypto.scrypt.SCryptPasswordEncoder; /** - * Used for creating {@link PasswordEncoder} instances + * Used for creating {@link PasswordEncoder} instances. * * @author Rob Winch * @since 5.0 diff --git a/crypto/src/main/java/org/springframework/security/crypto/factory/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/factory/package-info.java index 091e1f742a..160c780e29 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/factory/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/factory/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Factories for creating commonly used PasswordEncoder instances. + */ @NullMarked package org.springframework.security.crypto.factory; diff --git a/crypto/src/main/java/org/springframework/security/crypto/keygen/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/keygen/package-info.java index 6535155a5a..6c061d94b8 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/keygen/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/keygen/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Key generation utilities. + */ @NullMarked package org.springframework.security.crypto.keygen; diff --git a/crypto/src/main/java/org/springframework/security/crypto/password/AbstractPasswordEncoder.java b/crypto/src/main/java/org/springframework/security/crypto/password/AbstractPasswordEncoder.java index 973a11dd55..219cba444d 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password/AbstractPasswordEncoder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password/AbstractPasswordEncoder.java @@ -24,7 +24,7 @@ import org.springframework.security.crypto.keygen.KeyGenerators; import org.springframework.security.crypto.util.EncodingUtils; /** - * Abstract base class for password encoders + * Abstract base class for password encoders. * * @author Rob Worsnop */ diff --git a/crypto/src/main/java/org/springframework/security/crypto/password/DelegatingPasswordEncoder.java b/crypto/src/main/java/org/springframework/security/crypto/password/DelegatingPasswordEncoder.java index 144a04761e..ad80cf0457 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password/DelegatingPasswordEncoder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password/DelegatingPasswordEncoder.java @@ -153,7 +153,7 @@ public class DelegatingPasswordEncoder extends AbstractValidatingPasswordEncoder private PasswordEncoder defaultPasswordEncoderForMatches = new UnmappedIdPasswordEncoder(); /** - * Creates a new instance + * Creates a new instance. * @param idForEncode the id used to lookup which {@link PasswordEncoder} should be * used for {@link #encode(CharSequence)} * @param idToPasswordEncoder a Map of id to {@link PasswordEncoder} used to determine @@ -165,7 +165,7 @@ public class DelegatingPasswordEncoder extends AbstractValidatingPasswordEncoder } /** - * Creates a new instance + * Creates a new instance. * @param idForEncode the id used to lookup which {@link PasswordEncoder} should be * used for {@link #encode(CharSequence)} * @param idToPasswordEncoder a Map of id to {@link PasswordEncoder} used to determine diff --git a/crypto/src/main/java/org/springframework/security/crypto/password/LdapShaPasswordEncoder.java b/crypto/src/main/java/org/springframework/security/crypto/password/LdapShaPasswordEncoder.java index f7a190de23..a05eb39963 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password/LdapShaPasswordEncoder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password/LdapShaPasswordEncoder.java @@ -48,7 +48,7 @@ import org.springframework.security.crypto.keygen.KeyGenerators; @Deprecated public class LdapShaPasswordEncoder extends AbstractValidatingPasswordEncoder { - /** The number of bytes in a SHA hash */ + /** The number of bytes in a SHA hash. */ private static final int SHA_LENGTH = 20; private static final String SSHA_PREFIX = "{SSHA}"; diff --git a/crypto/src/main/java/org/springframework/security/crypto/password/Md4PasswordEncoder.java b/crypto/src/main/java/org/springframework/security/crypto/password/Md4PasswordEncoder.java index 0ab6b9001a..317c10237b 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password/Md4PasswordEncoder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password/Md4PasswordEncoder.java @@ -127,7 +127,7 @@ public class Md4PasswordEncoder extends AbstractValidatingPasswordEncoder { /** * Takes a previously encoded password and compares it with a rawpassword after mixing - * in the salt and encoding that value + * in the salt and encoding that value. * @param rawPassword plain text password * @param encodedPassword previously encoded password * @return true or false diff --git a/crypto/src/main/java/org/springframework/security/crypto/password/MessageDigestPasswordEncoder.java b/crypto/src/main/java/org/springframework/security/crypto/password/MessageDigestPasswordEncoder.java index d899593007..8e525693e0 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password/MessageDigestPasswordEncoder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password/MessageDigestPasswordEncoder.java @@ -137,7 +137,7 @@ public class MessageDigestPasswordEncoder extends AbstractValidatingPasswordEnco /** * Takes a previously encoded password and compares it with a rawpassword after mixing - * in the salt and encoding that value + * in the salt and encoding that value. * @param rawPassword plain text password * @param encodedPassword previously encoded password * @return true or false diff --git a/crypto/src/main/java/org/springframework/security/crypto/password/Pbkdf2PasswordEncoder.java b/crypto/src/main/java/org/springframework/security/crypto/password/Pbkdf2PasswordEncoder.java index d456c96267..56e2654e11 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password/Pbkdf2PasswordEncoder.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password/Pbkdf2PasswordEncoder.java @@ -234,7 +234,7 @@ public class Pbkdf2PasswordEncoder extends AbstractValidatingPasswordEncoder { } /** - * The Algorithm used for creating the {@link SecretKeyFactory} + * The Algorithm used for creating the {@link SecretKeyFactory}. * * @since 5.0 */ diff --git a/crypto/src/main/java/org/springframework/security/crypto/password/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/password/package-info.java index 47f2497a96..c81a00f51e 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Password encoding and hashing implementations. + */ @NullMarked package org.springframework.security.crypto.password; diff --git a/crypto/src/main/java/org/springframework/security/crypto/password4j/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/password4j/package-info.java index 7310e80b8f..7640016438 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/password4j/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/password4j/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Password encoding support backed by the password4j library. + */ @NullMarked package org.springframework.security.crypto.password4j; diff --git a/crypto/src/main/java/org/springframework/security/crypto/scrypt/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/scrypt/package-info.java index 77db0e9990..3cc00b0b08 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/scrypt/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/scrypt/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * SCrypt password encoding support. + */ @NullMarked package org.springframework.security.crypto.scrypt; diff --git a/crypto/src/main/java/org/springframework/security/crypto/util/package-info.java b/crypto/src/main/java/org/springframework/security/crypto/util/package-info.java index b4523fe7fe..8e97eb69bc 100644 --- a/crypto/src/main/java/org/springframework/security/crypto/util/package-info.java +++ b/crypto/src/main/java/org/springframework/security/crypto/util/package-info.java @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * Internal encoding utilities used by the crypto module. + */ @NullMarked package org.springframework.security.crypto.util; diff --git a/etc/checkstyle/checkstyle-suppressions.xml b/etc/checkstyle/checkstyle-suppressions.xml index 2a7db82387..5ee0a03604 100644 --- a/etc/checkstyle/checkstyle-suppressions.xml +++ b/etc/checkstyle/checkstyle-suppressions.xml @@ -11,6 +11,9 @@ + + + diff --git a/itest/context/src/integration-test/java/org/springframework/security/integration/MultiAnnotationTests.java b/itest/context/src/integration-test/java/org/springframework/security/integration/MultiAnnotationTests.java index 4b22db26b0..4103fc1dff 100644 --- a/itest/context/src/integration-test/java/org/springframework/security/integration/MultiAnnotationTests.java +++ b/itest/context/src/integration-test/java/org/springframework/security/integration/MultiAnnotationTests.java @@ -34,6 +34,8 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for services secured with multiple, differing security annotations. + * * @author Luke Taylor */ @ContextConfiguration(locations = { "/multi-sec-annotation-app-context.xml" }) diff --git a/itest/context/src/integration-test/java/org/springframework/security/performance/FilterChainPerformanceTests.java b/itest/context/src/integration-test/java/org/springframework/security/performance/FilterChainPerformanceTests.java index 1ca5da76e1..5f728e369c 100644 --- a/itest/context/src/integration-test/java/org/springframework/security/performance/FilterChainPerformanceTests.java +++ b/itest/context/src/integration-test/java/org/springframework/security/performance/FilterChainPerformanceTests.java @@ -43,6 +43,8 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; import org.springframework.util.StopWatch; /** + * Performance tests for invoking the {@link FilterChainProxy}. + * * @author Luke Taylor * @since 2.0 */ @@ -121,7 +123,7 @@ public class FilterChainPerformanceTests { /** * Creates data from 1 to N_AUTHORITIES in steps of 10, performing N_INVOCATIONS for - * each + * each. */ @Test public void provideDataOnScalingWithNumberOfAuthoritiesUserHas() throws Exception { diff --git a/itest/context/src/integration-test/java/org/springframework/security/performance/ProtectPointcutPerformanceTests.java b/itest/context/src/integration-test/java/org/springframework/security/performance/ProtectPointcutPerformanceTests.java index e52dec180d..c53a29e048 100644 --- a/itest/context/src/integration-test/java/org/springframework/security/performance/ProtectPointcutPerformanceTests.java +++ b/itest/context/src/integration-test/java/org/springframework/security/performance/ProtectPointcutPerformanceTests.java @@ -33,6 +33,8 @@ import org.springframework.util.StopWatch; import static org.assertj.core.api.Assertions.fail; /** + * Performance tests for pointcut-based method security. + * * @author Luke Taylor */ @ContextConfiguration(locations = { "/protect-pointcut-performance-app-context.xml" }) diff --git a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/MultiAnnotationService.java b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/MultiAnnotationService.java index 959734c5e5..981239b40b 100644 --- a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/MultiAnnotationService.java +++ b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/MultiAnnotationService.java @@ -20,7 +20,7 @@ import org.springframework.security.access.annotation.Secured; import org.springframework.security.access.prepost.PreAuthorize; /** - * Allows testing mixing of different annotation types + * Allows testing mixing of different annotation types. * * @author Luke Taylor */ diff --git a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeService.java b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeService.java index 582d512e96..e94cd45dee 100644 --- a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeService.java +++ b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeService.java @@ -19,6 +19,8 @@ package org.springframework.security.integration.multiannotation; import org.springframework.security.access.prepost.PreAuthorize; /** + * A service with a {@code @PreAuthorize}-protected method. + * * @author Luke Taylor */ public interface PreAuthorizeService { diff --git a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeServiceImpl.java b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeServiceImpl.java index f55922df12..dc15925b50 100644 --- a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeServiceImpl.java +++ b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/PreAuthorizeServiceImpl.java @@ -17,6 +17,8 @@ package org.springframework.security.integration.multiannotation; /** + * Default implementation of {@link PreAuthorizeService}. + * * @author Luke Taylor */ public class PreAuthorizeServiceImpl implements PreAuthorizeService { diff --git a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredService.java b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredService.java index 56e626366d..8a47de9833 100644 --- a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredService.java +++ b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredService.java @@ -19,6 +19,8 @@ package org.springframework.security.integration.multiannotation; import org.springframework.security.access.annotation.Secured; /** + * A test service secured with {@link Secured}. + * * @author Luke Taylor */ public interface SecuredService { diff --git a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredServiceImpl.java b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredServiceImpl.java index 97abe4f27f..c3155cf187 100644 --- a/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredServiceImpl.java +++ b/itest/context/src/main/java/org/springframework/security/integration/multiannotation/SecuredServiceImpl.java @@ -17,6 +17,8 @@ package org.springframework.security.integration.multiannotation; /** + * Default implementation of {@link SecuredService}. + * * @author Luke Taylor */ public class SecuredServiceImpl implements SecuredService { diff --git a/itest/ldap/embedded-ldap-mode-unboundid/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java b/itest/ldap/embedded-ldap-mode-unboundid/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java index 909b7a689d..439c323638 100644 --- a/itest/ldap/embedded-ldap-mode-unboundid/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java +++ b/itest/ldap/embedded-ldap-mode-unboundid/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java @@ -27,6 +27,9 @@ import org.springframework.security.ldap.server.UnboundIdContainer; import static org.assertj.core.api.Assertions.assertThat; /** + * Integration tests for the {@code } XML namespace element using an embedded + * UnboundID server. + * * @author Eddú Meléndez */ public class LdapServerBeanDefinitionParserTests { diff --git a/itest/ldap/embedded-ldap-none/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java b/itest/ldap/embedded-ldap-none/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java index 17da10691f..4dca69032c 100644 --- a/itest/ldap/embedded-ldap-none/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java +++ b/itest/ldap/embedded-ldap-none/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java @@ -25,6 +25,9 @@ import org.springframework.context.support.ClassPathXmlApplicationContext; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Tests that the {@code ldap-server} element fails when no embedded LDAP server is + * provided. + * * @author Eddú Meléndez */ public class LdapServerBeanDefinitionParserTests { diff --git a/itest/ldap/embedded-ldap-unboundid-default/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java b/itest/ldap/embedded-ldap-unboundid-default/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java index 909b7a689d..9156fec5bb 100644 --- a/itest/ldap/embedded-ldap-unboundid-default/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java +++ b/itest/ldap/embedded-ldap-unboundid-default/src/integration-test/java/org/springframework/security/LdapServerBeanDefinitionParserTests.java @@ -27,6 +27,8 @@ import org.springframework.security.ldap.server.UnboundIdContainer; import static org.assertj.core.api.Assertions.assertThat; /** + * Tests for the {@code ldap-server} bean definition parser. + * * @author Eddú Meléndez */ public class LdapServerBeanDefinitionParserTests { diff --git a/itest/web/src/integration-test/java/org/springframework/security/integration/ConcurrentSessionManagementTests.java b/itest/web/src/integration-test/java/org/springframework/security/integration/ConcurrentSessionManagementTests.java index 9f83ad6871..3ab0706d11 100644 --- a/itest/web/src/integration-test/java/org/springframework/security/integration/ConcurrentSessionManagementTests.java +++ b/itest/web/src/integration-test/java/org/springframework/security/integration/ConcurrentSessionManagementTests.java @@ -38,6 +38,8 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; /** + * Integration tests for concurrent session management. + * * @author Luke Taylor */ public class ConcurrentSessionManagementTests extends AbstractWebServerIntegrationTests { diff --git a/kerberos/kerberos-client/src/main/java/org/springframework/security/kerberos/client/ldap/KerberosLdapContextSource.java b/kerberos/kerberos-client/src/main/java/org/springframework/security/kerberos/client/ldap/KerberosLdapContextSource.java index 93e7b78f09..c0020e2b0e 100644 --- a/kerberos/kerberos-client/src/main/java/org/springframework/security/kerberos/client/ldap/KerberosLdapContextSource.java +++ b/kerberos/kerberos-client/src/main/java/org/springframework/security/kerberos/client/ldap/KerberosLdapContextSource.java @@ -135,7 +135,7 @@ public class KerberosLdapContextSource extends DefaultSpringSecurityContextSourc } /** - * The login configuration to get the serviceSubject from LoginContext + * The login configuration to get the serviceSubject from LoginContext. * @param loginConfig the login config */ public void setLoginConfig(Configuration loginConfig) { diff --git a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosClient.java b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosClient.java index ad8272cf84..e18ccb4ad6 100644 --- a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosClient.java +++ b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosClient.java @@ -17,6 +17,8 @@ package org.springframework.security.kerberos.authentication; /** + * Logs in a user against a Kerberos server. + * * @author Mike Wiesner * @author Bogdan Mustiata * @since 1.0 diff --git a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosMultiTier.java b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosMultiTier.java index b121a7f422..47240d135c 100644 --- a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosMultiTier.java +++ b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosMultiTier.java @@ -46,7 +46,7 @@ public final class KerberosMultiTier { public static final Oid KERBEROS_OID = createOid(KERBEROS_OID_STRING); /** - * Create a new ticket for the + * Create a new ticket for the. * @param authentication * @param username * @param lifetimeInSeconds diff --git a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosServiceRequestToken.java b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosServiceRequestToken.java index 3dc5f74272..44e84841d0 100644 --- a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosServiceRequestToken.java +++ b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosServiceRequestToken.java @@ -96,7 +96,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * equals() is based only on the Kerberos token + * equals() is based only on the Kerberos token. */ @Override public boolean equals(@Nullable Object obj) { @@ -120,7 +120,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Calculates hashcode based on the Kerberos token + * Calculates hashcode based on the Kerberos token. */ @Override public int hashCode() { @@ -141,7 +141,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Returns the Kerberos token + * Returns the Kerberos token. * @return the token data */ public byte[] getToken() { @@ -149,7 +149,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Gets the ticket validation + * Gets the ticket validation. * @return the ticket validation (which will be null if the token is unauthenticated) */ public @Nullable KerberosTicketValidation getTicketValidation() { @@ -157,7 +157,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Determines whether an authenticated token has a response token + * Determines whether an authenticated token has a response token. * @return whether a response token is available */ public boolean hasResponseToken() { @@ -179,7 +179,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Unwraps an encrypted message using the gss context + * Unwraps an encrypted message using the gss context. * @param data the data * @param offset data offset * @param length data length @@ -203,7 +203,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Unwraps an encrypted message using the gss context + * Unwraps an encrypted message using the gss context. * @param data the data * @return the decrypted message * @throws PrivilegedActionException if jaas throws and error @@ -213,7 +213,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Wraps an message using the gss context + * Wraps an message using the gss context. * @param data the data * @param offset data offset * @param length data length @@ -237,7 +237,7 @@ public class KerberosServiceRequestToken extends AbstractAuthenticationToken imp } /** - * Wraps an message using the gss context + * Wraps an message using the gss context. * @param data the data * @return the encrypted message * @throws PrivilegedActionException if jaas throws and error diff --git a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosTicketValidation.java b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosTicketValidation.java index 483e40ca3b..153064cc96 100644 --- a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosTicketValidation.java +++ b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/KerberosTicketValidation.java @@ -26,7 +26,7 @@ import org.ietf.jgss.GSSCredential; import org.jspecify.annotations.Nullable; /** - * Result of ticket validation + * Result of ticket validation. */ public final class KerberosTicketValidation { diff --git a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/sun/SunJaasKerberosTicketValidator.java b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/sun/SunJaasKerberosTicketValidator.java index cc686d2db1..dc32c53bb6 100644 --- a/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/sun/SunJaasKerberosTicketValidator.java +++ b/kerberos/kerberos-core/src/main/java/org/springframework/security/kerberos/authentication/sun/SunJaasKerberosTicketValidator.java @@ -147,6 +147,8 @@ public class SunJaasKerberosTicketValidator implements KerberosTicketValidator, } /** + * Sets whether to validate the ticket using a copy of the service subject, as needed + * in multi-tier deployments. * @param multiTier */ public void setMultiTier(boolean multiTier) { diff --git a/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/KerberosSecurityTestcase.java b/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/KerberosSecurityTestcase.java index 3af19c6981..2085d9f883 100644 --- a/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/KerberosSecurityTestcase.java +++ b/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/KerberosSecurityTestcase.java @@ -67,7 +67,7 @@ public class KerberosSecurityTestcase { } /** - * Create a Kdc configuration + * Create a Kdc configuration. */ public void createMiniKdcConf() { this.conf = MiniKdc.createConf(); diff --git a/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/MiniKdc.java b/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/MiniKdc.java index 7d4242b2c9..badf9d9464 100644 --- a/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/MiniKdc.java +++ b/kerberos/kerberos-test/src/main/java/org/springframework/security/kerberos/test/MiniKdc.java @@ -346,7 +346,7 @@ public class MiniKdc { } /** - * Stops the MiniKdc + * Stops the MiniKdc. */ public synchronized void stop() { if (this.simpleKdc != null) { diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/DefaultSpringSecurityContextSourceTests.java b/ldap/src/integration-test/java/org/springframework/security/ldap/DefaultSpringSecurityContextSourceTests.java index 44448189a1..9344abeb7d 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/DefaultSpringSecurityContextSourceTests.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/DefaultSpringSecurityContextSourceTests.java @@ -34,6 +34,8 @@ import static org.assertj.core.api.Assertions.assertThatExceptionOfType; import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; /** + * Integration tests for {@link DefaultSpringSecurityContextSource}. + * * @author Luke Taylor * @author Eddú Meléndez */ diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/SpringSecurityLdapTemplateITests.java b/ldap/src/integration-test/java/org/springframework/security/ldap/SpringSecurityLdapTemplateITests.java index 6b7aed63d2..d01b0e718a 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/SpringSecurityLdapTemplateITests.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/SpringSecurityLdapTemplateITests.java @@ -41,6 +41,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** + * Integration tests for {@link SpringSecurityLdapTemplate}. + * * @author Luke Taylor * @author Eddú Meléndez */ diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/UnboundIdContainerConfig.java b/ldap/src/integration-test/java/org/springframework/security/ldap/UnboundIdContainerConfig.java index b62f626b40..0b6ba8715a 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/UnboundIdContainerConfig.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/UnboundIdContainerConfig.java @@ -23,6 +23,8 @@ import org.springframework.ldap.core.ContextSource; import org.springframework.security.ldap.server.UnboundIdContainer; /** + * Configuration for an embedded UnboundID LDAP server used in integration tests. + * * @author Eddú Meléndez */ @Configuration diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/server/UnboundIdContainerTests.java b/ldap/src/integration-test/java/org/springframework/security/ldap/server/UnboundIdContainerTests.java index 99e1efadc3..3cfadd9b0f 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/server/UnboundIdContainerTests.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/server/UnboundIdContainerTests.java @@ -30,6 +30,8 @@ import org.springframework.test.util.ReflectionTestUtils; import static org.assertj.core.api.Assertions.assertThat; /** + * Integration tests for {@link UnboundIdContainer}. + * * @author Eddú Meléndez */ public class UnboundIdContainerTests { diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorGetGrantedAuthoritiesTests.java b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorGetGrantedAuthoritiesTests.java index 33a5539594..e26b282bb9 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorGetGrantedAuthoritiesTests.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorGetGrantedAuthoritiesTests.java @@ -38,6 +38,8 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; import static org.assertj.core.api.Assertions.assertThat; /** + * Tests for {@link DefaultLdapAuthoritiesPopulator#getGrantedAuthorities}. + * * @author Dayan Kodippily */ @ExtendWith(SpringExtension.class) diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorTests.java b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorTests.java index a7fc6aafc5..9445fbce18 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorTests.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulatorTests.java @@ -40,6 +40,8 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; /** + * Integration tests for {@link DefaultLdapAuthoritiesPopulator}. + * * @author Luke Taylor * @author Eddú Meléndez */ diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManagerTests.java b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManagerTests.java index df1f8b6e39..6090f84018 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManagerTests.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManagerTests.java @@ -47,6 +47,8 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; /** + * Integration tests for {@link LdapUserDetailsManager}. + * * @author Luke Taylor * @author Eddú Meléndez * @author Roman Zabaluev diff --git a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulatorTests.java b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulatorTests.java index 9d3023e595..74e516adea 100644 --- a/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulatorTests.java +++ b/ldap/src/integration-test/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulatorTests.java @@ -35,6 +35,8 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; import static org.assertj.core.api.Assertions.assertThat; /** + * Integration tests for {@link NestedLdapAuthoritiesPopulator}. + * * @author Filip Hanik * @author Eddú Meléndez */ diff --git a/ldap/src/main/java/org/springframework/security/ldap/DefaultLdapUsernameToDnMapper.java b/ldap/src/main/java/org/springframework/security/ldap/DefaultLdapUsernameToDnMapper.java index 31e6d8561c..77ddc66527 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/DefaultLdapUsernameToDnMapper.java +++ b/ldap/src/main/java/org/springframework/security/ldap/DefaultLdapUsernameToDnMapper.java @@ -35,6 +35,7 @@ public class DefaultLdapUsernameToDnMapper implements LdapUsernameToDnMapper { private final String usernameAttribute; /** + * Creates a new instance using the given base DN and username attribute. * @param userDnBase the base name of the DN * @param usernameAttribute the attribute to append for the username component. */ diff --git a/ldap/src/main/java/org/springframework/security/ldap/SpringSecurityLdapTemplate.java b/ldap/src/main/java/org/springframework/security/ldap/SpringSecurityLdapTemplate.java index 593b0cc9fe..d769bd1c3e 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/SpringSecurityLdapTemplate.java +++ b/ldap/src/main/java/org/springframework/security/ldap/SpringSecurityLdapTemplate.java @@ -73,7 +73,7 @@ public class SpringSecurityLdapTemplate extends LdapTemplate { private static final boolean RETURN_OBJECT = true; - /** Default search controls */ + /** Default search controls. */ private SearchControls searchControls = new SearchControls(); public SpringSecurityLdapTemplate(ContextSource contextSource) { @@ -217,7 +217,7 @@ public class SpringSecurityLdapTemplate extends LdapTemplate { /** * Extracts String values for a specified attribute name and places them in the map * representing the ldap record If a value is not of type String, it will derive it's - * value from the {@link Object#toString()} + * value from the {@link Object#toString()}. * @param adapter - the adapter that contains the values * @param record - the map holding the attribute names and values * @param attributeName - the name for which to fetch the values from diff --git a/ldap/src/main/java/org/springframework/security/ldap/aot/hint/LdapSecurityRuntimeHints.java b/ldap/src/main/java/org/springframework/security/ldap/aot/hint/LdapSecurityRuntimeHints.java index 58dc213457..f8ad0107dd 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/aot/hint/LdapSecurityRuntimeHints.java +++ b/ldap/src/main/java/org/springframework/security/ldap/aot/hint/LdapSecurityRuntimeHints.java @@ -24,7 +24,7 @@ import org.springframework.aot.hint.RuntimeHintsRegistrar; import org.springframework.aot.hint.TypeReference; /** - * {@link RuntimeHintsRegistrar} for LDAP Security resources and classes + * {@link RuntimeHintsRegistrar} for LDAP Security resources and classes. * * @author Marcus Da Coregio * @since 6.0 diff --git a/ldap/src/main/java/org/springframework/security/ldap/authentication/AbstractLdapAuthenticator.java b/ldap/src/main/java/org/springframework/security/ldap/authentication/AbstractLdapAuthenticator.java index 92a28d3e6a..e3862760d3 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/authentication/AbstractLdapAuthenticator.java +++ b/ldap/src/main/java/org/springframework/security/ldap/authentication/AbstractLdapAuthenticator.java @@ -45,7 +45,7 @@ public abstract class AbstractLdapAuthenticator implements LdapAuthenticator, In /** * Optional search object which can be used to locate a user when a simple DN match - * isn't sufficient + * isn't sufficient. */ private @Nullable LdapUserSearch userSearch; @@ -58,7 +58,7 @@ public abstract class AbstractLdapAuthenticator implements LdapAuthenticator, In private String @Nullable [] userAttributes = null; // private String[] userDnPattern = null; - /** Stores the patterns which are used as potential DN matches */ + /** Stores the patterns which are used as potential DN matches. */ private MessageFormat @Nullable [] userDnFormat = null; /** diff --git a/ldap/src/main/java/org/springframework/security/ldap/authentication/NullLdapAuthoritiesPopulator.java b/ldap/src/main/java/org/springframework/security/ldap/authentication/NullLdapAuthoritiesPopulator.java index c7c386a649..9524c12e36 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/authentication/NullLdapAuthoritiesPopulator.java +++ b/ldap/src/main/java/org/springframework/security/ldap/authentication/NullLdapAuthoritiesPopulator.java @@ -24,6 +24,9 @@ import org.springframework.security.core.authority.AuthorityUtils; import org.springframework.security.ldap.userdetails.LdapAuthoritiesPopulator; /** + * A {@link LdapAuthoritiesPopulator} which always returns an empty collection of + * authorities. + * * @author Luke Taylor * @since 3.0 */ diff --git a/ldap/src/main/java/org/springframework/security/ldap/authentication/SpringSecurityAuthenticationSource.java b/ldap/src/main/java/org/springframework/security/ldap/authentication/SpringSecurityAuthenticationSource.java index ffa9f04214..9f5f5eee02 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/authentication/SpringSecurityAuthenticationSource.java +++ b/ldap/src/main/java/org/springframework/security/ldap/authentication/SpringSecurityAuthenticationSource.java @@ -69,6 +69,7 @@ public class SpringSecurityAuthenticationSource implements AuthenticationSource } /** + * Returns the credentials of the logged in user. * @see org.springframework.ldap.core.AuthenticationSource#getCredentials() */ @Override diff --git a/ldap/src/main/java/org/springframework/security/ldap/authentication/ad/ActiveDirectoryLdapAuthenticationProvider.java b/ldap/src/main/java/org/springframework/security/ldap/authentication/ad/ActiveDirectoryLdapAuthenticationProvider.java index 3054c62418..f8086b9ea1 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/authentication/ad/ActiveDirectoryLdapAuthenticationProvider.java +++ b/ldap/src/main/java/org/springframework/security/ldap/authentication/ad/ActiveDirectoryLdapAuthenticationProvider.java @@ -142,6 +142,7 @@ public final class ActiveDirectoryLdapAuthenticationProvider extends AbstractLda private LdapAuthoritiesPopulator authoritiesPopulator = new DefaultActiveDirectoryAuthoritiesPopulator(); /** + * Creates a new instance with the given domain, LDAP url, and root DN. * @param domain the domain name (can be null or empty) * @param url an LDAP url (or multiple space-delimited URLs). * @param rootDn the root DN (can be null or empty) @@ -156,6 +157,8 @@ public final class ActiveDirectoryLdapAuthenticationProvider extends AbstractLda } /** + * Creates a new instance with the given domain and LDAP url, deriving the root DN + * from the domain. * @param domain the domain name (can be null or empty) * @param url an LDAP url (or multiple URLs) */ diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson/InetOrgPersonMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson/InetOrgPersonMixin.java index 2de4a6db90..9499f7cccc 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson/InetOrgPersonMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson/InetOrgPersonMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.ldap.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson.SecurityJacksonModules; import org.springframework.security.ldap.userdetails.InetOrgPerson; @@ -30,9 +32,9 @@ import org.springframework.security.ldap.userdetails.InetOrgPerson; * @see LdapJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class InetOrgPersonMixin { } diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapAuthorityMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapAuthorityMixin.java index 6ec3a3d477..f36b3a1e8b 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapAuthorityMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapAuthorityMixin.java @@ -20,9 +20,11 @@ import java.util.List; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson.SecurityJacksonModules; import org.springframework.security.ldap.userdetails.LdapAuthority; @@ -35,8 +37,8 @@ import org.springframework.security.ldap.userdetails.LdapAuthority; * @see LdapJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) abstract class LdapAuthorityMixin { @JsonCreator diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapUserDetailsImplMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapUserDetailsImplMixin.java index 9fb799dca3..becb56ce52 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapUserDetailsImplMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson/LdapUserDetailsImplMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.ldap.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson.SecurityJacksonModules; import org.springframework.security.ldap.userdetails.LdapUserDetailsImpl; @@ -30,9 +32,9 @@ import org.springframework.security.ldap.userdetails.LdapUserDetailsImpl; * @see LdapJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class LdapUserDetailsImplMixin { } diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson/PersonMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson/PersonMixin.java index 8f1e1976ca..d707c52d75 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson/PersonMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson/PersonMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.ldap.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson.SecurityJacksonModules; import org.springframework.security.ldap.userdetails.Person; @@ -30,9 +32,9 @@ import org.springframework.security.ldap.userdetails.Person; * @see LdapJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class PersonMixin { } diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson2/InetOrgPersonMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson2/InetOrgPersonMixin.java index 88c094778b..dda74ba9dc 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson2/InetOrgPersonMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson2/InetOrgPersonMixin.java @@ -17,8 +17,10 @@ package org.springframework.security.ldap.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson2.SecurityJackson2Modules; import org.springframework.security.ldap.userdetails.InetOrgPerson; @@ -34,9 +36,9 @@ import org.springframework.security.ldap.userdetails.InetOrgPerson; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class InetOrgPersonMixin { diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapAuthorityMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapAuthorityMixin.java index 553ceb162e..8cf0054914 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapAuthorityMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapAuthorityMixin.java @@ -20,10 +20,12 @@ import java.util.List; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson2.SecurityJackson2Modules; import org.springframework.security.ldap.userdetails.LdapAuthority; @@ -39,8 +41,8 @@ import org.springframework.security.ldap.userdetails.LdapAuthority; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class LdapAuthorityMixin { diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapUserDetailsImplMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapUserDetailsImplMixin.java index eb848e326e..2f76f6ed29 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapUserDetailsImplMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapUserDetailsImplMixin.java @@ -17,8 +17,10 @@ package org.springframework.security.ldap.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson2.SecurityJackson2Modules; import org.springframework.security.ldap.userdetails.LdapUserDetailsImpl; @@ -35,9 +37,9 @@ import org.springframework.security.ldap.userdetails.LdapUserDetailsImpl; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class LdapUserDetailsImplMixin { diff --git a/ldap/src/main/java/org/springframework/security/ldap/jackson2/PersonMixin.java b/ldap/src/main/java/org/springframework/security/ldap/jackson2/PersonMixin.java index 5fd33b2465..5cc0e06465 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/jackson2/PersonMixin.java +++ b/ldap/src/main/java/org/springframework/security/ldap/jackson2/PersonMixin.java @@ -17,8 +17,10 @@ package org.springframework.security.ldap.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.jackson2.SecurityJackson2Modules; import org.springframework.security.ldap.userdetails.Person; @@ -34,9 +36,9 @@ import org.springframework.security.ldap.userdetails.Person; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class PersonMixin { diff --git a/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyControl.java b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyControl.java index 18c33f6c60..50c0b1560f 100755 --- a/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyControl.java +++ b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyControl.java @@ -37,7 +37,7 @@ import org.jspecify.annotations.Nullable; public class PasswordPolicyControl implements Control { /** - * OID of the Password Policy Control + * OID of the Password Policy Control. */ public static final String OID = "1.3.6.1.4.1.42.2.27.8.5.1"; diff --git a/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyData.java b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyData.java index 03fa1d32c2..6e54b368a9 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyData.java +++ b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyData.java @@ -17,6 +17,8 @@ package org.springframework.security.ldap.ppolicy; /** + * Provides access to LDAP password policy data for a user. + * * @author Luke Taylor * @since 3.0 */ diff --git a/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyResponseControl.java b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyResponseControl.java index ae1ad52496..23c510bf86 100755 --- a/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyResponseControl.java +++ b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/PasswordPolicyResponseControl.java @@ -189,7 +189,7 @@ public class PasswordPolicyResponseControl extends PasswordPolicyControl { } /** - * Decoder based on Netscape ldapsdk library + * Decoder based on Netscape ldapsdk library. */ private class NetscapeDecoder implements PPolicyDecoder { @@ -227,7 +227,7 @@ public class PasswordPolicyResponseControl extends PasswordPolicyControl { static class SpecificTagDecoder extends BERTagDecoder { - /** Allows us to remember which of the two options we're decoding */ + /** Allows us to remember which of the two options we're decoding. */ private @Nullable Boolean inChoice = null; @Override diff --git a/ldap/src/main/java/org/springframework/security/ldap/search/FilterBasedLdapUserSearch.java b/ldap/src/main/java/org/springframework/security/ldap/search/FilterBasedLdapUserSearch.java index 2277b45463..a134ec44b8 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/search/FilterBasedLdapUserSearch.java +++ b/ldap/src/main/java/org/springframework/security/ldap/search/FilterBasedLdapUserSearch.java @@ -85,7 +85,7 @@ public class FilterBasedLdapUserSearch implements LdapUserSearch { } /** - * Return the LdapUserDetails containing the user's information + * Return the LdapUserDetails containing the user's information. * @param username the username to search for. * @return An LdapUserDetails object containing the details of the located user's * directory entry diff --git a/ldap/src/main/java/org/springframework/security/ldap/server/UnboundIdContainer.java b/ldap/src/main/java/org/springframework/security/ldap/server/UnboundIdContainer.java index 7b2eb0e506..e37820b36a 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/server/UnboundIdContainer.java +++ b/ldap/src/main/java/org/springframework/security/ldap/server/UnboundIdContainer.java @@ -41,6 +41,8 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** + * An {@link EmbeddedLdapServerContainer} backed by an UnboundID in-memory LDAP server. + * * @author Eddú Meléndez */ public class UnboundIdContainer diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulator.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulator.java index 7dcf417052..ab0d615d4d 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulator.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/DefaultLdapAuthoritiesPopulator.java @@ -109,12 +109,12 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator private static final Log logger = LogFactory.getLog(DefaultLdapAuthoritiesPopulator.class); /** - * A default role which will be assigned to all authenticated users if set + * A default role which will be assigned to all authenticated users if set. */ private @Nullable GrantedAuthority defaultRole; /** - * Template that will be used for searching + * Template that will be used for searching. */ private final SpringSecurityLdapTemplate ldapTemplate; @@ -125,12 +125,12 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator private final SearchControls searchControls = new SearchControls(); /** - * The ID of the attribute which contains the role name for a group + * The ID of the attribute which contains the role name for a group. */ private String groupRoleAttribute = "cn"; /** - * The base DN from which the search for group membership should be performed + * The base DN from which the search for group membership should be performed. */ private final @Nullable String groupSearchBase; @@ -140,12 +140,12 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator private String groupSearchFilter = "(member={0})"; /** - * The role prefix that will be prepended to each role name + * The role prefix that will be prepended to each role name. */ private String rolePrefix = "ROLE_"; /** - * Should we convert the role name to uppercase + * Should we convert the role name to uppercase. */ private boolean convertToUpperCase = true; @@ -250,7 +250,7 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator } /** - * Convert the role to uppercase + * Convert the role to uppercase. */ public void setConvertToUpperCase(boolean convertToUpperCase) { this.convertToUpperCase = convertToUpperCase; @@ -327,7 +327,7 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator /** * Returns the attribute name of the LDAP attribute that will be mapped to the role - * name Method available so that classes extending this can override + * name Method available so that classes extending this can override. * @return the attribute name used for role mapping * @see #setGroupRoleAttribute(String) */ @@ -337,7 +337,7 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator /** * Returns the search filter configured for this populator Method available so that - * classes extending this can override + * classes extending this can override. * @return the search filter * @see #setGroupSearchFilter(String) */ @@ -347,7 +347,7 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator /** * Returns the role prefix used by this populator Method available so that classes - * extending this can override + * extending this can override. * @return the role prefix * @see #setRolePrefix(String) */ @@ -357,7 +357,7 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator /** * Returns true if role names are converted to uppercase Method available so that - * classes extending this can override + * classes extending this can override. * @return true if role names are converted to uppercase. * @see #setConvertToUpperCase(boolean) */ @@ -367,7 +367,7 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator /** * Returns the search controls Method available so that classes extending this can - * override the search controls used + * override the search controls used. * @return the search controls */ private SearchControls getSearchControls() { diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/InetOrgPersonContextMapper.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/InetOrgPersonContextMapper.java index a5770becd8..62d763084a 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/InetOrgPersonContextMapper.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/InetOrgPersonContextMapper.java @@ -25,6 +25,9 @@ import org.springframework.security.core.userdetails.UserDetails; import org.springframework.util.Assert; /** + * A {@link UserDetailsContextMapper} that maps user details to and from an + * {@link InetOrgPerson}. + * * @author Luke Taylor */ public class InetOrgPersonContextMapper implements UserDetailsContextMapper { diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapAuthority.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapAuthority.java index 3c586732d5..aea32973b4 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapAuthority.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapAuthority.java @@ -44,7 +44,7 @@ public class LdapAuthority implements GrantedAuthority { private final @Nullable Map> attributes; /** - * Constructs an LdapAuthority that has a role and a DN but no other attributes + * Constructs an LdapAuthority that has a role and a DN but no other attributes. * @param role the principal's role * @param dn the distinguished name */ @@ -53,7 +53,7 @@ public class LdapAuthority implements GrantedAuthority { } /** - * Constructs an LdapAuthority with the given role, DN and other LDAP attributes + * Constructs an LdapAuthority with the given role, DN and other LDAP attributes. * @param role the principal's role * @param dn the distinguished name * @param attributes additional LDAP attributes @@ -67,7 +67,7 @@ public class LdapAuthority implements GrantedAuthority { } /** - * Returns the LDAP attributes + * Returns the LDAP attributes. * @return the LDAP attributes, map can be null */ public @Nullable Map> getAttributes() { @@ -75,7 +75,7 @@ public class LdapAuthority implements GrantedAuthority { } /** - * Returns the DN for this LDAP authority + * Returns the DN for this LDAP authority. * @return the distinguished name */ public String getDn() { @@ -83,7 +83,7 @@ public class LdapAuthority implements GrantedAuthority { } /** - * Returns the values for a specific attribute + * Returns the values for a specific attribute. * @param name the attribute name * @return a String array, never null but may be zero length */ @@ -96,7 +96,7 @@ public class LdapAuthority implements GrantedAuthority { } /** - * Returns the first attribute value for a specified attribute + * Returns the first attribute value for a specified attribute. * @param name the attribute name * @return the first attribute value for a specified attribute, may be null */ diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsImpl.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsImpl.java index 2a0d2800cf..0eece0e724 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsImpl.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsImpl.java @@ -196,7 +196,7 @@ public class LdapUserDetailsImpl implements LdapUserDetails, PasswordPolicyData /** * Adds the authority to the list, unless it is already there, in which case it is - * ignored + * ignored. */ public void addAuthority(GrantedAuthority a) { if (!hasAuthority(a)) { diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManager.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManager.java index 2a5f296b91..821edc3fce 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManager.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManager.java @@ -95,16 +95,16 @@ public class LdapUserDetailsManager implements UserDetailsManager { */ LdapUsernameToDnMapper usernameMapper = new DefaultLdapUsernameToDnMapper("cn=users", "uid"); - /** The DN under which groups are stored */ + /** The DN under which groups are stored. */ private LdapName groupSearchBase = LdapNameBuilder.newInstance("cn=groups").build(); - /** Password attribute name */ + /** Password attribute name. */ private String passwordAttributeName = "userPassword"; /** The attribute which corresponds to the role name of a group. */ private String groupRoleAttributeName = "cn"; - /** The attribute which contains members of a group */ + /** The attribute which contains members of a group. */ private String groupMemberAttributeName = "uniquemember"; private String rolePrefix = "ROLE_"; @@ -121,7 +121,7 @@ public class LdapUserDetailsManager implements UserDetailsManager { private final LdapTemplate template; - /** Default context mapper used to create a set of roles from a list of attributes */ + /** Default context mapper used to create a set of roles from a list of attributes. */ private AttributesMapper roleMapper = (attributes) -> { Attribute roleAttr = attributes.get(this.groupRoleAttributeName); NamingEnumeration ne = roleAttr.getAll(); @@ -203,6 +203,7 @@ public class LdapUserDetailsManager implements UserDetailsManager { } /** + * Obtains the granted authorities for the given user via the group search. * @param dn the distinguished name of the entry - may be either relative to the base * context or a complete DN including the name of the context (either is supported). * @param username the user whose roles are required. diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsMapper.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsMapper.java index ff39c02f1c..789abd9671 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsMapper.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsMapper.java @@ -166,7 +166,7 @@ public class LdapUserDetailsMapper implements UserDetailsContextMapper { } /** - * The prefix that should be applied to the role names + * The prefix that should be applied to the role names. * @param rolePrefix the prefix (defaults to "ROLE_"). */ public void setRolePrefix(String rolePrefix) { diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulator.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulator.java index e64429a6d0..3f2a10b4c6 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulator.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/NestedLdapAuthoritiesPopulator.java @@ -127,12 +127,12 @@ public class NestedLdapAuthoritiesPopulator extends DefaultLdapAuthoritiesPopula private static final Log logger = LogFactory.getLog(NestedLdapAuthoritiesPopulator.class); /** - * The attribute names to retrieve for each LDAP group + * The attribute names to retrieve for each LDAP group. */ private Set attributeNames = new HashSet<>(); /** - * Maximum search depth - represents the number of recursive searches performed + * Maximum search depth - represents the number of recursive searches performed. */ private int maxSearchDepth = 10; @@ -159,7 +159,7 @@ public class NestedLdapAuthoritiesPopulator extends DefaultLdapAuthoritiesPopula } /** - * Performs the nested group search + * Performs the nested group search. * @param userDn - the userDN to search for, will become the group DN for subsequent * searches * @param username - the username of the user @@ -209,7 +209,7 @@ public class NestedLdapAuthoritiesPopulator extends DefaultLdapAuthoritiesPopula /** * Returns the attribute names that this populator has been configured to retrieve - * Value can be null, represents fetch all attributes + * Value can be null, represents fetch all attributes. * @return the attribute names or null for all */ private Set getAttributeNames() { diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/PersonContextMapper.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/PersonContextMapper.java index 7f7399dd97..41e560e6c7 100644 --- a/ldap/src/main/java/org/springframework/security/ldap/userdetails/PersonContextMapper.java +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/PersonContextMapper.java @@ -25,6 +25,8 @@ import org.springframework.security.core.userdetails.UserDetails; import org.springframework.util.Assert; /** + * A {@link UserDetailsContextMapper} which maps to and from a {@link Person}. + * * @author Luke Taylor */ public class PersonContextMapper implements UserDetailsContextMapper { diff --git a/messaging/src/main/java/org/springframework/security/messaging/access/expression/DefaultMessageSecurityExpressionHandler.java b/messaging/src/main/java/org/springframework/security/messaging/access/expression/DefaultMessageSecurityExpressionHandler.java index d63d7975e7..cf7ba6c64a 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/access/expression/DefaultMessageSecurityExpressionHandler.java +++ b/messaging/src/main/java/org/springframework/security/messaging/access/expression/DefaultMessageSecurityExpressionHandler.java @@ -65,6 +65,7 @@ public class DefaultMessageSecurityExpressionHandler extends AbstractSecurity } /** + * Sets the {@link AuthenticationTrustResolver} to use. * @deprecated Use * {@link #setAuthorizationManagerFactory(AuthorizationManagerFactory)} instead */ diff --git a/messaging/src/main/java/org/springframework/security/messaging/access/intercept/AuthorizationChannelInterceptor.java b/messaging/src/main/java/org/springframework/security/messaging/access/intercept/AuthorizationChannelInterceptor.java index 381ac65ad1..aa87ee630e 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/access/intercept/AuthorizationChannelInterceptor.java +++ b/messaging/src/main/java/org/springframework/security/messaging/access/intercept/AuthorizationChannelInterceptor.java @@ -37,7 +37,7 @@ import org.springframework.security.core.context.SecurityContextHolderStrategy; import org.springframework.util.Assert; /** - * Authorizes {@link Message} resources using the provided {@link AuthorizationManager} + * Authorizes {@link Message} resources using the provided {@link AuthorizationManager}. * * @author Josh Cummings * @since 5.8 @@ -54,7 +54,7 @@ public final class AuthorizationChannelInterceptor implements ChannelInterceptor private AuthorizationEventPublisher eventPublisher = new NoopAuthorizationEventPublisher(); /** - * Creates a new instance + * Creates a new instance. * @param preSendAuthorizationManager the {@link AuthorizationManager} to use. Cannot * be null. * diff --git a/messaging/src/main/java/org/springframework/security/messaging/access/intercept/MessageMatcherDelegatingAuthorizationManager.java b/messaging/src/main/java/org/springframework/security/messaging/access/intercept/MessageMatcherDelegatingAuthorizationManager.java index f0d06dbd69..f70c093203 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/access/intercept/MessageMatcherDelegatingAuthorizationManager.java +++ b/messaging/src/main/java/org/springframework/security/messaging/access/intercept/MessageMatcherDelegatingAuthorizationManager.java @@ -223,7 +223,7 @@ public final class MessageMatcherDelegatingAuthorizationManager implements Autho private final List> messageMatchers; /** - * Creates a new instance + * Creates a new instance. * @param messageMatchers the {@link MessageMatcher} instances to map to this * constraint */ @@ -331,7 +331,7 @@ public final class MessageMatcherDelegatingAuthorizationManager implements Autho } /** - * Allows specifying that Messages are secured by an arbitrary expression + * Allows specifying that Messages are secured by an arbitrary expression. * @param authorizationManager the {@link AuthorizationManager} to secure the * destinations * @return the {@link Builder} for further customization diff --git a/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/AuthenticationPrincipalArgumentResolver.java b/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/AuthenticationPrincipalArgumentResolver.java index b0a03bf2e0..ae0c4127e6 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/AuthenticationPrincipalArgumentResolver.java +++ b/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/AuthenticationPrincipalArgumentResolver.java @@ -114,7 +114,7 @@ public class AuthenticationPrincipalArgumentResolver implements HandlerMethodArg private ReactiveAdapterRegistry adapterRegistry = ReactiveAdapterRegistry.getSharedInstance(); /** - * Sets the {@link BeanResolver} to be used on the expressions + * Sets the {@link BeanResolver} to be used on the expressions. * @param beanResolver the {@link BeanResolver} to use */ public void setBeanResolver(BeanResolver beanResolver) { diff --git a/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/CurrentSecurityContextArgumentResolver.java b/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/CurrentSecurityContextArgumentResolver.java index be64352f47..3b48feb7c7 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/CurrentSecurityContextArgumentResolver.java +++ b/messaging/src/main/java/org/springframework/security/messaging/handler/invocation/reactive/CurrentSecurityContextArgumentResolver.java @@ -112,7 +112,7 @@ public class CurrentSecurityContextArgumentResolver implements HandlerMethodArgu private ReactiveAdapterRegistry adapterRegistry = ReactiveAdapterRegistry.getSharedInstance(); /** - * Sets the {@link BeanResolver} to be used on the expressions + * Sets the {@link BeanResolver} to be used on the expressions. * @param beanResolver the {@link BeanResolver} to use */ public void setBeanResolver(BeanResolver beanResolver) { diff --git a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AbstractMessageMatcherComposite.java b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AbstractMessageMatcherComposite.java index c0153aa434..0c33c9002d 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AbstractMessageMatcherComposite.java +++ b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AbstractMessageMatcherComposite.java @@ -25,7 +25,7 @@ import org.apache.commons.logging.LogFactory; import org.springframework.util.Assert; /** - * Abstract {@link MessageMatcher} containing multiple {@link MessageMatcher} + * Abstract {@link MessageMatcher} containing multiple {@link MessageMatcher}. * * @since 4.0 */ @@ -34,6 +34,7 @@ public abstract class AbstractMessageMatcherComposite implements MessageMatch protected final Log logger = LogFactory.getLog(getClass()); /** + * The logger used by subclasses. * @deprecated since 5.4 in favor of {@link #logger} */ @Deprecated @@ -42,7 +43,7 @@ public abstract class AbstractMessageMatcherComposite implements MessageMatch private final List> messageMatchers; /** - * Creates a new instance + * Creates a new instance. * @param messageMatchers the {@link MessageMatcher} instances to try */ AbstractMessageMatcherComposite(List> messageMatchers) { @@ -53,7 +54,7 @@ public abstract class AbstractMessageMatcherComposite implements MessageMatch } /** - * Creates a new instance + * Creates a new instance. * @param messageMatchers the {@link MessageMatcher} instances to try */ @SafeVarargs diff --git a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AndMessageMatcher.java b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AndMessageMatcher.java index afcec605f4..8c154d8f66 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AndMessageMatcher.java +++ b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/AndMessageMatcher.java @@ -30,7 +30,7 @@ import org.springframework.messaging.Message; public final class AndMessageMatcher extends AbstractMessageMatcherComposite { /** - * Creates a new instance + * Creates a new instance. * @param messageMatchers the {@link MessageMatcher} instances to try */ public AndMessageMatcher(List> messageMatchers) { @@ -38,7 +38,7 @@ public final class AndMessageMatcher extends AbstractMessageMatcherComposite< } /** - * Creates a new instance + * Creates a new instance. * @param messageMatchers the {@link MessageMatcher} instances to try */ @SafeVarargs diff --git a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/MessageMatcher.java b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/MessageMatcher.java index 1c8abaf514..71fe458ad3 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/MessageMatcher.java +++ b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/MessageMatcher.java @@ -30,7 +30,7 @@ import org.springframework.messaging.Message; public interface MessageMatcher { /** - * Matches every {@link Message} + * Matches every {@link Message}. */ MessageMatcher ANY_MESSAGE = new MessageMatcher<>() { @@ -47,7 +47,7 @@ public interface MessageMatcher { }; /** - * Returns true if the {@link Message} matches, else false + * Returns true if the {@link Message} matches, else false. * @param message the {@link Message} to match on * @return true if the {@link Message} matches, else false */ @@ -68,7 +68,7 @@ public interface MessageMatcher { /** * The result of matching against a {@code Message} contains the status, true or - * false, of the match and if present, any variables extracted from the match + * false, of the match and if present, any variables extracted from the match. * * @since 6.5 */ @@ -85,7 +85,7 @@ public interface MessageMatcher { /** * Return whether the comparison against the {@code Message} produced a successful - * match + * match. */ public boolean isMatch() { return this.match; @@ -93,7 +93,7 @@ public interface MessageMatcher { /** * Returns the extracted variable values where the key is the variable name and - * the value is the variable value + * the value is the variable value. * @return a map containing key-value pairs representing extracted variable names * and variable values */ @@ -102,7 +102,7 @@ public interface MessageMatcher { } /** - * Creates an instance of {@link MatchResult} that is a match with no variables + * Creates an instance of {@link MatchResult} that is a match with no variables. */ public static MatchResult match() { return new MatchResult(true, Collections.emptyMap()); @@ -110,7 +110,7 @@ public interface MessageMatcher { /** * Creates an instance of {@link MatchResult} that is a match with the specified - * variables + * variables. */ public static MatchResult match(Map variables) { return new MatchResult(true, variables); diff --git a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/OrMessageMatcher.java b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/OrMessageMatcher.java index 960201466b..f96a6b98d0 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/OrMessageMatcher.java +++ b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/OrMessageMatcher.java @@ -30,7 +30,7 @@ import org.springframework.messaging.Message; public final class OrMessageMatcher extends AbstractMessageMatcherComposite { /** - * Creates a new instance + * Creates a new instance. * @param messageMatchers the {@link MessageMatcher} instances to try */ public OrMessageMatcher(List> messageMatchers) { @@ -38,7 +38,7 @@ public final class OrMessageMatcher extends AbstractMessageMatcherComposite { /** * Initialize this builder with the {@link PathPatternParser#defaultInstance} that is * configured with the - * {@link org.springframework.http.server.PathContainer.Options#HTTP_PATH} separator + * {@link org.springframework.http.server.PathContainer.Options#HTTP_PATH} separator. */ public static Builder withDefaults() { return new Builder(PathPatternParser.defaultInstance); } /** - * Initialize this builder with the provided {@link PathPatternParser} + * Initialize this builder with the provided {@link PathPatternParser}. */ public static Builder withPathPatternParser(PathPatternParser parser) { return new Builder(parser); @@ -87,7 +87,7 @@ public final class PathPatternMessageMatcher implements MessageMatcher { /** * Extract the path variables from the {@link Message} destination if the path is a * match, otherwise the {@link MatchResult#getVariables()} returns a - * {@link Collections#emptyMap()} + * {@link Collections#emptyMap()}. * @param message the message whose path variables to extract. * @return a {@code MatchResult} of the path variables and values. */ diff --git a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/SimpMessageTypeMatcher.java b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/SimpMessageTypeMatcher.java index 5f66d29f40..ff05181fa3 100644 --- a/messaging/src/main/java/org/springframework/security/messaging/util/matcher/SimpMessageTypeMatcher.java +++ b/messaging/src/main/java/org/springframework/security/messaging/util/matcher/SimpMessageTypeMatcher.java @@ -38,7 +38,7 @@ public class SimpMessageTypeMatcher implements MessageMatcher { private final SimpMessageType typeToMatch; /** - * Creates a new instance + * Creates a new instance. * @param typeToMatch the {@link SimpMessageType} that will result in a match. Cannot * be null. */ diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2AuthorizationServerMetadataClaimNames.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2AuthorizationServerMetadataClaimNames.java index fabc2c5a08..649123dfe7 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2AuthorizationServerMetadataClaimNames.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2AuthorizationServerMetadataClaimNames.java @@ -46,7 +46,7 @@ public class OAuth2AuthorizationServerMetadataClaimNames { /** * {@code issuer} - the {@code URL} the Authorization Server asserts as its Issuer - * Identifier + * Identifier. */ public static final String ISSUER = "issuer"; @@ -80,7 +80,7 @@ public class OAuth2AuthorizationServerMetadataClaimNames { public static final String TOKEN_ENDPOINT_AUTH_METHODS_SUPPORTED = "token_endpoint_auth_methods_supported"; /** - * {@code jwks_uri} - the {@code URL} of the JSON Web Key Set + * {@code jwks_uri} - the {@code URL} of the JSON Web Key Set. */ public static final String JWKS_URI = "jwks_uri"; @@ -132,19 +132,19 @@ public class OAuth2AuthorizationServerMetadataClaimNames { /** * {@code code_challenge_methods_supported} - the Proof Key for Code Exchange (PKCE) - * {@code code_challenge_method} values supported + * {@code code_challenge_method} values supported. */ public static final String CODE_CHALLENGE_METHODS_SUPPORTED = "code_challenge_methods_supported"; /** * {@code tls_client_certificate_bound_access_tokens} - {@code true} to indicate - * support for mutual-TLS client certificate-bound access tokens + * support for mutual-TLS client certificate-bound access tokens. */ public static final String TLS_CLIENT_CERTIFICATE_BOUND_ACCESS_TOKENS = "tls_client_certificate_bound_access_tokens"; /** * {@code dpop_signing_alg_values_supported} - the {@link JwsAlgorithms JSON Web - * Signature (JWS) algorithms} supported for DPoP Proof JWTs + * Signature (JWS) algorithms} supported for DPoP Proof JWTs. */ public static final String DPOP_SIGNING_ALG_VALUES_SUPPORTED = "dpop_signing_alg_values_supported"; diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2ClientMetadataClaimNames.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2ClientMetadataClaimNames.java index 7ec6ad4358..311299205d 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2ClientMetadataClaimNames.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/OAuth2ClientMetadataClaimNames.java @@ -28,39 +28,39 @@ package org.springframework.security.oauth2.server.authorization; public class OAuth2ClientMetadataClaimNames { /** - * {@code client_id} - the Client Identifier + * {@code client_id} - the Client Identifier. */ public static final String CLIENT_ID = "client_id"; /** - * {@code client_id_issued_at} - the time at which the Client Identifier was issued + * {@code client_id_issued_at} - the time at which the Client Identifier was issued. */ public static final String CLIENT_ID_ISSUED_AT = "client_id_issued_at"; /** - * {@code client_secret} - the Client Secret + * {@code client_secret} - the Client Secret. */ public static final String CLIENT_SECRET = "client_secret"; /** * {@code client_secret_expires_at} - the time at which the {@code client_secret} will - * expire or 0 if it will not expire + * expire or 0 if it will not expire. */ public static final String CLIENT_SECRET_EXPIRES_AT = "client_secret_expires_at"; /** - * {@code client_name} - the name of the Client to be presented to the End-User + * {@code client_name} - the name of the Client to be presented to the End-User. */ public static final String CLIENT_NAME = "client_name"; /** - * {@code redirect_uris} - the redirection {@code URI} values used by the Client + * {@code redirect_uris} - the redirection {@code URI} values used by the Client. */ public static final String REDIRECT_URIS = "redirect_uris"; /** * {@code token_endpoint_auth_method} - the authentication method used by the Client - * for the Token Endpoint + * for the Token Endpoint. */ public static final String TOKEN_ENDPOINT_AUTH_METHOD = "token_endpoint_auth_method"; @@ -83,7 +83,7 @@ public class OAuth2ClientMetadataClaimNames { public static final String SCOPE = "scope"; /** - * {@code jwks_uri} - the {@code URL} for the Client's JSON Web Key Set + * {@code jwks_uri} - the {@code URL} for the Client's JSON Web Key Set. */ public static final String JWKS_URI = "jwks_uri"; diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/JwsAlgorithmMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/JwsAlgorithmMixin.java index 610ff73a77..8ef6b00095 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/JwsAlgorithmMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/JwsAlgorithmMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.oauth2.server.authorization.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.oauth2.jose.jws.SignatureAlgorithm; @@ -28,9 +30,9 @@ import org.springframework.security.oauth2.jose.jws.SignatureAlgorithm; * @since 7.0 * @see SignatureAlgorithm */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class JwsAlgorithmMixin { } diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2AuthorizationRequestMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2AuthorizationRequestMixin.java index c451f8cf2d..7f0485e5ad 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2AuthorizationRequestMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2AuthorizationRequestMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.oauth2.server.authorization.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import tools.jackson.databind.annotation.JsonDeserialize; import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest; @@ -31,10 +33,10 @@ import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequ * @see OAuth2AuthorizationRequest * @see OAuth2AuthorizationRequestDeserializer */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonDeserialize(using = OAuth2AuthorizationRequestDeserializer.class) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class OAuth2AuthorizationRequestMixin { } diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeActorMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeActorMixin.java index 0e81cd1060..6b5e37de60 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeActorMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeActorMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.oauth2.server.authorization.jackson; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.oauth2.server.authorization.authentication.OAuth2TokenExchangeActor; @@ -32,9 +34,9 @@ import org.springframework.security.oauth2.server.authorization.authentication.O * @since 7.0 * @see OAuth2TokenExchangeActor */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.NONE) abstract class OAuth2TokenExchangeActorMixin { @JsonCreator diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java index a9d802ce77..03f3838eb6 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.oauth2.server.authorization.jackson; import java.util.List; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.Authentication; import org.springframework.security.oauth2.server.authorization.authentication.OAuth2TokenExchangeCompositeAuthenticationToken; @@ -34,9 +36,9 @@ import org.springframework.security.oauth2.server.authorization.authentication.O * @since 7.0 * @see OAuth2TokenExchangeCompositeAuthenticationToken */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.NONE) abstract class OAuth2TokenExchangeCompositeAuthenticationTokenMixin { @JsonCreator diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenFormatMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenFormatMixin.java index 6a21ce580d..2e8b72ad36 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenFormatMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson/OAuth2TokenFormatMixin.java @@ -17,9 +17,11 @@ package org.springframework.security.oauth2.server.authorization.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.oauth2.server.authorization.settings.OAuth2TokenFormat; @@ -30,9 +32,9 @@ import org.springframework.security.oauth2.server.authorization.settings.OAuth2T * @since 7.0 * @see OAuth2TokenFormat */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class OAuth2TokenFormatMixin { @JsonCreator diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/DurationMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/DurationMixin.java index 3b801dfd72..be88f8c91b 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/DurationMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/DurationMixin.java @@ -19,10 +19,12 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import java.time.Duration; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonGetter; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * This mixin class is used to serialize/deserialize {@link Duration}. @@ -32,10 +34,9 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @see Duration * @deprecated as of 7.0 */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, setterVisibility = JsonAutoDetect.Visibility.NONE, - creatorVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.NONE, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE, creatorVisibility = Visibility.NONE) @Deprecated(forRemoval = true) abstract class DurationMixin { diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/HashSetMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/HashSetMixin.java index 629c15c97d..a2aac4a866 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/HashSetMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/HashSetMixin.java @@ -21,6 +21,7 @@ import java.util.Set; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * This mixin class is used to serialize/deserialize {@link HashSet}. @@ -30,7 +31,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @see HashSet * @deprecated as of 7.0 */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @Deprecated(forRemoval = true) abstract class HashSetMixin { diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/JwsAlgorithmMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/JwsAlgorithmMixin.java index b9d1f3769e..883bb1d4df 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/JwsAlgorithmMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/JwsAlgorithmMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.oauth2.jose.jws.SignatureAlgorithm; @@ -32,9 +34,9 @@ import org.springframework.security.oauth2.jose.jws.SignatureAlgorithm; * based on Jackson 3 */ @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class JwsAlgorithmMixin { } diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2AuthorizationRequestMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2AuthorizationRequestMixin.java index 1370788776..001488eab2 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2AuthorizationRequestMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2AuthorizationRequestMixin.java @@ -17,8 +17,10 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest; @@ -37,10 +39,10 @@ import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequ */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonDeserialize(using = OAuth2AuthorizationRequestDeserializer.class) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class OAuth2AuthorizationRequestMixin { diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeActorMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeActorMixin.java index e163318af3..0d1844fa24 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeActorMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeActorMixin.java @@ -19,10 +19,12 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.oauth2.server.authorization.authentication.OAuth2TokenExchangeActor; @@ -37,9 +39,9 @@ import org.springframework.security.oauth2.server.authorization.authentication.O * based on Jackson 3 */ @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class OAuth2TokenExchangeActorMixin { diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java index c7ba8b407c..022a840ec6 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenExchangeCompositeAuthenticationTokenMixin.java @@ -19,10 +19,12 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import java.util.List; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.Authentication; import org.springframework.security.oauth2.server.authorization.authentication.OAuth2TokenExchangeCompositeAuthenticationToken; @@ -39,9 +41,9 @@ import org.springframework.security.oauth2.server.authorization.authentication.O * based on Jackson 3 */ @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) abstract class OAuth2TokenExchangeCompositeAuthenticationTokenMixin { diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenFormatMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenFormatMixin.java index b275c5c487..e97fdb4ccc 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenFormatMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/OAuth2TokenFormatMixin.java @@ -17,9 +17,11 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.oauth2.server.authorization.settings.OAuth2TokenFormat; @@ -34,9 +36,9 @@ import org.springframework.security.oauth2.server.authorization.settings.OAuth2T * based on Jackson 3 */ @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class OAuth2TokenFormatMixin { @JsonCreator diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/StringArrayMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/StringArrayMixin.java index 8f2ec97fa4..f861e3f107 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/StringArrayMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/StringArrayMixin.java @@ -18,6 +18,7 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * This mixin class is used to serialize/deserialize {@link String} array. @@ -28,7 +29,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @deprecated as of 7.0 */ @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) abstract class StringArrayMixin { @JsonCreator diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/UnmodifiableMapMixin.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/UnmodifiableMapMixin.java index e9c6d29585..a03a513448 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/UnmodifiableMapMixin.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/jackson2/UnmodifiableMapMixin.java @@ -21,6 +21,7 @@ import java.util.Map; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** @@ -36,7 +37,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonDeserialize(using = UnmodifiableMapDeserializer.class) abstract class UnmodifiableMapMixin { diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcClientMetadataClaimNames.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcClientMetadataClaimNames.java index 2527330e23..8f971a64a2 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcClientMetadataClaimNames.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcClientMetadataClaimNames.java @@ -52,25 +52,25 @@ public final class OidcClientMetadataClaimNames extends OAuth2ClientMetadataClai * that must be used for signing the {@link Jwt JWT} used to authenticate the Client * at the Token Endpoint for the {@link ClientAuthenticationMethod#PRIVATE_KEY_JWT * private_key_jwt} and {@link ClientAuthenticationMethod#CLIENT_SECRET_JWT - * client_secret_jwt} authentication methods + * client_secret_jwt} authentication methods. */ public static final String TOKEN_ENDPOINT_AUTH_SIGNING_ALG = "token_endpoint_auth_signing_alg"; /** * {@code id_token_signed_response_alg} - the {@link JwsAlgorithm JWS} algorithm - * required for signing the {@link OidcIdToken ID Token} issued to the Client + * required for signing the {@link OidcIdToken ID Token} issued to the Client. */ public static final String ID_TOKEN_SIGNED_RESPONSE_ALG = "id_token_signed_response_alg"; /** * {@code registration_access_token} - the Registration Access Token that can be used - * at the Client Configuration Endpoint + * at the Client Configuration Endpoint. */ public static final String REGISTRATION_ACCESS_TOKEN = "registration_access_token"; /** * {@code registration_client_uri} - the {@code URL} of the Client Configuration - * Endpoint where the Registration Access Token can be used + * Endpoint where the Registration Access Token can be used. */ public static final String REGISTRATION_CLIENT_URI = "registration_client_uri"; diff --git a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcProviderMetadataClaimNames.java b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcProviderMetadataClaimNames.java index bff7280614..e28916d97a 100644 --- a/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcProviderMetadataClaimNames.java +++ b/oauth2/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/OidcProviderMetadataClaimNames.java @@ -35,13 +35,13 @@ import org.springframework.security.oauth2.server.authorization.OAuth2Authorizat public final class OidcProviderMetadataClaimNames extends OAuth2AuthorizationServerMetadataClaimNames { /** - * {@code subject_types_supported} - the Subject Identifier types supported + * {@code subject_types_supported} - the Subject Identifier types supported. */ public static final String SUBJECT_TYPES_SUPPORTED = "subject_types_supported"; /** * {@code id_token_signing_alg_values_supported} - the {@link JwsAlgorithm JWS} - * signing algorithms supported for the {@link OidcIdToken ID Token} + * signing algorithms supported for the {@link OidcIdToken ID Token}. */ public static final String ID_TOKEN_SIGNING_ALG_VALUES_SUPPORTED = "id_token_signing_alg_values_supported"; diff --git a/oauth2/oauth2-authorization-server/src/test/java/org/springframework/security/oauth2/server/authorization/jackson2/TestingAuthenticationTokenMixin.java b/oauth2/oauth2-authorization-server/src/test/java/org/springframework/security/oauth2/server/authorization/jackson2/TestingAuthenticationTokenMixin.java index e3d0e690e9..3f185519e7 100644 --- a/oauth2/oauth2-authorization-server/src/test/java/org/springframework/security/oauth2/server/authorization/jackson2/TestingAuthenticationTokenMixin.java +++ b/oauth2/oauth2-authorization-server/src/test/java/org/springframework/security/oauth2/server/authorization/jackson2/TestingAuthenticationTokenMixin.java @@ -19,10 +19,12 @@ package org.springframework.security.oauth2.server.authorization.jackson2; import java.util.List; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.authentication.TestingAuthenticationToken; import org.springframework.security.core.GrantedAuthority; @@ -34,9 +36,9 @@ import org.springframework.security.core.GrantedAuthority; * @since 7.0 * @see TestingAuthenticationToken */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(value = { "authenticated" }, ignoreUnknown = true) public class TestingAuthenticationTokenMixin { diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/aot/hint/OAuth2ClientRuntimeHints.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/aot/hint/OAuth2ClientRuntimeHints.java index 4dd6c4a397..c22ef7ac86 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/aot/hint/OAuth2ClientRuntimeHints.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/aot/hint/OAuth2ClientRuntimeHints.java @@ -25,7 +25,7 @@ import org.springframework.aot.hint.TypeReference; import org.springframework.util.ClassUtils; /** - * {@link RuntimeHintsRegistrar} for OAuth2 Client + * {@link RuntimeHintsRegistrar} for OAuth2 Client. * * @author Marcus Da Coregio * @since 6.0 diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthenticationToken.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthenticationToken.java index 44e6875dc1..c6e04e37ae 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthenticationToken.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthenticationToken.java @@ -101,7 +101,7 @@ public class OAuth2AuthenticationToken extends AbstractAuthenticationToken { } /** - * A builder of {@link OAuth2AuthenticationToken} instances + * A builder of {@link OAuth2AuthenticationToken} instances. * * @since 7.0 */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthorizationCodeAuthenticationToken.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthorizationCodeAuthenticationToken.java index 2ec0a56e01..00b769b5cf 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthorizationCodeAuthenticationToken.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/authentication/OAuth2AuthorizationCodeAuthenticationToken.java @@ -151,7 +151,7 @@ public class OAuth2AuthorizationCodeAuthenticationToken extends AbstractAuthenti } /** - * Returns the additional parameters + * Returns the additional parameters. * @return the additional parameters */ public Map getAdditionalParameters() { diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/endpoint/AbstractWebClientReactiveOAuth2AccessTokenResponseClient.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/endpoint/AbstractWebClientReactiveOAuth2AccessTokenResponseClient.java index 93f9189069..44d702c24c 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/endpoint/AbstractWebClientReactiveOAuth2AccessTokenResponseClient.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/endpoint/AbstractWebClientReactiveOAuth2AccessTokenResponseClient.java @@ -243,7 +243,7 @@ public abstract class AbstractWebClientReactiveOAuth2AccessTokenResponseClient getEvents() { @@ -86,7 +86,8 @@ public interface LogoutTokenClaimAccessor extends ClaimAccessor { } /** - * Returns a {@code String} value {@code (sid)} representing the OIDC Provider session + * Returns a {@code String} value {@code (sid)} representing the OIDC Provider + * session. * @return the value representing the OIDC Provider session */ default @Nullable String getSessionId() { diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/LogoutTokenClaimNames.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/LogoutTokenClaimNames.java index 4d04ba8f6f..ddbbbe0772 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/LogoutTokenClaimNames.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/LogoutTokenClaimNames.java @@ -30,37 +30,37 @@ package org.springframework.security.oauth2.client.oidc.authentication.logout; public final class LogoutTokenClaimNames { /** - * {@code jti} - the JTI identifier + * {@code jti} - the JTI identifier. */ public static final String JTI = "jti"; /** - * {@code iss} - the Issuer identifier + * {@code iss} - the Issuer identifier. */ public static final String ISS = "iss"; /** - * {@code sub} - the Subject identifier + * {@code sub} - the Subject identifier. */ public static final String SUB = "sub"; /** - * {@code aud} - the Audience(s) that the ID Token is intended for + * {@code aud} - the Audience(s) that the ID Token is intended for. */ public static final String AUD = "aud"; /** - * {@code iat} - the time at which the ID Token was issued + * {@code iat} - the time at which the ID Token was issued. */ public static final String IAT = "iat"; /** - * {@code events} - a JSON object that identifies this token as a logout token + * {@code events} - a JSON object that identifies this token as a logout token. */ public static final String EVENTS = "events"; /** - * {@code sid} - the session id for the OIDC provider + * {@code sid} - the session id for the OIDC provider. */ public static final String SID = "sid"; diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/OidcLogoutToken.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/OidcLogoutToken.java index e7000ce628..7c3a86aeb1 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/OidcLogoutToken.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/authentication/logout/OidcLogoutToken.java @@ -73,7 +73,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Create a {@link OidcLogoutToken.Builder} based on the given token value + * Create a {@link OidcLogoutToken.Builder} based on the given token value. * @param tokenValue the token value to use * @return the {@link OidcLogoutToken.Builder} for further configuration */ @@ -82,7 +82,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * A builder for {@link OidcLogoutToken}s + * A builder for {@link OidcLogoutToken}s. * * @author Josh Cummings */ @@ -99,7 +99,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this token value in the resulting {@link OidcLogoutToken} + * Use this token value in the resulting {@link OidcLogoutToken}. * @param tokenValue The token value to use * @return the {@link Builder} for further configurations */ @@ -109,7 +109,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this claim in the resulting {@link OidcLogoutToken} + * Use this claim in the resulting {@link OidcLogoutToken}. * @param name The claim name * @param value The claim value * @return the {@link Builder} for further configurations @@ -131,7 +131,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this audience in the resulting {@link OidcLogoutToken} + * Use this audience in the resulting {@link OidcLogoutToken}. * @param audience The audience(s) to use * @return the {@link Builder} for further configurations */ @@ -140,7 +140,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this issued-at timestamp in the resulting {@link OidcLogoutToken} + * Use this issued-at timestamp in the resulting {@link OidcLogoutToken}. * @param issuedAt The issued-at timestamp to use * @return the {@link Builder} for further configurations */ @@ -149,7 +149,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this issuer in the resulting {@link OidcLogoutToken} + * Use this issuer in the resulting {@link OidcLogoutToken}. * @param issuer The issuer to use * @return the {@link Builder} for further configurations */ @@ -158,7 +158,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this id to identify the resulting {@link OidcLogoutToken} + * Use this id to identify the resulting {@link OidcLogoutToken}. * @param jti The unique identifier to use * @return the {@link Builder} for further configurations */ @@ -167,7 +167,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this subject in the resulting {@link OidcLogoutToken} + * Use this subject in the resulting {@link OidcLogoutToken}. * @param subject The subject to use * @return the {@link Builder} for further configurations */ @@ -176,7 +176,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * A JSON object that identifies this token as a logout token + * A JSON object that identifies this token as a logout token. * @param events The JSON object to use * @return the {@link Builder} for further configurations */ @@ -185,7 +185,7 @@ public class OidcLogoutToken extends AbstractOAuth2Token implements LogoutTokenC } /** - * Use this session id to correlate the OIDC Provider session + * Use this session id to correlate the OIDC Provider session. * @param sessionId The session id to use * @return the {@link Builder} for further configurations */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/server/session/InMemoryReactiveOidcSessionRegistry.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/server/session/InMemoryReactiveOidcSessionRegistry.java index 8a6c278834..6394368e2d 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/server/session/InMemoryReactiveOidcSessionRegistry.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/server/session/InMemoryReactiveOidcSessionRegistry.java @@ -25,7 +25,7 @@ import org.springframework.security.oauth2.client.oidc.session.OidcSessionInform /** * An in-memory implementation of - * {@link org.springframework.security.oauth2.client.oidc.server.session.ReactiveOidcSessionRegistry} + * {@link org.springframework.security.oauth2.client.oidc.server.session.ReactiveOidcSessionRegistry}. * * @author Josh Cummings * @since 6.2 diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/InMemoryOidcSessionRegistry.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/InMemoryOidcSessionRegistry.java index ffcba6a037..fecf2cc6d0 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/InMemoryOidcSessionRegistry.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/InMemoryOidcSessionRegistry.java @@ -33,7 +33,7 @@ import org.springframework.security.oauth2.client.oidc.authentication.logout.Log import org.springframework.security.oauth2.client.oidc.authentication.logout.OidcLogoutToken; /** - * An in-memory implementation of {@link OidcSessionRegistry} + * An in-memory implementation of {@link OidcSessionRegistry}. * * @author Josh Cummings * @since 6.2 diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/OidcSessionInformation.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/OidcSessionInformation.java index bcf9ab5c86..aa2ba82ad5 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/OidcSessionInformation.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/session/OidcSessionInformation.java @@ -40,7 +40,7 @@ public class OidcSessionInformation extends SessionInformation { private final Map authorities; /** - * Construct an {@link OidcSessionInformation} + * Construct an {@link OidcSessionInformation}. * @param sessionId the Client's session id * @param authorities any material that authorizes operating on the session * @param user the OIDC Provider's session and end user @@ -51,7 +51,7 @@ public class OidcSessionInformation extends SessionInformation { } /** - * Any material needed to authorize operations on this session + * Any material needed to authorize operations on this session. * @return the {@link Map} of credentials */ public Map getAuthorities() { @@ -67,7 +67,7 @@ public class OidcSessionInformation extends SessionInformation { } /** - * Copy this {@link OidcSessionInformation}, using a new session identifier + * Copy this {@link OidcSessionInformation}, using a new session identifier. * @param sessionId the new session identifier to use * @return a new {@link OidcSessionInformation} instance */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/userinfo/OidcUserRequestUtils.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/userinfo/OidcUserRequestUtils.java index ea4e383b68..1eddab6bf6 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/userinfo/OidcUserRequestUtils.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/userinfo/OidcUserRequestUtils.java @@ -31,7 +31,7 @@ import org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority; import org.springframework.util.StringUtils; /** - * Utilities for working with the {@link OidcUserRequest} + * Utilities for working with the {@link OidcUserRequest}. * * @author Rob Winch * @since 5.1 diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/web/server/logout/OidcClientInitiatedServerLogoutSuccessHandler.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/web/server/logout/OidcClientInitiatedServerLogoutSuccessHandler.java index 66534bad16..f8cd7bb78e 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/web/server/logout/OidcClientInitiatedServerLogoutSuccessHandler.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/oidc/web/server/logout/OidcClientInitiatedServerLogoutSuccessHandler.java @@ -64,7 +64,7 @@ public class OidcClientInitiatedServerLogoutSuccessHandler implements ServerLogo /** * Constructs an {@link OidcClientInitiatedServerLogoutSuccessHandler} with the - * provided parameters + * provided parameters. * @param clientRegistrationRepository The * {@link ReactiveClientRegistrationRepository} to use to derive the * end_session_endpoint value @@ -184,7 +184,7 @@ public class OidcClientInitiatedServerLogoutSuccessHandler implements ServerLogo /** * The URL to redirect to after successfully logging out when not originally an OIDC - * login + * login. * @param logoutSuccessUrl the url to redirect to. Default is "/login?logout". */ public void setLogoutSuccessUrl(URI logoutSuccessUrl) { @@ -194,7 +194,7 @@ public class OidcClientInitiatedServerLogoutSuccessHandler implements ServerLogo /** * Set the {@link Converter} that converts {@link RedirectUriParameters} to redirect - * URI + * URI. * @param redirectUriResolver {@link Converter} * @since 6.5 */ @@ -205,7 +205,7 @@ public class OidcClientInitiatedServerLogoutSuccessHandler implements ServerLogo /** * Set the {@link ServerRedirectStrategy} to use, default - * {@link DefaultServerRedirectStrategy} + * {@link DefaultServerRedirectStrategy}. * @param redirectStrategy {@link ServerRedirectStrategy} * @since 6.5 */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/userinfo/DefaultReactiveOAuth2UserService.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/userinfo/DefaultReactiveOAuth2UserService.java index 452ba95a0d..038fea8fed 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/userinfo/DefaultReactiveOAuth2UserService.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/userinfo/DefaultReactiveOAuth2UserService.java @@ -217,7 +217,7 @@ public class DefaultReactiveOAuth2UserService implements ReactiveOAuth2UserServi } /** - * Sets the {@link WebClient} used for retrieving the user endpoint + * Sets the {@link WebClient} used for retrieving the user endpoint. * @param webClient the client to use */ public void setWebClient(WebClient webClient) { diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/HttpSessionOAuth2AuthorizationRequestRepository.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/HttpSessionOAuth2AuthorizationRequestRepository.java index 4a95ce1d9a..9da141338d 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/HttpSessionOAuth2AuthorizationRequestRepository.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/HttpSessionOAuth2AuthorizationRequestRepository.java @@ -82,7 +82,7 @@ public final class HttpSessionOAuth2AuthorizationRequestRepository } /** - * Gets the state parameter from the {@link HttpServletRequest} + * Gets the state parameter from the {@link HttpServletRequest}. * @param request the request to use * @return the state parameter or null if not found */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/InvalidClientRegistrationIdException.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/InvalidClientRegistrationIdException.java index 9b785418fe..2b5d182333 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/InvalidClientRegistrationIdException.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/InvalidClientRegistrationIdException.java @@ -17,6 +17,8 @@ package org.springframework.security.oauth2.client.web; /** + * Thrown when a client registration id cannot be resolved. + * * @author Steve Riesenberg * @since 5.8 */ @@ -24,6 +26,7 @@ package org.springframework.security.oauth2.client.web; class InvalidClientRegistrationIdException extends IllegalArgumentException { /** + * Creates a new instance with the given message. * @param message the exception message */ InvalidClientRegistrationIdException(String message) { diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/reactive/function/client/ServletOAuth2AuthorizedClientExchangeFilterFunction.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/reactive/function/client/ServletOAuth2AuthorizedClientExchangeFilterFunction.java index f0e1f62fde..da5dc0d8e7 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/reactive/function/client/ServletOAuth2AuthorizedClientExchangeFilterFunction.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/reactive/function/client/ServletOAuth2AuthorizedClientExchangeFilterFunction.java @@ -273,7 +273,7 @@ public final class ServletOAuth2AuthorizedClientExchangeFilterFunction implement /** * Configures the builder with {@link #defaultRequest()} and adds this as a - * {@link ExchangeFilterFunction} + * {@link ExchangeFilterFunction}. * @return the {@link Consumer} to configure the builder */ public Consumer oauth2Configuration() { diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository.java index a0f6e49b99..9bae662b2f 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository.java @@ -55,7 +55,7 @@ public final class AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository private ServerOAuth2AuthorizedClientRepository anonymousAuthorizedClientRepository = new WebSessionServerOAuth2AuthorizedClientRepository(); /** - * Creates an instance + * Creates an instance. * @param authorizedClientService the authorized client service */ public AuthenticatedPrincipalServerOAuth2AuthorizedClientRepository( diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/DefaultServerOAuth2AuthorizationRequestResolver.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/DefaultServerOAuth2AuthorizationRequestResolver.java index f208f109d0..e9703db07e 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/DefaultServerOAuth2AuthorizationRequestResolver.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/DefaultServerOAuth2AuthorizationRequestResolver.java @@ -67,13 +67,13 @@ public class DefaultServerOAuth2AuthorizationRequestResolver implements ServerOA /** * The name of the path variable that contains the - * {@link ClientRegistration#getRegistrationId()} + * {@link ClientRegistration#getRegistrationId()}. */ public static final String DEFAULT_REGISTRATION_ID_URI_VARIABLE_NAME = "registrationId"; /** * The default pattern used to resolve the - * {@link ClientRegistration#getRegistrationId()} + * {@link ClientRegistration#getRegistrationId()}. */ public static final String DEFAULT_AUTHORIZATION_REQUEST_PATTERN = "/oauth2/authorization/{" + DEFAULT_REGISTRATION_ID_URI_VARIABLE_NAME + "}"; @@ -97,7 +97,7 @@ public class DefaultServerOAuth2AuthorizationRequestResolver implements ServerOA }; /** - * Creates a new instance + * Creates a new instance. * @param clientRegistrationRepository the repository to resolve the * {@link ClientRegistration} */ @@ -108,7 +108,7 @@ public class DefaultServerOAuth2AuthorizationRequestResolver implements ServerOA } /** - * Creates a new instance + * Creates a new instance. * @param clientRegistrationRepository the repository to resolve the * {@link ClientRegistration} * @param authorizationRequestMatcher the matcher that determines if the request is a diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/WebSessionOAuth2ServerAuthorizationRequestRepository.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/WebSessionOAuth2ServerAuthorizationRequestRepository.java index 87814f2806..ce8e212919 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/WebSessionOAuth2ServerAuthorizationRequestRepository.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/WebSessionOAuth2ServerAuthorizationRequestRepository.java @@ -98,7 +98,7 @@ public final class WebSessionOAuth2ServerAuthorizationRequestRepository } /** - * Gets the state parameter from the {@link ServerHttpRequest} + * Gets the state parameter from the {@link ServerHttpRequest}. * @param exchange the exchange to use * @return the state parameter or null if not found */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/authentication/OAuth2LoginAuthenticationWebFilter.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/authentication/OAuth2LoginAuthenticationWebFilter.java index 0059df58e0..5da1a4483c 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/authentication/OAuth2LoginAuthenticationWebFilter.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/server/authentication/OAuth2LoginAuthenticationWebFilter.java @@ -31,7 +31,7 @@ import org.springframework.util.Assert; /** * A specialized {@link AuthenticationWebFilter} that converts from an * {@link OAuth2LoginAuthenticationToken} to an {@link OAuth2AuthenticationToken} and - * saves the {@link OAuth2AuthorizedClient} + * saves the {@link OAuth2AuthorizedClient}. * * @author Rob Winch * @since 5.1 @@ -41,7 +41,7 @@ public class OAuth2LoginAuthenticationWebFilter extends AuthenticationWebFilter private final ServerOAuth2AuthorizedClientRepository authorizedClientRepository; /** - * Creates an instance + * Creates an instance. * @param authenticationManager the authentication manager to use * @param authorizedClientRepository */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/AuthorizationGrantType.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/AuthorizationGrantType.java index efe984dfc0..036b9cecac 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/AuthorizationGrantType.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/AuthorizationGrantType.java @@ -49,18 +49,21 @@ public final class AuthorizationGrantType implements Serializable { public static final AuthorizationGrantType CLIENT_CREDENTIALS = new AuthorizationGrantType("client_credentials"); /** + * The jwt-bearer authorization grant type. * @since 5.5 */ public static final AuthorizationGrantType JWT_BEARER = new AuthorizationGrantType( "urn:ietf:params:oauth:grant-type:jwt-bearer"); /** + * The device_code authorization grant type. * @since 6.1 */ public static final AuthorizationGrantType DEVICE_CODE = new AuthorizationGrantType( "urn:ietf:params:oauth:grant-type:device_code"); /** + * The token-exchange authorization grant type. * @since 6.3 */ public static final AuthorizationGrantType TOKEN_EXCHANGE = new AuthorizationGrantType( diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/ClientAuthenticationMethod.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/ClientAuthenticationMethod.java index 151c8a2080..ecaad61022 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/ClientAuthenticationMethod.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/ClientAuthenticationMethod.java @@ -36,39 +36,46 @@ public final class ClientAuthenticationMethod implements Serializable { private static final long serialVersionUID = 620L; /** + * The client_secret_basic authentication method. * @since 5.5 */ public static final ClientAuthenticationMethod CLIENT_SECRET_BASIC = new ClientAuthenticationMethod( "client_secret_basic"); /** + * The client_secret_post authentication method. * @since 5.5 */ public static final ClientAuthenticationMethod CLIENT_SECRET_POST = new ClientAuthenticationMethod( "client_secret_post"); /** + * The client_secret_jwt authentication method. * @since 5.5 */ public static final ClientAuthenticationMethod CLIENT_SECRET_JWT = new ClientAuthenticationMethod( "client_secret_jwt"); /** + * The private_key_jwt authentication method. * @since 5.5 */ public static final ClientAuthenticationMethod PRIVATE_KEY_JWT = new ClientAuthenticationMethod("private_key_jwt"); /** + * The none authentication method. * @since 5.2 */ public static final ClientAuthenticationMethod NONE = new ClientAuthenticationMethod("none"); /** + * The tls_client_auth authentication method. * @since 6.3 */ public static final ClientAuthenticationMethod TLS_CLIENT_AUTH = new ClientAuthenticationMethod("tls_client_auth"); /** + * The self_signed_tls_client_auth authentication method. * @since 6.3 */ public static final ClientAuthenticationMethod SELF_SIGNED_TLS_CLIENT_AUTH = new ClientAuthenticationMethod( diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/DelegatingOAuth2TokenValidator.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/DelegatingOAuth2TokenValidator.java index 3357ae5f72..cfa62192a2 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/DelegatingOAuth2TokenValidator.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/DelegatingOAuth2TokenValidator.java @@ -23,7 +23,7 @@ import java.util.Collection; import org.springframework.util.Assert; /** - * A composite validator + * A composite validator. * * @param the type of {@link OAuth2Token} this validator validates * @author Josh Cummings diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2AccessToken.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2AccessToken.java index 48cbbf6fd5..11b67a2da4 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2AccessToken.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2AccessToken.java @@ -110,6 +110,7 @@ public class OAuth2AccessToken extends AbstractOAuth2Token { public static final TokenType BEARER = new TokenType("Bearer"); /** + * The DPoP token type. * @since 6.5 */ public static final TokenType DPOP = new TokenType("DPoP"); diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimAccessor.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimAccessor.java index b68550ed89..0cb2a623a6 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimAccessor.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimAccessor.java @@ -36,7 +36,8 @@ import org.jspecify.annotations.Nullable; public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { /** - * Returns the indicator {@code (active)} whether or not the token is currently active + * Returns the indicator {@code (active)} whether or not the token is currently + * active. * @return the indicator whether or not the token is currently active */ default boolean isActive() { @@ -56,7 +57,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { /** * Returns the client identifier {@code (client_id)} for the token, or {@code null} if * it does not exist. - * @return the client identifier for the token, or {@code null} if it does not exist + * @return the client identifier for the token, or {@code null} if it does not exist. */ default @Nullable String getClientId() { return getClaimAsString(OAuth2TokenIntrospectionClaimNames.CLIENT_ID); @@ -65,7 +66,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { /** * Returns the scopes {@code (scope)} associated with the token, or {@code null} if it * does not exist. - * @return the scopes associated with the token, or {@code null} if it does not exist + * @return the scopes associated with the token, or {@code null} if it does not exist. */ default @Nullable List getScopes() { return getClaimAsStringList(OAuth2TokenIntrospectionClaimNames.SCOPE); @@ -85,7 +86,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { * Returns a timestamp {@code (exp)} indicating when the token expires, or * {@code null} if it does not exist. * @return a timestamp indicating when the token expires, or {@code null} if it does - * not exist + * not exist. */ default @Nullable Instant getExpiresAt() { return getClaimAsInstant(OAuth2TokenIntrospectionClaimNames.EXP); @@ -95,7 +96,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { * Returns a timestamp {@code (iat)} indicating when the token was issued, or * {@code null} if it does not exist. * @return a timestamp indicating when the token was issued, or {@code null} if it - * does not exist + * does not exist. */ default @Nullable Instant getIssuedAt() { return getClaimAsInstant(OAuth2TokenIntrospectionClaimNames.IAT); @@ -105,7 +106,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { * Returns a timestamp {@code (nbf)} indicating when the token is not to be used * before, or {@code null} if it does not exist. * @return a timestamp indicating when the token is not to be used before, or - * {@code null} if it does not exist + * {@code null} if it does not exist. */ default @Nullable Instant getNotBefore() { return getClaimAsInstant(OAuth2TokenIntrospectionClaimNames.NBF); @@ -124,7 +125,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { /** * Returns the intended audience {@code (aud)} for the token, or {@code null} if it * does not exist. - * @return the intended audience for the token, or {@code null} if it does not exist + * @return the intended audience for the token, or {@code null} if it does not exist. */ default @Nullable List getAudience() { return getClaimAsStringList(OAuth2TokenIntrospectionClaimNames.AUD); @@ -133,7 +134,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { /** * Returns the issuer {@code (iss)} of the token, or {@code null} if it does not * exist. - * @return the issuer of the token, or {@code null} if it does not exist + * @return the issuer of the token, or {@code null} if it does not exist. */ default @Nullable URL getIssuer() { return getClaimAsURL(OAuth2TokenIntrospectionClaimNames.ISS); @@ -142,7 +143,7 @@ public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor { /** * Returns the identifier {@code (jti)} for the token, or {@code null} if it does not * exist. - * @return the identifier for the token, or {@code null} if it does not exist + * @return the identifier for the token, or {@code null} if it does not exist. */ default @Nullable String getId() { return getClaimAsString(OAuth2TokenIntrospectionClaimNames.JTI); diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimNames.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimNames.java index 50317f9fed..113eca84bb 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimNames.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenIntrospectionClaimNames.java @@ -32,23 +32,23 @@ package org.springframework.security.oauth2.core; public final class OAuth2TokenIntrospectionClaimNames { /** - * {@code active} - Indicator whether or not the token is currently active + * {@code active} - Indicator whether or not the token is currently active. */ public static final String ACTIVE = "active"; /** * {@code username} - A human-readable identifier for the resource owner that - * authorized the token + * authorized the token. */ public static final String USERNAME = "username"; /** - * {@code client_id} - The Client identifier for the token + * {@code client_id} - The Client identifier for the token. */ public static final String CLIENT_ID = "client_id"; /** - * {@code scope} - The scopes for the token + * {@code scope} - The scopes for the token. */ public static final String SCOPE = "scope"; @@ -58,38 +58,38 @@ public final class OAuth2TokenIntrospectionClaimNames { public static final String TOKEN_TYPE = "token_type"; /** - * {@code exp} - A timestamp indicating when the token expires + * {@code exp} - A timestamp indicating when the token expires. */ public static final String EXP = "exp"; /** - * {@code iat} - A timestamp indicating when the token was issued + * {@code iat} - A timestamp indicating when the token was issued. */ public static final String IAT = "iat"; /** - * {@code nbf} - A timestamp indicating when the token is not to be used before + * {@code nbf} - A timestamp indicating when the token is not to be used before. */ public static final String NBF = "nbf"; /** * {@code sub} - Usually a machine-readable identifier of the resource owner who - * authorized the token + * authorized the token. */ public static final String SUB = "sub"; /** - * {@code aud} - The intended audience for the token + * {@code aud} - The intended audience for the token. */ public static final String AUD = "aud"; /** - * {@code iss} - The issuer of the token + * {@code iss} - The issuer of the token. */ public static final String ISS = "iss"; /** - * {@code jti} - The identifier for the token + * {@code jti} - The identifier for the token. */ public static final String JTI = "jti"; diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenValidatorResult.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenValidatorResult.java index bd929ee09d..78e8dec5ca 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenValidatorResult.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2TokenValidatorResult.java @@ -24,7 +24,7 @@ import java.util.Collections; import org.springframework.util.Assert; /** - * A result emitted from an {@link OAuth2TokenValidator} validation attempt + * A result emitted from an {@link OAuth2TokenValidator} validation attempt. * * @author Josh Cummings * @since 5.1 @@ -41,7 +41,7 @@ public final class OAuth2TokenValidatorResult { } /** - * Say whether this result indicates success + * Say whether this result indicates success. * @return whether this result has errors */ public boolean hasErrors() { @@ -49,7 +49,7 @@ public final class OAuth2TokenValidatorResult { } /** - * Return error details regarding the validation attempt + * Return error details regarding the validation attempt. * @return the collection of results in this result, if any; returns an empty list * otherwise */ @@ -58,7 +58,7 @@ public final class OAuth2TokenValidatorResult { } /** - * Construct a successful {@link OAuth2TokenValidatorResult} + * Construct a successful {@link OAuth2TokenValidatorResult}. * @return an {@link OAuth2TokenValidatorResult} with no errors */ public static OAuth2TokenValidatorResult success() { @@ -66,7 +66,7 @@ public final class OAuth2TokenValidatorResult { } /** - * Construct a failure {@link OAuth2TokenValidatorResult} with the provided detail + * Construct a failure {@link OAuth2TokenValidatorResult} with the provided detail. * @param errors the list of errors * @return an {@link OAuth2TokenValidatorResult} with the errors specified */ @@ -75,7 +75,7 @@ public final class OAuth2TokenValidatorResult { } /** - * Construct a failure {@link OAuth2TokenValidatorResult} with the provided detail + * Construct a failure {@link OAuth2TokenValidatorResult} with the provided detail. * @param errors the list of errors * @return an {@link OAuth2TokenValidatorResult} with the errors specified */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToBooleanConverter.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToBooleanConverter.java index ce9d19fb00..ab68b63488 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToBooleanConverter.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToBooleanConverter.java @@ -25,6 +25,8 @@ import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.converter.GenericConverter; /** + * A {@link GenericConverter} that converts an {@code Object} to a {@code Boolean}. + * * @author Joe Grandja * @since 5.2 */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToInstantConverter.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToInstantConverter.java index ea7f1cc951..456602b546 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToInstantConverter.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToInstantConverter.java @@ -27,6 +27,8 @@ import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.converter.GenericConverter; /** + * A {@link GenericConverter} that converts an {@link Object} to an {@link Instant}. + * * @author Joe Grandja * @since 5.2 */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToListStringConverter.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToListStringConverter.java index fdd2a4a09b..646a9e74bc 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToListStringConverter.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToListStringConverter.java @@ -30,6 +30,9 @@ import org.springframework.core.convert.converter.ConditionalGenericConverter; import org.springframework.util.ClassUtils; /** + * A {@link ConditionalGenericConverter} that converts an arbitrary {@code Object} to a + * {@code List} of {@code String}. + * * @author Joe Grandja * @since 5.2 */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToMapStringObjectConverter.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToMapStringObjectConverter.java index 23dc633aea..0d86f4136d 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToMapStringObjectConverter.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToMapStringObjectConverter.java @@ -27,6 +27,9 @@ import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.converter.ConditionalGenericConverter; /** + * A {@link ConditionalGenericConverter} that converts a {@code Map} to a + * {@code Map}. + * * @author Joe Grandja * @since 5.2 */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToStringConverter.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToStringConverter.java index 3c415063a4..1334394cd4 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToStringConverter.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToStringConverter.java @@ -25,6 +25,9 @@ import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.converter.GenericConverter; /** + * A {@link GenericConverter} that converts an {@code Object} to a {@code String} by + * calling {@code toString()}. + * * @author Joe Grandja * @since 5.2 */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToURLConverter.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToURLConverter.java index 46e3a1809e..2ed652ada4 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToURLConverter.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/converter/ObjectToURLConverter.java @@ -27,6 +27,8 @@ import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.converter.GenericConverter; /** + * A {@link GenericConverter} that converts an {@link Object} to a {@link URL}. + * * @author Joe Grandja * @since 5.2 */ diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/IdTokenClaimNames.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/IdTokenClaimNames.java index 84716fe081..24b80afabd 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/IdTokenClaimNames.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/IdTokenClaimNames.java @@ -30,33 +30,33 @@ package org.springframework.security.oauth2.core.oidc; public final class IdTokenClaimNames { /** - * {@code iss} - the Issuer identifier + * {@code iss} - the Issuer identifier. */ public static final String ISS = "iss"; /** - * {@code sub} - the Subject identifier + * {@code sub} - the Subject identifier. */ public static final String SUB = "sub"; /** - * {@code aud} - the Audience(s) that the ID Token is intended for + * {@code aud} - the Audience(s) that the ID Token is intended for. */ public static final String AUD = "aud"; /** * {@code exp} - the Expiration time on or after which the ID Token MUST NOT be - * accepted + * accepted. */ public static final String EXP = "exp"; /** - * {@code iat} - the time at which the ID Token was issued + * {@code iat} - the time at which the ID Token was issued. */ public static final String IAT = "iat"; /** - * {@code auth_time} - the time when the End-User authentication occurred + * {@code auth_time} - the time when the End-User authentication occurred. */ public static final String AUTH_TIME = "auth_time"; @@ -67,27 +67,27 @@ public final class IdTokenClaimNames { public static final String NONCE = "nonce"; /** - * {@code acr} - the Authentication Context Class Reference + * {@code acr} - the Authentication Context Class Reference. */ public static final String ACR = "acr"; /** - * {@code amr} - the Authentication Methods References + * {@code amr} - the Authentication Methods References. */ public static final String AMR = "amr"; /** - * {@code azp} - the Authorized party to which the ID Token was issued + * {@code azp} - the Authorized party to which the ID Token was issued. */ public static final String AZP = "azp"; /** - * {@code at_hash} - the Access Token hash value + * {@code at_hash} - the Access Token hash value. */ public static final String AT_HASH = "at_hash"; /** - * {@code c_hash} - the Authorization Code hash value + * {@code c_hash} - the Authorization Code hash value. */ public static final String C_HASH = "c_hash"; diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcIdToken.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcIdToken.java index c3da042a0f..f874b4a386 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcIdToken.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcIdToken.java @@ -78,7 +78,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Create a {@link Builder} based on the given token value + * Create a {@link Builder} based on the given token value. * @param tokenValue the token value to use * @return the {@link Builder} for further configuration * @since 5.3 @@ -88,7 +88,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * A builder for {@link OidcIdToken}s + * A builder for {@link OidcIdToken}s. * * @author Josh Cummings * @since 5.3 @@ -104,7 +104,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this token value in the resulting {@link OidcIdToken} + * Use this token value in the resulting {@link OidcIdToken}. * @param tokenValue The token value to use * @return the {@link Builder} for further configurations */ @@ -114,7 +114,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this claim in the resulting {@link OidcIdToken} + * Use this claim in the resulting {@link OidcIdToken}. * @param name The claim name * @param value The claim value * @return the {@link Builder} for further configurations @@ -136,7 +136,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this access token hash in the resulting {@link OidcIdToken} + * Use this access token hash in the resulting {@link OidcIdToken}. * @param accessTokenHash The access token hash to use * @return the {@link Builder} for further configurations */ @@ -145,7 +145,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this audience in the resulting {@link OidcIdToken} + * Use this audience in the resulting {@link OidcIdToken}. * @param audience The audience(s) to use * @return the {@link Builder} for further configurations */ @@ -154,7 +154,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this authentication {@link Instant} in the resulting {@link OidcIdToken} + * Use this authentication {@link Instant} in the resulting {@link OidcIdToken}. * @param authenticatedAt The authentication {@link Instant} to use * @return the {@link Builder} for further configurations */ @@ -164,7 +164,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce /** * Use this authentication context class reference in the resulting - * {@link OidcIdToken} + * {@link OidcIdToken}. * @param authenticationContextClass The authentication context class reference to * use * @return the {@link Builder} for further configurations @@ -174,7 +174,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use these authentication methods in the resulting {@link OidcIdToken} + * Use these authentication methods in the resulting {@link OidcIdToken}. * @param authenticationMethods The authentication methods to use * @return the {@link Builder} for further configurations */ @@ -183,7 +183,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this authorization code hash in the resulting {@link OidcIdToken} + * Use this authorization code hash in the resulting {@link OidcIdToken}. * @param authorizationCodeHash The authorization code hash to use * @return the {@link Builder} for further configurations */ @@ -192,7 +192,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this authorized party in the resulting {@link OidcIdToken} + * Use this authorized party in the resulting {@link OidcIdToken}. * @param authorizedParty The authorized party to use * @return the {@link Builder} for further configurations */ @@ -201,7 +201,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this expiration in the resulting {@link OidcIdToken} + * Use this expiration in the resulting {@link OidcIdToken}. * @param expiresAt The expiration to use * @return the {@link Builder} for further configurations */ @@ -210,7 +210,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this issued-at timestamp in the resulting {@link OidcIdToken} + * Use this issued-at timestamp in the resulting {@link OidcIdToken}. * @param issuedAt The issued-at timestamp to use * @return the {@link Builder} for further configurations */ @@ -219,7 +219,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this issuer in the resulting {@link OidcIdToken} + * Use this issuer in the resulting {@link OidcIdToken}. * @param issuer The issuer to use * @return the {@link Builder} for further configurations */ @@ -228,7 +228,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this nonce in the resulting {@link OidcIdToken} + * Use this nonce in the resulting {@link OidcIdToken}. * @param nonce The nonce to use * @return the {@link Builder} for further configurations */ @@ -237,7 +237,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Use this subject in the resulting {@link OidcIdToken} + * Use this subject in the resulting {@link OidcIdToken}. * @param subject The subject to use * @return the {@link Builder} for further configurations */ @@ -246,7 +246,7 @@ public class OidcIdToken extends AbstractOAuth2Token implements IdTokenClaimAcce } /** - * Build the {@link OidcIdToken} + * Build the {@link OidcIdToken}. * @return The constructed {@link OidcIdToken} */ public OidcIdToken build() { diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcUserInfo.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcUserInfo.java index 8b7d629890..880b0febaf 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcUserInfo.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/OidcUserInfo.java @@ -85,7 +85,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Create a {@link Builder} + * Create a {@link Builder}. * @return the {@link Builder} for further configuration * @since 5.3 */ @@ -94,7 +94,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * A builder for {@link OidcUserInfo}s + * A builder for {@link OidcUserInfo}s. * * @author Josh Cummings * @since 5.3 @@ -107,7 +107,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this claim in the resulting {@link OidcUserInfo} + * Use this claim in the resulting {@link OidcUserInfo}. * @param name The claim name * @param value The claim value * @return the {@link Builder} for further configurations @@ -129,7 +129,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this address in the resulting {@link OidcUserInfo} + * Use this address in the resulting {@link OidcUserInfo}. * @param address The address to use * @return the {@link Builder} for further configurations */ @@ -138,7 +138,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this birthdate in the resulting {@link OidcUserInfo} + * Use this birthdate in the resulting {@link OidcUserInfo}. * @param birthdate The birthdate to use * @return the {@link Builder} for further configurations */ @@ -147,7 +147,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this email in the resulting {@link OidcUserInfo} + * Use this email in the resulting {@link OidcUserInfo}. * @param email The email to use * @return the {@link Builder} for further configurations */ @@ -156,7 +156,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this verified-email indicator in the resulting {@link OidcUserInfo} + * Use this verified-email indicator in the resulting {@link OidcUserInfo}. * @param emailVerified The verified-email indicator to use * @return the {@link Builder} for further configurations */ @@ -165,7 +165,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this family name in the resulting {@link OidcUserInfo} + * Use this family name in the resulting {@link OidcUserInfo}. * @param familyName The family name to use * @return the {@link Builder} for further configurations */ @@ -174,7 +174,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this gender in the resulting {@link OidcUserInfo} + * Use this gender in the resulting {@link OidcUserInfo}. * @param gender The gender to use * @return the {@link Builder} for further configurations */ @@ -183,7 +183,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this given name in the resulting {@link OidcUserInfo} + * Use this given name in the resulting {@link OidcUserInfo}. * @param givenName The given name to use * @return the {@link Builder} for further configurations */ @@ -192,7 +192,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this locale in the resulting {@link OidcUserInfo} + * Use this locale in the resulting {@link OidcUserInfo}. * @param locale The locale to use * @return the {@link Builder} for further configurations */ @@ -201,7 +201,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this middle name in the resulting {@link OidcUserInfo} + * Use this middle name in the resulting {@link OidcUserInfo}. * @param middleName The middle name to use * @return the {@link Builder} for further configurations */ @@ -210,7 +210,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this name in the resulting {@link OidcUserInfo} + * Use this name in the resulting {@link OidcUserInfo}. * @param name The name to use * @return the {@link Builder} for further configurations */ @@ -219,7 +219,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this nickname in the resulting {@link OidcUserInfo} + * Use this nickname in the resulting {@link OidcUserInfo}. * @param nickname The nickname to use * @return the {@link Builder} for further configurations */ @@ -228,7 +228,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this picture in the resulting {@link OidcUserInfo} + * Use this picture in the resulting {@link OidcUserInfo}. * @param picture The picture to use * @return the {@link Builder} for further configurations */ @@ -237,7 +237,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this phone number in the resulting {@link OidcUserInfo} + * Use this phone number in the resulting {@link OidcUserInfo}. * @param phoneNumber The phone number to use * @return the {@link Builder} for further configurations */ @@ -246,7 +246,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this verified-phone-number indicator in the resulting {@link OidcUserInfo} + * Use this verified-phone-number indicator in the resulting {@link OidcUserInfo}. * @param phoneNumberVerified The verified-phone-number indicator to use * @return the {@link Builder} for further configurations * @since 5.8 @@ -256,7 +256,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this preferred username in the resulting {@link OidcUserInfo} + * Use this preferred username in the resulting {@link OidcUserInfo}. * @param preferredUsername The preferred username to use * @return the {@link Builder} for further configurations */ @@ -265,7 +265,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this profile in the resulting {@link OidcUserInfo} + * Use this profile in the resulting {@link OidcUserInfo}. * @param profile The profile to use * @return the {@link Builder} for further configurations */ @@ -274,7 +274,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this subject in the resulting {@link OidcUserInfo} + * Use this subject in the resulting {@link OidcUserInfo}. * @param subject The subject to use * @return the {@link Builder} for further configurations */ @@ -283,7 +283,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this updated-at {@link Instant} in the resulting {@link OidcUserInfo} + * Use this updated-at {@link Instant} in the resulting {@link OidcUserInfo}. * @param updatedAt The updated-at {@link Instant} to use * @return the {@link Builder} for further configurations */ @@ -292,7 +292,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this website in the resulting {@link OidcUserInfo} + * Use this website in the resulting {@link OidcUserInfo}. * @param website The website to use * @return the {@link Builder} for further configurations */ @@ -301,7 +301,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Use this zoneinfo in the resulting {@link OidcUserInfo} + * Use this zoneinfo in the resulting {@link OidcUserInfo}. * @param zoneinfo The zoneinfo to use * @return the {@link Builder} for further configurations */ @@ -310,7 +310,7 @@ public class OidcUserInfo implements StandardClaimAccessor, Serializable { } /** - * Build the {@link OidcUserInfo} + * Build the {@link OidcUserInfo}. * @return The constructed {@link OidcUserInfo} */ public OidcUserInfo build() { diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/StandardClaimNames.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/StandardClaimNames.java index 00e115dee5..f4cf115870 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/StandardClaimNames.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/oidc/StandardClaimNames.java @@ -34,106 +34,106 @@ package org.springframework.security.oauth2.core.oidc; public final class StandardClaimNames { /** - * {@code sub} - the Subject identifier + * {@code sub} - the Subject identifier. */ public static final String SUB = "sub"; /** - * {@code name} - the user's full name + * {@code name} - the user's full name. */ public static final String NAME = "name"; /** - * {@code given_name} - the user's given name(s) or first name(s) + * {@code given_name} - the user's given name(s) or first name(s). */ public static final String GIVEN_NAME = "given_name"; /** - * {@code family_name} - the user's surname(s) or last name(s) + * {@code family_name} - the user's surname(s) or last name(s). */ public static final String FAMILY_NAME = "family_name"; /** - * {@code middle_name} - the user's middle name(s) + * {@code middle_name} - the user's middle name(s). */ public static final String MIDDLE_NAME = "middle_name"; /** * {@code nickname} - the user's nick name that may or may not be the same as the - * {@code given_name} + * {@code given_name}. */ public static final String NICKNAME = "nickname"; /** * {@code preferred_username} - the preferred username that the user wishes to be - * referred to + * referred to. */ public static final String PREFERRED_USERNAME = "preferred_username"; /** - * {@code profile} - the URL of the user's profile page + * {@code profile} - the URL of the user's profile page. */ public static final String PROFILE = "profile"; /** - * {@code picture} - the URL of the user's profile picture + * {@code picture} - the URL of the user's profile picture. */ public static final String PICTURE = "picture"; /** - * {@code website} - the URL of the user's web page or blog + * {@code website} - the URL of the user's web page or blog. */ public static final String WEBSITE = "website"; /** - * {@code email} - the user's preferred e-mail address + * {@code email} - the user's preferred e-mail address. */ public static final String EMAIL = "email"; /** * {@code email_verified} - {@code true} if the user's e-mail address has been - * verified, otherwise {@code false} + * verified, otherwise {@code false}. */ public static final String EMAIL_VERIFIED = "email_verified"; /** - * {@code gender} - the user's gender + * {@code gender} - the user's gender. */ public static final String GENDER = "gender"; /** - * {@code birthdate} - the user's birth date + * {@code birthdate} - the user's birth date. */ public static final String BIRTHDATE = "birthdate"; /** - * {@code zoneinfo} - the user's time zone + * {@code zoneinfo} - the user's time zone. */ public static final String ZONEINFO = "zoneinfo"; /** - * {@code locale} - the user's locale + * {@code locale} - the user's locale. */ public static final String LOCALE = "locale"; /** - * {@code phone_number} - the user's preferred phone number + * {@code phone_number} - the user's preferred phone number. */ public static final String PHONE_NUMBER = "phone_number"; /** * {@code phone_number_verified} - {@code true} if the user's phone number has been - * verified, otherwise {@code false} + * verified, otherwise {@code false}. */ public static final String PHONE_NUMBER_VERIFIED = "phone_number_verified"; /** - * {@code address} - the user's preferred postal address + * {@code address} - the user's preferred postal address. */ public static final String ADDRESS = "address"; /** - * {@code updated_at} - the time the user's information was last updated + * {@code updated_at} - the time the user's information was last updated. */ public static final String UPDATED_AT = "updated_at"; diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/user/OAuth2UserAuthority.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/user/OAuth2UserAuthority.java index 9e967378b9..3671ca2ec3 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/user/OAuth2UserAuthority.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/user/OAuth2UserAuthority.java @@ -167,6 +167,7 @@ public class OAuth2UserAuthority implements GrantedAuthority { } /** + * Converts a {@code URL} value to a string for use in equality/hashCode checks. * @return {@code URL} converted to a string since {@code URL} shouldn't be used for * equality/hashCode. For other instances the value is returned as is (including * null). diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2AccessTokenResponseBodyExtractor.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2AccessTokenResponseBodyExtractor.java index 3a66d3bd76..237847f2eb 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2AccessTokenResponseBodyExtractor.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2AccessTokenResponseBodyExtractor.java @@ -43,7 +43,7 @@ import org.springframework.web.reactive.function.BodyExtractors; /** * Provides a way to create an {@link OAuth2AccessTokenResponse} from a - * {@link ReactiveHttpInputMessage} + * {@link ReactiveHttpInputMessage}. * * @author Rob Winch * @since 5.1 diff --git a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2BodyExtractors.java b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2BodyExtractors.java index c5773c5158..b5498779c3 100644 --- a/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2BodyExtractors.java +++ b/oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/web/reactive/function/OAuth2BodyExtractors.java @@ -31,7 +31,7 @@ import org.springframework.web.reactive.function.BodyExtractor; public abstract class OAuth2BodyExtractors { /** - * Extractor to decode an {@link OAuth2AccessTokenResponse} + * Extractor to decode an {@link OAuth2AccessTokenResponse}. * @return a BodyExtractor for {@link OAuth2AccessTokenResponse} */ public static BodyExtractor, ReactiveHttpInputMessage> oauth2AccessTokenResponse() { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/JwsAlgorithms.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/JwsAlgorithms.java index ed8976c22f..b357c1dde1 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/JwsAlgorithms.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/JwsAlgorithms.java @@ -34,62 +34,62 @@ package org.springframework.security.oauth2.jose.jws; public final class JwsAlgorithms { /** - * HMAC using SHA-256 (Required) + * HMAC using SHA-256 (Required). */ public static final String HS256 = "HS256"; /** - * HMAC using SHA-384 (Optional) + * HMAC using SHA-384 (Optional). */ public static final String HS384 = "HS384"; /** - * HMAC using SHA-512 (Optional) + * HMAC using SHA-512 (Optional). */ public static final String HS512 = "HS512"; /** - * RSASSA-PKCS1-v1_5 using SHA-256 (Recommended) + * RSASSA-PKCS1-v1_5 using SHA-256 (Recommended). */ public static final String RS256 = "RS256"; /** - * RSASSA-PKCS1-v1_5 using SHA-384 (Optional) + * RSASSA-PKCS1-v1_5 using SHA-384 (Optional). */ public static final String RS384 = "RS384"; /** - * RSASSA-PKCS1-v1_5 using SHA-512 (Optional) + * RSASSA-PKCS1-v1_5 using SHA-512 (Optional). */ public static final String RS512 = "RS512"; /** - * ECDSA using P-256 and SHA-256 (Recommended+) + * ECDSA using P-256 and SHA-256 (Recommended+). */ public static final String ES256 = "ES256"; /** - * ECDSA using P-384 and SHA-384 (Optional) + * ECDSA using P-384 and SHA-384 (Optional). */ public static final String ES384 = "ES384"; /** - * ECDSA using P-521 and SHA-512 (Optional) + * ECDSA using P-521 and SHA-512 (Optional). */ public static final String ES512 = "ES512"; /** - * RSASSA-PSS using SHA-256 and MGF1 with SHA-256 (Optional) + * RSASSA-PSS using SHA-256 and MGF1 with SHA-256 (Optional). */ public static final String PS256 = "PS256"; /** - * RSASSA-PSS using SHA-384 and MGF1 with SHA-384 (Optional) + * RSASSA-PSS using SHA-384 and MGF1 with SHA-384 (Optional). */ public static final String PS384 = "PS384"; /** - * RSASSA-PSS using SHA-512 and MGF1 with SHA-512 (Optional) + * RSASSA-PSS using SHA-512 and MGF1 with SHA-512 (Optional). */ public static final String PS512 = "PS512"; diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/MacAlgorithm.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/MacAlgorithm.java index 7074e09424..ea761156cd 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/MacAlgorithm.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/MacAlgorithm.java @@ -37,17 +37,17 @@ import org.jspecify.annotations.Nullable; public enum MacAlgorithm implements JwsAlgorithm { /** - * HMAC using SHA-256 (Required) + * HMAC using SHA-256 (Required). */ HS256(JwsAlgorithms.HS256), /** - * HMAC using SHA-384 (Optional) + * HMAC using SHA-384 (Optional). */ HS384(JwsAlgorithms.HS384), /** - * HMAC using SHA-512 (Optional) + * HMAC using SHA-512 (Optional). */ HS512(JwsAlgorithms.HS512); diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/SignatureAlgorithm.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/SignatureAlgorithm.java index 764601892c..20fc584385 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/SignatureAlgorithm.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jose/jws/SignatureAlgorithm.java @@ -37,47 +37,47 @@ import org.jspecify.annotations.Nullable; public enum SignatureAlgorithm implements JwsAlgorithm { /** - * RSASSA-PKCS1-v1_5 using SHA-256 (Recommended) + * RSASSA-PKCS1-v1_5 using SHA-256 (Recommended). */ RS256(JwsAlgorithms.RS256), /** - * RSASSA-PKCS1-v1_5 using SHA-384 (Optional) + * RSASSA-PKCS1-v1_5 using SHA-384 (Optional). */ RS384(JwsAlgorithms.RS384), /** - * RSASSA-PKCS1-v1_5 using SHA-512 (Optional) + * RSASSA-PKCS1-v1_5 using SHA-512 (Optional). */ RS512(JwsAlgorithms.RS512), /** - * ECDSA using P-256 and SHA-256 (Recommended+) + * ECDSA using P-256 and SHA-256 (Recommended+). */ ES256(JwsAlgorithms.ES256), /** - * ECDSA using P-384 and SHA-384 (Optional) + * ECDSA using P-384 and SHA-384 (Optional). */ ES384(JwsAlgorithms.ES384), /** - * ECDSA using P-521 and SHA-512 (Optional) + * ECDSA using P-521 and SHA-512 (Optional). */ ES512(JwsAlgorithms.ES512), /** - * RSASSA-PSS using SHA-256 and MGF1 with SHA-256 (Optional) + * RSASSA-PSS using SHA-256 and MGF1 with SHA-256 (Optional). */ PS256(JwsAlgorithms.PS256), /** - * RSASSA-PSS using SHA-384 and MGF1 with SHA-384 (Optional) + * RSASSA-PSS using SHA-384 and MGF1 with SHA-384 (Optional). */ PS384(JwsAlgorithms.PS384), /** - * RSASSA-PSS using SHA-512 and MGF1 with SHA-512 (Optional) + * RSASSA-PSS using SHA-512 and MGF1 with SHA-512 (Optional). */ PS512(JwsAlgorithms.PS512); diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JoseHeaderNames.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JoseHeaderNames.java index 21294ad327..9008503ddd 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JoseHeaderNames.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JoseHeaderNames.java @@ -35,26 +35,26 @@ public final class JoseHeaderNames { /** * {@code alg} - the algorithm header identifies the cryptographic algorithm used to - * secure a JWS or JWE + * secure a JWS or JWE. */ public static final String ALG = "alg"; /** * {@code jku} - the JWK Set URL header is a URI that refers to a resource for a set * of JSON-encoded public keys, one of which corresponds to the key used to digitally - * sign a JWS or encrypt a JWE + * sign a JWS or encrypt a JWE. */ public static final String JKU = "jku"; /** * {@code jwk} - the JSON Web Key header is the public key that corresponds to the key - * used to digitally sign a JWS or encrypt a JWE + * used to digitally sign a JWS or encrypt a JWE. */ public static final String JWK = "jwk"; /** * {@code kid} - the key ID header is a hint indicating which key was used to secure a - * JWS or JWE + * JWS or JWE. */ public static final String KID = "kid"; @@ -97,19 +97,19 @@ public final class JoseHeaderNames { /** * {@code typ} - the type header is used by JWS/JWE applications to declare the media - * type of a JWS/JWE + * type of a JWS/JWE. */ public static final String TYP = "typ"; /** * {@code cty} - the content type header is used by JWS/JWE applications to declare - * the media type of the secured content (the payload) + * the media type of the secured content (the payload). */ public static final String CTY = "cty"; /** * {@code crit} - the critical header indicates that extensions to the JWS/JWE/JWA - * specifications are being used that MUST be understood and processed + * specifications are being used that MUST be understood and processed. */ public static final String CRIT = "crit"; diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/Jwt.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/Jwt.java index 71d5ceafbb..f5d4e52ffb 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/Jwt.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/Jwt.java @@ -96,7 +96,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Return a {@link Jwt.Builder} + * Return a {@link Jwt.Builder}. * @return A {@link Jwt.Builder} */ public static Builder withTokenValue(String tokenValue) { @@ -104,7 +104,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Helps configure a {@link Jwt} + * Helps configure a {@link Jwt}. * * @author Jérôme Wacongne <ch4mp@c4-soft.com> * @author Josh Cummings @@ -123,7 +123,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this token value in the resulting {@link Jwt} + * Use this token value in the resulting {@link Jwt}. * @param tokenValue The token value to use * @return the {@link Builder} for further configurations */ @@ -133,7 +133,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this claim in the resulting {@link Jwt} + * Use this claim in the resulting {@link Jwt}. * @param name The claim name * @param value The claim value * @return the {@link Builder} for further configurations @@ -155,7 +155,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this header in the resulting {@link Jwt} + * Use this header in the resulting {@link Jwt}. * @param name The header name * @param value The header value * @return the {@link Builder} for further configurations @@ -177,7 +177,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this audience in the resulting {@link Jwt} + * Use this audience in the resulting {@link Jwt}. * @param audience The audience(s) to use * @return the {@link Builder} for further configurations */ @@ -186,7 +186,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this expiration in the resulting {@link Jwt} + * Use this expiration in the resulting {@link Jwt}. * @param expiresAt The expiration to use * @return the {@link Builder} for further configurations */ @@ -196,7 +196,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this identifier in the resulting {@link Jwt} + * Use this identifier in the resulting {@link Jwt}. * @param jti The identifier to use * @return the {@link Builder} for further configurations */ @@ -206,7 +206,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this issued-at timestamp in the resulting {@link Jwt} + * Use this issued-at timestamp in the resulting {@link Jwt}. * @param issuedAt The issued-at timestamp to use * @return the {@link Builder} for further configurations */ @@ -216,7 +216,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this issuer in the resulting {@link Jwt} + * Use this issuer in the resulting {@link Jwt}. * @param issuer The issuer to use * @return the {@link Builder} for further configurations */ @@ -226,7 +226,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this not-before timestamp in the resulting {@link Jwt} + * Use this not-before timestamp in the resulting {@link Jwt}. * @param notBefore The not-before timestamp to use * @return the {@link Builder} for further configurations */ @@ -236,7 +236,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Use this subject in the resulting {@link Jwt} + * Use this subject in the resulting {@link Jwt}. * @param subject The subject to use * @return the {@link Builder} for further configurations */ @@ -246,7 +246,7 @@ public class Jwt extends AbstractOAuth2Token implements JwtClaimAccessor { } /** - * Build the {@link Jwt} + * Build the {@link Jwt}. * @return The constructed {@link Jwt} */ public Jwt build() { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtAudienceValidator.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtAudienceValidator.java index b875737546..f44e69ff94 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtAudienceValidator.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtAudienceValidator.java @@ -33,7 +33,7 @@ public final class JwtAudienceValidator implements OAuth2TokenValidator { private final JwtClaimValidator> validator; /** - * Constructs a {@link JwtAudienceValidator} using the provided parameters + * Constructs a {@link JwtAudienceValidator} using the provided parameters. * @param audience - The audience that each {@link Jwt} should have. */ public JwtAudienceValidator(String audience) { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimNames.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimNames.java index d07aacf754..a26adf3f69 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimNames.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimNames.java @@ -29,41 +29,41 @@ package org.springframework.security.oauth2.jwt; public final class JwtClaimNames { /** - * {@code iss} - the Issuer claim identifies the principal that issued the JWT + * {@code iss} - the Issuer claim identifies the principal that issued the JWT. */ public static final String ISS = "iss"; /** * {@code sub} - the Subject claim identifies the principal that is the subject of the - * JWT + * JWT. */ public static final String SUB = "sub"; /** * {@code aud} - the Audience claim identifies the recipient(s) that the JWT is - * intended for + * intended for. */ public static final String AUD = "aud"; /** * {@code exp} - the Expiration time claim identifies the expiration time on or after - * which the JWT MUST NOT be accepted for processing + * which the JWT MUST NOT be accepted for processing. */ public static final String EXP = "exp"; /** * {@code nbf} - the Not Before claim identifies the time before which the JWT MUST - * NOT be accepted for processing + * NOT be accepted for processing. */ public static final String NBF = "nbf"; /** - * {@code iat} - The Issued at claim identifies the time at which the JWT was issued + * {@code iat} - The Issued at claim identifies the time at which the JWT was issued. */ public static final String IAT = "iat"; /** - * {@code jti} - The JWT ID claim provides a unique identifier for the JWT + * {@code jti} - The JWT ID claim provides a unique identifier for the JWT. */ public static final String JTI = "jti"; diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimValidator.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimValidator.java index 54ec78dd70..fff6b0d39d 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimValidator.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtClaimValidator.java @@ -29,7 +29,7 @@ import org.springframework.util.Assert; /** * Validates a claim in a {@link Jwt} against a provided - * {@link java.util.function.Predicate} + * {@link java.util.function.Predicate}. * * @author Zeeshan Adnan * @since 5.3 @@ -45,7 +45,7 @@ public final class JwtClaimValidator implements OAuth2TokenValidator { private final OAuth2Error error; /** - * Constructs a {@link JwtClaimValidator} using the provided parameters + * Constructs a {@link JwtClaimValidator} using the provided parameters. * @param claim - is the name of the claim in {@link Jwt} to validate. * @param test - is the predicate function for the claim to test against. */ diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtIssuerValidator.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtIssuerValidator.java index 42a9c03b82..f37a7e93c6 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtIssuerValidator.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtIssuerValidator.java @@ -23,7 +23,7 @@ import org.springframework.security.oauth2.core.OAuth2TokenValidatorResult; import org.springframework.util.Assert; /** - * Validates the "iss" claim in a {@link Jwt}, that is matches a configured value + * Validates the "iss" claim in a {@link Jwt}, that is matches a configured value. * * @author Josh Cummings * @since 5.1 @@ -33,7 +33,7 @@ public final class JwtIssuerValidator implements OAuth2TokenValidator { private final JwtClaimValidator validator; /** - * Constructs a {@link JwtIssuerValidator} using the provided parameters + * Constructs a {@link JwtIssuerValidator} using the provided parameters. * @param issuer - The issuer that each {@link Jwt} should have. */ public JwtIssuerValidator(String issuer) { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTimestampValidator.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTimestampValidator.java index adcdbc4b5d..539e3bf7be 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTimestampValidator.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTimestampValidator.java @@ -33,7 +33,7 @@ import org.springframework.util.ObjectUtils; /** * An implementation of {@link OAuth2TokenValidator} for verifying claims in a Jwt-based - * access token + * access token. * *

      * Because clocks can differ between the Jwt source, say the Authorization Server, and its @@ -62,7 +62,7 @@ public final class JwtTimestampValidator implements OAuth2TokenValidator { private Clock clock = Clock.systemUTC(); /** - * A basic instance with no custom verification and the default max clock skew + * A basic instance with no custom verification and the default max clock skew. */ public JwtTimestampValidator() { this(DEFAULT_MAX_CLOCK_SKEW); @@ -124,7 +124,7 @@ public final class JwtTimestampValidator implements OAuth2TokenValidator { } /** - * Use this {@link Clock} with {@link Instant#now()} for assessing timestamp validity + * Use this {@link Clock} with {@link Instant#now()} for assessing timestamp validity. * @param clock */ public void setClock(Clock clock) { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTypeValidator.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTypeValidator.java index e34bc098f9..b7e853f5a6 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTypeValidator.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtTypeValidator.java @@ -50,7 +50,7 @@ public final class JwtTypeValidator implements OAuth2TokenValidator { } /** - * Require that the {@code typ} header be {@code JWT} or absent + * Require that the {@code typ} header be {@code JWT} or absent. */ public static JwtTypeValidator jwt() { JwtTypeValidator validator = new JwtTypeValidator(List.of("JWT")); diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidationException.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidationException.java index 52bc3cd97c..546a8403a9 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidationException.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidationException.java @@ -25,7 +25,7 @@ import org.springframework.security.oauth2.core.OAuth2TokenValidatorResult; import org.springframework.util.Assert; /** - * An exception that results from an unsuccessful {@link OAuth2TokenValidatorResult} + * An exception that results from an unsuccessful {@link OAuth2TokenValidatorResult}. * * @author Josh Cummings * @since 5.1 @@ -38,7 +38,7 @@ public class JwtValidationException extends BadJwtException { private final Collection errors; /** - * Constructs a {@link JwtValidationException} using the provided parameters + * Constructs a {@link JwtValidationException} using the provided parameters. * * While each {@link OAuth2Error} does contain an error description, this constructor * can take an overarching description that encapsulates the composition of failures @@ -63,7 +63,7 @@ public class JwtValidationException extends BadJwtException { } /** - * Return the list of {@link OAuth2Error}s associated with this exception + * Return the list of {@link OAuth2Error}s associated with this exception. * @return the list of {@link OAuth2Error}s associated with this exception */ public Collection getErrors() { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidators.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidators.java index 054619e237..6ea6d8283c 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidators.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtValidators.java @@ -33,7 +33,7 @@ import org.springframework.util.Assert; import org.springframework.util.CollectionUtils; /** - * Provides factory methods for creating {@code OAuth2TokenValidator} + * Provides factory methods for creating {@code OAuth2TokenValidator}. * * @author Josh Cummings * @author Rob Winch @@ -222,7 +222,7 @@ public final class JwtValidators { } /** - * Build the validator + * Build the validator. * @return the RFC 9068 validator */ public OAuth2TokenValidator build() { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtDecoder.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtDecoder.java index 108b4a7326..72e45cff31 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtDecoder.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtDecoder.java @@ -103,7 +103,7 @@ public final class NimbusJwtDecoder implements JwtDecoder { private OAuth2TokenValidator jwtValidator = JwtValidators.createDefault(); /** - * Configures a {@link NimbusJwtDecoder} with the given parameters + * Configures a {@link NimbusJwtDecoder} with the given parameters. * @param jwtProcessor - the {@link JWTProcessor} to use */ public NimbusJwtDecoder(JWTProcessor jwtProcessor) { @@ -112,7 +112,7 @@ public final class NimbusJwtDecoder implements JwtDecoder { } /** - * Use this {@link Jwt} Validator + * Use this {@link Jwt} Validator. * @param jwtValidator - the Jwt Validator to use */ public void setJwtValidator(OAuth2TokenValidator jwtValidator) { @@ -121,7 +121,7 @@ public final class NimbusJwtDecoder implements JwtDecoder { } /** - * Use the following {@link Converter} for manipulating the JWT's claim set + * Use the following {@link Converter} for manipulating the JWT's claim set. * @param claimSetConverter the {@link Converter} to use */ public void setClaimSetConverter(Converter, Map> claimSetConverter) { @@ -130,7 +130,7 @@ public final class NimbusJwtDecoder implements JwtDecoder { } /** - * Decode and validate the JWT from its compact claims representation format + * Decode and validate the JWT from its compact claims representation format. * @param token the JWT value * @return a validated {@link Jwt} * @throws JwtException when the token is malformed or otherwise invalid @@ -250,7 +250,7 @@ public final class NimbusJwtDecoder implements JwtDecoder { } /** - * Use the given public key to validate JWTs + * Use the given public key to validate JWTs. * @param key the public key to use * @return a {@link PublicKeyJwtDecoderBuilder} for further configurations */ diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtEncoder.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtEncoder.java index 9f6ee0eba5..aae49ebdf7 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtEncoder.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtEncoder.java @@ -424,7 +424,7 @@ public final class NimbusJwtEncoder implements JwtEncoder { } /** - * Creates a builder for constructing a {@link NimbusJwtEncoder} using the provided + * Creates a builder for constructing a {@link NimbusJwtEncoder} using the provided. * @param publicKey the {@link RSAPublicKey} and @Param privateKey the * {@link RSAPrivateKey} to use for signing JWTs * @return a {@link RsaKeyPairJwtEncoderBuilder} @@ -435,7 +435,7 @@ public final class NimbusJwtEncoder implements JwtEncoder { } /** - * Creates a builder for constructing a {@link NimbusJwtEncoder} using the provided + * Creates a builder for constructing a {@link NimbusJwtEncoder} using the provided. * @param publicKey the {@link ECPublicKey} and @param privateKey the * {@link ECPrivateKey} to use for signing JWTs * @return a {@link EcKeyPairJwtEncoderBuilder} @@ -446,7 +446,7 @@ public final class NimbusJwtEncoder implements JwtEncoder { } /** - * Creates a builder for constructing a {@link NimbusJwtEncoder} using the provided + * Creates a builder for constructing a {@link NimbusJwtEncoder} using the provided. * @param secretKey * @return a {@link SecretKeyJwtEncoderBuilder} for configuring the {@link JWK} * @since 7.0 diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusReactiveJwtDecoder.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusReactiveJwtDecoder.java index 4e5c357a18..35bb30e9a8 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusReactiveJwtDecoder.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusReactiveJwtDecoder.java @@ -139,7 +139,7 @@ public final class NimbusReactiveJwtDecoder implements ReactiveJwtDecoder { } /** - * Use the following {@link Converter} for manipulating the JWT's claim set + * Use the following {@link Converter} for manipulating the JWT's claim set. * @param claimSetConverter the {@link Converter} to use */ public void setClaimSetConverter(Converter, Map> claimSetConverter) { @@ -261,7 +261,7 @@ public final class NimbusReactiveJwtDecoder implements ReactiveJwtDecoder { } /** - * Use the given public key to validate JWTs + * Use the given public key to validate JWTs. * @param key the public key to use * @return a {@link PublicKeyReactiveJwtDecoderBuilder} for further configurations * @@ -283,7 +283,7 @@ public final class NimbusReactiveJwtDecoder implements ReactiveJwtDecoder { } /** - * Use the given {@link Function} to validate JWTs + * Use the given {@link Function} to validate JWTs. * @param source the {@link Function} * @return a {@link JwkSourceReactiveJwtDecoderBuilder} for further configurations * diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSource.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSource.java index 01ef9fb6f4..9f7e7a31c1 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSource.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSource.java @@ -23,7 +23,7 @@ import com.nimbusds.jose.jwk.JWKSelector; import reactor.core.publisher.Mono; /** - * A reactive version of {@link com.nimbusds.jose.jwk.source.JWKSource} + * A reactive version of {@link com.nimbusds.jose.jwk.source.JWKSource}. * * @author Rob Winch * @since 5.1 diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSourceAdapter.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSourceAdapter.java index f36defc47c..4680e6d32d 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSourceAdapter.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJWKSourceAdapter.java @@ -35,7 +35,7 @@ class ReactiveJWKSourceAdapter implements ReactiveJWKSource { private final JWKSource source; /** - * Creates a new instance + * Creates a new instance. * @param source */ ReactiveJWKSourceAdapter(JWKSource source) { diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveRemoteJWKSource.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveRemoteJWKSource.java index e976328623..77fca9ffb8 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveRemoteJWKSource.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveRemoteJWKSource.java @@ -34,6 +34,8 @@ import org.springframework.util.Assert; import org.springframework.web.reactive.function.client.WebClient; /** + * A {@link ReactiveJWKSource} that retrieves and caches a JWK set from a remote URL. + * * @author Rob Winch * @since 5.1 */ diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierJwtDecoder.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierJwtDecoder.java index 9e6a1a4e11..31f71b5684 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierJwtDecoder.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierJwtDecoder.java @@ -21,7 +21,7 @@ import java.util.function.Supplier; import org.springframework.util.function.SingletonSupplier; /** - * A {@link JwtDecoder} that lazily initializes another {@link JwtDecoder} + * A {@link JwtDecoder} that lazily initializes another {@link JwtDecoder}. * * @author Josh Cummings * @since 5.6 diff --git a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierReactiveJwtDecoder.java b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierReactiveJwtDecoder.java index 844a0265b0..86a5f445ab 100644 --- a/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierReactiveJwtDecoder.java +++ b/oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/SupplierReactiveJwtDecoder.java @@ -23,7 +23,8 @@ import reactor.core.publisher.Mono; import reactor.core.scheduler.Schedulers; /** - * A {@link ReactiveJwtDecoder} that lazily initializes another {@link ReactiveJwtDecoder} + * A {@link ReactiveJwtDecoder} that lazily initializes another + * {@link ReactiveJwtDecoder}. * * @author Josh Cummings * @since 5.6 diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenError.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenError.java index 267280c925..ddff189aee 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenError.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenError.java @@ -46,7 +46,7 @@ public final class BearerTokenError extends OAuth2Error { private final @Nullable String scope; /** - * Create a {@code BearerTokenError} using the provided parameters + * Create a {@code BearerTokenError} using the provided parameters. * @param errorCode the error code * @param httpStatus the HTTP status */ @@ -56,7 +56,7 @@ public final class BearerTokenError extends OAuth2Error { } /** - * Create a {@code BearerTokenError} using the provided parameters + * Create a {@code BearerTokenError} using the provided parameters. * @param errorCode the error code * @param httpStatus the HTTP status * @param description the description diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenErrors.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenErrors.java index 1f010b37dd..dd2f77ea1e 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenErrors.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/BearerTokenErrors.java @@ -42,7 +42,7 @@ public final class BearerTokenErrors { } /** - * Create a {@link BearerTokenError} caused by an invalid request + * Create a {@link BearerTokenError} caused by an invalid request. * @param message a description of the error * @return a {@link BearerTokenError} */ @@ -59,7 +59,7 @@ public final class BearerTokenErrors { } /** - * Create a {@link BearerTokenError} caused by an invalid token + * Create a {@link BearerTokenError} caused by an invalid token. * @param message a description of the error * @return a {@link BearerTokenError} */ @@ -76,7 +76,7 @@ public final class BearerTokenErrors { } /** - * Create a {@link BearerTokenError} caused by an invalid token + * Create a {@link BearerTokenError} caused by an invalid token. * @param scope the scope attribute to use in the error * @return a {@link BearerTokenError} */ diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/OAuth2ProtectedResourceMetadataClaimNames.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/OAuth2ProtectedResourceMetadataClaimNames.java index 8f434c83f8..c206bc865f 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/OAuth2ProtectedResourceMetadataClaimNames.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/OAuth2ProtectedResourceMetadataClaimNames.java @@ -29,19 +29,19 @@ public final class OAuth2ProtectedResourceMetadataClaimNames { /** * {@code resource} - the {@code URL} the protected resource asserts as its resource - * identifier + * identifier. */ public static final String RESOURCE = "resource"; /** * {@code authorization_servers} - a list of {@code issuer} identifier {@code URL}'s, - * for authorization servers that can be used with this protected resource + * for authorization servers that can be used with this protected resource. */ public static final String AUTHORIZATION_SERVERS = "authorization_servers"; /** * {@code scopes_supported} - a list of {@code scope} values supported, that are used - * in authorization requests to request access to this protected resource + * in authorization requests to request access to this protected resource. */ public static final String SCOPES_SUPPORTED = "scopes_supported"; @@ -54,13 +54,13 @@ public final class OAuth2ProtectedResourceMetadataClaimNames { /** * {@code resource_name} - the name of the protected resource intended for display to - * the end user + * the end user. */ public static final String RESOURCE_NAME = "resource_name"; /** * {@code tls_client_certificate_bound_access_tokens} - {@code true} to indicate - * protected resource support for mutual-TLS client certificate-bound access tokens + * protected resource support for mutual-TLS client certificate-bound access tokens. */ public static final String TLS_CLIENT_CERTIFICATE_BOUND_ACCESS_TOKENS = "tls_client_certificate_bound_access_tokens"; diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/AbstractOAuth2TokenAuthenticationToken.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/AbstractOAuth2TokenAuthenticationToken.java index 89777976d4..9d86a67044 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/AbstractOAuth2TokenAuthenticationToken.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/AbstractOAuth2TokenAuthenticationToken.java @@ -117,7 +117,7 @@ public abstract class AbstractOAuth2TokenAuthenticationToken getTokenAttributes(); /** - * A builder for {@link AbstractOAuth2TokenAuthenticationToken} implementations + * A builder for {@link AbstractOAuth2TokenAuthenticationToken} implementations. * * @param * @since 7.0 diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthentication.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthentication.java index 59c230ecf7..3330a370cc 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthentication.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthentication.java @@ -45,7 +45,7 @@ public class BearerTokenAuthentication extends AbstractOAuth2TokenAuthentication private final Map attributes; /** - * Constructs a {@link BearerTokenAuthentication} with the provided arguments + * Constructs a {@link BearerTokenAuthentication} with the provided arguments. * @param principal The OAuth 2.0 attributes * @param credentials The verified token * @param authorities The authorities associated with the given token @@ -75,7 +75,7 @@ public class BearerTokenAuthentication extends AbstractOAuth2TokenAuthentication } /** - * A builder preserving the concrete {@link Authentication} type + * A builder preserving the concrete {@link Authentication} type. * * @since 7.0 */ @@ -103,7 +103,7 @@ public class BearerTokenAuthentication extends AbstractOAuth2TokenAuthentication } /** - * A synonym for {@link #token(OAuth2AccessToken)} + * A synonym for {@link #token(OAuth2AccessToken)}. * @param token the token to use * @return the {@link Builder} for further configurations */ diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthenticationToken.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthenticationToken.java index bf4591ff14..73440044a1 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthenticationToken.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/BearerTokenAuthenticationToken.java @@ -41,7 +41,7 @@ public class BearerTokenAuthenticationToken extends AbstractAuthenticationToken private final String token; /** - * Create a {@code BearerTokenAuthenticationToken} using the provided parameter(s) + * Create a {@code BearerTokenAuthenticationToken} using the provided parameter(s). * @param token - the bearer token */ public BearerTokenAuthenticationToken(String token) { @@ -53,7 +53,7 @@ public class BearerTokenAuthenticationToken extends AbstractAuthenticationToken /** * Get the * Bearer - * Token + * Token. * @return the token that proves the caller's authority to perform the * {@link jakarta.servlet.http.HttpServletRequest} */ diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/DelegatingJwtGrantedAuthoritiesConverter.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/DelegatingJwtGrantedAuthoritiesConverter.java index 218a4a5169..69c7e02486 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/DelegatingJwtGrantedAuthoritiesConverter.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/DelegatingJwtGrantedAuthoritiesConverter.java @@ -58,7 +58,7 @@ public class DelegatingJwtGrantedAuthoritiesConverter implements Converter authenticationConverter = this::defaultAuthenticationConverter; /** - * Creates a {@code OpaqueTokenAuthenticationProvider} with the provided parameters + * Creates a {@code OpaqueTokenAuthenticationProvider} with the provided parameters. * @param introspectionUri The introspection endpoint uri * @param clientId The URL-encoded client id authorized to introspect * @param clientSecret The URL-encoded client secret authorized to introspect @@ -278,7 +278,7 @@ public class SpringOpaqueTokenIntrospector implements OpaqueTokenIntrospector { /** * Creates a {@code SpringOpaqueTokenIntrospector.Builder} with the given - * introspection endpoint uri + * introspection endpoint uri. * @param introspectionUri The introspection endpoint uri * @return the {@link SpringOpaqueTokenIntrospector.Builder} * @since 6.5 @@ -375,7 +375,7 @@ public class SpringOpaqueTokenIntrospector implements OpaqueTokenIntrospector { } /** - * Creates a {@code SpringOpaqueTokenIntrospector} + * Creates a {@code SpringOpaqueTokenIntrospector}. * @return the {@link SpringOpaqueTokenIntrospector} * @since 6.5 */ diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/introspection/SpringReactiveOpaqueTokenIntrospector.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/introspection/SpringReactiveOpaqueTokenIntrospector.java index a6d56cad41..5559160d4b 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/introspection/SpringReactiveOpaqueTokenIntrospector.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/introspection/SpringReactiveOpaqueTokenIntrospector.java @@ -74,7 +74,7 @@ public class SpringReactiveOpaqueTokenIntrospector implements ReactiveOpaqueToke /** * Creates a {@code OpaqueTokenReactiveAuthenticationManager} with the provided - * parameters + * parameters. * @param introspectionUri The introspection endpoint uri * @param clientId The URL-encoded client id authorized to introspect * @param clientSecret The URL-encoded client secret authorized to introspect @@ -91,7 +91,7 @@ public class SpringReactiveOpaqueTokenIntrospector implements ReactiveOpaqueToke /** * Creates a {@code OpaqueTokenReactiveAuthenticationManager} with the provided - * parameters + * parameters. * @param introspectionUri The introspection endpoint uri * @param webClient The client for performing the introspection request */ @@ -231,7 +231,7 @@ public class SpringReactiveOpaqueTokenIntrospector implements ReactiveOpaqueToke /** * Creates a {@code SpringReactiveOpaqueTokenIntrospector.Builder} with the given - * introspection endpoint uri + * introspection endpoint uri. * @param introspectionUri The introspection endpoint uri * @return the {@link SpringReactiveOpaqueTokenIntrospector.Builder} * @since 6.5 @@ -329,7 +329,7 @@ public class SpringReactiveOpaqueTokenIntrospector implements ReactiveOpaqueToke } /** - * Creates a {@code SpringReactiveOpaqueTokenIntrospector} + * Creates a {@code SpringReactiveOpaqueTokenIntrospector}. * @return the {@link SpringReactiveOpaqueTokenIntrospector} * @since 6.5 */ diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/BearerTokenAuthenticationEntryPoint.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/BearerTokenAuthenticationEntryPoint.java index b08cf11434..6677e03a2c 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/BearerTokenAuthenticationEntryPoint.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/BearerTokenAuthenticationEntryPoint.java @@ -95,7 +95,7 @@ public final class BearerTokenAuthenticationEntryPoint implements Authentication } /** - * Set the default realm name to use in the bearer token error response + * Set the default realm name to use in the bearer token error response. * @param realmName the realm name, or {@code null} */ public void setRealmName(@Nullable String realmName) { diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/BearerTokenAccessDeniedHandler.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/BearerTokenAccessDeniedHandler.java index bddc6d1360..a2c90ef214 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/BearerTokenAccessDeniedHandler.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/BearerTokenAccessDeniedHandler.java @@ -76,7 +76,7 @@ public final class BearerTokenAccessDeniedHandler implements AccessDeniedHandler } /** - * Set the default realm name to use in the bearer token error response + * Set the default realm name to use in the bearer token error response. * @param realmName */ public void setRealmName(@Nullable String realmName) { diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/server/BearerTokenServerAccessDeniedHandler.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/server/BearerTokenServerAccessDeniedHandler.java index d2b2bf6995..ce9c29aa79 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/server/BearerTokenServerAccessDeniedHandler.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/access/server/BearerTokenServerAccessDeniedHandler.java @@ -70,7 +70,7 @@ public class BearerTokenServerAccessDeniedHandler implements ServerAccessDeniedH } /** - * Set the default realm name to use in the bearer token error response + * Set the default realm name to use in the bearer token error response. * @param realmName */ public final void setRealmName(@Nullable String realmName) { diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationConverter.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationConverter.java index 340de5bbe9..e377537fe4 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationConverter.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationConverter.java @@ -31,7 +31,7 @@ import org.springframework.util.StringUtils; /** * Implementation of {@link AuthenticationConverter}, that converts request to - * {@link BearerTokenAuthenticationToken} + * {@link BearerTokenAuthenticationToken}. * * @author Max Batischev * @author Josh Cummings diff --git a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationFilter.java b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationFilter.java index 6541b5aa7a..862c8fbdd9 100644 --- a/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationFilter.java +++ b/oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/web/authentication/BearerTokenAuthenticationFilter.java @@ -94,7 +94,8 @@ public class BearerTokenAuthenticationFilter extends OncePerRequestFilter { private SecurityContextRepository securityContextRepository = new RequestAttributeSecurityContextRepository(); /** - * Construct a {@code BearerTokenAuthenticationFilter} using the provided parameter(s) + * Construct a {@code BearerTokenAuthenticationFilter} using the provided + * parameter(s). * @param authenticationManagerResolver */ public BearerTokenAuthenticationFilter( @@ -103,7 +104,8 @@ public class BearerTokenAuthenticationFilter extends OncePerRequestFilter { } /** - * Construct a {@code BearerTokenAuthenticationFilter} using the provided parameter(s) + * Construct a {@code BearerTokenAuthenticationFilter} using the provided + * parameter(s). * @param authenticationManager */ public BearerTokenAuthenticationFilter(AuthenticationManager authenticationManager) { @@ -111,7 +113,7 @@ public class BearerTokenAuthenticationFilter extends OncePerRequestFilter { } /** - * Construct this filter using the provided parameters + * Construct this filter using the provided parameters. * @param authenticationManager the {@link AuthenticationManager} to use * @param authenticationConverter the {@link AuthenticationConverter} to use * @since 7.0 @@ -128,7 +130,7 @@ public class BearerTokenAuthenticationFilter extends OncePerRequestFilter { } /** - * Construct this filter using the provided parameters + * Construct this filter using the provided parameters. * @param authenticationManagerResolver the {@link AuthenticationManagerResolver} to * use * @param authenticationConverter the {@link AuthenticationConverter} to use diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/api/PayloadExchangeType.java b/rsocket/src/main/java/org/springframework/security/rsocket/api/PayloadExchangeType.java index 3bc0a48c0a..6fc0093e9b 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/api/PayloadExchangeType.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/api/PayloadExchangeType.java @@ -17,7 +17,7 @@ package org.springframework.security.rsocket.api; /** - * The {@link PayloadExchange} type + * The {@link PayloadExchange} type. * * @author Rob Winch * @since 5.2 diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AnonymousPayloadInterceptor.java b/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AnonymousPayloadInterceptor.java index c654ad76ac..c3073ac801 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AnonymousPayloadInterceptor.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AnonymousPayloadInterceptor.java @@ -32,7 +32,7 @@ import org.springframework.util.Assert; /** * If {@link ReactiveSecurityContextHolder} is empty populates an - * {@code AnonymousAuthenticationToken} + * {@code AnonymousAuthenticationToken}. * * @author Rob Winch * @since 5.2 @@ -57,6 +57,7 @@ public class AnonymousPayloadInterceptor implements PayloadInterceptor, Ordered } /** + * Creates a filter with the given principal and authorities. * @param key key the key to identify tokens created by this filter * @param principal the principal which will be used to represent anonymous users * @param authorities the authority list for anonymous users diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AuthenticationPayloadInterceptor.java b/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AuthenticationPayloadInterceptor.java index c9272cfc9b..9ef7151367 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AuthenticationPayloadInterceptor.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/authentication/AuthenticationPayloadInterceptor.java @@ -44,7 +44,7 @@ public class AuthenticationPayloadInterceptor implements PayloadInterceptor, Ord private PayloadExchangeAuthenticationConverter authenticationConverter = new BasicAuthenticationPayloadExchangeConverter(); /** - * Creates a new instance + * Creates a new instance. * @param authenticationManager the manager to use. Cannot be null */ public AuthenticationPayloadInterceptor(ReactiveAuthenticationManager authenticationManager) { @@ -62,7 +62,7 @@ public class AuthenticationPayloadInterceptor implements PayloadInterceptor, Ord } /** - * Sets the convert to be used + * Sets the convert to be used. * @param authenticationConverter */ public void setAuthenticationConverter(PayloadExchangeAuthenticationConverter authenticationConverter) { diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/authentication/PayloadExchangeAuthenticationConverter.java b/rsocket/src/main/java/org/springframework/security/rsocket/authentication/PayloadExchangeAuthenticationConverter.java index de59c0cc94..d4a1435704 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/authentication/PayloadExchangeAuthenticationConverter.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/authentication/PayloadExchangeAuthenticationConverter.java @@ -22,7 +22,7 @@ import org.springframework.security.core.Authentication; import org.springframework.security.rsocket.api.PayloadExchange; /** - * Converts from a {@link PayloadExchange} to an {@link Authentication} + * Converts from a {@link PayloadExchange} to an {@link Authentication}. * * @author Rob Winch * @since 5.2 diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/core/DefaultPayloadExchange.java b/rsocket/src/main/java/org/springframework/security/rsocket/core/DefaultPayloadExchange.java index 183f5139ce..c4d39bd45e 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/core/DefaultPayloadExchange.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/core/DefaultPayloadExchange.java @@ -24,7 +24,7 @@ import org.springframework.util.Assert; import org.springframework.util.MimeType; /** - * Default implementation of {@link PayloadExchange} + * Default implementation of {@link PayloadExchange}. * * @author Rob Winch * @since 5.2 diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadInterceptorRSocket.java b/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadInterceptorRSocket.java index 2e46f0963b..1dcce0c954 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadInterceptorRSocket.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadInterceptorRSocket.java @@ -32,7 +32,7 @@ import org.springframework.util.Assert; import org.springframework.util.MimeType; /** - * Combines the {@link PayloadInterceptor} with an {@link RSocketProxy} + * Combines the {@link PayloadInterceptor} with an {@link RSocketProxy}. * * @author Rob Winch * @since 5.2 diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptor.java b/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptor.java index fffca5a636..2d4a232f49 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptor.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptor.java @@ -35,6 +35,9 @@ import org.springframework.util.MimeTypeUtils; import org.springframework.util.StringUtils; /** + * A {@link SocketAcceptor} that applies {@link PayloadInterceptor} instances to the setup + * exchange before delegating to accept the connection. + * * @author Rob Winch * @since 5.2 */ diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptorInterceptor.java b/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptorInterceptor.java index 22dc67c134..93e1124625 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptorInterceptor.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/core/PayloadSocketAcceptorInterceptor.java @@ -29,7 +29,7 @@ import org.springframework.util.MimeType; import org.springframework.util.MimeTypeUtils; /** - * A {@link SocketAcceptorInterceptor} that applies the {@link PayloadInterceptor}s + * A {@link SocketAcceptorInterceptor} that applies the {@link PayloadInterceptor}s. * * @author Rob Winch * @since 5.2 diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationDecoder.java b/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationDecoder.java index bbe224742e..485e243327 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationDecoder.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationDecoder.java @@ -29,7 +29,7 @@ import org.springframework.core.io.buffer.DataBuffer; import org.springframework.util.MimeType; /** - * Decodes {@link UsernamePasswordMetadata#BASIC_AUTHENTICATION_MIME_TYPE} + * Decodes {@link UsernamePasswordMetadata#BASIC_AUTHENTICATION_MIME_TYPE}. * * @author Rob Winch * @since 5.2 diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationEncoder.java b/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationEncoder.java index bd98fbe0fa..0ac140cf3d 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationEncoder.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/metadata/BasicAuthenticationEncoder.java @@ -32,7 +32,7 @@ import org.springframework.core.io.buffer.DataBufferUtils; import org.springframework.util.MimeType; /** - * Encodes {@link UsernamePasswordMetadata#BASIC_AUTHENTICATION_MIME_TYPE} + * Encodes {@link UsernamePasswordMetadata#BASIC_AUTHENTICATION_MIME_TYPE}. * * @author Rob Winch * @since 5.2 diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeAuthorizationContext.java b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeAuthorizationContext.java index d8b93f8476..5f20570b06 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeAuthorizationContext.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeAuthorizationContext.java @@ -22,6 +22,8 @@ import java.util.Map; import org.springframework.security.rsocket.api.PayloadExchange; /** + * The context used for authorizing a {@link PayloadExchange}. + * * @author Rob Winch * @since 5.2 */ diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcher.java b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcher.java index dde03690d3..35552a2c02 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcher.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcher.java @@ -34,14 +34,14 @@ import org.springframework.security.rsocket.api.PayloadExchange; public interface PayloadExchangeMatcher { /** - * Determines if a request matches or not + * Determines if a request matches or not. * @param exchange * @return */ Mono matches(PayloadExchange exchange); /** - * The result of matching + * The result of matching. */ class MatchResult { @@ -59,7 +59,7 @@ public interface PayloadExchangeMatcher { } /** - * Gets potential variables and their values + * Gets potential variables and their values. * @return */ public @Nullable Map getVariables() { @@ -67,7 +67,7 @@ public interface PayloadExchangeMatcher { } /** - * Creates an instance of {@link MatchResult} that is a match with no variables + * Creates an instance of {@link MatchResult} that is a match with no variables. * @return */ public static Mono match() { @@ -77,7 +77,7 @@ public interface PayloadExchangeMatcher { /** * * Creates an instance of {@link MatchResult} that is a match with the specified - * variables + * variables. * @param variables * @return */ diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcherEntry.java b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcherEntry.java index a0855f8ad4..cc4e5a7482 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcherEntry.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatcherEntry.java @@ -17,6 +17,8 @@ package org.springframework.security.rsocket.util.matcher; /** + * Associates a {@link PayloadExchangeMatcher} with an entry of a given type. + * * @author Rob Winch */ public class PayloadExchangeMatcherEntry { diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatchers.java b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatchers.java index 6eaced0c40..ff48462114 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatchers.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/PayloadExchangeMatchers.java @@ -19,6 +19,8 @@ package org.springframework.security.rsocket.util.matcher; import org.springframework.security.rsocket.api.PayloadExchangeType; /** + * Static factory methods for creating common {@link PayloadExchangeMatcher} instances. + * * @author Rob Winch */ public final class PayloadExchangeMatchers { diff --git a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/RoutePayloadExchangeMatcher.java b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/RoutePayloadExchangeMatcher.java index f50280f02a..59069cfb7a 100644 --- a/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/RoutePayloadExchangeMatcher.java +++ b/rsocket/src/main/java/org/springframework/security/rsocket/util/matcher/RoutePayloadExchangeMatcher.java @@ -29,6 +29,8 @@ import org.springframework.util.RouteMatcher; // FIXME: Pay attention to the package this goes into. It requires spring-messaging for the MetadataExtractor. /** + * A {@link PayloadExchangeMatcher} that matches based on the request's route. + * * @author Rob Winch * @since 5.2 */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/Saml2Exception.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/Saml2Exception.java index 8ef1565e2e..a9d4c45b27 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/Saml2Exception.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/Saml2Exception.java @@ -19,6 +19,8 @@ package org.springframework.security.saml2; import java.io.Serial; /** + * A generic exception for SAML 2.0 related errors. + * * @since 5.2 */ public class Saml2Exception extends RuntimeException { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2Error.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2Error.java index a6150cffda..b48c604d57 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2Error.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2Error.java @@ -53,7 +53,7 @@ public class Saml2Error implements Serializable { } /** - * Construct an {@link Saml2ErrorCodes#INVALID_RESPONSE} error + * Construct an {@link Saml2ErrorCodes#INVALID_RESPONSE} error. * @param description the error description * @return the resulting {@link Saml2Error} * @since 7.0 @@ -63,7 +63,7 @@ public class Saml2Error implements Serializable { } /** - * Construct an {@link Saml2ErrorCodes#INTERNAL_VALIDATION_ERROR} error + * Construct an {@link Saml2ErrorCodes#INTERNAL_VALIDATION_ERROR} error. * @param description the error description * @return the resulting {@link Saml2Error} * @since 7.0 @@ -73,7 +73,7 @@ public class Saml2Error implements Serializable { } /** - * Construct an {@link Saml2ErrorCodes#MALFORMED_RESPONSE_DATA} error + * Construct an {@link Saml2ErrorCodes#MALFORMED_RESPONSE_DATA} error. * @param description the error description * @return the resulting {@link Saml2Error} * @since 7.0 @@ -83,7 +83,7 @@ public class Saml2Error implements Serializable { } /** - * Construct an {@link Saml2ErrorCodes#DECRYPTION_ERROR} error + * Construct an {@link Saml2ErrorCodes#DECRYPTION_ERROR} error. * @param description the error description * @return the resulting {@link Saml2Error} * @since 7.0 @@ -93,7 +93,7 @@ public class Saml2Error implements Serializable { } /** - * Construct an {@link Saml2ErrorCodes#RELYING_PARTY_REGISTRATION_NOT_FOUND} error + * Construct an {@link Saml2ErrorCodes#RELYING_PARTY_REGISTRATION_NOT_FOUND} error. * @param description the error description * @return the resulting {@link Saml2Error} * @since 7.0 @@ -103,7 +103,7 @@ public class Saml2Error implements Serializable { } /** - * Construct an {@link Saml2ErrorCodes#SUBJECT_NOT_FOUND} error + * Construct an {@link Saml2ErrorCodes#SUBJECT_NOT_FOUND} error. * @param description the error description * @return the resulting {@link Saml2Error} * @since 7.0 diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ParameterNames.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ParameterNames.java index a5812329bf..1a6e6b49f7 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ParameterNames.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ParameterNames.java @@ -30,18 +30,18 @@ package org.springframework.security.saml2.core; public final class Saml2ParameterNames { /** - * {@code SAMLRequest} - used to request authentication or request logout + * {@code SAMLRequest} - used to request authentication or request logout. */ public static final String SAML_REQUEST = "SAMLRequest"; /** - * {@code SAMLResponse} - used to respond to an authentication or logout request + * {@code SAMLResponse} - used to respond to an authentication or logout request. */ public static final String SAML_RESPONSE = "SAMLResponse"; /** * {@code RelayState} - used to communicate shared state between the relying and - * asserting party + * asserting party. * @see 3.1.1 * Use of RelayState @@ -50,7 +50,7 @@ public final class Saml2ParameterNames { /** * {@code SigAlg} - used to communicate which signature algorithm to use to verify - * signature + * signature. */ public static final String SIG_ALG = "SigAlg"; diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ResponseValidatorResult.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ResponseValidatorResult.java index 04fef88dec..041b7a2f61 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ResponseValidatorResult.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2ResponseValidatorResult.java @@ -41,7 +41,7 @@ public final class Saml2ResponseValidatorResult { } /** - * Say whether this result indicates success + * Say whether this result indicates success. * @return whether this result has errors */ public boolean hasErrors() { @@ -49,7 +49,7 @@ public final class Saml2ResponseValidatorResult { } /** - * Return error details regarding the validation attempt + * Return error details regarding the validation attempt. * @return the collection of results in this result, if any; returns an empty list * otherwise */ @@ -59,7 +59,7 @@ public final class Saml2ResponseValidatorResult { /** * Return a new {@link Saml2ResponseValidatorResult} that contains both the given - * {@link Saml2Error} and the errors from the result + * {@link Saml2Error} and the errors from the result. * @param error the {@link Saml2Error} to append * @return a new {@link Saml2ResponseValidatorResult} for further reporting */ @@ -84,7 +84,7 @@ public final class Saml2ResponseValidatorResult { } /** - * Construct a successful {@link Saml2ResponseValidatorResult} + * Construct a successful {@link Saml2ResponseValidatorResult}. * @return an {@link Saml2ResponseValidatorResult} with no errors */ public static Saml2ResponseValidatorResult success() { @@ -92,7 +92,7 @@ public final class Saml2ResponseValidatorResult { } /** - * Construct a failure {@link Saml2ResponseValidatorResult} with the provided detail + * Construct a failure {@link Saml2ResponseValidatorResult} with the provided detail. * @param errors the list of errors * @return an {@link Saml2ResponseValidatorResult} with the errors specified */ @@ -101,7 +101,7 @@ public final class Saml2ResponseValidatorResult { } /** - * Construct a failure {@link Saml2ResponseValidatorResult} with the provided detail + * Construct a failure {@link Saml2ResponseValidatorResult} with the provided detail. * @param errors the list of errors * @return an {@link Saml2ResponseValidatorResult} with the errors specified */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2X509Credential.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2X509Credential.java index 1a6016df5c..bb6d8e32f2 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2X509Credential.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/core/Saml2X509Credential.java @@ -49,7 +49,7 @@ public final class Saml2X509Credential implements Serializable { private final Set credentialTypes; /** - * Creates a {@link Saml2X509Credential} using the provided parameters + * Creates a {@link Saml2X509Credential} using the provided parameters. * @param certificate the credential's public certificate * @param types the credential's intended usages, must be one of * {@link Saml2X509CredentialType#VERIFICATION} or @@ -61,7 +61,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Creates a {@link Saml2X509Credential} using the provided parameters + * Creates a {@link Saml2X509Credential} using the provided parameters. * @param privateKey the credential's private key * @param certificate the credential's public certificate * @param types the credential's intended usages, must be one of @@ -74,7 +74,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Creates a {@link Saml2X509Credential} using the provided parameters + * Creates a {@link Saml2X509Credential} using the provided parameters. * @param privateKey the credential's private key * @param certificate the credential's public certificate * @param types the credential's intended usages @@ -139,7 +139,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Get the private key for this credential + * Get the private key for this credential. * @return the private key, may be null * @see #Saml2X509Credential(PrivateKey, X509Certificate, Saml2X509CredentialType...) */ @@ -148,7 +148,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Get the public certificate for this credential + * Get the public certificate for this credential. * @return the public certificate */ public X509Certificate getCertificate() { @@ -156,7 +156,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Indicate whether this credential can be used for signing + * Indicate whether this credential can be used for signing. * @return true if the credential has a {@link Saml2X509CredentialType#SIGNING} type */ public boolean isSigningCredential() { @@ -164,7 +164,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Indicate whether this credential can be used for decryption + * Indicate whether this credential can be used for decryption. * @return true if the credential has a {@link Saml2X509CredentialType#DECRYPTION} * type */ @@ -173,7 +173,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Indicate whether this credential can be used for verification + * Indicate whether this credential can be used for verification. * @return true if the credential has a {@link Saml2X509CredentialType#VERIFICATION} * type */ @@ -182,7 +182,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * Indicate whether this credential can be used for encryption + * Indicate whether this credential can be used for encryption. * @return true if the credential has a {@link Saml2X509CredentialType#ENCRYPTION} * type */ @@ -191,7 +191,7 @@ public final class Saml2X509Credential implements Serializable { } /** - * List all this credential's intended usages + * List all this credential's intended usages. * @return the set of this credential's intended usages */ public Set getCredentialTypes() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/DefaultSaml2AuthenticatedPrincipalMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/DefaultSaml2AuthenticatedPrincipalMixin.java index 3ba69381b6..1753bdce7c 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/DefaultSaml2AuthenticatedPrincipalMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/DefaultSaml2AuthenticatedPrincipalMixin.java @@ -20,8 +20,10 @@ import java.util.List; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson.SecurityJacksonModules; @@ -37,8 +39,8 @@ import org.springframework.security.saml2.provider.service.authentication.Defaul * @see Saml2JacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @NullUnmarked class DefaultSaml2AuthenticatedPrincipalMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AssertionAuthenticationMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AssertionAuthenticationMixin.java index 8686758e7b..04ed8d2cc6 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AssertionAuthenticationMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AssertionAuthenticationMixin.java @@ -19,9 +19,11 @@ package org.springframework.security.saml2.jackson; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.core.GrantedAuthority; @@ -39,9 +41,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2R * @see Saml2JacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @NullUnmarked class Saml2AssertionAuthenticationMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationExceptionMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationExceptionMixin.java index a22eea8751..3538b83bbb 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationExceptionMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationExceptionMixin.java @@ -17,10 +17,12 @@ package org.springframework.security.saml2.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.saml2.core.Saml2Error; @@ -35,9 +37,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2A * @see Saml2AuthenticationException * @see Saml2JacksonModule */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.NONE, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties({ "cause", "stackTrace", "suppressedExceptions" }) @NullUnmarked abstract class Saml2AuthenticationExceptionMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationMixin.java index 46e1a0a122..16a8c13d53 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2AuthenticationMixin.java @@ -19,10 +19,12 @@ package org.springframework.security.saml2.jackson; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.core.AuthenticatedPrincipal; @@ -38,9 +40,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2A * @see Saml2JacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties({ "authenticated" }) @NullUnmarked class Saml2AuthenticationMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2ErrorMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2ErrorMixin.java index 8b6e971c83..52e8e9e388 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2ErrorMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2ErrorMixin.java @@ -17,9 +17,11 @@ package org.springframework.security.saml2.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.saml2.core.Saml2Error; @@ -33,9 +35,9 @@ import org.springframework.security.saml2.core.Saml2Error; * @see Saml2Error * @see Saml2JacksonModule */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @NullUnmarked class Saml2ErrorMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2LogoutRequestMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2LogoutRequestMixin.java index 6e8e071fbb..4c3627b98c 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2LogoutRequestMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2LogoutRequestMixin.java @@ -20,10 +20,12 @@ import java.util.Map; import java.util.function.Function; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson.SecurityJacksonModules; @@ -39,8 +41,8 @@ import org.springframework.security.saml2.provider.service.registration.Saml2Mes * @see Saml2JacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @NullUnmarked class Saml2LogoutRequestMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2PostAuthenticationRequestMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2PostAuthenticationRequestMixin.java index c812b92d12..8d528743b1 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2PostAuthenticationRequestMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2PostAuthenticationRequestMixin.java @@ -17,9 +17,11 @@ package org.springframework.security.saml2.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson.SecurityJacksonModules; @@ -35,8 +37,8 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2P * @see Saml2JacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @NullUnmarked class Saml2PostAuthenticationRequestMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2RedirectAuthenticationRequestMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2RedirectAuthenticationRequestMixin.java index 1e6fc70f8e..bfaeeb36cb 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2RedirectAuthenticationRequestMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/Saml2RedirectAuthenticationRequestMixin.java @@ -17,9 +17,11 @@ package org.springframework.security.saml2.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson.SecurityJacksonModules; @@ -35,8 +37,8 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2R * @see Saml2JacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @NullUnmarked class Saml2RedirectAuthenticationRequestMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/SimpleSaml2ResponseAssertionAccessorMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/SimpleSaml2ResponseAssertionAccessorMixin.java index d6a41f160f..c0d016cd85 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/SimpleSaml2ResponseAssertionAccessorMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson/SimpleSaml2ResponseAssertionAccessorMixin.java @@ -20,10 +20,12 @@ import java.util.List; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson.SecurityJacksonModules; @@ -38,9 +40,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2R * @see Saml2JacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties({ "authenticated" }) @NullUnmarked class SimpleSaml2ResponseAssertionAccessorMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/DefaultSaml2AuthenticatedPrincipalMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/DefaultSaml2AuthenticatedPrincipalMixin.java index bb1834f385..223bb5ba35 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/DefaultSaml2AuthenticatedPrincipalMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/DefaultSaml2AuthenticatedPrincipalMixin.java @@ -20,9 +20,11 @@ import java.util.List; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson2.SecurityJackson2Modules; @@ -47,8 +49,8 @@ import org.springframework.security.saml2.provider.service.authentication.Defaul */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) @NullUnmarked class DefaultSaml2AuthenticatedPrincipalMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AssertionAuthenticationMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AssertionAuthenticationMixin.java index 4697b76e6a..fbe4cd6ca9 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AssertionAuthenticationMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AssertionAuthenticationMixin.java @@ -19,10 +19,12 @@ package org.springframework.security.saml2.jackson2; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.core.GrantedAuthority; @@ -49,9 +51,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2R */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(value = { "authenticated" }, ignoreUnknown = true) @NullUnmarked class Saml2AssertionAuthenticationMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationExceptionMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationExceptionMixin.java index dd3deb878c..49467090b1 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationExceptionMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationExceptionMixin.java @@ -17,10 +17,12 @@ package org.springframework.security.saml2.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.saml2.core.Saml2Error; @@ -39,9 +41,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2A */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.NONE, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true, value = { "cause", "stackTrace", "suppressedExceptions" }) @NullUnmarked abstract class Saml2AuthenticationExceptionMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationMixin.java index 0bf96be01c..c2c0ea63be 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2AuthenticationMixin.java @@ -19,10 +19,12 @@ package org.springframework.security.saml2.jackson2; import java.util.Collection; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.core.AuthenticatedPrincipal; @@ -48,9 +50,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2A */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(value = { "authenticated" }, ignoreUnknown = true) @NullUnmarked class Saml2AuthenticationMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2ErrorMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2ErrorMixin.java index 551e049cbf..3edc5eb8ea 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2ErrorMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2ErrorMixin.java @@ -17,10 +17,12 @@ package org.springframework.security.saml2.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.saml2.core.Saml2Error; @@ -37,9 +39,9 @@ import org.springframework.security.saml2.core.Saml2Error; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) @NullUnmarked class Saml2ErrorMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2LogoutRequestMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2LogoutRequestMixin.java index 7ff0a9341a..c5e1f87f06 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2LogoutRequestMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2LogoutRequestMixin.java @@ -20,11 +20,13 @@ import java.util.Map; import java.util.function.Function; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson2.SecurityJackson2Modules; @@ -49,8 +51,8 @@ import org.springframework.security.saml2.provider.service.registration.Saml2Mes */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) @NullUnmarked class Saml2LogoutRequestMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2PostAuthenticationRequestMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2PostAuthenticationRequestMixin.java index d39dec9bf5..a8decf92ba 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2PostAuthenticationRequestMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2PostAuthenticationRequestMixin.java @@ -17,10 +17,12 @@ package org.springframework.security.saml2.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson2.SecurityJackson2Modules; @@ -45,8 +47,8 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2P */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) @NullUnmarked class Saml2PostAuthenticationRequestMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2RedirectAuthenticationRequestMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2RedirectAuthenticationRequestMixin.java index 286f7fa8eb..251faf6edf 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2RedirectAuthenticationRequestMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/Saml2RedirectAuthenticationRequestMixin.java @@ -17,10 +17,12 @@ package org.springframework.security.saml2.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson2.SecurityJackson2Modules; @@ -45,8 +47,8 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2R */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) @JsonIgnoreProperties(ignoreUnknown = true) @NullUnmarked class Saml2RedirectAuthenticationRequestMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/SimpleSaml2ResponseAssertionAccessorMixin.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/SimpleSaml2ResponseAssertionAccessorMixin.java index c04bc852bf..cac20d9fe0 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/SimpleSaml2ResponseAssertionAccessorMixin.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/jackson2/SimpleSaml2ResponseAssertionAccessorMixin.java @@ -20,10 +20,12 @@ import java.util.List; import java.util.Map; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.NullUnmarked; import org.springframework.security.jackson2.SecurityJackson2Modules; @@ -47,9 +49,9 @@ import org.springframework.security.saml2.provider.service.authentication.Saml2R */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonIgnoreProperties(value = { "authenticated" }, ignoreUnknown = true) @NullUnmarked class SimpleSaml2ResponseAssertionAccessorMixin { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/AbstractSaml2AuthenticationRequest.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/AbstractSaml2AuthenticationRequest.java index 09848878af..a458a963a2 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/AbstractSaml2AuthenticationRequest.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/AbstractSaml2AuthenticationRequest.java @@ -53,7 +53,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable private final @Nullable String id; /** - * Mandatory constructor for the {@link AbstractSaml2AuthenticationRequest} + * Mandatory constructor for the {@link AbstractSaml2AuthenticationRequest}. * @param samlRequest - the SAMLRequest XML data, SAML encoded, cannot be empty or * null * @param relayState - RelayState value that accompanies the request, may be null @@ -87,7 +87,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable } /** - * Returns the RelayState value, if present in the parameters + * Returns the RelayState value, if present in the parameters. * @return the RelayState value, or null if not available */ public @Nullable String getRelayState() { @@ -104,7 +104,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable /** * The identifier for the {@link RelyingPartyRegistration} associated with this - * request + * request. * @return the {@link RelyingPartyRegistration} id * @since 5.8 */ @@ -113,7 +113,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable } /** - * The unique identifier for this Authentication Request + * The unique identifier for this Authentication Request. * @return the Authentication Request identifier * @since 5.8 */ @@ -145,6 +145,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable @Nullable String id; /** + * Creates a new Builder. * @deprecated Use {@link #Builder(RelyingPartyRegistration)} instead */ @Deprecated @@ -152,7 +153,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable } /** - * Creates a new Builder with relying party registration + * Creates a new Builder with relying party registration. * @param registration the registration of the relying party. * @since 5.8 */ @@ -161,7 +162,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable } /** - * Casting the return as the generic subtype, when returning itself + * Casting the return as the generic subtype, when returning itself. * @return this object */ @SuppressWarnings("unchecked") @@ -170,7 +171,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable } /** - * Sets the {@code RelayState} parameter that will accompany this AuthNRequest + * Sets the {@code RelayState} parameter that will accompany this AuthNRequest. * @param relayState the relay state value, unencoded. if null or empty, the * parameter will be removed from the map. * @return this object @@ -181,7 +182,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable } /** - * Sets the {@code SAMLRequest} parameter that will accompany this AuthNRequest + * Sets the {@code SAMLRequest} parameter that will accompany this AuthNRequest. * @param samlRequest the SAMLRequest parameter. * @return this object */ @@ -192,7 +193,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable /** * Sets the {@code authenticationRequestUri}, a URL that will receive the - * AuthNRequest message + * AuthNRequest message. * @param authenticationRequestUri the relay state value, unencoded. * @return this object */ @@ -202,7 +203,7 @@ public abstract class AbstractSaml2AuthenticationRequest implements Serializable } /** - * This is the unique id used in the {@link #samlRequest} + * This is the unique id used in the {@link #samlRequest}. * @param id the SAML2 request id * @return the {@link AbstractSaml2AuthenticationRequest.Builder} for further * configurations diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AssertionAuthentication.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AssertionAuthentication.java index faf3d13db4..8d617faa08 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AssertionAuthentication.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AssertionAuthentication.java @@ -78,7 +78,7 @@ public class Saml2AssertionAuthentication extends Saml2Authentication { } /** - * A builder of {@link Saml2AssertionAuthentication} instances + * A builder of {@link Saml2AssertionAuthentication} instances. * * @since 7.0 */ @@ -110,7 +110,7 @@ public class Saml2AssertionAuthentication extends Saml2Authentication { } /** - * Use this registration id + * Use this registration id. * @param relyingPartyRegistrationId the * {@link RelyingPartyRegistration#getRegistrationId} to use * @return the {@link Builder} for further configurations diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticatedPrincipal.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticatedPrincipal.java index 77193e1bec..e17ec29fd5 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticatedPrincipal.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticatedPrincipal.java @@ -40,7 +40,7 @@ import org.springframework.util.CollectionUtils; public interface Saml2AuthenticatedPrincipal extends AuthenticatedPrincipal { /** - * Get the first value of Saml2 token attribute by name + * Get the first value of Saml2 token attribute by name. * @param name the name of the attribute * @param the type of the attribute * @return the first attribute value or {@code null} otherwise @@ -52,7 +52,7 @@ public interface Saml2AuthenticatedPrincipal extends AuthenticatedPrincipal { } /** - * Get the Saml2 token attribute by name + * Get the Saml2 token attribute by name. * @param name the name of the attribute * @param the type of the attribute * @return the attribute or {@code null} otherwise @@ -63,7 +63,7 @@ public interface Saml2AuthenticatedPrincipal extends AuthenticatedPrincipal { } /** - * Get the Saml2 token attributes + * Get the Saml2 token attributes. * @return the Saml2 token attributes * @since 5.4 */ @@ -72,7 +72,7 @@ public interface Saml2AuthenticatedPrincipal extends AuthenticatedPrincipal { } /** - * Get the {@link RelyingPartyRegistration} identifier + * Get the {@link RelyingPartyRegistration} identifier. * @return the {@link RelyingPartyRegistration} identifier * @since 5.6 */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2Authentication.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2Authentication.java index d3e57fe3bd..9b34e87fc0 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2Authentication.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2Authentication.java @@ -48,7 +48,7 @@ public class Saml2Authentication extends AbstractAuthenticationToken { private final String saml2Response; /** - * Construct a {@link Saml2Authentication} using the provided parameters + * Construct a {@link Saml2Authentication} using the provided parameters. * @param principal the logged in user * @param saml2Response the SAML 2.0 response used to authenticate the user * @param authorities the authorities for the logged in user diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationException.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationException.java index 9ba795c63b..d8735ab878 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationException.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationException.java @@ -94,7 +94,7 @@ public class Saml2AuthenticationException extends AuthenticationException { } /** - * Get the associated {@link Saml2Error} + * Get the associated {@link Saml2Error}. * @return the associated {@link Saml2Error} */ public Saml2Error getSaml2Error() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationToken.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationToken.java index 7dec6d450a..7efc727ef0 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationToken.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationToken.java @@ -103,7 +103,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken { } /** - * Get the resolved {@link RelyingPartyRegistration} associated with the request + * Get the resolved {@link RelyingPartyRegistration} associated with the request. * @return the resolved {@link RelyingPartyRegistration} * @since 5.4 */ @@ -112,7 +112,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken { } /** - * Returns inflated and decoded XML representation of the SAML 2 Response + * Returns inflated and decoded XML representation of the SAML 2 Response. * @return inflated and decoded XML representation of the SAML 2 Response */ public String getSaml2Response() { @@ -120,6 +120,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken { } /** + * Always returns false, as this token represents an unauthenticated request. * @return false */ @Override @@ -138,7 +139,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken { /** * Returns the authentication request sent to the assertion party or {@code null} if - * no authentication request is present + * no authentication request is present. * @return the authentication request sent to the assertion party * @since 5.6 */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2PostAuthenticationRequest.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2PostAuthenticationRequest.java index f74850fb1c..7a37fb1eb4 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2PostAuthenticationRequest.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2PostAuthenticationRequest.java @@ -44,6 +44,7 @@ public class Saml2PostAuthenticationRequest extends AbstractSaml2AuthenticationR } /** + * Returns {@link Saml2MessageBinding#POST}. * @return {@link Saml2MessageBinding#POST} */ @Override diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2RedirectAuthenticationRequest.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2RedirectAuthenticationRequest.java index 24e47ffcf4..c3bc6da85c 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2RedirectAuthenticationRequest.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2RedirectAuthenticationRequest.java @@ -51,7 +51,7 @@ public final class Saml2RedirectAuthenticationRequest extends AbstractSaml2Authe } /** - * Returns the SigAlg value for {@link Saml2MessageBinding#REDIRECT} requests + * Returns the SigAlg value for {@link Saml2MessageBinding#REDIRECT} requests. * @return the SigAlg value */ public @Nullable String getSigAlg() { @@ -59,7 +59,7 @@ public final class Saml2RedirectAuthenticationRequest extends AbstractSaml2Authe } /** - * Returns the Signature value for {@link Saml2MessageBinding#REDIRECT} requests + * Returns the Signature value for {@link Saml2MessageBinding#REDIRECT} requests. * @return the Signature value */ public @Nullable String getSignature() { @@ -67,6 +67,7 @@ public final class Saml2RedirectAuthenticationRequest extends AbstractSaml2Authe } /** + * Returns the binding used to send this request. * @return {@link Saml2MessageBinding#REDIRECT} */ @Override @@ -100,7 +101,7 @@ public final class Saml2RedirectAuthenticationRequest extends AbstractSaml2Authe } /** - * Sets the {@code SigAlg} parameter that will accompany this AuthNRequest + * Sets the {@code SigAlg} parameter that will accompany this AuthNRequest. * @param sigAlg the SigAlg parameter value. * @return this object */ @@ -110,7 +111,7 @@ public final class Saml2RedirectAuthenticationRequest extends AbstractSaml2Authe } /** - * Sets the {@code Signature} parameter that will accompany this AuthNRequest + * Sets the {@code Signature} parameter that will accompany this AuthNRequest. * @param signature the Signature parameter value. * @return this object */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertion.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertion.java index 66ade64ca4..29cb581b9a 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertion.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertion.java @@ -25,7 +25,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** - * An OpenSAML-based implementation of {@link Saml2ResponseAssertionAccessor} + * An OpenSAML-based implementation of {@link Saml2ResponseAssertionAccessor}. * * @author Josh Cummings * @since 7.0 diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertionAccessor.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertionAccessor.java index 43475642ed..d2ce02a4c1 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertionAccessor.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2ResponseAssertionAccessor.java @@ -38,7 +38,7 @@ public interface Saml2ResponseAssertionAccessor extends Serializable { List getSessionIndexes(); /** - * Get the first value of Saml2 token attribute by name + * Get the first value of Saml2 token attribute by name. * @param name the name of the attribute * @param the type of the attribute * @return the first attribute value or {@code null} otherwise @@ -49,7 +49,7 @@ public interface Saml2ResponseAssertionAccessor extends Serializable { } /** - * Get the Saml2 token attribute by name + * Get the Saml2 token attribute by name. * @param name the name of the attribute * @param the type of the attribute * @return the attribute or {@code null} otherwise diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequest.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequest.java index 50598045a3..daecc3f2f1 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequest.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequest.java @@ -86,7 +86,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * The unique identifier for this Logout Request + * The unique identifier for this Logout Request. * @return the Logout Request identifier */ public @Nullable String getId() { @@ -95,7 +95,7 @@ public final class Saml2LogoutRequest implements Serializable { /** * Get the location of the asserting party's SingleLogoutService + * "https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService. * @return the SingleLogoutService location */ public String getLocation() { @@ -104,7 +104,7 @@ public final class Saml2LogoutRequest implements Serializable { /** * Get the binding for the asserting party's SingleLogoutService + * "https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService. * @return the SingleLogoutService binding */ public Saml2MessageBinding getBinding() { @@ -112,7 +112,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * Get the signed and serialized <saml2:LogoutRequest> payload + * Get the signed and serialized <saml2:LogoutRequest> payload. * @return the signed and serialized <saml2:LogoutRequest> payload */ public String getSamlRequest() { @@ -122,7 +122,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * The relay state associated with this Logout Request + * The relay state associated with this Logout Request. * @return the relay state */ public @Nullable String getRelayState() { @@ -132,7 +132,7 @@ public final class Saml2LogoutRequest implements Serializable { /** * Get the {@code name} parameters, a short-hand for * getParameters().get(name) - * + * . * * Useful when specifying additional query parameters for the Logout Request * @param name the parameter's name @@ -143,7 +143,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * Get all parameters + * Get all parameters. * * Useful when specifying additional query parameters for the Logout Request * @return the Logout Request query parameters @@ -164,7 +164,7 @@ public final class Saml2LogoutRequest implements Serializable { /** * The identifier for the {@link RelyingPartyRegistration} associated with this Logout - * Request + * Request. * @return the {@link RelyingPartyRegistration} id */ public String getRelyingPartyRegistrationId() { @@ -172,7 +172,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * Create a {@link Builder} instance from this {@link RelyingPartyRegistration} + * Create a {@link Builder} instance from this {@link RelyingPartyRegistration}. * * Specifically, this will pull the SingleLogoutService @@ -246,7 +246,7 @@ public final class Saml2LogoutRequest implements Serializable { /** * Use this value for the relay state when sending the Logout Request to the - * asserting party + * asserting party. * * It should not be URL-encoded as this will be done when the request is sent * @param relayState the relay state @@ -258,7 +258,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * This is the unique id used in the {@link #samlRequest} + * This is the unique id used in the {@link #samlRequest}. * @param id the Logout Request id * @return the {@link Builder} for further configurations */ @@ -268,7 +268,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * Use this {@link Consumer} to modify the set of query parameters + * Use this {@link Consumer} to modify the set of query parameters. * * No parameter should be URL-encoded as this will be done when the request is * sent @@ -296,7 +296,7 @@ public final class Saml2LogoutRequest implements Serializable { } /** - * Build the {@link Saml2LogoutRequest} + * Build the {@link Saml2LogoutRequest}. * @return a constructed {@link Saml2LogoutRequest} */ public Saml2LogoutRequest build() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequestValidatorParameters.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequestValidatorParameters.java index b0006e2612..9dfd2a10ac 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequestValidatorParameters.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutRequestValidatorParameters.java @@ -22,7 +22,7 @@ import org.springframework.security.core.Authentication; import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration; /** - * A holder of the parameters needed to invoke {@link Saml2LogoutRequestValidator} + * A holder of the parameters needed to invoke {@link Saml2LogoutRequestValidator}. * * @author Josh Cummings * @since 5.6 @@ -36,7 +36,7 @@ public class Saml2LogoutRequestValidatorParameters { private final @Nullable Authentication authentication; /** - * Construct a {@link Saml2LogoutRequestValidatorParameters} + * Construct a {@link Saml2LogoutRequestValidatorParameters}. * @param request the SAML 2.0 Logout Request received from the asserting party * @param registration the associated {@link RelyingPartyRegistration} * @param authentication the current user @@ -57,7 +57,7 @@ public class Saml2LogoutRequestValidatorParameters { } /** - * The {@link RelyingPartyRegistration} representing this relying party + * The {@link RelyingPartyRegistration} representing this relying party. * @return the relying party */ public RelyingPartyRegistration getRelyingPartyRegistration() { @@ -65,7 +65,7 @@ public class Saml2LogoutRequestValidatorParameters { } /** - * The current {@link Authentication} + * The current {@link Authentication}. * @return the authenticated user */ public @Nullable Authentication getAuthentication() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponse.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponse.java index 11796905fb..abe1b641e5 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponse.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponse.java @@ -70,7 +70,7 @@ public final class Saml2LogoutResponse { /** * Get the response location of the asserting party's SingleLogoutService + * "https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService. * @return the SingleLogoutService response location */ public String getResponseLocation() { @@ -79,7 +79,7 @@ public final class Saml2LogoutResponse { /** * Get the binding for the asserting party's SingleLogoutService + * "https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService. * @return the SingleLogoutService binding */ public Saml2MessageBinding getBinding() { @@ -87,7 +87,7 @@ public final class Saml2LogoutResponse { } /** - * Get the signed and serialized <saml2:LogoutResponse> payload + * Get the signed and serialized <saml2:LogoutResponse> payload. * @return the signed and serialized <saml2:LogoutResponse> payload */ public String getSamlResponse() { @@ -97,7 +97,7 @@ public final class Saml2LogoutResponse { } /** - * The relay state associated with this Logout Request + * The relay state associated with this Logout Request. * @return the relay state */ public @Nullable String getRelayState() { @@ -107,7 +107,7 @@ public final class Saml2LogoutResponse { /** * Get the {@code name} parameter, a short-hand for * getParameters().get(name) - * + * . * * Useful when specifying additional query parameters for the Logout Response * @param name the parameter's name @@ -118,7 +118,7 @@ public final class Saml2LogoutResponse { } /** - * Get all parameters + * Get all parameters. * * Useful when specifying additional query parameters for the Logout Response * @return the Logout Response query parameters @@ -138,7 +138,7 @@ public final class Saml2LogoutResponse { } /** - * Create a {@link Builder} instance from this {@link RelyingPartyRegistration} + * Create a {@link Builder} instance from this {@link RelyingPartyRegistration}. * * Specifically, this will pull the SingleLogoutService @@ -207,7 +207,7 @@ public final class Saml2LogoutResponse { /** * Use this value for the relay state when sending the Logout Request to the - * asserting party + * asserting party. * * It should not be URL-encoded as this will be done when the response is sent * @param relayState the relay state @@ -219,7 +219,7 @@ public final class Saml2LogoutResponse { } /** - * Use this {@link Consumer} to modify the set of query parameters + * Use this {@link Consumer} to modify the set of query parameters. * * No parameter should be URL-encoded as this will be done when the response is * sent, though any signature specified should be Base64-encoded @@ -247,7 +247,7 @@ public final class Saml2LogoutResponse { } /** - * Build the {@link Saml2LogoutResponse} + * Build the {@link Saml2LogoutResponse}. * @return a constructed {@link Saml2LogoutResponse} */ public Saml2LogoutResponse build() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponseValidatorParameters.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponseValidatorParameters.java index e41c3b290d..1b48cc5a3e 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponseValidatorParameters.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutResponseValidatorParameters.java @@ -19,7 +19,7 @@ package org.springframework.security.saml2.provider.service.authentication.logou import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration; /** - * A holder of the parameters needed to invoke {@link Saml2LogoutResponseValidator} + * A holder of the parameters needed to invoke {@link Saml2LogoutResponseValidator}. * * @author Josh Cummings * @since 5.6 @@ -33,7 +33,7 @@ public class Saml2LogoutResponseValidatorParameters { private final RelyingPartyRegistration registration; /** - * Construct a {@link Saml2LogoutRequestValidatorParameters} + * Construct a {@link Saml2LogoutRequestValidatorParameters}. * @param response the SAML 2.0 Logout Response received from the asserting party * @param request the SAML 2.0 Logout Request send by this application * @param registration the associated {@link RelyingPartyRegistration} @@ -62,7 +62,7 @@ public class Saml2LogoutResponseValidatorParameters { } /** - * The {@link RelyingPartyRegistration} representing this relying party + * The {@link RelyingPartyRegistration} representing this relying party. * @return the relying party */ public RelyingPartyRegistration getRelyingPartyRegistration() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutValidatorResult.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutValidatorResult.java index 3b58bcb49f..ede1d1b1ec 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutValidatorResult.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/logout/Saml2LogoutValidatorResult.java @@ -43,7 +43,7 @@ public final class Saml2LogoutValidatorResult { } /** - * Say whether this result indicates success + * Say whether this result indicates success. * @return whether this result has errors */ public boolean hasErrors() { @@ -51,7 +51,7 @@ public final class Saml2LogoutValidatorResult { } /** - * Return error details regarding the validation attempt + * Return error details regarding the validation attempt. * @return the collection of results in this result, if any; returns an empty list * otherwise */ @@ -60,7 +60,7 @@ public final class Saml2LogoutValidatorResult { } /** - * Construct a successful {@link Saml2LogoutValidatorResult} + * Construct a successful {@link Saml2LogoutValidatorResult}. * @return an {@link Saml2LogoutValidatorResult} with no errors */ public static Saml2LogoutValidatorResult success() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/BaseOpenSamlMetadataResolver.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/BaseOpenSamlMetadataResolver.java index e01b9f05da..ac60219d60 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/BaseOpenSamlMetadataResolver.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/BaseOpenSamlMetadataResolver.java @@ -113,7 +113,7 @@ final class BaseOpenSamlMetadataResolver implements Saml2MetadataResolver { } /** - * Set a {@link Consumer} for modifying the OpenSAML {@link EntityDescriptor} + * Set a {@link Consumer} for modifying the OpenSAML {@link EntityDescriptor}. * @param entityDescriptorCustomizer a consumer that accepts an * {@link EntityDescriptorParameters} * @since 5.7 @@ -222,7 +222,7 @@ final class BaseOpenSamlMetadataResolver implements Saml2MetadataResolver { /** * A tuple containing an OpenSAML {@link EntityDescriptor} and its associated - * {@link RelyingPartyRegistration} + * {@link RelyingPartyRegistration}. * * @since 5.7 */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/RequestMatcherMetadataResponseResolver.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/RequestMatcherMetadataResponseResolver.java index f307fc4c3d..66d56ef4f6 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/RequestMatcherMetadataResponseResolver.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/RequestMatcherMetadataResponseResolver.java @@ -24,7 +24,7 @@ import org.springframework.security.web.util.matcher.RequestMatcher; /** * An implementation of {@link Saml2MetadataResponseResolver} that identifies which - * {@link RelyingPartyRegistration}s to use with a {@link RequestMatcher} + * {@link RelyingPartyRegistration}s to use with a {@link RequestMatcher}. * * @author Josh Cummings * @since 6.1 @@ -38,7 +38,7 @@ public final class RequestMatcherMetadataResponseResolver extends /** * Construct a - * {@link org.springframework.security.saml2.provider.service.web.metadata.RequestMatcherMetadataResponseResolver} + * {@link org.springframework.security.saml2.provider.service.web.metadata.RequestMatcherMetadataResponseResolver}. * @param registrations the source for relying party metadata * @param metadata the strategy for converting {@link RelyingPartyRegistration}s into * metadata diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/Saml2MetadataResolver.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/Saml2MetadataResolver.java index f3a8aa95e7..0a5ab73f38 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/Saml2MetadataResolver.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/metadata/Saml2MetadataResolver.java @@ -29,7 +29,7 @@ import org.springframework.security.saml2.provider.service.registration.RelyingP public interface Saml2MetadataResolver { /** - * Resolve the given relying party's metadata + * Resolve the given relying party's metadata. * @param relyingPartyRegistration the relying party * @return the relying party's metadata */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/AssertingPartyMetadata.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/AssertingPartyMetadata.java index 85753ddebf..a1dc2d4a1c 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/AssertingPartyMetadata.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/AssertingPartyMetadata.java @@ -70,7 +70,7 @@ public interface AssertingPartyMetadata extends Serializable { /** * Get all verification {@link Saml2X509Credential}s associated with this asserting - * party + * party. * @return all verification {@link Saml2X509Credential}s associated with this * asserting party * @since 5.4 @@ -79,7 +79,7 @@ public interface AssertingPartyMetadata extends Serializable { /** * Get all encryption {@link Saml2X509Credential}s associated with this asserting - * party + * party. * @return all encryption {@link Saml2X509Credential}s associated with this asserting * party * @since 5.4 @@ -172,7 +172,7 @@ public interface AssertingPartyMetadata extends Serializable { B wantAuthnRequestsSigned(boolean wantAuthnRequestsSigned); /** - * Apply this {@link Consumer} to the list of SigningMethod Algorithms + * Apply this {@link Consumer} to the list of SigningMethod Algorithms. * @param signingMethodAlgorithmsConsumer a {@link Consumer} of the list of * SigningMethod Algorithms * @return this {@link B} for further configuration @@ -181,7 +181,7 @@ public interface AssertingPartyMetadata extends Serializable { B signingAlgorithms(Consumer> signingMethodAlgorithmsConsumer); /** - * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s + * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s. * @param credentialsConsumer a {@link Consumer} of the {@link List} of * {@link Saml2X509Credential}s * @return the {@link RelyingPartyRegistration.Builder} for further configuration @@ -190,7 +190,7 @@ public interface AssertingPartyMetadata extends Serializable { B verificationX509Credentials(Consumer> credentialsConsumer); /** - * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s + * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s. * @param credentialsConsumer a {@link Consumer} of the {@link List} of * {@link Saml2X509Credential}s * @return the {@link RelyingPartyRegistration.Builder} for further configuration @@ -269,7 +269,7 @@ public interface AssertingPartyMetadata extends Serializable { /** * Creates an immutable ProviderDetails object representing the configuration for - * an Identity Provider, IDP + * an Identity Provider, IDP. * @return immutable ProviderDetails object */ AssertingPartyMetadata build(); diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/IterableRelyingPartyRegistrationRepository.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/IterableRelyingPartyRegistrationRepository.java index 5610215379..b7831cf414 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/IterableRelyingPartyRegistrationRepository.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/IterableRelyingPartyRegistrationRepository.java @@ -18,7 +18,7 @@ package org.springframework.security.saml2.provider.service.registration; /** * An interface that simplifies APIs which require the - * {@link RelyingPartyRegistrationRepository} to also be {@link Iterable} + * {@link RelyingPartyRegistrationRepository} to also be {@link Iterable}. * * @author Josh Cummings * @since 6.4 diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/JdbcAssertingPartyMetadataRepository.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/JdbcAssertingPartyMetadataRepository.java index 5334eb9323..dbf0321fac 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/JdbcAssertingPartyMetadataRepository.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/JdbcAssertingPartyMetadataRepository.java @@ -134,7 +134,7 @@ public final class JdbcAssertingPartyMetadataRepository implements AssertingPart } /** - * Persist this {@link AssertingPartyMetadata} + * Persist this {@link AssertingPartyMetadata}. * @param metadata the metadata to persist */ public void save(AssertingPartyMetadata metadata) { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/OpenSamlAssertingPartyDetails.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/OpenSamlAssertingPartyDetails.java index 7bcc724eb7..fafc7c1ac7 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/OpenSamlAssertingPartyDetails.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/OpenSamlAssertingPartyDetails.java @@ -43,7 +43,7 @@ import org.springframework.util.Assert; /** * A {@link RelyingPartyRegistration.AssertingPartyDetails} that contains - * OpenSAML-specific members + * OpenSAML-specific members. * * @author Josh Cummings * @since 5.7 @@ -66,7 +66,7 @@ public final class OpenSamlAssertingPartyDetails extends RelyingPartyRegistratio /** * Get the {@link EntityDescriptor} that underlies this - * {@link org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.AssertingPartyDetails} + * {@link org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.AssertingPartyDetails}. * @return the {@link EntityDescriptor} */ public EntityDescriptor getEntityDescriptor() { @@ -75,7 +75,7 @@ public final class OpenSamlAssertingPartyDetails extends RelyingPartyRegistratio /** * Use this {@link EntityDescriptor} to begin building an - * {@link org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.AssertingPartyDetails} + * {@link org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.AssertingPartyDetails}. * @param entity the {@link EntityDescriptor} to use * @return the * {@link org.springframework.security.saml2.provider.service.registration.OpenSamlAssertingPartyDetails.Builder} @@ -213,7 +213,7 @@ public final class OpenSamlAssertingPartyDetails extends RelyingPartyRegistratio /** * An OpenSAML version of * {@link org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.AssertingPartyDetails.Builder} - * that contains the underlying {@link EntityDescriptor} + * that contains the underlying {@link EntityDescriptor}. */ public static final class Builder extends RelyingPartyRegistration.AssertingPartyDetails.Builder { @@ -305,7 +305,7 @@ public final class OpenSamlAssertingPartyDetails extends RelyingPartyRegistratio /** * Build an - * {@link org.springframework.security.saml2.provider.service.registration.OpenSamlAssertingPartyDetails} + * {@link org.springframework.security.saml2.provider.service.registration.OpenSamlAssertingPartyDetails}. * @return */ @Override diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.java index e9e2ef7054..68e0d2adf0 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.java @@ -176,7 +176,8 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Copy the properties in this {@link RelyingPartyRegistration} into a {@link Builder} + * Copy the properties in this {@link RelyingPartyRegistration} into a + * {@link Builder}. * @return a {@link Builder} based off of the properties in this * {@link RelyingPartyRegistration} * @since 6.1 @@ -195,7 +196,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Get the unique registration id for this RP/AP pair + * Get the unique registration id for this RP/AP pair. * @return the unique registration id for this RP/AP pair */ public String getRegistrationId() { @@ -336,7 +337,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Get the {@link Collection} of decryption {@link Saml2X509Credential}s associated - * with this relying party + * with this relying party. * @return the {@link Collection} of decryption {@link Saml2X509Credential}s * associated with this relying party * @since 5.4 @@ -347,7 +348,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Get the {@link Collection} of signing {@link Saml2X509Credential}s associated with - * this relying party + * this relying party. * @return the {@link Collection} of signing {@link Saml2X509Credential}s associated * with this relying party * @since 5.4 @@ -357,7 +358,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Get the metadata for the Asserting Party + * Get the metadata for the Asserting Party. * @return the {@link AssertingPartyMetadata} * @since 6.4 */ @@ -367,7 +368,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Creates a {@code RelyingPartyRegistration} {@link Builder} with a known - * {@code registrationId} + * {@code registrationId}. * @param registrationId a string identifier for the {@code RelyingPartyRegistration} * @return {@code Builder} to create a {@code RelyingPartyRegistration} object */ @@ -391,7 +392,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * The configuration metadata of the Asserting party + * The configuration metadata of the Asserting party. * * @since 5.4 */ @@ -495,7 +496,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Get all verification {@link Saml2X509Credential}s associated with this - * asserting party + * asserting party. * @return all verification {@link Saml2X509Credential}s associated with this * asserting party * @since 5.4 @@ -506,7 +507,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Get all encryption {@link Saml2X509Credential}s associated with this asserting - * party + * party. * @return all encryption {@link Saml2X509Credential}s associated with this * asserting party * @since 5.4 @@ -649,7 +650,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Apply this {@link Consumer} to the list of SigningMethod Algorithms + * Apply this {@link Consumer} to the list of SigningMethod Algorithms. * @param signingMethodAlgorithmsConsumer a {@link Consumer} of the list of * SigningMethod Algorithms * @return this {@link AssertingPartyDetails.Builder} for further @@ -662,7 +663,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s + * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s. * @param credentialsConsumer a {@link Consumer} of the {@link List} of * {@link Saml2X509Credential}s * @return the {@link RelyingPartyRegistration.Builder} for further @@ -675,7 +676,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s + * Apply this {@link Consumer} to the list of {@link Saml2X509Credential}s. * @param credentialsConsumer a {@link Consumer} of the {@link List} of * {@link Saml2X509Credential}s * @return the {@link RelyingPartyRegistration.Builder} for further @@ -774,7 +775,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Creates an immutable ProviderDetails object representing the configuration - * for an Identity Provider, IDP + * for an Identity Provider, IDP. * @return immutable ProviderDetails object */ public AssertingPartyDetails build() { @@ -856,7 +857,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Apply this {@link Consumer} to the {@link Collection} of * {@link Saml2X509Credential}s for the purposes of modifying the - * {@link Collection} + * {@link Collection}. * @param credentialsConsumer - the {@link Consumer} for modifying the * {@link Collection} * @return the {@link Builder} for further configuration @@ -870,7 +871,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Apply this {@link Consumer} to the {@link Collection} of * {@link Saml2X509Credential}s for the purposes of modifying the - * {@link Collection} + * {@link Collection}. * @param credentialsConsumer - the {@link Consumer} for modifying the * {@link Collection} * @return the {@link Builder} for further configuration @@ -994,7 +995,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Set the NameID format + * Set the NameID format. * @param nameIdFormat the given NameID format * @return the {@link Builder} for further configuration * @since 5.7 @@ -1023,7 +1024,7 @@ public class RelyingPartyRegistration implements Serializable { } /** - * Apply this {@link Consumer} to further configure the Asserting Party metadata + * Apply this {@link Consumer} to further configure the Asserting Party metadata. * @param assertingPartyMetadata The {@link Consumer} to apply * @return the {@link Builder} for further configuration * @since 6.4 @@ -1035,7 +1036,7 @@ public class RelyingPartyRegistration implements Serializable { /** * Constructs a RelyingPartyRegistration object based on the builder - * configurations + * configurations. * @return a RelyingPartyRegistration instance */ public RelyingPartyRegistration build() { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrationRepository.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrationRepository.java index 360510c110..0f9c2c3e05 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrationRepository.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrationRepository.java @@ -19,7 +19,7 @@ package org.springframework.security.saml2.provider.service.registration; import org.jspecify.annotations.Nullable; /** - * A repository for {@link RelyingPartyRegistration}s + * A repository for {@link RelyingPartyRegistration}s. * * @author Filip Hanik * @author Josh Cummings diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrations.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrations.java index 0659abcf8a..927d2ddfa2 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrations.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistrations.java @@ -29,7 +29,7 @@ import org.springframework.core.io.ResourceLoader; import org.springframework.security.saml2.Saml2Exception; /** - * A utility class for constructing instances of {@link RelyingPartyRegistration} + * A utility class for constructing instances of {@link RelyingPartyRegistration}. * * @author Josh Cummings * @author Ryan Cassar diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/BaseOpenSamlAuthenticationTokenConverter.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/BaseOpenSamlAuthenticationTokenConverter.java index 1c6af54bbc..eb3f48e21b 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/BaseOpenSamlAuthenticationTokenConverter.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/BaseOpenSamlAuthenticationTokenConverter.java @@ -60,7 +60,7 @@ final class BaseOpenSamlAuthenticationTokenConverter implements AuthenticationCo /** * Constructs a {@link BaseOpenSamlAuthenticationTokenConverter} given a repository - * for {@link RelyingPartyRegistration}s + * for {@link RelyingPartyRegistration}s. * @param registrations the repository for {@link RelyingPartyRegistration}s * {@link RelyingPartyRegistration}s */ diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/HttpSessionSaml2AuthenticationRequestRepository.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/HttpSessionSaml2AuthenticationRequestRepository.java index 087ade40f2..3ac053e16e 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/HttpSessionSaml2AuthenticationRequestRepository.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/HttpSessionSaml2AuthenticationRequestRepository.java @@ -26,7 +26,7 @@ import org.springframework.security.saml2.provider.service.authentication.Abstra /** * A {@link Saml2AuthenticationRequestRepository} implementation that uses * {@link HttpSession} to store and retrieve the - * {@link AbstractSaml2AuthenticationRequest} + * {@link AbstractSaml2AuthenticationRequest}. * * @author Marcus Da Coregio * @since 5.6 diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationPlaceholderResolvers.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationPlaceholderResolvers.java index d733a8fea0..d7ed0f2aa4 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationPlaceholderResolvers.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationPlaceholderResolvers.java @@ -113,7 +113,7 @@ public final class RelyingPartyRegistrationPlaceholderResolvers { } /** - * A class for resolving {@link RelyingPartyRegistration} URIs + * A class for resolving {@link RelyingPartyRegistration} URIs. */ public static final class UriResolver { diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationResolver.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationResolver.java index 2734510923..72647c1703 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationResolver.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/RelyingPartyRegistrationResolver.java @@ -22,7 +22,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration; /** - * A contract for resolving a {@link RelyingPartyRegistration} from the HTTP request + * A contract for resolving a {@link RelyingPartyRegistration} from the HTTP request. * * @author Josh Cummings * @since 5.6 @@ -31,7 +31,7 @@ public interface RelyingPartyRegistrationResolver { /** * Resolve a {@link RelyingPartyRegistration} from the HTTP request, using the - * {@code relyingPartyRegistrationId}, if it is provided + * {@code relyingPartyRegistrationId}, if it is provided. * @param request the HTTP request * @param relyingPartyRegistrationId the {@link RelyingPartyRegistration} identifier; * when {@code null}, may attempt to resolve from the request diff --git a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/Saml2AuthenticationRequestRepository.java b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/Saml2AuthenticationRequestRepository.java index b9219c076f..d8351b9f4a 100644 --- a/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/Saml2AuthenticationRequestRepository.java +++ b/saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/Saml2AuthenticationRequestRepository.java @@ -23,7 +23,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest; /** - * A repository for {@link AbstractSaml2AuthenticationRequest} + * A repository for {@link AbstractSaml2AuthenticationRequest}. * * @param the type of SAML 2.0 Authentication Request * @author Marcus Da Coregio @@ -32,7 +32,7 @@ import org.springframework.security.saml2.provider.service.authentication.Abstra public interface Saml2AuthenticationRequestRepository { /** - * Loads the {@link AbstractSaml2AuthenticationRequest} from the request + * Loads the {@link AbstractSaml2AuthenticationRequest} from the request. * @param request the current request * @return the {@link AbstractSaml2AuthenticationRequest} or {@code null} if it is not * present @@ -41,7 +41,7 @@ public interface Saml2AuthenticationRequestRepository> paramsConsumer) { @@ -714,7 +715,7 @@ public final class OpenSaml5AuthenticationProvider implements AuthenticationProv } /** - * Create the default assertion validator + * Create the default assertion validator. * @return the default assertion validator */ public static AssertionValidator withDefaults() { @@ -722,7 +723,7 @@ public final class OpenSaml5AuthenticationProvider implements AuthenticationProv } /** - * Use a builder to configure aspects of the validator + * Use a builder to configure aspects of the validator. * @return the {@link Builder} for configuration {@link AssertionValidator} */ public static Builder builder() { @@ -820,7 +821,7 @@ public final class OpenSaml5AuthenticationProvider implements AuthenticationProv } /** - * Build the {@link AssertionValidator} + * Build the {@link AssertionValidator}. * @return the {@link AssertionValidator} */ public AssertionValidator build() { diff --git a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolver.java b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolver.java index 5667d18a6c..74e1bc1cfe 100644 --- a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolver.java +++ b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolver.java @@ -55,7 +55,7 @@ public final class OpenSaml5MetadataResolver implements Saml2MetadataResolver { } /** - * Set a {@link Consumer} for modifying the OpenSAML {@link EntityDescriptor} + * Set a {@link Consumer} for modifying the OpenSAML {@link EntityDescriptor}. * @param entityDescriptorCustomizer a consumer that accepts an * {@link EntityDescriptorParameters} * @since 5.7 @@ -86,7 +86,7 @@ public final class OpenSaml5MetadataResolver implements Saml2MetadataResolver { /** * A tuple containing an OpenSAML {@link EntityDescriptor} and its associated - * {@link RelyingPartyRegistration} + * {@link RelyingPartyRegistration}. * * @since 5.7 */ diff --git a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverter.java b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverter.java index 6fc3a8f70c..fcafd58225 100644 --- a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverter.java +++ b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverter.java @@ -44,7 +44,7 @@ public final class OpenSaml5AuthenticationTokenConverter implements Authenticati /** * Constructs a {@link OpenSaml5AuthenticationTokenConverter} given a repository for - * {@link RelyingPartyRegistration}s + * {@link RelyingPartyRegistration}s. * @param registrations the repository for {@link RelyingPartyRegistration}s * {@link RelyingPartyRegistration}s */ diff --git a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5AuthenticationRequestResolver.java b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5AuthenticationRequestResolver.java index c8bed4b578..316e2bbda2 100644 --- a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5AuthenticationRequestResolver.java +++ b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5AuthenticationRequestResolver.java @@ -46,7 +46,7 @@ public final class OpenSaml5AuthenticationRequestResolver implements Saml2Authen private final BaseOpenSamlAuthenticationRequestResolver delegate; /** - * Construct an {@link OpenSaml5AuthenticationRequestResolver} + * Construct an {@link OpenSaml5AuthenticationRequestResolver}. * @param registrations a repository for relying and asserting party configuration * @since 6.1 */ @@ -60,7 +60,7 @@ public final class OpenSaml5AuthenticationRequestResolver implements Saml2Authen } /** - * Construct a {@link OpenSaml5AuthenticationRequestResolver} + * Construct a {@link OpenSaml5AuthenticationRequestResolver}. */ public OpenSaml5AuthenticationRequestResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver) { this.delegate = new BaseOpenSamlAuthenticationRequestResolver(relyingPartyRegistrationResolver, @@ -73,7 +73,7 @@ public final class OpenSaml5AuthenticationRequestResolver implements Saml2Authen } /** - * Set a {@link Consumer} for modifying the OpenSAML {@link AuthnRequest} + * Set a {@link Consumer} for modifying the OpenSAML {@link AuthnRequest}. * @param contextConsumer a consumer that accepts an {@link AuthnRequestContext} */ public void setAuthnRequestCustomizer(Consumer contextConsumer) { @@ -86,7 +86,7 @@ public final class OpenSaml5AuthenticationRequestResolver implements Saml2Authen /** * Set the {@link RequestMatcher} to use for setting the * {@link BaseOpenSamlAuthenticationRequestResolver#setRequestMatcher(RequestMatcher)} - * (RequestMatcher)} + * (RequestMatcher)}. * @param requestMatcher the {@link RequestMatcher} to identify authentication * requests. * @since 5.8 @@ -97,7 +97,7 @@ public final class OpenSaml5AuthenticationRequestResolver implements Saml2Authen } /** - * Use this {@link Clock} for generating the issued {@link Instant} + * Use this {@link Clock} for generating the issued {@link Instant}. * @param clock the {@link Clock} to use */ public void setClock(Clock clock) { @@ -106,7 +106,7 @@ public final class OpenSaml5AuthenticationRequestResolver implements Saml2Authen } /** - * Use this {@link Converter} to compute the RelayState + * Use this {@link Converter} to compute the RelayState. * @param relayStateResolver the {@link Converter} to use * @since 5.8 */ diff --git a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolver.java b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolver.java index c15ea0e7e2..76f8ffa2e3 100644 --- a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolver.java +++ b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolver.java @@ -56,7 +56,7 @@ public final class OpenSaml5LogoutRequestResolver implements Saml2LogoutRequestR } /** - * Construct a {@link OpenSaml5LogoutRequestResolver} + * Construct a {@link OpenSaml5LogoutRequestResolver}. */ public OpenSaml5LogoutRequestResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver) { this.delegate = new BaseOpenSamlLogoutRequestResolver(relyingPartyRegistrationResolver, @@ -72,7 +72,7 @@ public final class OpenSaml5LogoutRequestResolver implements Saml2LogoutRequestR } /** - * Set a {@link Consumer} for modifying the OpenSAML {@link LogoutRequest} + * Set a {@link Consumer} for modifying the OpenSAML {@link LogoutRequest}. * @param parametersConsumer a consumer that accepts an * {@link LogoutRequestParameters} */ @@ -83,7 +83,7 @@ public final class OpenSaml5LogoutRequestResolver implements Saml2LogoutRequestR } /** - * Use this {@link Clock} for determining the issued {@link Instant} + * Use this {@link Clock} for determining the issued {@link Instant}. * @param clock the {@link Clock} to use */ public void setClock(Clock clock) { @@ -92,7 +92,7 @@ public final class OpenSaml5LogoutRequestResolver implements Saml2LogoutRequestR } /** - * Use this {@link Converter} to compute the RelayState + * Use this {@link Converter} to compute the RelayState. * @param relayStateResolver the {@link Converter} to use * @since 6.1 */ diff --git a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestValidatorParametersResolver.java b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestValidatorParametersResolver.java index da980ac105..1294798997 100644 --- a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestValidatorParametersResolver.java +++ b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestValidatorParametersResolver.java @@ -31,7 +31,7 @@ import org.springframework.util.Assert; /** * An OpenSAML-based implementation of - * {@link Saml2LogoutRequestValidatorParametersResolver} + * {@link Saml2LogoutRequestValidatorParametersResolver}. */ @NullMarked public final class OpenSaml5LogoutRequestValidatorParametersResolver @@ -44,7 +44,7 @@ public final class OpenSaml5LogoutRequestValidatorParametersResolver private final BaseOpenSamlLogoutRequestValidatorParametersResolver delegate; /** - * Constructs a {@link OpenSaml5LogoutRequestValidatorParametersResolver} + * Constructs a {@link OpenSaml5LogoutRequestValidatorParametersResolver}. */ public OpenSaml5LogoutRequestValidatorParametersResolver(RelyingPartyRegistrationRepository registrations) { Assert.notNull(registrations, "relyingPartyRegistrationRepository cannot be null"); diff --git a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolver.java b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolver.java index a6fa45885b..e338425516 100644 --- a/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolver.java +++ b/saml2/saml2-service-provider/src/opensaml5Main/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolver.java @@ -55,7 +55,7 @@ public final class OpenSaml5LogoutResponseResolver implements Saml2LogoutRespons } /** - * Construct a {@link OpenSaml5LogoutResponseResolver} + * Construct a {@link OpenSaml5LogoutResponseResolver}. */ public OpenSaml5LogoutResponseResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver) { this.delegate = new BaseOpenSamlLogoutResponseResolver(null, relyingPartyRegistrationResolver, @@ -80,7 +80,7 @@ public final class OpenSaml5LogoutResponseResolver implements Saml2LogoutRespons } /** - * Set a {@link Consumer} for modifying the OpenSAML {@link LogoutRequest} + * Set a {@link Consumer} for modifying the OpenSAML {@link LogoutRequest}. * @param parametersConsumer a consumer that accepts an * {@link OpenSaml5LogoutRequestResolver.LogoutRequestParameters} */ @@ -91,7 +91,7 @@ public final class OpenSaml5LogoutResponseResolver implements Saml2LogoutRespons } /** - * Use this {@link Clock} for determining the issued {@link Instant} + * Use this {@link Clock} for determining the issued {@link Instant}. * @param clock the {@link Clock} to use */ public void setClock(Clock clock) { diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/OpenSaml5AuthenticationProviderTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/OpenSaml5AuthenticationProviderTests.java index 8744047d95..d8fb32a6a6 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/OpenSaml5AuthenticationProviderTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/OpenSaml5AuthenticationProviderTests.java @@ -102,7 +102,7 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verifyNoInteractions; /** - * Tests for {@link OpenSaml5AuthenticationProvider} + * Tests for {@link OpenSaml5AuthenticationProvider}. * * @author Filip Hanik * @author Josh Cummings diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutRequestValidatorTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutRequestValidatorTests.java index 078563e9d9..4400eeead0 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutRequestValidatorTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutRequestValidatorTests.java @@ -41,7 +41,7 @@ import org.springframework.security.saml2.provider.service.registration.TestRely import static org.assertj.core.api.Assertions.assertThat; /** - * Tests for {@link OpenSaml5LogoutRequestValidator} + * Tests for {@link OpenSaml5LogoutRequestValidator}. * * @author Josh Cummings */ diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutResponseValidatorTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutResponseValidatorTests.java index a568c1cc6f..554ddc97e6 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutResponseValidatorTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/authentication/logout/OpenSaml5LogoutResponseValidatorTests.java @@ -37,7 +37,7 @@ import org.springframework.security.saml2.provider.service.registration.TestRely import static org.assertj.core.api.Assertions.assertThat; /** - * Tests for {@link OpenSaml5LogoutResponseValidator} + * Tests for {@link OpenSaml5LogoutResponseValidator}. * * @author Josh Cummings */ diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolverTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolverTests.java index 39719c243b..8b086abc10 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolverTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/metadata/OpenSaml5MetadataResolverTests.java @@ -28,7 +28,7 @@ import org.springframework.security.saml2.provider.service.registration.TestRely import static org.assertj.core.api.Assertions.assertThat; /** - * Tests for {@link OpenSaml5MetadataResolver} + * Tests for {@link OpenSaml5MetadataResolver}. */ public class OpenSaml5MetadataResolverTests { diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/registration/OpenSaml5AssertingPartyMetadataRepositoryTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/registration/OpenSaml5AssertingPartyMetadataRepositoryTests.java index 033c9c1ad5..be8bdcc985 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/registration/OpenSaml5AssertingPartyMetadataRepositoryTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/registration/OpenSaml5AssertingPartyMetadataRepositoryTests.java @@ -66,7 +66,7 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.withSettings; /** - * Tests for {@link BaseOpenSamlAssertingPartyMetadataRepository} + * Tests for {@link BaseOpenSamlAssertingPartyMetadataRepository}. */ public class OpenSaml5AssertingPartyMetadataRepositoryTests { diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverterTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverterTests.java index 2166f80322..fc7fd91531 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverterTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/OpenSaml5AuthenticationTokenConverterTests.java @@ -54,7 +54,7 @@ import static org.mockito.BDDMockito.given; import static org.mockito.Mockito.mock; /** - * Tests for {@link OpenSaml5AuthenticationTokenConverter} + * Tests for {@link OpenSaml5AuthenticationTokenConverter}. */ @ExtendWith(MockitoExtension.class) public final class OpenSaml5AuthenticationTokenConverterTests { diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5SigningUtilsTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5SigningUtilsTests.java index 6eb99e0e8d..2e9afa1c0a 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5SigningUtilsTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/OpenSaml5SigningUtilsTests.java @@ -36,7 +36,7 @@ import org.springframework.security.saml2.provider.service.registration.RelyingP import static org.assertj.core.api.Assertions.assertThat; /** - * Test open SAML signatures + * Test open SAML signatures. */ public class OpenSaml5SigningUtilsTests { diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolverTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolverTests.java index 6bd9288206..782bb897fe 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolverTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutRequestResolverTests.java @@ -37,7 +37,7 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; /** - * Tests for {@link OpenSaml5LogoutRequestResolver} + * Tests for {@link OpenSaml5LogoutRequestResolver}. */ public class OpenSaml5LogoutRequestResolverTests { diff --git a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolverTests.java b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolverTests.java index 5cbdeeb89e..a7b27285c6 100644 --- a/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolverTests.java +++ b/saml2/saml2-service-provider/src/opensaml5Test/java/org/springframework/security/saml2/provider/service/web/authentication/logout/OpenSaml5LogoutResponseResolverTests.java @@ -40,7 +40,7 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; /** - * Tests for {@link OpenSaml5LogoutResponseResolver} + * Tests for {@link OpenSaml5LogoutResponseResolver}. */ public class OpenSaml5LogoutResponseResolverTests { diff --git a/test/src/main/java/org/springframework/security/test/context/TestSecurityContextHolder.java b/test/src/main/java/org/springframework/security/test/context/TestSecurityContextHolder.java index 8bb0d68280..74409913bf 100644 --- a/test/src/main/java/org/springframework/security/test/context/TestSecurityContextHolder.java +++ b/test/src/main/java/org/springframework/security/test/context/TestSecurityContextHolder.java @@ -113,7 +113,7 @@ public final class TestSecurityContextHolder { /** * Gets the default {@link SecurityContext} by delegating to the - * {@link SecurityContextHolder} + * {@link SecurityContextHolder}. * @return the default {@link SecurityContext} */ private static SecurityContext getDefaultContext() { diff --git a/test/src/main/java/org/springframework/security/test/context/support/DelegatingTestExecutionListener.java b/test/src/main/java/org/springframework/security/test/context/support/DelegatingTestExecutionListener.java index b56ad1b7c0..3ea54a5f12 100644 --- a/test/src/main/java/org/springframework/security/test/context/support/DelegatingTestExecutionListener.java +++ b/test/src/main/java/org/springframework/security/test/context/support/DelegatingTestExecutionListener.java @@ -22,6 +22,9 @@ import org.springframework.test.context.support.AbstractTestExecutionListener; import org.springframework.util.Assert; /** + * A {@link TestExecutionListener} that delegates all its methods to another + * {@link TestExecutionListener}. + * * @author Rob Winch * @since 5.0 */ diff --git a/test/src/main/java/org/springframework/security/test/context/support/TestExecutionEvent.java b/test/src/main/java/org/springframework/security/test/context/support/TestExecutionEvent.java index ae40ab1d02..bdfaff38f8 100644 --- a/test/src/main/java/org/springframework/security/test/context/support/TestExecutionEvent.java +++ b/test/src/main/java/org/springframework/security/test/context/support/TestExecutionEvent.java @@ -20,7 +20,7 @@ import org.springframework.test.context.TestContext; /** * Represents the events on the methods of - * {@link org.springframework.test.context.TestExecutionListener} + * {@link org.springframework.test.context.TestExecutionListener}. * * @author Rob Winch * @since 5.1 diff --git a/test/src/main/java/org/springframework/security/test/context/support/WithSecurityContextTestExecutionListener.java b/test/src/main/java/org/springframework/security/test/context/support/WithSecurityContextTestExecutionListener.java index 0dcec157cb..6cae2ab149 100644 --- a/test/src/main/java/org/springframework/security/test/context/support/WithSecurityContextTestExecutionListener.java +++ b/test/src/main/java/org/springframework/security/test/context/support/WithSecurityContextTestExecutionListener.java @@ -100,7 +100,7 @@ public class WithSecurityContextTestExecutionListener extends AbstractTestExecut } /** - * If configured before test execution sets the SecurityContext + * If configured before test execution sets the SecurityContext. * @since 5.1 */ @Override diff --git a/test/src/main/java/org/springframework/security/test/context/support/WithUserDetails.java b/test/src/main/java/org/springframework/security/test/context/support/WithUserDetails.java index 6d042abc18..a2f0984a5d 100644 --- a/test/src/main/java/org/springframework/security/test/context/support/WithUserDetails.java +++ b/test/src/main/java/org/springframework/security/test/context/support/WithUserDetails.java @@ -57,7 +57,7 @@ import org.springframework.test.web.servlet.MockMvc; public @interface WithUserDetails { /** - * The username to look up in the {@link UserDetailsService} + * The username to look up in the {@link UserDetailsService}. * @return */ String value() default "user"; diff --git a/test/src/main/java/org/springframework/security/test/web/reactive/server/SecurityMockServerConfigurers.java b/test/src/main/java/org/springframework/security/test/web/reactive/server/SecurityMockServerConfigurers.java index bc7224e008..aae493ee18 100644 --- a/test/src/main/java/org/springframework/security/test/web/reactive/server/SecurityMockServerConfigurers.java +++ b/test/src/main/java/org/springframework/security/test/web/reactive/server/SecurityMockServerConfigurers.java @@ -106,7 +106,7 @@ public final class SecurityMockServerConfigurers { } /** - * Sets up Spring Security's {@link WebTestClient} test support + * Sets up Spring Security's {@link WebTestClient} test support. * @return the MockServerConfigurer to use */ public static MockServerConfigurer springSecurity() { @@ -121,7 +121,7 @@ public final class SecurityMockServerConfigurers { } /** - * Updates the ServerWebExchange to use the provided Authentication as the Principal + * Updates the ServerWebExchange to use the provided Authentication as the Principal. * @param authentication the Authentication to use. * @return the configurer to use */ @@ -132,7 +132,7 @@ public final class SecurityMockServerConfigurers { /** * Updates the ServerWebExchange to use the provided UserDetails to create a - * UsernamePasswordAuthenticationToken as the Principal + * UsernamePasswordAuthenticationToken as the Principal. * @param userDetails the UserDetails to use. * @return the configurer to use */ @@ -493,7 +493,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the given {@link Jwt} + * Use the given {@link Jwt}. * @param jwt The {@link Jwt} to use * @return the {@link JwtMutator} for further configuration */ @@ -503,7 +503,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the token + * Use the provided authorities in the token. * @param authorities the authorities to use * @return the {@link JwtMutator} for further configuration */ @@ -514,7 +514,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the token + * Use the provided authorities in the token. * @param authorities the authorities to use * @return the {@link JwtMutator} for further configuration */ @@ -526,7 +526,7 @@ public final class SecurityMockServerConfigurers { /** * Provides the configured {@link Jwt} so that custom authorities can be derived - * from it + * from it. * @param authoritiesConverter the conversion strategy from {@link Jwt} to a * {@link Collection} of {@link GrantedAuthority}s * @return the {@link JwtMutator} for further configuration @@ -569,6 +569,8 @@ public final class SecurityMockServerConfigurers { } /** + * Configures a mock authenticated opaque token for use in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -584,7 +586,7 @@ public final class SecurityMockServerConfigurers { } /** - * Mutate the attributes using the given {@link Consumer} + * Mutate the attributes using the given {@link Consumer}. * @param attributesConsumer The {@link Consumer} for mutating the {@code Map} of * attributes * @return the {@link OpaqueTokenMutator} for further configuration @@ -601,7 +603,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the resulting principal + * Use the provided authorities in the resulting principal. * @param authorities the authorities to use * @return the {@link OpaqueTokenMutator} for further configuration */ @@ -613,7 +615,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the resulting principal + * Use the provided authorities in the resulting principal. * @param authorities the authorities to use * @return the {@link OpaqueTokenMutator} for further configuration */ @@ -625,7 +627,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided principal + * Use the provided principal. * @param principal the principal to use * @return the {@link OpaqueTokenMutator} for further configuration */ @@ -720,6 +722,8 @@ public final class SecurityMockServerConfigurers { } /** + * Configures a mock authenticated OAuth2 login for use in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -743,7 +747,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OAuth2LoginMutator} for further configuration */ @@ -755,7 +759,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OAuth2LoginMutator} for further configuration */ @@ -767,7 +771,7 @@ public final class SecurityMockServerConfigurers { } /** - * Mutate the attributes using the given {@link Consumer} + * Mutate the attributes using the given {@link Consumer}. * @param attributesConsumer The {@link Consumer} for mutating the {@code Map} of * attributes * @return the {@link OAuth2LoginMutator} for further configuration @@ -874,6 +878,8 @@ public final class SecurityMockServerConfigurers { } /** + * Configures a mock authenticated OIDC login for use in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -898,7 +904,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OidcLoginMutator} for further configuration */ @@ -910,7 +916,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OidcLoginMutator} for further configuration */ @@ -922,7 +928,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided {@link OidcIdToken} when constructing the authenticated user + * Use the provided {@link OidcIdToken} when constructing the authenticated user. * @param idTokenBuilderConsumer a {@link Consumer} of a * {@link OidcIdToken.Builder} * @return the {@link OidcLoginMutator} for further configuration @@ -937,7 +943,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use the provided {@link OidcUserInfo} when constructing the authenticated user + * Use the provided {@link OidcUserInfo} when constructing the authenticated user. * @param userInfoBuilderConsumer a {@link Consumer} of a * {@link OidcUserInfo.Builder} * @return the {@link OidcLoginMutator} for further configuration @@ -1052,6 +1058,8 @@ public final class SecurityMockServerConfigurers { } /** + * Configures a mock authorized OAuth2 client for use in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -1076,7 +1084,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use this {@link ClientRegistration} + * Use this {@link ClientRegistration}. * @param clientRegistration * @return the * {@link SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor} @@ -1088,7 +1096,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use this {@link Consumer} to configure a {@link ClientRegistration} + * Use this {@link Consumer} to configure a {@link ClientRegistration}. * @param clientRegistrationConfigurer the {@link ClientRegistration} configurer * @return the * {@link SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor} @@ -1103,7 +1111,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use this as the resource owner's principal name + * Use this as the resource owner's principal name. * @param principalName the resource owner's principal name * @return the {@link OAuth2ClientMutator} for further configuration */ @@ -1114,7 +1122,7 @@ public final class SecurityMockServerConfigurers { } /** - * Use this {@link OAuth2AccessToken} + * Use this {@link OAuth2AccessToken}. * @param accessToken the {@link OAuth2AccessToken} to use * @return the * {@link SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor} @@ -1181,7 +1189,7 @@ public final class SecurityMockServerConfigurers { /** * Used to wrap the {@link OAuth2AuthorizedClientRepository} to provide support - * for testing when the request is wrapped + * for testing when the request is wrapped. */ private static final class TestOAuth2AuthorizedClientManager implements ReactiveOAuth2AuthorizedClientManager { @@ -1218,7 +1226,7 @@ public final class SecurityMockServerConfigurers { /** * Used to wrap the {@link OAuth2AuthorizedClientRepository} to provide support - * for testing when the request is wrapped + * for testing when the request is wrapped. */ static final class TestOAuth2AuthorizedClientRepository implements ServerOAuth2AuthorizedClientRepository { diff --git a/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestBuilders.java b/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestBuilders.java index cc506881b0..405d48e98a 100644 --- a/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestBuilders.java +++ b/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestBuilders.java @@ -72,7 +72,7 @@ public final class SecurityMockMvcRequestBuilders { /** * Creates a logout request (including any necessary {@link CsrfToken}) to the - * specified {@code logoutUrl} + * specified {@code logoutUrl}. * @param logoutUrl the logout request URL * @return the LogoutRequestBuilder for additional customizations */ @@ -81,7 +81,7 @@ public final class SecurityMockMvcRequestBuilders { } /** - * Creates a logout request (including any necessary {@link CsrfToken}) + * Creates a logout request (including any necessary {@link CsrfToken}). * * @author Rob Winch * @since 4.0 diff --git a/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestPostProcessors.java b/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestPostProcessors.java index 8aba494fad..f60860c13f 100644 --- a/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestPostProcessors.java +++ b/test/src/main/java/org/springframework/security/test/web/servlet/request/SecurityMockMvcRequestPostProcessors.java @@ -476,7 +476,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Populates the X509Certificate instances onto the request + * Populates the X509Certificate instances onto the request. */ private static final class X509RequestPostProcessor implements RequestPostProcessor { @@ -630,7 +630,7 @@ public final class SecurityMockMvcRequestPostProcessors { private String cnonce = "c822c727a648aba7"; /** - * Configures the username to use + * Configures the username to use. * @param username the username to use * @return the DigestRequestPostProcessor for further customization */ @@ -641,7 +641,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Configures the password to use + * Configures the password to use. * @param password the password to use * @return the DigestRequestPostProcessor for further customization */ @@ -652,7 +652,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Configures the realm to use + * Configures the realm to use. * @param realm the realm to use * @return the DigestRequestPostProcessor for further customization */ @@ -731,7 +731,7 @@ public final class SecurityMockMvcRequestPostProcessors { /** * Support class for {@link RequestPostProcessor}'s that establish a Spring Security - * context + * context. */ private abstract static class SecurityContextRequestPostProcessorSupport { @@ -748,7 +748,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Saves the {@link SecurityContext} using the {@link SecurityContextRepository} + * Saves the {@link SecurityContext} using the {@link SecurityContextRepository}. * @param securityContext the {@link SecurityContext} to save * @param request the {@link HttpServletRequest} to use */ @@ -769,7 +769,7 @@ public final class SecurityMockMvcRequestPostProcessors { /** * Used to wrap the SecurityContextRepository to provide support for testing in - * stateless mode + * stateless mode. */ static final class TestSecurityContextRepository implements SecurityContextRepository { @@ -866,7 +866,7 @@ public final class SecurityMockMvcRequestPostProcessors { /** * Sets the specified {@link Authentication} on an empty {@link SecurityContext} and - * associates it to the {@link MockHttpServletRequest} + * associates it to the {@link MockHttpServletRequest}. * * @author Rob Winch * @since 4.0 @@ -943,7 +943,7 @@ public final class SecurityMockMvcRequestPostProcessors { private boolean accountNonLocked = true; /** - * Creates a new instance with the given username + * Creates a new instance with the given username. * @param username the username to use */ private UserRequestPostProcessor(String username) { @@ -1010,7 +1010,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Creates a new {@link User} + * Creates a new {@link User}. * @return the {@link User} for the principal */ private User createUser() { @@ -1052,6 +1052,9 @@ public final class SecurityMockMvcRequestPostProcessors { } /** + * A {@link RequestPostProcessor} for establishing a JWT-authenticated user for use in + * tests. + * * @author Jérôme Wacongne <ch4mp@c4-soft.com> * @author Josh Cummings * @since 5.2 @@ -1091,7 +1094,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the given {@link Jwt} + * Use the given {@link Jwt}. * @param jwt The {@link Jwt} to use * @return the {@link JwtRequestPostProcessor} for additional customization */ @@ -1101,7 +1104,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the token + * Use the provided authorities in the token. * @param authorities the authorities to use * @return the {@link JwtRequestPostProcessor} for further configuration */ @@ -1112,7 +1115,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the token + * Use the provided authorities in the token. * @param authorities the authorities to use * @return the {@link JwtRequestPostProcessor} for further configuration */ @@ -1124,7 +1127,7 @@ public final class SecurityMockMvcRequestPostProcessors { /** * Provides the configured {@link Jwt} so that custom authorities can be derived - * from it + * from it. * @param authoritiesConverter the conversion strategy from {@link Jwt} to a * {@link Collection} of {@link GrantedAuthority}s * @return the {@link JwtRequestPostProcessor} for further configuration @@ -1146,6 +1149,9 @@ public final class SecurityMockMvcRequestPostProcessors { } /** + * A {@link RequestPostProcessor} for establishing an opaque-token-authenticated user + * for use in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -1161,7 +1167,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Mutate the attributes using the given {@link Consumer} + * Mutate the attributes using the given {@link Consumer}. * @param attributesConsumer The {@link Consumer} for mutating the {@code Map} of * attributes * @return the {@link OpaqueTokenRequestPostProcessor} for further configuration @@ -1178,7 +1184,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the resulting principal + * Use the provided authorities in the resulting principal. * @param authorities the authorities to use * @return the {@link OpaqueTokenRequestPostProcessor} for further configuration */ @@ -1190,7 +1196,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the resulting principal + * Use the provided authorities in the resulting principal. * @param authorities the authorities to use * @return the {@link OpaqueTokenRequestPostProcessor} for further configuration */ @@ -1202,7 +1208,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided principal + * Use the provided principal. * @param principal the principal to use * @return the {@link OpaqueTokenRequestPostProcessor} for further configuration */ @@ -1275,6 +1281,9 @@ public final class SecurityMockMvcRequestPostProcessors { } /** + * A {@link RequestPostProcessor} for establishing an OAuth 2.0 login-authenticated + * user for use in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -1298,7 +1307,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OAuth2LoginRequestPostProcessor} for further configuration */ @@ -1310,7 +1319,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OAuth2LoginRequestPostProcessor} for further configuration */ @@ -1322,7 +1331,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Mutate the attributes using the given {@link Consumer} + * Mutate the attributes using the given {@link Consumer}. * @param attributesConsumer The {@link Consumer} for mutating the {@code Map} of * attributes * @return the {@link OAuth2LoginRequestPostProcessor} for further configuration @@ -1404,6 +1413,9 @@ public final class SecurityMockMvcRequestPostProcessors { } /** + * A {@link RequestPostProcessor} for establishing an OIDC-authenticated user for use + * in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -1428,7 +1440,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OidcLoginRequestPostProcessor} for further configuration */ @@ -1440,7 +1452,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided authorities in the {@link Authentication} + * Use the provided authorities in the {@link Authentication}. * @param authorities the authorities to use * @return the {@link OidcLoginRequestPostProcessor} for further configuration */ @@ -1452,7 +1464,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided {@link OidcIdToken} when constructing the authenticated user + * Use the provided {@link OidcIdToken} when constructing the authenticated user. * @param idTokenBuilderConsumer a {@link Consumer} of a * {@link OidcIdToken.Builder} * @return the {@link OidcLoginRequestPostProcessor} for further configuration @@ -1467,7 +1479,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use the provided {@link OidcUserInfo} when constructing the authenticated user + * Use the provided {@link OidcUserInfo} when constructing the authenticated user. * @param userInfoBuilderConsumer a {@link Consumer} of a * {@link OidcUserInfo.Builder} * @return the {@link OidcLoginRequestPostProcessor} for further configuration @@ -1550,6 +1562,9 @@ public final class SecurityMockMvcRequestPostProcessors { } /** + * A {@link RequestPostProcessor} for establishing an {@link OAuth2AuthorizedClient} + * for use in tests. + * * @author Josh Cummings * @since 5.3 */ @@ -1574,7 +1589,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use this {@link ClientRegistration} + * Use this {@link ClientRegistration}. * @param clientRegistration * @return the {@link OAuth2ClientRequestPostProcessor} for further configuration */ @@ -1584,7 +1599,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use this {@link Consumer} to configure a {@link ClientRegistration} + * Use this {@link Consumer} to configure a {@link ClientRegistration}. * @param clientRegistrationConfigurer the {@link ClientRegistration} configurer * @return the {@link OAuth2ClientRequestPostProcessor} for further configuration */ @@ -1597,7 +1612,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use this as the resource owner's principal name + * Use this as the resource owner's principal name. * @param principalName the resource owner's principal name * @return the {@link OAuth2ClientRequestPostProcessor} for further configuration */ @@ -1608,7 +1623,7 @@ public final class SecurityMockMvcRequestPostProcessors { } /** - * Use this {@link OAuth2AccessToken} + * Use this {@link OAuth2AccessToken}. * @param accessToken the {@link OAuth2AccessToken} to use * @return the {@link OAuth2ClientRequestPostProcessor} for further configuration */ @@ -1653,7 +1668,7 @@ public final class SecurityMockMvcRequestPostProcessors { /** * Used to wrap the {@link OAuth2AuthorizedClientRepository} to provide support - * for testing when the request is wrapped + * for testing when the request is wrapped. */ private static final class TestOAuth2AuthorizedClientManager implements OAuth2AuthorizedClientManager { @@ -1690,7 +1705,7 @@ public final class SecurityMockMvcRequestPostProcessors { /** * Used to wrap the {@link OAuth2AuthorizedClientRepository} to provide support - * for testing when the request is wrapped + * for testing when the request is wrapped. */ static final class TestOAuth2AuthorizedClientRepository implements OAuth2AuthorizedClientRepository { diff --git a/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultHandlers.java b/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultHandlers.java index 50d9208209..2bb3cf4b03 100644 --- a/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultHandlers.java +++ b/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultHandlers.java @@ -24,7 +24,7 @@ import org.springframework.test.web.servlet.MvcResult; import org.springframework.test.web.servlet.ResultHandler; /** - * Security related {@link MockMvc} {@link ResultHandler}s + * Security related {@link MockMvc} {@link ResultHandler}s. * * @author Marcus da Coregio * @since 5.6 @@ -36,7 +36,7 @@ public final class SecurityMockMvcResultHandlers { /** * Exports the {@link SecurityContext} from {@link TestSecurityContextHolder} to - * {@link SecurityContextHolder} + * {@link SecurityContextHolder}. */ public static ResultHandler exportTestSecurityContext() { return new ExportTestSecurityContextHandler(); @@ -44,7 +44,7 @@ public final class SecurityMockMvcResultHandlers { /** * A {@link ResultHandler} that copies the {@link SecurityContext} from - * {@link TestSecurityContextHolder} to {@link SecurityContextHolder} + * {@link TestSecurityContextHolder} to {@link SecurityContextHolder}. * * @author Marcus da Coregio * @since 5.6 diff --git a/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultMatchers.java b/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultMatchers.java index fe2fcb6f85..2193a35363 100644 --- a/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultMatchers.java +++ b/test/src/main/java/org/springframework/security/test/web/servlet/response/SecurityMockMvcResultMatchers.java @@ -164,7 +164,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Allows for any validating the authentication with arbitrary assertions + * Allows for any validating the authentication with arbitrary assertions. * @param assertAuthentication the Consumer which validates the authentication * @return the AuthenticatedMatcher to perform additional assertions */ @@ -174,7 +174,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Specifies the expected username + * Specifies the expected username. * @param expected the expected username * @return the {@link AuthenticatedMatcher} for further customization */ @@ -183,7 +183,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Specifies the expected {@link SecurityContext} + * Specifies the expected {@link SecurityContext}. * @param expected the expected {@link SecurityContext} * @return the {@link AuthenticatedMatcher} for further customization */ @@ -193,7 +193,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Specifies the expected {@link Authentication} + * Specifies the expected {@link Authentication}. * @param expected the expected {@link Authentication} * @return the {@link AuthenticatedMatcher} for further customization */ @@ -203,7 +203,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Specifies the expected principal + * Specifies the expected principal. * @param expected the expected principal * @return the {@link AuthenticatedMatcher} for further customization */ @@ -213,7 +213,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Specifies the expected {@link Authentication#getName()} + * Specifies the expected {@link Authentication#getName()}. * @param expected the expected {@link Authentication#getName()} * @return the {@link AuthenticatedMatcher} for further customization */ @@ -223,7 +223,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Specifies the {@link GrantedAuthority#getAuthority()} + * Specifies the {@link GrantedAuthority#getAuthority()}. * @param authorities the authorityNames * @return the {@link AuthenticatedMatcher} for further customization */ @@ -234,7 +234,7 @@ public final class SecurityMockMvcResultMatchers { } /** - * Specifies the {@link Authentication#getAuthorities()} + * Specifies the {@link Authentication#getAuthorities()}. * @param expected the {@link Authentication#getAuthorities()} * @return the {@link AuthenticatedMatcher} for further customization */ diff --git a/test/src/main/java/org/springframework/security/test/web/servlet/setup/SecurityMockMvcConfigurer.java b/test/src/main/java/org/springframework/security/test/web/servlet/setup/SecurityMockMvcConfigurer.java index 6a033c18ff..441105fa9e 100644 --- a/test/src/main/java/org/springframework/security/test/web/servlet/setup/SecurityMockMvcConfigurer.java +++ b/test/src/main/java/org/springframework/security/test/web/servlet/setup/SecurityMockMvcConfigurer.java @@ -49,14 +49,14 @@ final class SecurityMockMvcConfigurer extends MockMvcConfigurerAdapter { private final DelegateFilter delegateFilter; /** - * Creates a new instance + * Creates a new instance. */ SecurityMockMvcConfigurer() { this.delegateFilter = new DelegateFilter(); } /** - * Creates a new instance with the provided {@link jakarta.servlet.Filter} + * Creates a new instance with the provided {@link jakarta.servlet.Filter}. * @param springSecurityFilterChain the {@link jakarta.servlet.Filter} to use */ SecurityMockMvcConfigurer(Filter springSecurityFilterChain) { diff --git a/test/src/main/java/org/springframework/security/test/web/support/WebTestUtils.java b/test/src/main/java/org/springframework/security/test/web/support/WebTestUtils.java index eb23d4b946..d77088e67f 100644 --- a/test/src/main/java/org/springframework/security/test/web/support/WebTestUtils.java +++ b/test/src/main/java/org/springframework/security/test/web/support/WebTestUtils.java @@ -41,7 +41,7 @@ import org.springframework.web.context.WebApplicationContext; import org.springframework.web.context.support.WebApplicationContextUtils; /** - * A utility class for testing spring security + * A utility class for testing spring security. * * @author Rob Winch * @since 4.0 diff --git a/test/src/test/java/org/springframework/security/test/context/support/WithSecurityContextTestExcecutionListenerTests.java b/test/src/test/java/org/springframework/security/test/context/support/WithSecurityContextTestExcecutionListenerTests.java index cbdb537693..3cf9268272 100644 --- a/test/src/test/java/org/springframework/security/test/context/support/WithSecurityContextTestExcecutionListenerTests.java +++ b/test/src/test/java/org/springframework/security/test/context/support/WithSecurityContextTestExcecutionListenerTests.java @@ -40,6 +40,7 @@ import org.springframework.security.core.context.SecurityContext; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.security.test.context.TestSecurityContextHolder; import org.springframework.test.context.NestedTestConfiguration; +import org.springframework.test.context.NestedTestConfiguration.EnclosingConfiguration; import org.springframework.test.context.TestContext; import org.springframework.test.context.TestExecutionListener; import org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener; @@ -222,7 +223,7 @@ public class WithSecurityContextTestExcecutionListenerTests { } @WithMockUser - @NestedTestConfiguration(NestedTestConfiguration.EnclosingConfiguration.OVERRIDE) + @NestedTestConfiguration(EnclosingConfiguration.OVERRIDE) class OverrideOuterClass { class InnerClass { diff --git a/web/src/main/java/org/springframework/security/web/FilterChainProxy.java b/web/src/main/java/org/springframework/security/web/FilterChainProxy.java index fb3aa11d58..92fe7b9ff5 100644 --- a/web/src/main/java/org/springframework/security/web/FilterChainProxy.java +++ b/web/src/main/java/org/springframework/security/web/FilterChainProxy.java @@ -273,6 +273,8 @@ public class FilterChainProxy extends GenericFilterBean { } /** + * Returns the list of {@code SecurityFilterChain}s which will be matched against and + * applied to incoming requests. * @return the list of {@code SecurityFilterChain}s which will be matched against and * applied to incoming requests. */ @@ -302,7 +304,7 @@ public class FilterChainProxy extends GenericFilterBean { } /** - * Used to decorate the original {@link FilterChain} for each request + * Used to decorate the original {@link FilterChain} for each request. * *

      * By default, this decorates the filter chain with a {@link VirtualFilterChain} that @@ -433,7 +435,7 @@ public class FilterChainProxy extends GenericFilterBean { } /** - * A {@link FilterChainDecorator} that uses the {@link VirtualFilterChain} + * A {@link FilterChainDecorator} that uses the {@link VirtualFilterChain}. * * @author Josh Cummings * @since 6.0 diff --git a/web/src/main/java/org/springframework/security/web/ObservationFilterChainDecorator.java b/web/src/main/java/org/springframework/security/web/ObservationFilterChainDecorator.java index 627f002b20..59bf652f48 100644 --- a/web/src/main/java/org/springframework/security/web/ObservationFilterChainDecorator.java +++ b/web/src/main/java/org/springframework/security/web/ObservationFilterChainDecorator.java @@ -44,7 +44,7 @@ import org.springframework.util.StringUtils; /** * A {@link org.springframework.security.web.FilterChainProxy.FilterChainDecorator} that - * wraps the chain in before and after observations + * wraps the chain in before and after observations. * * @author Josh Cummings * @author Nikita Konev diff --git a/web/src/main/java/org/springframework/security/web/PortMapperImpl.java b/web/src/main/java/org/springframework/security/web/PortMapperImpl.java index 10af27390d..dc91028218 100644 --- a/web/src/main/java/org/springframework/security/web/PortMapperImpl.java +++ b/web/src/main/java/org/springframework/security/web/PortMapperImpl.java @@ -45,7 +45,7 @@ public class PortMapperImpl implements PortMapper { /** * Returns the translated (Integer -> Integer) version of the original port mapping - * specified via setHttpsPortMapping() + * specified via setHttpsPortMapping(). */ public Map getTranslatedPortMappings() { return this.httpsPortMappings; diff --git a/web/src/main/java/org/springframework/security/web/RedirectStrategy.java b/web/src/main/java/org/springframework/security/web/RedirectStrategy.java index ed1cde1c82..1dc3c1cc14 100644 --- a/web/src/main/java/org/springframework/security/web/RedirectStrategy.java +++ b/web/src/main/java/org/springframework/security/web/RedirectStrategy.java @@ -31,7 +31,7 @@ import jakarta.servlet.http.HttpServletResponse; public interface RedirectStrategy { /** - * Performs a redirect to the supplied URL + * Performs a redirect to the supplied URL. * @param request the current request * @param response the response to redirect * @param url the target URL to redirect to, for example "/login" diff --git a/web/src/main/java/org/springframework/security/web/WebAttributes.java b/web/src/main/java/org/springframework/security/web/WebAttributes.java index f0e849ea80..1c2008f445 100644 --- a/web/src/main/java/org/springframework/security/web/WebAttributes.java +++ b/web/src/main/java/org/springframework/security/web/WebAttributes.java @@ -62,7 +62,7 @@ public final class WebAttributes { /** * Set as a request attribute to override the default - * {@link WebInvocationPrivilegeEvaluator} + * {@link WebInvocationPrivilegeEvaluator}. * * @since 3.1.3 * @see WebInvocationPrivilegeEvaluator diff --git a/web/src/main/java/org/springframework/security/web/access/AuthorizationManagerWebInvocationPrivilegeEvaluator.java b/web/src/main/java/org/springframework/security/web/access/AuthorizationManagerWebInvocationPrivilegeEvaluator.java index f22cee6088..e973c3f6a1 100644 --- a/web/src/main/java/org/springframework/security/web/access/AuthorizationManagerWebInvocationPrivilegeEvaluator.java +++ b/web/src/main/java/org/springframework/security/web/access/AuthorizationManagerWebInvocationPrivilegeEvaluator.java @@ -29,7 +29,7 @@ import org.springframework.web.context.ServletContextAware; /** * An implementation of {@link WebInvocationPrivilegeEvaluator} which delegates the checks - * to an instance of {@link AuthorizationManager} + * to an instance of {@link AuthorizationManager}. * * @author Marcus Da Coregio * @since 5.5.5 @@ -88,7 +88,7 @@ public final class AuthorizationManagerWebInvocationPrivilegeEvaluator /** * Return the {@link HttpServletRequest} that is passed into the - * {@link AuthorizationManager} + * {@link AuthorizationManager}. * @param request the {@link HttpServletRequest} created by the * {@link WebInvocationPrivilegeEvaluator} * @return the {@link HttpServletRequest} that is passed into the diff --git a/web/src/main/java/org/springframework/security/web/access/DelegatingAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/access/DelegatingAccessDeniedHandler.java index 7cd207a573..6442e5d76b 100644 --- a/web/src/main/java/org/springframework/security/web/access/DelegatingAccessDeniedHandler.java +++ b/web/src/main/java/org/springframework/security/web/access/DelegatingAccessDeniedHandler.java @@ -43,7 +43,7 @@ public final class DelegatingAccessDeniedHandler implements AccessDeniedHandler private final AccessDeniedHandler defaultHandler; /** - * Creates a new instance + * Creates a new instance. * @param handlers a map of the {@link AccessDeniedException} class to the * {@link AccessDeniedHandler} that should be used. Each is considered in the order * they are specified and only the first {@link AccessDeniedHandler} is ued. diff --git a/web/src/main/java/org/springframework/security/web/access/DelegatingMissingAuthorityAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/access/DelegatingMissingAuthorityAccessDeniedHandler.java index bfeac8c992..cd2e986f6b 100644 --- a/web/src/main/java/org/springframework/security/web/access/DelegatingMissingAuthorityAccessDeniedHandler.java +++ b/web/src/main/java/org/springframework/security/web/access/DelegatingMissingAuthorityAccessDeniedHandler.java @@ -193,7 +193,7 @@ public final class DelegatingMissingAuthorityAccessDeniedHandler implements Acce } /** - * A builder for configuring the set of authority/entry-point pairs + * A builder for configuring the set of authority/entry-point pairs. * * @author Josh Cummings * @since 7.0 @@ -208,7 +208,7 @@ public final class DelegatingMissingAuthorityAccessDeniedHandler implements Acce /** * Use this {@link AuthenticationEntryPoint} when the given - * {@code missingAuthority} is missing from the authenticated user + * {@code missingAuthority} is missing from the authenticated user. * @param entryPoint the {@link AuthenticationEntryPoint} for the given authority * @param missingAuthority the authority * @return the {@link Builder} for further configurations @@ -222,7 +222,7 @@ public final class DelegatingMissingAuthorityAccessDeniedHandler implements Acce /** * Use this {@link AuthenticationEntryPoint} when the given - * {@code missingAuthority} is missing from the authenticated user + * {@code missingAuthority} is missing from the authenticated user. * @param entryPoint a consumer to configure the underlying * {@link DelegatingAuthenticationEntryPoint} * @param missingAuthority the authority diff --git a/web/src/main/java/org/springframework/security/web/access/ExceptionTranslationFilter.java b/web/src/main/java/org/springframework/security/web/access/ExceptionTranslationFilter.java index 84a0ba7c26..a2ce3ab574 100644 --- a/web/src/main/java/org/springframework/security/web/access/ExceptionTranslationFilter.java +++ b/web/src/main/java/org/springframework/security/web/access/ExceptionTranslationFilter.java @@ -237,6 +237,7 @@ public class ExceptionTranslationFilter extends GenericFilterBean implements Mes } /** + * Sets the {@link MessageSource} used to resolve exception messages. * @since 5.5 */ @Override @@ -263,6 +264,7 @@ public class ExceptionTranslationFilter extends GenericFilterBean implements Mes private static final class DefaultThrowableAnalyzer extends ThrowableAnalyzer { /** + * Registers extractors for unwrapping {@code ServletException}s. * @see org.springframework.security.web.util.ThrowableAnalyzer#initExtractorMap() */ @Override diff --git a/web/src/main/java/org/springframework/security/web/access/IpAddressAuthorizationManager.java b/web/src/main/java/org/springframework/security/web/access/IpAddressAuthorizationManager.java index fb4147b5c9..36da5872ba 100644 --- a/web/src/main/java/org/springframework/security/web/access/IpAddressAuthorizationManager.java +++ b/web/src/main/java/org/springframework/security/web/access/IpAddressAuthorizationManager.java @@ -30,7 +30,7 @@ import org.springframework.util.Assert; /** * A {@link AuthorizationManager}, that determines if the current request contains the - * specified address or range of addresses + * specified address or range of addresses. * * @author brunodmartins * @since 6.3 diff --git a/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingAccessDeniedHandler.java index e66b79d2b6..cb64bea941 100644 --- a/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingAccessDeniedHandler.java +++ b/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingAccessDeniedHandler.java @@ -44,7 +44,7 @@ public final class RequestMatcherDelegatingAccessDeniedHandler implements Access private final AccessDeniedHandler defaultHandler; /** - * Creates a new instance + * Creates a new instance. * @param handlers a map of {@link RequestMatcher}s to {@link AccessDeniedHandler}s * that should be used. Each is considered in the order they are specified and only * the first {@link AccessDeniedHandler} is used. diff --git a/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingWebInvocationPrivilegeEvaluator.java b/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingWebInvocationPrivilegeEvaluator.java index 8ecb81aabe..caa73d538a 100644 --- a/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingWebInvocationPrivilegeEvaluator.java +++ b/web/src/main/java/org/springframework/security/web/access/RequestMatcherDelegatingWebInvocationPrivilegeEvaluator.java @@ -33,7 +33,7 @@ import org.springframework.web.context.ServletContextAware; /** * A {@link WebInvocationPrivilegeEvaluator} which delegates to a list of * {@link WebInvocationPrivilegeEvaluator} based on a - * {@link org.springframework.security.web.util.matcher.RequestMatcher} evaluation + * {@link org.springframework.security.web.util.matcher.RequestMatcher} evaluation. * * @author Marcus Da Coregio * @since 5.5.5 diff --git a/web/src/main/java/org/springframework/security/web/access/expression/EvaluationContextPostProcessor.java b/web/src/main/java/org/springframework/security/web/access/expression/EvaluationContextPostProcessor.java index 55d91cdb07..b44418324d 100644 --- a/web/src/main/java/org/springframework/security/web/access/expression/EvaluationContextPostProcessor.java +++ b/web/src/main/java/org/springframework/security/web/access/expression/EvaluationContextPostProcessor.java @@ -20,7 +20,7 @@ import org.springframework.expression.EvaluationContext; /** * - * /** Allows post processing the {@link EvaluationContext} + * /** Allows post processing the {@link EvaluationContext}. * *

      * This API is intentionally kept package scope as it may evolve over time. diff --git a/web/src/main/java/org/springframework/security/web/access/expression/FilterInvocationExpressionRoot.java b/web/src/main/java/org/springframework/security/web/access/expression/FilterInvocationExpressionRoot.java index 50add0b055..cd07e5884f 100644 --- a/web/src/main/java/org/springframework/security/web/access/expression/FilterInvocationExpressionRoot.java +++ b/web/src/main/java/org/springframework/security/web/access/expression/FilterInvocationExpressionRoot.java @@ -26,13 +26,15 @@ import org.springframework.security.web.FilterInvocation; import org.springframework.security.web.util.matcher.IpAddressMatcher; /** + * The {@link SecurityExpressionRoot} used for web security expressions. + * * @author Steve Riesenberg * @since 7.0 */ final class FilterInvocationExpressionRoot extends SecurityExpressionRoot { /** - * Allows direct access to the request object + * Allows direct access to the request object. */ public final HttpServletRequest request; diff --git a/web/src/main/java/org/springframework/security/web/access/expression/WebExpressionAuthorizationManager.java b/web/src/main/java/org/springframework/security/web/access/expression/WebExpressionAuthorizationManager.java index d84786905f..0c96b6b429 100644 --- a/web/src/main/java/org/springframework/security/web/access/expression/WebExpressionAuthorizationManager.java +++ b/web/src/main/java/org/springframework/security/web/access/expression/WebExpressionAuthorizationManager.java @@ -115,7 +115,7 @@ public final class WebExpressionAuthorizationManager implements AuthorizationMan /** * Use this {@link SecurityExpressionHandler} to create - * {@link WebExpressionAuthorizationManager} instances + * {@link WebExpressionAuthorizationManager} instances. * @param expressionHandler * @return a {@link Builder} for constructing * {@link WebExpressionAuthorizationManager} instances @@ -154,7 +154,7 @@ public final class WebExpressionAuthorizationManager implements AuthorizationMan /** * Create a {@link WebExpressionAuthorizationManager} using this - * {@code expression} + * {@code expression}. * @param expression the expression to evaluate * @return the resulting {@link AuthorizationManager} */ diff --git a/web/src/main/java/org/springframework/security/web/access/expression/WebSecurityExpressionRoot.java b/web/src/main/java/org/springframework/security/web/access/expression/WebSecurityExpressionRoot.java index 37ef7819f6..9e429291fa 100644 --- a/web/src/main/java/org/springframework/security/web/access/expression/WebSecurityExpressionRoot.java +++ b/web/src/main/java/org/springframework/security/web/access/expression/WebSecurityExpressionRoot.java @@ -28,6 +28,8 @@ import org.springframework.security.web.access.intercept.RequestAuthorizationCon import org.springframework.security.web.util.matcher.IpAddressMatcher; /** + * The {@link SecurityExpressionRoot} used for web security expression evaluation. + * * @author Luke Taylor * @author Evgeniy Cheban * @author Steve Riesenberg @@ -36,11 +38,13 @@ import org.springframework.security.web.util.matcher.IpAddressMatcher; public class WebSecurityExpressionRoot extends SecurityExpressionRoot { /** - * Allows direct access to the request object + * Allows direct access to the request object. */ public final HttpServletRequest request; /** + * Creates an instance for the given {@link Authentication} and + * {@link FilterInvocation}. * @deprecated Use * {@link #WebSecurityExpressionRoot(Supplier, RequestAuthorizationContext)} instead */ diff --git a/web/src/main/java/org/springframework/security/web/access/intercept/AuthorizationFilter.java b/web/src/main/java/org/springframework/security/web/access/intercept/AuthorizationFilter.java index 297ba2514d..1f8db84610 100644 --- a/web/src/main/java/org/springframework/security/web/access/intercept/AuthorizationFilter.java +++ b/web/src/main/java/org/springframework/security/web/access/intercept/AuthorizationFilter.java @@ -157,7 +157,7 @@ public class AuthorizationFilter extends GenericFilterBean { } /** - * Gets the {@link AuthorizationManager} used by this filter + * Gets the {@link AuthorizationManager} used by this filter. * @return the {@link AuthorizationManager} */ public AuthorizationManager getAuthorizationManager() { diff --git a/web/src/main/java/org/springframework/security/web/access/intercept/RequestKey.java b/web/src/main/java/org/springframework/security/web/access/intercept/RequestKey.java index 72781ead1b..f805426fe0 100644 --- a/web/src/main/java/org/springframework/security/web/access/intercept/RequestKey.java +++ b/web/src/main/java/org/springframework/security/web/access/intercept/RequestKey.java @@ -21,6 +21,8 @@ import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** + * Represents a request URL pattern and optional HTTP method to be secured. + * * @author Luke Taylor * @since 2.0 */ diff --git a/web/src/main/java/org/springframework/security/web/aot/hint/WebMvcSecurityRuntimeHints.java b/web/src/main/java/org/springframework/security/web/aot/hint/WebMvcSecurityRuntimeHints.java index 5a2531f09f..a0b3879e34 100644 --- a/web/src/main/java/org/springframework/security/web/aot/hint/WebMvcSecurityRuntimeHints.java +++ b/web/src/main/java/org/springframework/security/web/aot/hint/WebMvcSecurityRuntimeHints.java @@ -27,7 +27,7 @@ import org.springframework.security.web.access.expression.WebSecurityExpressionR import org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationToken; /** - * {@link RuntimeHintsRegistrar} for WebMVC classes + * {@link RuntimeHintsRegistrar} for WebMVC classes. * * @author Marcus Da Coregio * @author Daniel Garnier-Moiroux diff --git a/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationProcessingFilter.java b/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationProcessingFilter.java index 59c9329398..1f53c10d21 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationProcessingFilter.java +++ b/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationProcessingFilter.java @@ -161,6 +161,7 @@ public abstract class AbstractAuthenticationProcessingFilter extends GenericFilt private boolean mfaEnabled; /** + * Creates a new instance. * @param defaultFilterProcessesUrl the default value for filterProcessesUrl. */ protected AbstractAuthenticationProcessingFilter(String defaultFilterProcessesUrl) { @@ -168,7 +169,7 @@ public abstract class AbstractAuthenticationProcessingFilter extends GenericFilt } /** - * Creates a new instance + * Creates a new instance. * @param requiresAuthenticationRequestMatcher the {@link RequestMatcher} used to * determine if authentication is required. Cannot be null. */ @@ -179,7 +180,7 @@ public abstract class AbstractAuthenticationProcessingFilter extends GenericFilt /** * Creates a new instance with a default filterProcessesUrl and an - * {@link AuthenticationManager} + * {@link AuthenticationManager}. * @param defaultFilterProcessesUrl the default value for filterProcessesUrl. * @param authenticationManager the {@link AuthenticationManager} used to authenticate * an {@link Authentication} object. Cannot be null. @@ -192,7 +193,7 @@ public abstract class AbstractAuthenticationProcessingFilter extends GenericFilt /** * Creates a new instance with a {@link RequestMatcher} and an - * {@link AuthenticationManager} + * {@link AuthenticationManager}. * @param requiresAuthenticationRequestMatcher the {@link RequestMatcher} used to * determine if authentication is required. Cannot be null. * @param authenticationManager the {@link AuthenticationManager} used to authenticate @@ -441,7 +442,7 @@ public abstract class AbstractAuthenticationProcessingFilter extends GenericFilt } /** - * Sets the URL that determines if authentication is required + * Sets the URL that determines if authentication is required. * @param filterProcessesUrl */ public void setFilterProcessesUrl(String filterProcessesUrl) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java b/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java index 94fe3bce7b..30fcf2c5fa 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java @@ -93,7 +93,7 @@ public abstract class AbstractAuthenticationTargetUrlRequestHandler { } /** - * Builds the target URL according to the logic defined in the main class Javadoc + * Builds the target URL according to the logic defined in the main class Javadoc. * @since 5.2 */ protected String determineTargetUrl(HttpServletRequest request, HttpServletResponse response, diff --git a/web/src/main/java/org/springframework/security/web/authentication/AnonymousAuthenticationFilter.java b/web/src/main/java/org/springframework/security/web/authentication/AnonymousAuthenticationFilter.java index 5949dff4a4..9fe152117c 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/AnonymousAuthenticationFilter.java +++ b/web/src/main/java/org/springframework/security/web/authentication/AnonymousAuthenticationFilter.java @@ -71,6 +71,7 @@ public class AnonymousAuthenticationFilter extends GenericFilterBean implements } /** + * Creates a filter with the given principal and authorities. * @param key key the key to identify tokens created by this filter * @param principal the principal which will be used to represent anonymous users * @param authorities the authority list for anonymous users diff --git a/web/src/main/java/org/springframework/security/web/authentication/AuthenticationEntryPointFailureHandler.java b/web/src/main/java/org/springframework/security/web/authentication/AuthenticationEntryPointFailureHandler.java index 5afc57f9c8..39fcbf4c2d 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/AuthenticationEntryPointFailureHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/AuthenticationEntryPointFailureHandler.java @@ -28,7 +28,7 @@ import org.springframework.security.web.AuthenticationEntryPoint; import org.springframework.util.Assert; /** - * Adapts a {@link AuthenticationEntryPoint} into a {@link AuthenticationFailureHandler} + * Adapts a {@link AuthenticationEntryPoint} into a {@link AuthenticationFailureHandler}. * * @author Sergey Bespalov * @since 5.2.0 @@ -59,7 +59,7 @@ public class AuthenticationEntryPointFailureHandler implements AuthenticationFai } /** - * Set whether to rethrow {@link AuthenticationServiceException}s (defaults to true) + * Set whether to rethrow {@link AuthenticationServiceException}s (defaults to true). * @param rethrowAuthenticationServiceException whether to rethrow * {@link AuthenticationServiceException}s * @since 5.8 diff --git a/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationEntryPoint.java b/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationEntryPoint.java index 878ff3712f..e286506deb 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationEntryPoint.java +++ b/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationEntryPoint.java @@ -138,7 +138,7 @@ public class DelegatingAuthenticationEntryPoint implements AuthenticationEntryPo } /** - * EntryPoint which is used when no RequestMatcher returned true + * EntryPoint which is used when no RequestMatcher returned true. * @deprecated Use * {@link #DelegatingAuthenticationEntryPoint(AuthenticationEntryPoint, List)} */ @@ -154,7 +154,7 @@ public class DelegatingAuthenticationEntryPoint implements AuthenticationEntryPo } /** - * Creates a new {@link Builder} + * Creates a new {@link Builder}. * @return the new {@link Builder} */ public static Builder builder() { diff --git a/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationFailureHandler.java b/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationFailureHandler.java index 16ab783568..4a5cdb7ecc 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationFailureHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/DelegatingAuthenticationFailureHandler.java @@ -44,7 +44,7 @@ public class DelegatingAuthenticationFailureHandler implements AuthenticationFai private final AuthenticationFailureHandler defaultHandler; /** - * Creates a new instance + * Creates a new instance. * @param handlers a map of the {@link AuthenticationException} class to the * {@link AuthenticationFailureHandler} that should be used. Each is considered in the * order they are specified and only the first {@link AuthenticationFailureHandler} is diff --git a/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationFailureHandler.java b/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationFailureHandler.java index 18fc359036..58daab5b22 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationFailureHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationFailureHandler.java @@ -31,6 +31,7 @@ import org.springframework.util.Assert; *

      * Forward Authentication Failure Handler *

      + * . * * @author Shazin Sadakath * @since 4.1 @@ -40,6 +41,7 @@ public class ForwardAuthenticationFailureHandler implements AuthenticationFailur private final String forwardUrl; /** + * Creates a new instance which forwards to the given URL on authentication failure. * @param forwardUrl */ public ForwardAuthenticationFailureHandler(String forwardUrl) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationSuccessHandler.java index a5f23f721d..cee4a7d389 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/ForwardAuthenticationSuccessHandler.java @@ -30,6 +30,7 @@ import org.springframework.util.Assert; *

      * Forward Authentication Success Handler *

      + * . * * @author Shazin Sadakath * @since 4.1 @@ -40,6 +41,7 @@ public class ForwardAuthenticationSuccessHandler implements AuthenticationSucces private final String forwardUrl; /** + * Creates a new instance that forwards to the given URL. * @param forwardUrl */ public ForwardAuthenticationSuccessHandler(String forwardUrl) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/HttpMessageConverterAuthenticationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/authentication/HttpMessageConverterAuthenticationSuccessHandler.java index 2e8e0fe85c..817b327c24 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/HttpMessageConverterAuthenticationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/HttpMessageConverterAuthenticationSuccessHandler.java @@ -35,7 +35,7 @@ import org.springframework.util.Assert; /** * An {@link AuthenticationSuccessHandler} that writes a JSON response with the redirect - * URL and an authenticated status similar to: + * URL and an authenticated status similar to:. * * * { diff --git a/web/src/main/java/org/springframework/security/web/authentication/LoginUrlAuthenticationEntryPoint.java b/web/src/main/java/org/springframework/security/web/authentication/LoginUrlAuthenticationEntryPoint.java index 322591f3dc..c6ce64784d 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/LoginUrlAuthenticationEntryPoint.java +++ b/web/src/main/java/org/springframework/security/web/authentication/LoginUrlAuthenticationEntryPoint.java @@ -90,6 +90,7 @@ public class LoginUrlAuthenticationEntryPoint implements AuthenticationEntryPoin private final RedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); /** + * Creates a new instance using the given login form URL. * @param loginFormUrl URL where the login page can be found. Should either be * relative to the web-app context path (include a leading {@code /}) or an absolute * URL. diff --git a/web/src/main/java/org/springframework/security/web/authentication/RequestMatcherDelegatingAuthenticationManagerResolver.java b/web/src/main/java/org/springframework/security/web/authentication/RequestMatcherDelegatingAuthenticationManagerResolver.java index 885356b047..c11fc646ae 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/RequestMatcherDelegatingAuthenticationManagerResolver.java +++ b/web/src/main/java/org/springframework/security/web/authentication/RequestMatcherDelegatingAuthenticationManagerResolver.java @@ -54,7 +54,7 @@ public final class RequestMatcherDelegatingAuthenticationManagerResolver /** * Construct an {@link RequestMatcherDelegatingAuthenticationManagerResolver} based on - * the provided parameters + * the provided parameters. * @param authenticationManagers a {@link Map} of * {@link RequestMatcher}/{@link AuthenticationManager} pairs */ @@ -66,7 +66,7 @@ public final class RequestMatcherDelegatingAuthenticationManagerResolver /** * Construct an {@link RequestMatcherDelegatingAuthenticationManagerResolver} based on - * the provided parameters + * the provided parameters. * @param authenticationManagers a {@link Map} of * {@link RequestMatcher}/{@link AuthenticationManager} pairs */ @@ -91,7 +91,7 @@ public final class RequestMatcherDelegatingAuthenticationManagerResolver } /** - * Set the default {@link AuthenticationManager} to use when a request does not match + * Set the default {@link AuthenticationManager} to use when a request does not match. * @param defaultAuthenticationManager the default {@link AuthenticationManager} to * use */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetails.java b/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetails.java index fa56d3520c..549e420c95 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetails.java +++ b/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetails.java @@ -47,7 +47,7 @@ public class WebAuthenticationDetails implements Serializable { } /** - * Constructor to add Jackson2 serialize/deserialize support + * Constructor to add Jackson2 serialize/deserialize support. * @param remoteAddress remote address of current request * @param sessionId session id * @since 5.7 diff --git a/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetailsSource.java b/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetailsSource.java index bf1946e794..44a05bd793 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetailsSource.java +++ b/web/src/main/java/org/springframework/security/web/authentication/WebAuthenticationDetailsSource.java @@ -31,6 +31,7 @@ public class WebAuthenticationDetailsSource implements AuthenticationDetailsSource { /** + * Builds the {@code WebAuthenticationDetails} from the given request. * @param context the {@code HttpServletRequest} object. * @return the {@code WebAuthenticationDetails} containing information about the * current request diff --git a/web/src/main/java/org/springframework/security/web/authentication/logout/CookieClearingLogoutHandler.java b/web/src/main/java/org/springframework/security/web/authentication/logout/CookieClearingLogoutHandler.java index c1ed81fa4e..50ac1a5289 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/logout/CookieClearingLogoutHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/logout/CookieClearingLogoutHandler.java @@ -31,7 +31,7 @@ import org.springframework.util.StringUtils; /** * A logout handler which clears either - A defined list of cookie names, using the - * context path as the cookie path OR - A given list of Cookies + * context path as the cookie path OR - A given list of Cookies. * * @author Luke Taylor * @author Onur Kagan Ozcan @@ -59,6 +59,7 @@ public final class CookieClearingLogoutHandler implements LogoutHandler { } /** + * Creates a new instance. * @param cookiesToClear - One or more Cookie objects that must have maxAge of 0 * @since 5.2 */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/logout/DelegatingLogoutSuccessHandler.java b/web/src/main/java/org/springframework/security/web/authentication/logout/DelegatingLogoutSuccessHandler.java index d1d09a867d..35dc459d77 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/logout/DelegatingLogoutSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/logout/DelegatingLogoutSuccessHandler.java @@ -30,7 +30,7 @@ import org.springframework.security.web.util.matcher.RequestMatcher; import org.springframework.util.Assert; /** - * Delegates to logout handlers based on matched request matchers + * Delegates to logout handlers based on matched request matchers. * * @author Shazin Sadakath * @author Rob Winch @@ -64,7 +64,7 @@ public class DelegatingLogoutSuccessHandler implements LogoutSuccessHandler { } /** - * Sets the default {@link LogoutSuccessHandler} if no other handlers available + * Sets the default {@link LogoutSuccessHandler} if no other handlers available. * @param defaultLogoutSuccessHandler the defaultLogoutSuccessHandler to set */ public void setDefaultLogoutSuccessHandler(LogoutSuccessHandler defaultLogoutSuccessHandler) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/logout/HeaderWriterLogoutHandler.java b/web/src/main/java/org/springframework/security/web/authentication/logout/HeaderWriterLogoutHandler.java index e04ab8f165..b71c0ee807 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/logout/HeaderWriterLogoutHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/logout/HeaderWriterLogoutHandler.java @@ -25,6 +25,9 @@ import org.springframework.security.web.header.HeaderWriter; import org.springframework.util.Assert; /** + * A {@link LogoutHandler} that writes headers to the response on logout using the given + * {@link HeaderWriter}. + * * @author Rafiullah Hamedy * @since 5.2 */ @@ -33,7 +36,7 @@ public final class HeaderWriterLogoutHandler implements LogoutHandler { private final HeaderWriter headerWriter; /** - * Constructs a new instance using the passed {@link HeaderWriter} implementation + * Constructs a new instance using the passed {@link HeaderWriter} implementation. * @param headerWriter * @throws IllegalArgumentException if headerWriter is null. */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/logout/LogoutSuccessEventPublishingLogoutHandler.java b/web/src/main/java/org/springframework/security/web/authentication/logout/LogoutSuccessEventPublishingLogoutHandler.java index dc7abcdcbb..37178e7bdd 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/logout/LogoutSuccessEventPublishingLogoutHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/logout/LogoutSuccessEventPublishingLogoutHandler.java @@ -26,7 +26,7 @@ import org.springframework.security.authentication.event.LogoutSuccessEvent; import org.springframework.security.core.Authentication; /** - * A logout handler which publishes {@link LogoutSuccessEvent} + * A logout handler which publishes {@link LogoutSuccessEvent}. * * @author Onur Kagan Ozcan * @since 5.2.0 diff --git a/web/src/main/java/org/springframework/security/web/authentication/ott/DefaultGenerateOneTimeTokenRequestResolver.java b/web/src/main/java/org/springframework/security/web/authentication/ott/DefaultGenerateOneTimeTokenRequestResolver.java index e9ce61be08..ccd1100e0d 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/ott/DefaultGenerateOneTimeTokenRequestResolver.java +++ b/web/src/main/java/org/springframework/security/web/authentication/ott/DefaultGenerateOneTimeTokenRequestResolver.java @@ -48,7 +48,7 @@ public final class DefaultGenerateOneTimeTokenRequestResolver implements Generat } /** - * Sets one-time token expiration time + * Sets one-time token expiration time. * @param expiresIn one-time token expiration time */ public void setExpiresIn(Duration expiresIn) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/ott/GenerateOneTimeTokenRequestResolver.java b/web/src/main/java/org/springframework/security/web/authentication/ott/GenerateOneTimeTokenRequestResolver.java index 800cb81287..f6b22fd344 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/ott/GenerateOneTimeTokenRequestResolver.java +++ b/web/src/main/java/org/springframework/security/web/authentication/ott/GenerateOneTimeTokenRequestResolver.java @@ -31,7 +31,7 @@ import org.springframework.security.authentication.ott.GenerateOneTimeTokenReque public interface GenerateOneTimeTokenRequestResolver { /** - * Resolves {@link GenerateOneTimeTokenRequest} from {@link HttpServletRequest} + * Resolves {@link GenerateOneTimeTokenRequest} from {@link HttpServletRequest}. * @param request {@link HttpServletRequest} to resolve * @return {@link GenerateOneTimeTokenRequest} */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/ott/OneTimeTokenGenerationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/authentication/ott/OneTimeTokenGenerationSuccessHandler.java index 68e3605029..1d9672e315 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/ott/OneTimeTokenGenerationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/ott/OneTimeTokenGenerationSuccessHandler.java @@ -34,7 +34,7 @@ import org.springframework.security.authentication.ott.OneTimeToken; public interface OneTimeTokenGenerationSuccessHandler { /** - * Handles generated one-time tokens + * Handles generated one-time tokens. */ void handle(HttpServletRequest request, HttpServletResponse response, OneTimeToken oneTimeToken) throws IOException, ServletException; diff --git a/web/src/main/java/org/springframework/security/web/authentication/ott/RedirectOneTimeTokenGenerationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/authentication/ott/RedirectOneTimeTokenGenerationSuccessHandler.java index 9fb9d70177..8d84e332c1 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/ott/RedirectOneTimeTokenGenerationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/ott/RedirectOneTimeTokenGenerationSuccessHandler.java @@ -28,7 +28,7 @@ import org.springframework.util.Assert; /** * A {@link OneTimeTokenGenerationSuccessHandler} that performs a redirect to a specific - * location + * location. * * @author Marcus da Coregio * @since 6.4 diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/AbstractPreAuthenticatedProcessingFilter.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/AbstractPreAuthenticatedProcessingFilter.java index 92df3bdcf0..68a372f2f7 100755 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/AbstractPreAuthenticatedProcessingFilter.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/AbstractPreAuthenticatedProcessingFilter.java @@ -297,6 +297,7 @@ public abstract class AbstractPreAuthenticatedProcessingFilter extends GenericFi } /** + * Sets the {@link ApplicationEventPublisher} to use. * @param anApplicationEventPublisher The ApplicationEventPublisher to use */ @Override @@ -326,6 +327,7 @@ public abstract class AbstractPreAuthenticatedProcessingFilter extends GenericFi } /** + * Sets the {@link AuthenticationDetailsSource} to use. * @param authenticationDetailsSource The AuthenticationDetailsSource to use */ public void setAuthenticationDetailsSource( @@ -339,6 +341,7 @@ public abstract class AbstractPreAuthenticatedProcessingFilter extends GenericFi } /** + * Sets the {@link AuthenticationManager} to use. * @param authenticationManager The AuthenticationManager to use */ public void setAuthenticationManager(AuthenticationManager authenticationManager) { @@ -413,7 +416,7 @@ public abstract class AbstractPreAuthenticatedProcessingFilter extends GenericFi } /** - * Override to extract the principal information from the current request + * Override to extract the principal information from the current request. */ protected abstract @Nullable Object getPreAuthenticatedPrincipal(HttpServletRequest request); @@ -425,7 +428,7 @@ public abstract class AbstractPreAuthenticatedProcessingFilter extends GenericFi protected abstract @Nullable Object getPreAuthenticatedCredentials(HttpServletRequest request); /** - * Request matcher for default auth check logic + * Request matcher for default auth check logic. */ private class PreAuthenticatedProcessingRequestMatcher implements RequestMatcher { diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationProvider.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationProvider.java index 945a5a6d68..526e0a213a 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationProvider.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationProvider.java @@ -153,7 +153,7 @@ public class PreAuthenticatedAuthenticationProvider implements AuthenticationPro } /** - * Sets authorities that this provider should grant once authentication completes + * Sets authorities that this provider should grant once authentication completes. * @param grantedAuthoritySupplier the supplier that grants authorities */ public void setGrantedAuthoritySupplier(Supplier> grantedAuthoritySupplier) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationToken.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationToken.java index e7d75c3206..d4917ac139 100755 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationToken.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedAuthenticationToken.java @@ -74,7 +74,7 @@ public class PreAuthenticatedAuthenticationToken extends AbstractAuthenticationT } /** - * Get the credentials + * Get the credentials. */ @Override public @Nullable Object getCredentials() { @@ -82,7 +82,7 @@ public class PreAuthenticatedAuthenticationToken extends AbstractAuthenticationT } /** - * Get the principal + * Get the principal. */ @Override public Object getPrincipal() { @@ -95,7 +95,7 @@ public class PreAuthenticatedAuthenticationToken extends AbstractAuthenticationT } /** - * A builder of {@link PreAuthenticatedAuthenticationToken} instances + * A builder of {@link PreAuthenticatedAuthenticationToken} instances. * * @since 7.0 */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedCredentialsNotFoundException.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedCredentialsNotFoundException.java index d50bc37dc1..1cfd3d3ebf 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedCredentialsNotFoundException.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/PreAuthenticatedCredentialsNotFoundException.java @@ -30,6 +30,7 @@ public class PreAuthenticatedCredentialsNotFoundException extends Authentication } /** + * Creates a new instance with the given message and cause. * @param message The message for the Exception * @param cause The Exception that caused this Exception. */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/J2eeBasedPreAuthenticatedWebAuthenticationDetailsSource.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/J2eeBasedPreAuthenticatedWebAuthenticationDetailsSource.java index 83b6e52af6..0cbc6f77f1 100755 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/J2eeBasedPreAuthenticatedWebAuthenticationDetailsSource.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/J2eeBasedPreAuthenticatedWebAuthenticationDetailsSource.java @@ -50,7 +50,7 @@ public class J2eeBasedPreAuthenticatedWebAuthenticationDetailsSource implements protected final Log logger = LogFactory.getLog(getClass()); /** - * The role attributes returned by the configured {@code MappableAttributesRetriever} + * The role attributes returned by the configured {@code MappableAttributesRetriever}. */ @SuppressWarnings("NullAway.Init") protected Set j2eeMappableRoles; @@ -103,6 +103,7 @@ public class J2eeBasedPreAuthenticatedWebAuthenticationDetailsSource implements } /** + * Sets the {@code MappableAttributesRetriever} to use. * @param aJ2eeMappableRolesRetriever The MappableAttributesRetriever to use */ public void setMappableRolesRetriever(MappableAttributesRetriever aJ2eeMappableRolesRetriever) { @@ -110,6 +111,7 @@ public class J2eeBasedPreAuthenticatedWebAuthenticationDetailsSource implements } /** + * Sets the {@code Attributes2GrantedAuthoritiesMapper} to use. * @param mapper The Attributes2GrantedAuthoritiesMapper to use */ public void setUserRoles2GrantedAuthoritiesMapper(Attributes2GrantedAuthoritiesMapper mapper) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/WebXmlMappableAttributesRetriever.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/WebXmlMappableAttributesRetriever.java index d7f4bcb618..bdea4d50e7 100755 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/WebXmlMappableAttributesRetriever.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/WebXmlMappableAttributesRetriever.java @@ -110,6 +110,7 @@ public class WebXmlMappableAttributesRetriever } /** + * Parses the given InputStream into a {@link Document}. * @return Document for the specified InputStream */ private Document getDocument(InputStream aStream) { diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/WebSpherePreAuthenticatedWebAuthenticationDetailsSource.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/WebSpherePreAuthenticatedWebAuthenticationDetailsSource.java index 470bc274b8..43357d0dad 100755 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/WebSpherePreAuthenticatedWebAuthenticationDetailsSource.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/WebSpherePreAuthenticatedWebAuthenticationDetailsSource.java @@ -74,6 +74,7 @@ public class WebSpherePreAuthenticatedWebAuthenticationDetailsSource implements } /** + * Sets the {@code Attributes2GrantedAuthoritiesMapper} to use. * @param mapper The Attributes2GrantedAuthoritiesMapper to use for converting the WAS * groups to authorities */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/SubjectDnX509PrincipalExtractor.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/SubjectDnX509PrincipalExtractor.java index e1cce04bb8..a7c55c88b9 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/SubjectDnX509PrincipalExtractor.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/SubjectDnX509PrincipalExtractor.java @@ -93,6 +93,7 @@ public class SubjectDnX509PrincipalExtractor implements X509PrincipalExtractor, } /** + * Sets the message source to use for resolving error messages. * @since 5.5 */ @Override diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/X509AuthenticationFilter.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/X509AuthenticationFilter.java index 1b0b42f6cc..8e39c9a4df 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/X509AuthenticationFilter.java +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/X509AuthenticationFilter.java @@ -25,6 +25,9 @@ import org.springframework.core.log.LogMessage; import org.springframework.security.web.authentication.preauth.AbstractPreAuthenticatedProcessingFilter; /** + * A pre-authentication filter that extracts the principal from an X.509 client + * certificate. + * * @author Luke Taylor */ public class X509AuthenticationFilter extends AbstractPreAuthenticatedProcessingFilter { diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServices.java b/web/src/main/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServices.java index f3ebed73a6..f6b71ca1a5 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServices.java +++ b/web/src/main/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServices.java @@ -480,6 +480,7 @@ public abstract class AbstractRememberMeServices } /** + * Sets the {@link MessageSource} used to resolve messages. * @since 5.5 */ @Override diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/CookieTheftException.java b/web/src/main/java/org/springframework/security/web/authentication/rememberme/CookieTheftException.java index 5252838ec6..449754a8e8 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/rememberme/CookieTheftException.java +++ b/web/src/main/java/org/springframework/security/web/authentication/rememberme/CookieTheftException.java @@ -19,6 +19,8 @@ package org.springframework.security.web.authentication.rememberme; import java.io.Serial; /** + * Thrown if a remember-me cookie is presented that indicates it may have been stolen. + * * @author Luke Taylor */ public class CookieTheftException extends RememberMeAuthenticationException { diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/JdbcTokenRepositoryImpl.java b/web/src/main/java/org/springframework/security/web/authentication/rememberme/JdbcTokenRepositoryImpl.java index 0b2179835a..fbe27e6cf4 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/rememberme/JdbcTokenRepositoryImpl.java +++ b/web/src/main/java/org/springframework/security/web/authentication/rememberme/JdbcTokenRepositoryImpl.java @@ -38,20 +38,20 @@ import org.springframework.jdbc.core.support.JdbcDaoSupport; @SuppressWarnings("removal") public class JdbcTokenRepositoryImpl extends JdbcDaoSupport implements PersistentTokenRepository { - /** Default SQL for creating the database table to store the tokens */ + /** Default SQL for creating the database table to store the tokens. */ public static final String CREATE_TABLE_SQL = "create table persistent_logins (username varchar(64) not null, series varchar(64) primary key, " + "token varchar(64) not null, last_used timestamp not null)"; - /** The default SQL used by the getTokenBySeries query */ + /** The default SQL used by the getTokenBySeries query. */ public static final String DEF_TOKEN_BY_SERIES_SQL = "select username,series,token,last_used from persistent_logins where series = ?"; - /** The default SQL used by createNewToken */ + /** The default SQL used by createNewToken. */ public static final String DEF_INSERT_TOKEN_SQL = "insert into persistent_logins (username, series, token, last_used) values(?,?,?,?)"; - /** The default SQL used by updateToken */ + /** The default SQL used by updateToken. */ public static final String DEF_UPDATE_TOKEN_SQL = "update persistent_logins set token = ?, last_used = ? where series = ?"; - /** The default SQL used by removeUserTokens */ + /** The default SQL used by removeUserTokens. */ public static final String DEF_REMOVE_USER_TOKENS_SQL = "delete from persistent_logins where username = ?"; private String tokensBySeriesSql = DEF_TOKEN_BY_SERIES_SQL; diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/PersistentRememberMeToken.java b/web/src/main/java/org/springframework/security/web/authentication/rememberme/PersistentRememberMeToken.java index d07cf1c13c..1c2332f7bb 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/rememberme/PersistentRememberMeToken.java +++ b/web/src/main/java/org/springframework/security/web/authentication/rememberme/PersistentRememberMeToken.java @@ -19,6 +19,8 @@ package org.springframework.security.web.authentication.rememberme; import java.util.Date; /** + * Represents the persistent state of a remember-me token. + * * @author Luke Taylor */ public class PersistentRememberMeToken { diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/TokenBasedRememberMeServices.java b/web/src/main/java/org/springframework/security/web/authentication/rememberme/TokenBasedRememberMeServices.java index e970e9326e..7e5523f52b 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/rememberme/TokenBasedRememberMeServices.java +++ b/web/src/main/java/org/springframework/security/web/authentication/rememberme/TokenBasedRememberMeServices.java @@ -108,7 +108,7 @@ public class TokenBasedRememberMeServices extends AbstractRememberMeServices { } /** - * Construct the instance with the parameters provided + * Construct the instance with the parameters provided. * @param key the signature key * @param userDetailsService the {@link UserDetailsService} * @param encodingAlgorithm the {@link RememberMeTokenAlgorithm} used to encode the @@ -245,7 +245,7 @@ public class TokenBasedRememberMeServices extends AbstractRememberMeServices { } /** - * Sets the algorithm to be used to match the token signature + * Sets the algorithm to be used to match the token signature. * @param matchingAlgorithm the matching algorithm * @since 5.8 */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/AbstractSessionFixationProtectionStrategy.java b/web/src/main/java/org/springframework/security/web/authentication/session/AbstractSessionFixationProtectionStrategy.java index ed0788d845..4d2d4885b0 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/session/AbstractSessionFixationProtectionStrategy.java +++ b/web/src/main/java/org/springframework/security/web/authentication/session/AbstractSessionFixationProtectionStrategy.java @@ -103,7 +103,7 @@ public abstract class AbstractSessionFixationProtectionStrategy } /** - * Applies session fixation + * Applies session fixation. * @param request the {@link HttpServletRequest} to apply session fixation protection * for * @return the new {@link HttpSession} to use. Cannot be null. diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/ConcurrentSessionControlAuthenticationStrategy.java b/web/src/main/java/org/springframework/security/web/authentication/session/ConcurrentSessionControlAuthenticationStrategy.java index 4393aefb63..0f595e3f14 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/session/ConcurrentSessionControlAuthenticationStrategy.java +++ b/web/src/main/java/org/springframework/security/web/authentication/session/ConcurrentSessionControlAuthenticationStrategy.java @@ -79,6 +79,7 @@ public class ConcurrentSessionControlAuthenticationStrategy private SessionLimit sessionLimit = SessionLimit.of(1); /** + * Creates a new instance using the given session registry. * @param sessionRegistry the session registry which should be updated when the * authenticated session is changed. */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/NullAuthenticatedSessionStrategy.java b/web/src/main/java/org/springframework/security/web/authentication/session/NullAuthenticatedSessionStrategy.java index 55254fed7b..9a180c2dd9 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/session/NullAuthenticatedSessionStrategy.java +++ b/web/src/main/java/org/springframework/security/web/authentication/session/NullAuthenticatedSessionStrategy.java @@ -23,6 +23,8 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.core.Authentication; /** + * A {@link SessionAuthenticationStrategy} which takes no action. + * * @author Luke Taylor * @since 3.0 */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/RegisterSessionAuthenticationStrategy.java b/web/src/main/java/org/springframework/security/web/authentication/session/RegisterSessionAuthenticationStrategy.java index f7f50e3997..c2b795cd4a 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/session/RegisterSessionAuthenticationStrategy.java +++ b/web/src/main/java/org/springframework/security/web/authentication/session/RegisterSessionAuthenticationStrategy.java @@ -49,6 +49,7 @@ public class RegisterSessionAuthenticationStrategy implements SessionAuthenticat private final SessionRegistry sessionRegistry; /** + * Creates a new instance. * @param sessionRegistry the session registry which should be updated when the * authenticated session is changed. */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/SessionFixationProtectionStrategy.java b/web/src/main/java/org/springframework/security/web/authentication/session/SessionFixationProtectionStrategy.java index a7a6cbaa9a..4b205a70c7 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/session/SessionFixationProtectionStrategy.java +++ b/web/src/main/java/org/springframework/security/web/authentication/session/SessionFixationProtectionStrategy.java @@ -99,6 +99,7 @@ public class SessionFixationProtectionStrategy extends AbstractSessionFixationPr } /** + * Transfers the given attributes into the new session. * @param attributes the attributes which were extracted from the original session by * {@code extractAttributes} * @param newSession the newly created session diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/SessionLimit.java b/web/src/main/java/org/springframework/security/web/authentication/session/SessionLimit.java index 9b883d1148..f69af0dba4 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/session/SessionLimit.java +++ b/web/src/main/java/org/springframework/security/web/authentication/session/SessionLimit.java @@ -36,7 +36,7 @@ public interface SessionLimit extends Function { SessionLimit UNLIMITED = (authentication) -> -1; /** - * Creates a {@link SessionLimit} that always returns the given value for any user + * Creates a {@link SessionLimit} that always returns the given value for any user. * @param maxSessions the maximum number of sessions allowed * @return a {@link SessionLimit} instance that returns the given value. */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/switchuser/AuthenticationSwitchUserEvent.java b/web/src/main/java/org/springframework/security/web/authentication/switchuser/AuthenticationSwitchUserEvent.java index e88273031e..640e8fe442 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/switchuser/AuthenticationSwitchUserEvent.java +++ b/web/src/main/java/org/springframework/security/web/authentication/switchuser/AuthenticationSwitchUserEvent.java @@ -37,7 +37,7 @@ public class AuthenticationSwitchUserEvent extends AbstractAuthenticationEvent { private final @Nullable UserDetails targetUser; /** - * Switch user context event constructor + * Switch user context event constructor. * @param authentication The current Authentication object * @param targetUser The target user */ diff --git a/web/src/main/java/org/springframework/security/web/authentication/switchuser/SwitchUserFilter.java b/web/src/main/java/org/springframework/security/web/authentication/switchuser/SwitchUserFilter.java index c6910250cd..b22b4708de 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/switchuser/SwitchUserFilter.java +++ b/web/src/main/java/org/springframework/security/web/authentication/switchuser/SwitchUserFilter.java @@ -493,6 +493,7 @@ public class SwitchUserFilter extends GenericFilterBean implements ApplicationEv } /** + * Sets the {@link SwitchUserAuthorityChanger} to use. * @param switchUserAuthorityChanger to use to fine-tune the authorities granted to * subclasses (may be null if SwitchUserFilter should not fine-tune the authorities) */ diff --git a/web/src/main/java/org/springframework/security/web/context/AbstractSecurityWebApplicationInitializer.java b/web/src/main/java/org/springframework/security/web/context/AbstractSecurityWebApplicationInitializer.java index ee13902712..7d8e0e5968 100644 --- a/web/src/main/java/org/springframework/security/web/context/AbstractSecurityWebApplicationInitializer.java +++ b/web/src/main/java/org/springframework/security/web/context/AbstractSecurityWebApplicationInitializer.java @@ -128,7 +128,7 @@ public abstract class AbstractSecurityWebApplicationInitializer implements WebAp } /** - * Registers the springSecurityFilterChain + * Registers the springSecurityFilterChain. * @param servletContext the {@link ServletContext} */ private void insertSpringSecurityFilterChain(ServletContext servletContext) { diff --git a/web/src/main/java/org/springframework/security/web/context/DelegatingSecurityContextRepository.java b/web/src/main/java/org/springframework/security/web/context/DelegatingSecurityContextRepository.java index 8aa8e6c96d..e5636a0a9e 100644 --- a/web/src/main/java/org/springframework/security/web/context/DelegatingSecurityContextRepository.java +++ b/web/src/main/java/org/springframework/security/web/context/DelegatingSecurityContextRepository.java @@ -28,6 +28,9 @@ import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.util.Assert; /** + * A {@link SecurityContextRepository} that delegates to a list of other + * {@link SecurityContextRepository} instances. + * * @author Steve Riesenberg * @author Josh Cummings * @since 5.8 @@ -46,6 +49,7 @@ public final class DelegatingSecurityContextRepository implements SecurityContex } /** + * Loads the security context by delegating to each configured repository. * @deprecated * @see SecurityContextRepository#loadContext */ diff --git a/web/src/main/java/org/springframework/security/web/context/HttpSessionSecurityContextRepository.java b/web/src/main/java/org/springframework/security/web/context/HttpSessionSecurityContextRepository.java index d77192feec..bfbf322652 100644 --- a/web/src/main/java/org/springframework/security/web/context/HttpSessionSecurityContextRepository.java +++ b/web/src/main/java/org/springframework/security/web/context/HttpSessionSecurityContextRepository.java @@ -98,7 +98,7 @@ public class HttpSessionSecurityContextRepository implements SecurityContextRepo /** * SecurityContext instance used to check for equality with default (unauthenticated) - * content + * content. */ private Object contextObject = this.securityContextHolderStrategy.createEmptyContext(); @@ -202,6 +202,7 @@ public class HttpSessionSecurityContextRepository implements SecurityContextRepo } /** + * Reads the {@link SecurityContext} from the given session, if present. * @param httpSession the session obtained from the request. */ private @Nullable SecurityContext readSecurityContextFromSession(HttpSession httpSession) { diff --git a/web/src/main/java/org/springframework/security/web/context/NullSecurityContextRepository.java b/web/src/main/java/org/springframework/security/web/context/NullSecurityContextRepository.java index 21fbfab363..2700a7aa97 100644 --- a/web/src/main/java/org/springframework/security/web/context/NullSecurityContextRepository.java +++ b/web/src/main/java/org/springframework/security/web/context/NullSecurityContextRepository.java @@ -26,6 +26,9 @@ import org.springframework.security.core.context.SecurityContextHolderStrategy; import org.springframework.util.Assert; /** + * A {@link SecurityContextRepository} that never persists or loads a + * {@link SecurityContext}. + * * @author Luke Taylor * @since 3.1 */ @@ -40,6 +43,7 @@ public final class NullSecurityContextRepository implements SecurityContextRepos } /** + * Returns an empty {@link SecurityContext}. * @deprecated please see {@link SecurityContextRepository#loadContext} */ @Override diff --git a/web/src/main/java/org/springframework/security/web/context/RequestAttributeSecurityContextRepository.java b/web/src/main/java/org/springframework/security/web/context/RequestAttributeSecurityContextRepository.java index d4bb44810d..d1de58e044 100644 --- a/web/src/main/java/org/springframework/security/web/context/RequestAttributeSecurityContextRepository.java +++ b/web/src/main/java/org/springframework/security/web/context/RequestAttributeSecurityContextRepository.java @@ -77,6 +77,7 @@ public final class RequestAttributeSecurityContextRepository implements Security } /** + * Loads the {@link SecurityContext} from the request attribute. * @deprecated please see {@link SecurityContextRepository#loadContext} */ @Override diff --git a/web/src/main/java/org/springframework/security/web/context/SaveContextOnUpdateOrErrorResponseWrapper.java b/web/src/main/java/org/springframework/security/web/context/SaveContextOnUpdateOrErrorResponseWrapper.java index db78e73581..d2d216f5b3 100644 --- a/web/src/main/java/org/springframework/security/web/context/SaveContextOnUpdateOrErrorResponseWrapper.java +++ b/web/src/main/java/org/springframework/security/web/context/SaveContextOnUpdateOrErrorResponseWrapper.java @@ -57,6 +57,7 @@ public abstract class SaveContextOnUpdateOrErrorResponseWrapper extends OnCommit private final boolean disableUrlRewriting; /** + * Creates a new instance. * @param response the response to be wrapped * @param disableUrlRewriting turns the URL encoding methods into null operations, * preventing the use of URL rewriting to add the session identifier as a URL diff --git a/web/src/main/java/org/springframework/security/web/context/SupplierDeferredSecurityContext.java b/web/src/main/java/org/springframework/security/web/context/SupplierDeferredSecurityContext.java index 1ff20f5b95..c4d10ba0a6 100644 --- a/web/src/main/java/org/springframework/security/web/context/SupplierDeferredSecurityContext.java +++ b/web/src/main/java/org/springframework/security/web/context/SupplierDeferredSecurityContext.java @@ -28,6 +28,9 @@ import org.springframework.security.core.context.SecurityContext; import org.springframework.security.core.context.SecurityContextHolderStrategy; /** + * A {@link DeferredSecurityContext} that lazily obtains its {@link SecurityContext} from + * a {@link Supplier}. + * * @author Steve Riesenberg * @since 5.8 */ diff --git a/web/src/main/java/org/springframework/security/web/csrf/CsrfAuthenticationStrategy.java b/web/src/main/java/org/springframework/security/web/csrf/CsrfAuthenticationStrategy.java index de1705b92d..b2be788277 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/CsrfAuthenticationStrategy.java +++ b/web/src/main/java/org/springframework/security/web/csrf/CsrfAuthenticationStrategy.java @@ -45,7 +45,7 @@ public final class CsrfAuthenticationStrategy implements SessionAuthenticationSt private CsrfTokenRequestHandler requestHandler = new XorCsrfTokenRequestAttributeHandler(); /** - * Creates a new instance + * Creates a new instance. * @param tokenRepository the {@link CsrfTokenRepository} to use */ public CsrfAuthenticationStrategy(CsrfTokenRepository tokenRepository) { diff --git a/web/src/main/java/org/springframework/security/web/csrf/CsrfException.java b/web/src/main/java/org/springframework/security/web/csrf/CsrfException.java index 8dfd231e70..a23c88e880 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/CsrfException.java +++ b/web/src/main/java/org/springframework/security/web/csrf/CsrfException.java @@ -21,7 +21,7 @@ import java.io.Serial; import org.springframework.security.access.AccessDeniedException; /** - * Thrown when an invalid or missing {@link CsrfToken} is found in the HttpServletRequest + * Thrown when an invalid or missing {@link CsrfToken} is found in the HttpServletRequest. * * @author Rob Winch * @since 3.2 diff --git a/web/src/main/java/org/springframework/security/web/csrf/CsrfLogoutHandler.java b/web/src/main/java/org/springframework/security/web/csrf/CsrfLogoutHandler.java index 0cf20b6b91..45c60d55e2 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/CsrfLogoutHandler.java +++ b/web/src/main/java/org/springframework/security/web/csrf/CsrfLogoutHandler.java @@ -36,7 +36,7 @@ public final class CsrfLogoutHandler implements LogoutHandler { private final CsrfTokenRepository csrfTokenRepository; /** - * Creates a new instance + * Creates a new instance. * @param csrfTokenRepository the {@link CsrfTokenRepository} to use */ public CsrfLogoutHandler(CsrfTokenRepository csrfTokenRepository) { @@ -45,7 +45,7 @@ public final class CsrfLogoutHandler implements LogoutHandler { } /** - * Clears the {@link CsrfToken} + * Clears the {@link CsrfToken}. * * @see org.springframework.security.web.authentication.logout.LogoutHandler#logout(jakarta.servlet.http.HttpServletRequest, * jakarta.servlet.http.HttpServletResponse, diff --git a/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRepository.java b/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRepository.java index c0fa366338..25a48d18a8 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRepository.java +++ b/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRepository.java @@ -34,7 +34,7 @@ import org.jspecify.annotations.Nullable; public interface CsrfTokenRepository { /** - * Generates a {@link CsrfToken} + * Generates a {@link CsrfToken}. * @param request the {@link HttpServletRequest} to use * @return the {@link CsrfToken} that was generated. Cannot be null. */ @@ -51,7 +51,7 @@ public interface CsrfTokenRepository { void saveToken(@Nullable CsrfToken token, HttpServletRequest request, HttpServletResponse response); /** - * Loads the expected {@link CsrfToken} from the {@link HttpServletRequest} + * Loads the expected {@link CsrfToken} from the {@link HttpServletRequest}. * @param request the {@link HttpServletRequest} to use * @return the {@link CsrfToken} or null if none exists */ diff --git a/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestHandlerLoggerHolder.java b/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestHandlerLoggerHolder.java index ff6bc965f9..d5c6bd33f2 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestHandlerLoggerHolder.java +++ b/web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestHandlerLoggerHolder.java @@ -20,7 +20,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** - * Utility class for holding the logger for {@link CsrfTokenRequestHandler} + * Utility class for holding the logger for {@link CsrfTokenRequestHandler}. */ final class CsrfTokenRequestHandlerLoggerHolder { diff --git a/web/src/main/java/org/springframework/security/web/csrf/DefaultCsrfToken.java b/web/src/main/java/org/springframework/security/web/csrf/DefaultCsrfToken.java index 0f2d1ca926..82c7292a3b 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/DefaultCsrfToken.java +++ b/web/src/main/java/org/springframework/security/web/csrf/DefaultCsrfToken.java @@ -38,7 +38,7 @@ public final class DefaultCsrfToken implements CsrfToken { private final String headerName; /** - * Creates a new instance + * Creates a new instance. * @param headerName the HTTP header name to use * @param parameterName the HTTP parameter name to use * @param token the value of the token (i.e. expected value of the HTTP parameter of diff --git a/web/src/main/java/org/springframework/security/web/csrf/DeferredCsrfToken.java b/web/src/main/java/org/springframework/security/web/csrf/DeferredCsrfToken.java index a8bed83393..ed6ccf81e7 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/DeferredCsrfToken.java +++ b/web/src/main/java/org/springframework/security/web/csrf/DeferredCsrfToken.java @@ -29,7 +29,7 @@ import java.util.function.Supplier; public interface DeferredCsrfToken extends Supplier { /** - * Gets the {@link CsrfToken} + * Gets the {@link CsrfToken}. * @return a non-null {@link CsrfToken} */ CsrfToken get(); diff --git a/web/src/main/java/org/springframework/security/web/csrf/HttpSessionCsrfTokenRepository.java b/web/src/main/java/org/springframework/security/web/csrf/HttpSessionCsrfTokenRepository.java index 6907cd6959..6d032c7bdd 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/HttpSessionCsrfTokenRepository.java +++ b/web/src/main/java/org/springframework/security/web/csrf/HttpSessionCsrfTokenRepository.java @@ -77,7 +77,7 @@ public final class HttpSessionCsrfTokenRepository implements CsrfTokenRepository /** * Sets the {@link HttpServletRequest} parameter name that the {@link CsrfToken} is - * expected to appear on + * expected to appear on. * @param parameterName the new parameter name to use */ public void setParameterName(String parameterName) { @@ -96,7 +96,8 @@ public final class HttpSessionCsrfTokenRepository implements CsrfTokenRepository } /** - * Sets the {@link HttpSession} attribute name that the {@link CsrfToken} is stored in + * Sets the {@link HttpSession} attribute name that the {@link CsrfToken} is stored + * in. * @param sessionAttributeName the new attribute name to use */ public void setSessionAttributeName(String sessionAttributeName) { diff --git a/web/src/main/java/org/springframework/security/web/csrf/InvalidCsrfTokenException.java b/web/src/main/java/org/springframework/security/web/csrf/InvalidCsrfTokenException.java index 46c8089ef6..3ead144df7 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/InvalidCsrfTokenException.java +++ b/web/src/main/java/org/springframework/security/web/csrf/InvalidCsrfTokenException.java @@ -23,7 +23,7 @@ import org.jspecify.annotations.Nullable; /** * Thrown when an expected {@link CsrfToken} exists, but it does not match the value - * present on the {@link HttpServletRequest} + * present on the {@link HttpServletRequest}. * * @author Rob Winch * @since 3.2 @@ -34,6 +34,7 @@ public class InvalidCsrfTokenException extends CsrfException { private static final long serialVersionUID = -7745955098435417418L; /** + * Creates a new instance. * @param expectedAccessToken * @param actualAccessToken */ diff --git a/web/src/main/java/org/springframework/security/web/csrf/RepositoryDeferredCsrfToken.java b/web/src/main/java/org/springframework/security/web/csrf/RepositoryDeferredCsrfToken.java index 2fdd1be50d..ff0bde6a10 100644 --- a/web/src/main/java/org/springframework/security/web/csrf/RepositoryDeferredCsrfToken.java +++ b/web/src/main/java/org/springframework/security/web/csrf/RepositoryDeferredCsrfToken.java @@ -23,6 +23,9 @@ import jakarta.servlet.http.HttpServletResponse; import org.jspecify.annotations.Nullable; /** + * A {@link DeferredCsrfToken} that lazily loads (and generates and saves, if missing) the + * {@link CsrfToken} from a {@link CsrfTokenRepository}. + * * @author Rob Winch * @author Steve Riesenberg * @since 5.8 diff --git a/web/src/main/java/org/springframework/security/web/firewall/FirewalledResponse.java b/web/src/main/java/org/springframework/security/web/firewall/FirewalledResponse.java index 1b3429ce4e..d24c71b39b 100644 --- a/web/src/main/java/org/springframework/security/web/firewall/FirewalledResponse.java +++ b/web/src/main/java/org/springframework/security/web/firewall/FirewalledResponse.java @@ -25,6 +25,9 @@ import jakarta.servlet.http.HttpServletResponseWrapper; import org.springframework.util.Assert; /** + * An {@link HttpServletResponseWrapper} that rejects header values containing characters + * that could be used to inject additional headers or split the response. + * * @author Luke Taylor * @author Eddú Meléndez * @author Gabriel Lavoie diff --git a/web/src/main/java/org/springframework/security/web/firewall/RequestRejectedException.java b/web/src/main/java/org/springframework/security/web/firewall/RequestRejectedException.java index f56da436bb..22a4551c67 100644 --- a/web/src/main/java/org/springframework/security/web/firewall/RequestRejectedException.java +++ b/web/src/main/java/org/springframework/security/web/firewall/RequestRejectedException.java @@ -19,6 +19,8 @@ package org.springframework.security.web.firewall; import java.io.Serial; /** + * Thrown when a request is rejected by the {@link HttpFirewall}. + * * @author Luke Taylor */ public class RequestRejectedException extends RuntimeException { diff --git a/web/src/main/java/org/springframework/security/web/firewall/RequestWrapper.java b/web/src/main/java/org/springframework/security/web/firewall/RequestWrapper.java index 95aa9e7102..477acca292 100644 --- a/web/src/main/java/org/springframework/security/web/firewall/RequestWrapper.java +++ b/web/src/main/java/org/springframework/security/web/firewall/RequestWrapper.java @@ -139,6 +139,7 @@ final class RequestWrapper extends FirewalledRequest { private final String path; /** + * Creates a new instance for the given path. * @param path the {@code path} that will be used to obtain the delegate * {@link RequestDispatcher} from the original {@link HttpServletRequest}. */ diff --git a/web/src/main/java/org/springframework/security/web/firewall/StrictHttpFirewall.java b/web/src/main/java/org/springframework/security/web/firewall/StrictHttpFirewall.java index 89a556d398..575809586d 100644 --- a/web/src/main/java/org/springframework/security/web/firewall/StrictHttpFirewall.java +++ b/web/src/main/java/org/springframework/security/web/firewall/StrictHttpFirewall.java @@ -657,7 +657,7 @@ public class StrictHttpFirewall implements HttpFirewall { } /** - * Provides the existing encoded url blocklist which can add/remove entries from + * Provides the existing encoded url blocklist which can add/remove entries from. * @return the existing encoded url blocklist, never null */ public Set getEncodedUrlBlocklist() { @@ -665,7 +665,7 @@ public class StrictHttpFirewall implements HttpFirewall { } /** - * Provides the existing decoded url blocklist which can add/remove entries from + * Provides the existing decoded url blocklist which can add/remove entries from. * @return the existing decoded url blocklist, never null */ public Set getDecodedUrlBlocklist() { @@ -673,7 +673,7 @@ public class StrictHttpFirewall implements HttpFirewall { } /** - * Provides the existing encoded url blocklist which can add/remove entries from + * Provides the existing encoded url blocklist which can add/remove entries from. * @return the existing encoded url blocklist, never null * @deprecated Use {@link #getEncodedUrlBlocklist()} instead */ @@ -683,7 +683,7 @@ public class StrictHttpFirewall implements HttpFirewall { } /** - * Provides the existing decoded url blocklist which can add/remove entries from + * Provides the existing decoded url blocklist which can add/remove entries from. * @return the existing decoded url blocklist, never null * */ diff --git a/web/src/main/java/org/springframework/security/web/header/Header.java b/web/src/main/java/org/springframework/security/web/header/Header.java index 921852ebfd..876323a072 100644 --- a/web/src/main/java/org/springframework/security/web/header/Header.java +++ b/web/src/main/java/org/springframework/security/web/header/Header.java @@ -25,7 +25,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** - * Represents a Header to be added to the {@link HttpServletResponse} + * Represents a Header to be added to the {@link HttpServletResponse}. */ public final class Header { @@ -34,7 +34,7 @@ public final class Header { private final List headerValues; /** - * Creates a new instance + * Creates a new instance. * @param headerName the name of the header * @param headerValues the values of the header */ diff --git a/web/src/main/java/org/springframework/security/web/header/HeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/HeaderWriter.java index 4c9d09d55e..abc6bcf04c 100644 --- a/web/src/main/java/org/springframework/security/web/header/HeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/HeaderWriter.java @@ -20,7 +20,7 @@ import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; /** - * Contract for writing headers to a {@link HttpServletResponse} + * Contract for writing headers to a {@link HttpServletResponse}. * * @author Marten Deinum * @author Rob Winch diff --git a/web/src/main/java/org/springframework/security/web/header/writers/CacheControlHeadersWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/CacheControlHeadersWriter.java index 7a471e18eb..f300b3c05e 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/CacheControlHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/CacheControlHeadersWriter.java @@ -49,7 +49,7 @@ public final class CacheControlHeadersWriter implements HeaderWriter { private final HeaderWriter delegate; /** - * Creates a new instance + * Creates a new instance. */ public CacheControlHeadersWriter() { this.delegate = new StaticHeadersWriter(createHeaders()); diff --git a/web/src/main/java/org/springframework/security/web/header/writers/ContentSecurityPolicyHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/ContentSecurityPolicyHeaderWriter.java index 9dd3eb4acc..4c42a81e0d 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/ContentSecurityPolicyHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/ContentSecurityPolicyHeaderWriter.java @@ -102,7 +102,7 @@ public final class ContentSecurityPolicyHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param policyDirectives maps to {@link #setPolicyDirectives(String)} * @throws IllegalArgumentException if policyDirectives is null or empty */ @@ -112,6 +112,7 @@ public final class ContentSecurityPolicyHeaderWriter implements HeaderWriter { } /** + * Writes the Content-Security-Policy (or report-only) header to the response. * @see org.springframework.security.web.header.HeaderWriter#writeHeaders(jakarta.servlet.http.HttpServletRequest, * jakarta.servlet.http.HttpServletResponse) */ diff --git a/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginEmbedderPolicyHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginEmbedderPolicyHeaderWriter.java index 768ff0f272..637db68ab9 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginEmbedderPolicyHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginEmbedderPolicyHeaderWriter.java @@ -40,7 +40,7 @@ public final class CrossOriginEmbedderPolicyHeaderWriter implements HeaderWriter /** * Sets the {@link CrossOriginEmbedderPolicy} value to be used in the - * {@code Cross-Origin-Embedder-Policy} header + * {@code Cross-Origin-Embedder-Policy} header. * @param embedderPolicy the {@link CrossOriginEmbedderPolicy} to use */ public void setPolicy(CrossOriginEmbedderPolicy embedderPolicy) { diff --git a/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginOpenerPolicyHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginOpenerPolicyHeaderWriter.java index 7087c52fbc..9919f39b6c 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginOpenerPolicyHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginOpenerPolicyHeaderWriter.java @@ -24,7 +24,7 @@ import org.springframework.security.web.header.HeaderWriter; import org.springframework.util.Assert; /** - * Inserts the Cross-Origin-Opener-Policy header + * Inserts the Cross-Origin-Opener-Policy header. * * @author Marcus Da Coregio * @since 5.7 @@ -40,7 +40,7 @@ public final class CrossOriginOpenerPolicyHeaderWriter implements HeaderWriter { /** * Sets the {@link CrossOriginOpenerPolicy} value to be used in the - * {@code Cross-Origin-Opener-Policy} header + * {@code Cross-Origin-Opener-Policy} header. * @param openerPolicy the {@link CrossOriginOpenerPolicy} to use */ public void setPolicy(CrossOriginOpenerPolicy openerPolicy) { diff --git a/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginResourcePolicyHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginResourcePolicyHeaderWriter.java index 4d7df47eda..a4cf981c98 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginResourcePolicyHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/CrossOriginResourcePolicyHeaderWriter.java @@ -24,7 +24,7 @@ import org.springframework.security.web.header.HeaderWriter; import org.springframework.util.Assert; /** - * Inserts Cross-Origin-Resource-Policy header + * Inserts Cross-Origin-Resource-Policy header. * * @author Marcus Da Coregio * @since 5.7 @@ -40,7 +40,7 @@ public final class CrossOriginResourcePolicyHeaderWriter implements HeaderWriter /** * Sets the {@link CrossOriginResourcePolicy} value to be used in the - * {@code Cross-Origin-Resource-Policy} header + * {@code Cross-Origin-Resource-Policy} header. * @param resourcePolicy the {@link CrossOriginResourcePolicy} to use */ public void setPolicy(CrossOriginResourcePolicy resourcePolicy) { diff --git a/web/src/main/java/org/springframework/security/web/header/writers/DelegatingRequestMatcherHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/DelegatingRequestMatcherHeaderWriter.java index fdb8f31eb7..9e88eb12cd 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/DelegatingRequestMatcherHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/DelegatingRequestMatcherHeaderWriter.java @@ -37,7 +37,7 @@ public final class DelegatingRequestMatcherHeaderWriter implements HeaderWriter private final HeaderWriter delegateHeaderWriter; /** - * Creates a new instance + * Creates a new instance. * @param requestMatcher the {@link RequestMatcher} to use. If returns true, the * delegateHeaderWriter will be invoked. * @param delegateHeaderWriter the {@link HeaderWriter} to invoke if the diff --git a/web/src/main/java/org/springframework/security/web/header/writers/HpkpHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/HpkpHeaderWriter.java index daa83c3fc1..5971bca56b 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/HpkpHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/HpkpHeaderWriter.java @@ -139,7 +139,7 @@ public final class HpkpHeaderWriter implements HeaderWriter { private String hpkpHeaderValue; /** - * Creates a new instance + * Creates a new instance. * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} * @param includeSubDomains maps to {@link #setIncludeSubDomains(boolean)} * @param reportOnly maps to {@link #setReportOnly(boolean)} @@ -152,7 +152,7 @@ public final class HpkpHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} * @param includeSubDomains maps to {@link #setIncludeSubDomains(boolean)} */ @@ -161,7 +161,7 @@ public final class HpkpHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} */ public HpkpHeaderWriter(long maxAgeInSeconds) { @@ -169,7 +169,7 @@ public final class HpkpHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. */ public HpkpHeaderWriter() { this(DEFAULT_MAX_AGE_SECONDS); diff --git a/web/src/main/java/org/springframework/security/web/header/writers/HstsHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/HstsHeaderWriter.java index f43e3432d9..f1ad145ba9 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/HstsHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/HstsHeaderWriter.java @@ -75,7 +75,7 @@ public final class HstsHeaderWriter implements HeaderWriter { private String hstsHeaderValue; /** - * Creates a new instance + * Creates a new instance. * @param requestMatcher maps to {@link #setRequestMatcher(RequestMatcher)} * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} * @param includeSubDomains maps to {@link #setIncludeSubDomains(boolean)} @@ -92,7 +92,7 @@ public final class HstsHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param requestMatcher maps to {@link #setRequestMatcher(RequestMatcher)} * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} * @param includeSubDomains maps to {@link #setIncludeSubDomains(boolean)} @@ -102,7 +102,7 @@ public final class HstsHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} * @param includeSubDomains maps to {@link #setIncludeSubDomains(boolean)} * @param preload maps to {@link #setPreload(boolean)} @@ -113,7 +113,7 @@ public final class HstsHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} * @param includeSubDomains maps to {@link #setIncludeSubDomains(boolean)} */ @@ -122,7 +122,7 @@ public final class HstsHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param maxAgeInSeconds maps to {@link #setMaxAgeInSeconds(long)} */ public HstsHeaderWriter(long maxAgeInSeconds) { @@ -130,7 +130,7 @@ public final class HstsHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. * @param includeSubDomains maps to {@link #setIncludeSubDomains(boolean)} */ public HstsHeaderWriter(boolean includeSubDomains) { @@ -138,7 +138,7 @@ public final class HstsHeaderWriter implements HeaderWriter { } /** - * Creates a new instance + * Creates a new instance. */ public HstsHeaderWriter() { this(DEFAULT_MAX_AGE_SECONDS); diff --git a/web/src/main/java/org/springframework/security/web/header/writers/ReferrerPolicyHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/ReferrerPolicyHeaderWriter.java index 750d0378fc..379d24e482 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/ReferrerPolicyHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/ReferrerPolicyHeaderWriter.java @@ -90,6 +90,7 @@ public class ReferrerPolicyHeaderWriter implements HeaderWriter { } /** + * Writes the Referrer-Policy header to the response. * @see org.springframework.security.web.header.HeaderWriter#writeHeaders(HttpServletRequest, * HttpServletResponse) */ diff --git a/web/src/main/java/org/springframework/security/web/header/writers/StaticHeadersWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/StaticHeadersWriter.java index b4b07434d1..44c7ac4ef4 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/StaticHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/StaticHeadersWriter.java @@ -39,7 +39,7 @@ public class StaticHeadersWriter implements HeaderWriter { private final List
      headers; /** - * Creates a new instance + * Creates a new instance. * @param headers the {@link Header} instances to use */ public StaticHeadersWriter(List
      headers) { @@ -48,7 +48,7 @@ public class StaticHeadersWriter implements HeaderWriter { } /** - * Creates a new instance with a single header + * Creates a new instance with a single header. * @param headerName the name of the header * @param headerValues the values for the header */ diff --git a/web/src/main/java/org/springframework/security/web/header/writers/XContentTypeOptionsHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/XContentTypeOptionsHeaderWriter.java index 6e856ffb40..fabbc0125b 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/XContentTypeOptionsHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/XContentTypeOptionsHeaderWriter.java @@ -29,7 +29,7 @@ package org.springframework.security.web.header.writers; public final class XContentTypeOptionsHeaderWriter extends StaticHeadersWriter { /** - * Creates a new instance + * Creates a new instance. */ public XContentTypeOptionsHeaderWriter() { super("X-Content-Type-Options", "nosniff"); diff --git a/web/src/main/java/org/springframework/security/web/header/writers/XXssProtectionHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/XXssProtectionHeaderWriter.java index cb54702b91..61b7e81223 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/XXssProtectionHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/XXssProtectionHeaderWriter.java @@ -40,7 +40,7 @@ public final class XXssProtectionHeaderWriter implements HeaderWriter { private HeaderValue headerValue; /** - * Create a new instance + * Create a new instance. */ public XXssProtectionHeaderWriter() { this.headerValue = HeaderValue.DISABLED; diff --git a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/AbstractRequestParameterAllowFromStrategy.java b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/AbstractRequestParameterAllowFromStrategy.java index 6238bae194..4493288cba 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/AbstractRequestParameterAllowFromStrategy.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/AbstractRequestParameterAllowFromStrategy.java @@ -43,7 +43,7 @@ public abstract class AbstractRequestParameterAllowFromStrategy implements Allow private String allowFromParameterName = DEFAULT_ORIGIN_REQUEST_PARAMETER; - /** Logger for use by subclasses */ + /** Logger for use by subclasses. */ protected final Log log = LogFactory.getLog(getClass()); AbstractRequestParameterAllowFromStrategy() { diff --git a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/RegExpAllowFromStrategy.java b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/RegExpAllowFromStrategy.java index 51fbf2e2bc..b5755007a9 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/RegExpAllowFromStrategy.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/RegExpAllowFromStrategy.java @@ -38,7 +38,7 @@ public final class RegExpAllowFromStrategy extends AbstractRequestParameterAllow private final Pattern pattern; /** - * Creates a new instance + * Creates a new instance. * @param pattern the Pattern to compare against the HTTP parameter value. If the * pattern matches, the domain will be allowed, else denied. */ diff --git a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/StaticAllowFromStrategy.java b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/StaticAllowFromStrategy.java index f25cecff38..8854288b34 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/StaticAllowFromStrategy.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/StaticAllowFromStrategy.java @@ -21,7 +21,7 @@ import java.net.URI; import jakarta.servlet.http.HttpServletRequest; /** - * Simple implementation of the {@code AllowFromStrategy} + * Simple implementation of the {@code AllowFromStrategy}. * * @deprecated ALLOW-FROM is an obsolete directive that no longer works in modern * browsers. Instead use Content-Security-Policy with the allowed; /** - * Creates a new instance + * Creates a new instance. * @param allowed the origins that are allowed. */ public WhiteListedAllowFromStrategy(Collection allowed) { diff --git a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/XFrameOptionsHeaderWriter.java b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/XFrameOptionsHeaderWriter.java index b22412f0c4..e5d80cf522 100644 --- a/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/XFrameOptionsHeaderWriter.java +++ b/web/src/main/java/org/springframework/security/web/header/writers/frameoptions/XFrameOptionsHeaderWriter.java @@ -41,14 +41,14 @@ public final class XFrameOptionsHeaderWriter implements HeaderWriter { private final XFrameOptionsMode frameOptionsMode; /** - * Creates an instance with {@link XFrameOptionsMode#DENY} + * Creates an instance with {@link XFrameOptionsMode#DENY}. */ public XFrameOptionsHeaderWriter() { this(XFrameOptionsMode.DENY); } /** - * Creates a new instance + * Creates a new instance. * @param frameOptionsMode the {@link XFrameOptionsMode} to use. If using * {@link XFrameOptionsMode#ALLOW_FROM}, use Content-Security-Policy with the frame-ancestors @@ -121,6 +121,7 @@ public final class XFrameOptionsHeaderWriter implements HeaderWriter { SAMEORIGIN("SAMEORIGIN"), /** + * Allows the page to be framed only by the specified origin. * @deprecated ALLOW-FROM is an obsolete directive that no longer works in modern * browsers. Instead use Content-Security-Policy with the frame-ancestors diff --git a/web/src/main/java/org/springframework/security/web/http/SecurityHeaders.java b/web/src/main/java/org/springframework/security/web/http/SecurityHeaders.java index 7f4a08d645..e2bac5708a 100644 --- a/web/src/main/java/org/springframework/security/web/http/SecurityHeaders.java +++ b/web/src/main/java/org/springframework/security/web/http/SecurityHeaders.java @@ -22,7 +22,7 @@ import org.springframework.http.HttpHeaders; import org.springframework.util.Assert; /** - * Utilities for interacting with {@link HttpHeaders} + * Utilities for interacting with {@link HttpHeaders}. * * @author Rob Winch * @since 5.1 @@ -34,7 +34,7 @@ public final class SecurityHeaders { /** * Sets the provided value as a Bearer token in a header with the name of - * {@link HttpHeaders#AUTHORIZATION} + * {@link HttpHeaders#AUTHORIZATION}. * @param bearerTokenValue the bear token value * @return a {@link Consumer} that sets the header. */ diff --git a/web/src/main/java/org/springframework/security/web/jackson/CookieMixin.java b/web/src/main/java/org/springframework/security/web/jackson/CookieMixin.java index 1256bec6ff..9f97bc6c3d 100644 --- a/web/src/main/java/org/springframework/security/web/jackson/CookieMixin.java +++ b/web/src/main/java/org/springframework/security/web/jackson/CookieMixin.java @@ -17,11 +17,13 @@ package org.springframework.security.web.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import tools.jackson.databind.annotation.JsonDeserialize; /** - * Mixin class to serialize/deserialize {@link jakarta.servlet.http.Cookie} + * Mixin class to serialize/deserialize {@link jakarta.servlet.http.Cookie}. * * @author Sebastien Deleuze * @author Jitendra Singh @@ -29,9 +31,9 @@ import tools.jackson.databind.annotation.JsonDeserialize; * @see WebServletJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonDeserialize(using = CookieDeserializer.class) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, isGetterVisibility = Visibility.NONE) abstract class CookieMixin { } diff --git a/web/src/main/java/org/springframework/security/web/jackson/DefaultCsrfTokenMixin.java b/web/src/main/java/org/springframework/security/web/jackson/DefaultCsrfTokenMixin.java index c7606a1ede..dc2f5f9dbe 100644 --- a/web/src/main/java/org/springframework/security/web/jackson/DefaultCsrfTokenMixin.java +++ b/web/src/main/java/org/springframework/security/web/jackson/DefaultCsrfTokenMixin.java @@ -19,6 +19,7 @@ package org.springframework.security.web.jackson; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson mixin class to serialize/deserialize @@ -30,7 +31,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @see WebJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) class DefaultCsrfTokenMixin { /** diff --git a/web/src/main/java/org/springframework/security/web/jackson/DefaultSavedRequestMixin.java b/web/src/main/java/org/springframework/security/web/jackson/DefaultSavedRequestMixin.java index 61a52e47a4..e54ff322df 100644 --- a/web/src/main/java/org/springframework/security/web/jackson/DefaultSavedRequestMixin.java +++ b/web/src/main/java/org/springframework/security/web/jackson/DefaultSavedRequestMixin.java @@ -17,8 +17,11 @@ package org.springframework.security.web.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonInclude.Include; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.jspecify.annotations.Nullable; import tools.jackson.databind.annotation.JsonDeserialize; @@ -35,12 +38,12 @@ import org.springframework.security.web.savedrequest.DefaultSavedRequest; * @see WebServletJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) @JsonDeserialize(builder = DefaultSavedRequest.Builder.class) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) abstract class DefaultSavedRequestMixin { - @JsonInclude(JsonInclude.Include.NON_NULL) + @JsonInclude(Include.NON_NULL) @Nullable String matchingRequestParameterName; } diff --git a/web/src/main/java/org/springframework/security/web/jackson/PreAuthenticatedAuthenticationTokenMixin.java b/web/src/main/java/org/springframework/security/web/jackson/PreAuthenticatedAuthenticationTokenMixin.java index 6c12158d50..e76220b37d 100644 --- a/web/src/main/java/org/springframework/security/web/jackson/PreAuthenticatedAuthenticationTokenMixin.java +++ b/web/src/main/java/org/springframework/security/web/jackson/PreAuthenticatedAuthenticationTokenMixin.java @@ -17,7 +17,9 @@ package org.springframework.security.web.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import tools.jackson.databind.annotation.JsonDeserialize; import org.springframework.security.jackson.SecurityJacksonModules; @@ -34,9 +36,9 @@ import org.springframework.security.jackson.SecurityJacksonModules; * @see WebJacksonModule * @see SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) @JsonDeserialize(using = PreAuthenticatedAuthenticationTokenDeserializer.class) abstract class PreAuthenticatedAuthenticationTokenMixin { diff --git a/web/src/main/java/org/springframework/security/web/jackson/SavedCookieMixin.java b/web/src/main/java/org/springframework/security/web/jackson/SavedCookieMixin.java index 68b375d96d..7f786e5ddc 100644 --- a/web/src/main/java/org/springframework/security/web/jackson/SavedCookieMixin.java +++ b/web/src/main/java/org/springframework/security/web/jackson/SavedCookieMixin.java @@ -17,9 +17,11 @@ package org.springframework.security.web.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson mixin class to serialize/deserialize @@ -32,8 +34,8 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @see WebServletJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE) abstract class SavedCookieMixin { @JsonCreator diff --git a/web/src/main/java/org/springframework/security/web/jackson/SwitchUserGrantedAuthorityMixIn.java b/web/src/main/java/org/springframework/security/web/jackson/SwitchUserGrantedAuthorityMixIn.java index 122de53b2b..4f58a0bcfe 100644 --- a/web/src/main/java/org/springframework/security/web/jackson/SwitchUserGrantedAuthorityMixIn.java +++ b/web/src/main/java/org/springframework/security/web/jackson/SwitchUserGrantedAuthorityMixIn.java @@ -17,9 +17,11 @@ package org.springframework.security.web.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import org.springframework.security.core.Authentication; import org.springframework.security.web.authentication.switchuser.SwitchUserGrantedAuthority; @@ -34,9 +36,9 @@ import org.springframework.security.web.authentication.switchuser.SwitchUserGran * @see WebServletJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE) +@JsonTypeInfo(use = Id.CLASS) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE) abstract class SwitchUserGrantedAuthorityMixIn { @JsonCreator diff --git a/web/src/main/java/org/springframework/security/web/jackson/WebAuthenticationDetailsMixin.java b/web/src/main/java/org/springframework/security/web/jackson/WebAuthenticationDetailsMixin.java index 32b28381a9..c0bca2bcea 100644 --- a/web/src/main/java/org/springframework/security/web/jackson/WebAuthenticationDetailsMixin.java +++ b/web/src/main/java/org/springframework/security/web/jackson/WebAuthenticationDetailsMixin.java @@ -17,9 +17,12 @@ package org.springframework.security.web.jackson; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson mixin class to serialize/deserialize @@ -31,9 +34,9 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @see WebServletJacksonModule * @see org.springframework.security.jackson.SecurityJacksonModules */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY) -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, - isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY) +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY) +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE, + isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY) class WebAuthenticationDetailsMixin { @JsonCreator diff --git a/web/src/main/java/org/springframework/security/web/jackson2/CookieMixin.java b/web/src/main/java/org/springframework/security/web/jackson2/CookieMixin.java index 47f928b91e..25a1378f33 100644 --- a/web/src/main/java/org/springframework/security/web/jackson2/CookieMixin.java +++ b/web/src/main/java/org/springframework/security/web/jackson2/CookieMixin.java @@ -17,11 +17,14 @@ package org.springframework.security.web.jackson2; import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** - * Mixin class to serialize/deserialize {@link jakarta.servlet.http.Cookie} + * Mixin class to serialize/deserialize {@link jakarta.servlet.http.Cookie}. * *
        *     ObjectMapper mapper = new ObjectMapper();
      @@ -37,9 +40,9 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
        */
       @SuppressWarnings("removal")
       @Deprecated(forRemoval = true)
      -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
      +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY)
       @JsonDeserialize(using = CookieDeserializer.class)
      -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, isGetterVisibility = JsonAutoDetect.Visibility.NONE)
      +@JsonAutoDetect(fieldVisibility = Visibility.ANY, isGetterVisibility = Visibility.NONE)
       abstract class CookieMixin {
       
       }
      diff --git a/web/src/main/java/org/springframework/security/web/jackson2/DefaultCsrfTokenMixin.java b/web/src/main/java/org/springframework/security/web/jackson2/DefaultCsrfTokenMixin.java
      index 07daf872cf..1213819c6c 100644
      --- a/web/src/main/java/org/springframework/security/web/jackson2/DefaultCsrfTokenMixin.java
      +++ b/web/src/main/java/org/springframework/security/web/jackson2/DefaultCsrfTokenMixin.java
      @@ -20,6 +20,8 @@ import com.fasterxml.jackson.annotation.JsonCreator;
       import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
       import com.fasterxml.jackson.annotation.JsonProperty;
       import com.fasterxml.jackson.annotation.JsonTypeInfo;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
       
       /**
        * Jackson mixin class to serialize/deserialize
      @@ -40,7 +42,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo;
        */
       @SuppressWarnings("removal")
       @Deprecated(forRemoval = true)
      -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
      +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY, property = "@class")
       @JsonIgnoreProperties(ignoreUnknown = true)
       class DefaultCsrfTokenMixin {
       
      diff --git a/web/src/main/java/org/springframework/security/web/jackson2/DefaultSavedRequestMixin.java b/web/src/main/java/org/springframework/security/web/jackson2/DefaultSavedRequestMixin.java
      index 8f4c001b48..dca70c9cf6 100644
      --- a/web/src/main/java/org/springframework/security/web/jackson2/DefaultSavedRequestMixin.java
      +++ b/web/src/main/java/org/springframework/security/web/jackson2/DefaultSavedRequestMixin.java
      @@ -17,8 +17,12 @@
       package org.springframework.security.web.jackson2;
       
       import com.fasterxml.jackson.annotation.JsonAutoDetect;
      +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
       import com.fasterxml.jackson.annotation.JsonInclude;
      +import com.fasterxml.jackson.annotation.JsonInclude.Include;
       import com.fasterxml.jackson.annotation.JsonTypeInfo;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
       import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
       import org.jspecify.annotations.Nullable;
       
      @@ -45,12 +49,12 @@ import org.springframework.security.web.savedrequest.DefaultSavedRequest;
        */
       @SuppressWarnings("removal")
       @Deprecated(forRemoval = true)
      -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
      +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY)
       @JsonDeserialize(builder = DefaultSavedRequest.Builder.class)
      -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE)
      +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE)
       abstract class DefaultSavedRequestMixin {
       
      -	@JsonInclude(JsonInclude.Include.NON_NULL)
      +	@JsonInclude(Include.NON_NULL)
       	@Nullable String matchingRequestParameterName;
       
       }
      diff --git a/web/src/main/java/org/springframework/security/web/jackson2/PreAuthenticatedAuthenticationTokenMixin.java b/web/src/main/java/org/springframework/security/web/jackson2/PreAuthenticatedAuthenticationTokenMixin.java
      index 4e281df34b..05c55fd93d 100644
      --- a/web/src/main/java/org/springframework/security/web/jackson2/PreAuthenticatedAuthenticationTokenMixin.java
      +++ b/web/src/main/java/org/springframework/security/web/jackson2/PreAuthenticatedAuthenticationTokenMixin.java
      @@ -17,7 +17,10 @@
       package org.springframework.security.web.jackson2;
       
       import com.fasterxml.jackson.annotation.JsonAutoDetect;
      +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
       import com.fasterxml.jackson.annotation.JsonTypeInfo;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
       import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
       
       import org.springframework.security.jackson2.SecurityJackson2Modules;
      @@ -48,9 +51,9 @@ import org.springframework.security.jackson2.SimpleGrantedAuthorityMixin;
        */
       @SuppressWarnings("removal")
       @Deprecated(forRemoval = true)
      -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
      -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE,
      -		isGetterVisibility = JsonAutoDetect.Visibility.NONE)
      +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY, property = "@class")
      +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE,
      +		isGetterVisibility = Visibility.NONE)
       @JsonDeserialize(using = PreAuthenticatedAuthenticationTokenDeserializer.class)
       abstract class PreAuthenticatedAuthenticationTokenMixin {
       
      diff --git a/web/src/main/java/org/springframework/security/web/jackson2/SavedCookieMixin.java b/web/src/main/java/org/springframework/security/web/jackson2/SavedCookieMixin.java
      index 71f35bb99b..c4bcd5caa9 100644
      --- a/web/src/main/java/org/springframework/security/web/jackson2/SavedCookieMixin.java
      +++ b/web/src/main/java/org/springframework/security/web/jackson2/SavedCookieMixin.java
      @@ -17,10 +17,13 @@
       package org.springframework.security.web.jackson2;
       
       import com.fasterxml.jackson.annotation.JsonAutoDetect;
      +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
       import com.fasterxml.jackson.annotation.JsonCreator;
       import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
       import com.fasterxml.jackson.annotation.JsonProperty;
       import com.fasterxml.jackson.annotation.JsonTypeInfo;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
       
       /**
        * Jackson mixin class to serialize/deserialize
      @@ -41,8 +44,8 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo;
        */
       @SuppressWarnings("removal")
       @Deprecated(forRemoval = true)
      -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
      -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE)
      +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY)
      +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE)
       @JsonIgnoreProperties(ignoreUnknown = true)
       abstract class SavedCookieMixin {
       
      diff --git a/web/src/main/java/org/springframework/security/web/jackson2/SwitchUserGrantedAuthorityMixIn.java b/web/src/main/java/org/springframework/security/web/jackson2/SwitchUserGrantedAuthorityMixIn.java
      index 0bdfb32509..c36434683f 100644
      --- a/web/src/main/java/org/springframework/security/web/jackson2/SwitchUserGrantedAuthorityMixIn.java
      +++ b/web/src/main/java/org/springframework/security/web/jackson2/SwitchUserGrantedAuthorityMixIn.java
      @@ -17,10 +17,12 @@
       package org.springframework.security.web.jackson2;
       
       import com.fasterxml.jackson.annotation.JsonAutoDetect;
      +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
       import com.fasterxml.jackson.annotation.JsonCreator;
       import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
       import com.fasterxml.jackson.annotation.JsonProperty;
       import com.fasterxml.jackson.annotation.JsonTypeInfo;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
       
       import org.springframework.security.core.Authentication;
       import org.springframework.security.web.authentication.switchuser.SwitchUserGrantedAuthority;
      @@ -39,9 +41,9 @@ import org.springframework.security.web.authentication.switchuser.SwitchUserGran
        */
       @SuppressWarnings("removal")
       @Deprecated(forRemoval = true)
      -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
      -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE,
      -		isGetterVisibility = JsonAutoDetect.Visibility.NONE)
      +@JsonTypeInfo(use = Id.CLASS)
      +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE,
      +		isGetterVisibility = Visibility.NONE)
       @JsonIgnoreProperties(ignoreUnknown = true)
       abstract class SwitchUserGrantedAuthorityMixIn {
       
      diff --git a/web/src/main/java/org/springframework/security/web/jackson2/WebAuthenticationDetailsMixin.java b/web/src/main/java/org/springframework/security/web/jackson2/WebAuthenticationDetailsMixin.java
      index cecbcafd68..beab1dc1ba 100644
      --- a/web/src/main/java/org/springframework/security/web/jackson2/WebAuthenticationDetailsMixin.java
      +++ b/web/src/main/java/org/springframework/security/web/jackson2/WebAuthenticationDetailsMixin.java
      @@ -17,10 +17,13 @@
       package org.springframework.security.web.jackson2;
       
       import com.fasterxml.jackson.annotation.JsonAutoDetect;
      +import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
       import com.fasterxml.jackson.annotation.JsonCreator;
       import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
       import com.fasterxml.jackson.annotation.JsonProperty;
       import com.fasterxml.jackson.annotation.JsonTypeInfo;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
      +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
       
       /**
        * Jackson mixin class to serialize/deserialize
      @@ -41,10 +44,10 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo;
        */
       @SuppressWarnings("removal")
       @Deprecated(forRemoval = true)
      -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
      +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY)
       @JsonIgnoreProperties(ignoreUnknown = true)
      -@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE,
      -		isGetterVisibility = JsonAutoDetect.Visibility.NONE, creatorVisibility = JsonAutoDetect.Visibility.ANY)
      +@JsonAutoDetect(fieldVisibility = Visibility.ANY, getterVisibility = Visibility.NONE,
      +		isGetterVisibility = Visibility.NONE, creatorVisibility = Visibility.ANY)
       class WebAuthenticationDetailsMixin {
       
       	@JsonCreator
      diff --git a/web/src/main/java/org/springframework/security/web/method/annotation/AuthenticationPrincipalArgumentResolver.java b/web/src/main/java/org/springframework/security/web/method/annotation/AuthenticationPrincipalArgumentResolver.java
      index 2b4d9ec42e..05716f9ee2 100644
      --- a/web/src/main/java/org/springframework/security/web/method/annotation/AuthenticationPrincipalArgumentResolver.java
      +++ b/web/src/main/java/org/springframework/security/web/method/annotation/AuthenticationPrincipalArgumentResolver.java
      @@ -145,7 +145,7 @@ public final class AuthenticationPrincipalArgumentResolver implements HandlerMet
       	}
       
       	/**
      -	 * Sets the {@link BeanResolver} to be used on the expressions
      +	 * Sets the {@link BeanResolver} to be used on the expressions.
       	 * @param beanResolver the {@link BeanResolver} to use
       	 */
       	public void setBeanResolver(BeanResolver beanResolver) {
      diff --git a/web/src/main/java/org/springframework/security/web/method/annotation/CurrentSecurityContextArgumentResolver.java b/web/src/main/java/org/springframework/security/web/method/annotation/CurrentSecurityContextArgumentResolver.java
      index bc915ffcef..02dfe42ad6 100644
      --- a/web/src/main/java/org/springframework/security/web/method/annotation/CurrentSecurityContextArgumentResolver.java
      +++ b/web/src/main/java/org/springframework/security/web/method/annotation/CurrentSecurityContextArgumentResolver.java
      @@ -130,7 +130,7 @@ public final class CurrentSecurityContextArgumentResolver implements HandlerMeth
       	}
       
       	/**
      -	 * Set the {@link BeanResolver} to be used on the expressions
      +	 * Set the {@link BeanResolver} to be used on the expressions.
       	 * @param beanResolver the {@link BeanResolver} to use
       	 */
       	public void setBeanResolver(BeanResolver beanResolver) {
      diff --git a/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/AuthenticationPrincipalArgumentResolver.java b/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/AuthenticationPrincipalArgumentResolver.java
      index f004c7cf68..013c797f43 100644
      --- a/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/AuthenticationPrincipalArgumentResolver.java
      +++ b/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/AuthenticationPrincipalArgumentResolver.java
      @@ -46,7 +46,7 @@ import org.springframework.web.reactive.result.method.HandlerMethodArgumentResol
       import org.springframework.web.server.ServerWebExchange;
       
       /**
      - * Resolves the Authentication
      + * Resolves the Authentication.
        *
        * @author Rob Winch
        * @author DingHao
      @@ -70,7 +70,7 @@ public class AuthenticationPrincipalArgumentResolver extends HandlerMethodArgume
       	}
       
       	/**
      -	 * Sets the {@link BeanResolver} to be used on the expressions
      +	 * Sets the {@link BeanResolver} to be used on the expressions.
       	 * @param beanResolver the {@link BeanResolver} to use
       	 */
       	public void setBeanResolver(BeanResolver beanResolver) {
      diff --git a/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/CurrentSecurityContextArgumentResolver.java b/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/CurrentSecurityContextArgumentResolver.java
      index f3b2950f03..f904ce0f75 100644
      --- a/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/CurrentSecurityContextArgumentResolver.java
      +++ b/web/src/main/java/org/springframework/security/web/reactive/result/method/annotation/CurrentSecurityContextArgumentResolver.java
      @@ -46,7 +46,7 @@ import org.springframework.web.reactive.result.method.HandlerMethodArgumentResol
       import org.springframework.web.server.ServerWebExchange;
       
       /**
      - * Resolves the {@link SecurityContext}
      + * Resolves the {@link SecurityContext}.
        *
        * @author Dan Zheng
        * @author DingHao
      @@ -70,7 +70,7 @@ public class CurrentSecurityContextArgumentResolver extends HandlerMethodArgumen
       	}
       
       	/**
      -	 * Sets the {@link BeanResolver} to be used on the expressions
      +	 * Sets the {@link BeanResolver} to be used on the expressions.
       	 * @param beanResolver the {@link BeanResolver} to use
       	 */
       	public void setBeanResolver(BeanResolver beanResolver) {
      diff --git a/web/src/main/java/org/springframework/security/web/reactive/result/view/CsrfRequestDataValueProcessor.java b/web/src/main/java/org/springframework/security/web/reactive/result/view/CsrfRequestDataValueProcessor.java
      index a525dbb31e..a23873f90f 100644
      --- a/web/src/main/java/org/springframework/security/web/reactive/result/view/CsrfRequestDataValueProcessor.java
      +++ b/web/src/main/java/org/springframework/security/web/reactive/result/view/CsrfRequestDataValueProcessor.java
      @@ -27,6 +27,9 @@ import org.springframework.web.reactive.result.view.RequestDataValueProcessor;
       import org.springframework.web.server.ServerWebExchange;
       
       /**
      + * A {@link RequestDataValueProcessor} that adds a hidden input for the CSRF token to
      + * forms.
      + *
        * @author Rob Winch
        * @since 5.0
        */
      diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/DefaultSavedRequest.java b/web/src/main/java/org/springframework/security/web/savedrequest/DefaultSavedRequest.java
      index b06a08594a..35f4920e81 100644
      --- a/web/src/main/java/org/springframework/security/web/savedrequest/DefaultSavedRequest.java
      +++ b/web/src/main/java/org/springframework/security/web/savedrequest/DefaultSavedRequest.java
      @@ -141,7 +141,7 @@ public class DefaultSavedRequest implements SavedRequest {
       	}
       
       	/**
      -	 * Private constructor invoked through Builder
      +	 * Private constructor invoked through Builder.
       	 */
       	private DefaultSavedRequest(Builder builder) {
       		this.contextPath = builder.contextPath;
      @@ -158,6 +158,7 @@ public class DefaultSavedRequest implements SavedRequest {
       	}
       
       	/**
      +	 * Adds the given cookies.
       	 * @since 4.2
       	 */
       	private void addCookies(Cookie[] cookies) {
      @@ -178,6 +179,7 @@ public class DefaultSavedRequest implements SavedRequest {
       	}
       
       	/**
      +	 * Adds the given locales.
       	 * @since 4.2
       	 */
       	private void addLocales(Enumeration locales) {
      @@ -192,6 +194,7 @@ public class DefaultSavedRequest implements SavedRequest {
       	}
       
       	/**
      +	 * Adds the given request parameters.
       	 * @since 4.2
       	 */
       	private void addParameters(Map parameters) {
      @@ -321,6 +324,8 @@ public class DefaultSavedRequest implements SavedRequest {
       	}
       
       	/**
      +	 * Builder for {@link DefaultSavedRequest}.
      +	 *
       	 * @since 4.2
       	 */
       	@JsonIgnoreProperties(ignoreUnknown = true)
      diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/FastHttpDateFormat.java b/web/src/main/java/org/springframework/security/web/savedrequest/FastHttpDateFormat.java
      index cf03518387..df9c529c10 100644
      --- a/web/src/main/java/org/springframework/security/web/savedrequest/FastHttpDateFormat.java
      +++ b/web/src/main/java/org/springframework/security/web/savedrequest/FastHttpDateFormat.java
      @@ -50,7 +50,7 @@ public final class FastHttpDateFormat {
       			new SimpleDateFormat("EEE MMMM d HH:mm:ss yyyy", Locale.US) };
       
       	/**
      -	 * GMT time zone - all HTTP dates are on GMT
      +	 * GMT time zone - all HTTP dates are on GMT.
       	 */
       	protected static final TimeZone gmtZone = TimeZone.getTimeZone("GMT");
       
      diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/HttpSessionRequestCache.java b/web/src/main/java/org/springframework/security/web/savedrequest/HttpSessionRequestCache.java
      index 0ca90d85dc..836d9d2363 100644
      --- a/web/src/main/java/org/springframework/security/web/savedrequest/HttpSessionRequestCache.java
      +++ b/web/src/main/java/org/springframework/security/web/savedrequest/HttpSessionRequestCache.java
      @@ -169,7 +169,7 @@ public class HttpSessionRequestCache implements RequestCache {
       	/**
       	 * Specify the name of a query parameter that is added to the URL that specifies the
       	 * request cache should be checked in
      -	 * {@link #getMatchingRequest(HttpServletRequest, HttpServletResponse)}
      +	 * {@link #getMatchingRequest(HttpServletRequest, HttpServletResponse)}.
       	 * @param matchingRequestParameterName the parameter name that must be in the request
       	 * for {@link #getMatchingRequest(HttpServletRequest, HttpServletResponse)} to check
       	 * the session. Default is "continue".
      diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/SavedCookie.java b/web/src/main/java/org/springframework/security/web/savedrequest/SavedCookie.java
      index dbc54830ab..d88b88c0b1 100644
      --- a/web/src/main/java/org/springframework/security/web/savedrequest/SavedCookie.java
      +++ b/web/src/main/java/org/springframework/security/web/savedrequest/SavedCookie.java
      @@ -21,7 +21,7 @@ import java.io.Serializable;
       import jakarta.servlet.http.Cookie;
       
       /**
      - * Stores off the values of a cookie in a serializable holder
      + * Stores off the values of a cookie in a serializable holder.
        *
        * @author Ray Krueger
        */
      diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/SavedRequest.java b/web/src/main/java/org/springframework/security/web/savedrequest/SavedRequest.java
      index 4a59e171d8..9263071f6f 100644
      --- a/web/src/main/java/org/springframework/security/web/savedrequest/SavedRequest.java
      +++ b/web/src/main/java/org/springframework/security/web/savedrequest/SavedRequest.java
      @@ -36,6 +36,7 @@ import org.jspecify.annotations.Nullable;
       public interface SavedRequest extends java.io.Serializable {
       
       	/**
      +	 * Returns the URL for the saved request.
       	 * @return the URL for the saved request, allowing a redirect to be performed.
       	 */
       	String getRedirectUrl();
      diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/SimpleSavedRequest.java b/web/src/main/java/org/springframework/security/web/savedrequest/SimpleSavedRequest.java
      index fc2169f124..80fa48dad4 100644
      --- a/web/src/main/java/org/springframework/security/web/savedrequest/SimpleSavedRequest.java
      +++ b/web/src/main/java/org/springframework/security/web/savedrequest/SimpleSavedRequest.java
      @@ -29,7 +29,7 @@ import jakarta.servlet.http.Cookie;
       import org.springframework.util.Assert;
       
       /**
      - * A Bean implementation of SavedRequest
      + * A Bean implementation of SavedRequest.
        *
        * @author Rob Winch
        * @since 5.1
      diff --git a/web/src/main/java/org/springframework/security/web/server/DelegatingServerAuthenticationEntryPoint.java b/web/src/main/java/org/springframework/security/web/server/DelegatingServerAuthenticationEntryPoint.java
      index 5e5f9c7714..77eea96009 100644
      --- a/web/src/main/java/org/springframework/security/web/server/DelegatingServerAuthenticationEntryPoint.java
      +++ b/web/src/main/java/org/springframework/security/web/server/DelegatingServerAuthenticationEntryPoint.java
      @@ -34,7 +34,7 @@ import org.springframework.web.server.ServerWebExchange;
       
       /**
        * A {@link ServerAuthenticationEntryPoint} which delegates to multiple
      - * {@link ServerAuthenticationEntryPoint} based on a {@link ServerWebExchangeMatcher}
      + * {@link ServerAuthenticationEntryPoint} based on a {@link ServerWebExchangeMatcher}.
        *
        * @author Rob Winch
        * @author Mathieu Ouellet
      @@ -80,7 +80,7 @@ public class DelegatingServerAuthenticationEntryPoint implements ServerAuthentic
       	}
       
       	/**
      -	 * EntryPoint which is used when no RequestMatcher returned true
      +	 * EntryPoint which is used when no RequestMatcher returned true.
       	 */
       	public void setDefaultEntryPoint(ServerAuthenticationEntryPoint defaultEntryPoint) {
       		this.defaultEntryPoint = defaultEntryPoint;
      diff --git a/web/src/main/java/org/springframework/security/web/server/ObservationWebFilterChainDecorator.java b/web/src/main/java/org/springframework/security/web/server/ObservationWebFilterChainDecorator.java
      index c24a0debf0..01e120ea97 100644
      --- a/web/src/main/java/org/springframework/security/web/server/ObservationWebFilterChainDecorator.java
      +++ b/web/src/main/java/org/springframework/security/web/server/ObservationWebFilterChainDecorator.java
      @@ -39,7 +39,7 @@ import org.springframework.web.server.WebHandler;
       /**
        * A
        * {@link org.springframework.security.web.server.WebFilterChainProxy.WebFilterChainDecorator}
      - * that wraps the chain in before and after observations
      + * that wraps the chain in before and after observations.
        *
        * @author Josh Cummings
        * @since 6.0
      diff --git a/web/src/main/java/org/springframework/security/web/server/SecurityWebFilterChain.java b/web/src/main/java/org/springframework/security/web/server/SecurityWebFilterChain.java
      index c59ae79eaa..0c0ff4812e 100644
      --- a/web/src/main/java/org/springframework/security/web/server/SecurityWebFilterChain.java
      +++ b/web/src/main/java/org/springframework/security/web/server/SecurityWebFilterChain.java
      @@ -33,14 +33,14 @@ public interface SecurityWebFilterChain {
       
       	/**
       	 * Determines if this {@link SecurityWebFilterChain} matches the provided
      -	 * {@link ServerWebExchange}
      +	 * {@link ServerWebExchange}.
       	 * @param exchange the {@link ServerWebExchange}
       	 * @return true if it matches, else false
       	 */
       	Mono matches(ServerWebExchange exchange);
       
       	/**
      -	 * The {@link WebFilter} to use
      +	 * The {@link WebFilter} to use.
       	 * @return
       	 */
       	Flux getWebFilters();
      diff --git a/web/src/main/java/org/springframework/security/web/server/ServerAuthenticationEntryPoint.java b/web/src/main/java/org/springframework/security/web/server/ServerAuthenticationEntryPoint.java
      index 5ba1960536..a9b253376f 100644
      --- a/web/src/main/java/org/springframework/security/web/server/ServerAuthenticationEntryPoint.java
      +++ b/web/src/main/java/org/springframework/security/web/server/ServerAuthenticationEntryPoint.java
      @@ -22,7 +22,7 @@ import org.springframework.security.core.AuthenticationException;
       import org.springframework.web.server.ServerWebExchange;
       
       /**
      - * Used to request authentication
      + * Used to request authentication.
        *
        * @author Rob Winch
        * @since 5.0
      @@ -31,7 +31,7 @@ import org.springframework.web.server.ServerWebExchange;
       public interface ServerAuthenticationEntryPoint {
       
       	/**
      -	 * Initiates the authentication flow
      +	 * Initiates the authentication flow.
       	 * @param exchange
       	 * @param ex
       	 * @return {@code Mono} to indicate when the request for authentication is
      diff --git a/web/src/main/java/org/springframework/security/web/server/ServerFormLoginAuthenticationConverter.java b/web/src/main/java/org/springframework/security/web/server/ServerFormLoginAuthenticationConverter.java
      index 8f7444242b..72f43fd9f9 100644
      --- a/web/src/main/java/org/springframework/security/web/server/ServerFormLoginAuthenticationConverter.java
      +++ b/web/src/main/java/org/springframework/security/web/server/ServerFormLoginAuthenticationConverter.java
      @@ -56,7 +56,7 @@ public class ServerFormLoginAuthenticationConverter implements Function} to indicate when redirect is complete
      diff --git a/web/src/main/java/org/springframework/security/web/server/WebFilterChainProxy.java b/web/src/main/java/org/springframework/security/web/server/WebFilterChainProxy.java
      index e38517acfa..a5812553ab 100644
      --- a/web/src/main/java/org/springframework/security/web/server/WebFilterChainProxy.java
      +++ b/web/src/main/java/org/springframework/security/web/server/WebFilterChainProxy.java
      @@ -99,7 +99,7 @@ public class WebFilterChainProxy implements WebFilter {
       	}
       
       	/**
      -	 * Used to decorate the original {@link WebFilterChain} for each request
      +	 * Used to decorate the original {@link WebFilterChain} for each request.
       	 *
       	 * 

      * By default, this decorates the filter chain with a {@link DefaultWebFilterChain} @@ -144,7 +144,7 @@ public class WebFilterChainProxy implements WebFilter { } /** - * A {@link WebFilterChainDecorator} that uses the {@link DefaultWebFilterChain} + * A {@link WebFilterChainDecorator} that uses the {@link DefaultWebFilterChain}. * * @author Josh Cummings * @since 6.0 diff --git a/web/src/main/java/org/springframework/security/web/server/WebFilterExchange.java b/web/src/main/java/org/springframework/security/web/server/WebFilterExchange.java index fbe0e896d0..ca88ad630c 100644 --- a/web/src/main/java/org/springframework/security/web/server/WebFilterExchange.java +++ b/web/src/main/java/org/springframework/security/web/server/WebFilterExchange.java @@ -41,7 +41,7 @@ public class WebFilterExchange { } /** - * Get the exchange + * Get the exchange. * @return the exchange. Cannot be {@code null} */ public ServerWebExchange getExchange() { @@ -49,7 +49,7 @@ public class WebFilterExchange { } /** - * The filter chain + * The filter chain. * @return the filter chain. Cannot be {@code null} */ public WebFilterChain getChain() { diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/AnonymousAuthenticationWebFilter.java b/web/src/main/java/org/springframework/security/web/server/authentication/AnonymousAuthenticationWebFilter.java index 05ae8a44b7..64d2f1c096 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/AnonymousAuthenticationWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/AnonymousAuthenticationWebFilter.java @@ -63,6 +63,7 @@ public class AnonymousAuthenticationWebFilter implements WebFilter { } /** + * Creates a filter with the given key, principal, and authorities. * @param key key the key to identify tokens created by this filter * @param principal the principal which will be used to represent anonymous users * @param authorities the authority list for anonymous users diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/AuthenticationWebFilter.java b/web/src/main/java/org/springframework/security/web/server/authentication/AuthenticationWebFilter.java index 3bbbdb108c..9d10308e0b 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/AuthenticationWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/AuthenticationWebFilter.java @@ -87,7 +87,7 @@ public class AuthenticationWebFilter implements WebFilter { private ServerWebExchangeMatcher requiresAuthenticationMatcher = ServerWebExchangeMatchers.anyExchange(); /** - * Creates an instance + * Creates an instance. * @param authenticationManager the authentication manager to use */ public AuthenticationWebFilter(ReactiveAuthenticationManager authenticationManager) { @@ -96,7 +96,7 @@ public class AuthenticationWebFilter implements WebFilter { } /** - * Creates an instance + * Creates an instance. * @param authenticationManagerResolver the authentication manager resolver to use * @since 5.3 */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationConverter.java b/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationConverter.java index 46a596640e..6bf0abd67a 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationConverter.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationConverter.java @@ -61,7 +61,7 @@ public final class DelegatingServerAuthenticationConverter implements ServerAuth } /** - * Continue iterating when a delegate errors, defaults to {@code false} + * Continue iterating when a delegate errors, defaults to {@code false}. * @param continueOnError whether to continue when a delegate errors * @since 6.3 */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationSuccessHandler.java index 81dc8052f9..eb29d9f391 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/DelegatingServerAuthenticationSuccessHandler.java @@ -43,7 +43,7 @@ public class DelegatingServerAuthenticationSuccessHandler implements ServerAuthe } /** - * Creates a new instance with the provided list of delegates + * Creates a new instance with the provided list of delegates. * @param delegates the {@link List} of {@link ServerAuthenticationSuccessHandler} * @since 6.3 */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/HttpBasicServerAuthenticationEntryPoint.java b/web/src/main/java/org/springframework/security/web/server/authentication/HttpBasicServerAuthenticationEntryPoint.java index 76729d7648..0f8fae45fc 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/HttpBasicServerAuthenticationEntryPoint.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/HttpBasicServerAuthenticationEntryPoint.java @@ -51,7 +51,7 @@ public class HttpBasicServerAuthenticationEntryPoint implements ServerAuthentica } /** - * Sets the realm to be used + * Sets the realm to be used. * @param realm the realm. Default is "Realm" */ public void setRealm(String realm) { diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationEntryPoint.java b/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationEntryPoint.java index ce02d624db..9e44d51791 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationEntryPoint.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationEntryPoint.java @@ -44,7 +44,7 @@ public class RedirectServerAuthenticationEntryPoint implements ServerAuthenticat private ServerRequestCache requestCache = new WebSessionServerRequestCache(); /** - * Creates an instance + * Creates an instance. * @param location the location to redirect to (i.e. "/logout-success") */ public RedirectServerAuthenticationEntryPoint(String location) { diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationFailureHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationFailureHandler.java index 5f0c9c8950..dd26829d0a 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationFailureHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationFailureHandler.java @@ -39,7 +39,7 @@ public class RedirectServerAuthenticationFailureHandler implements ServerAuthent private ServerRedirectStrategy redirectStrategy = new DefaultServerRedirectStrategy(); /** - * Creates an instance + * Creates an instance. * @param location the location to redirect to (i.e. "/login?failed") */ public RedirectServerAuthenticationFailureHandler(String location) { diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationSuccessHandler.java index e90f7c74eb..9e6e1a8b44 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/RedirectServerAuthenticationSuccessHandler.java @@ -45,13 +45,13 @@ public class RedirectServerAuthenticationSuccessHandler implements ServerAuthent private ServerRequestCache requestCache = new WebSessionServerRequestCache(); /** - * Creates a new instance with location of "/" + * Creates a new instance with location of "/". */ public RedirectServerAuthenticationSuccessHandler() { } /** - * Creates a new instance with the specified location + * Creates a new instance with the specified location. * @param location the location to redirect if the no request is cached in * {@link #setRequestCache(ServerRequestCache)} */ @@ -78,7 +78,7 @@ public class RedirectServerAuthenticationSuccessHandler implements ServerAuthent } /** - * Where the user is redirected to upon authentication success + * Where the user is redirected to upon authentication success. * @param location the location to redirect to. The default is "/" */ public void setLocation(URI location) { diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationConverter.java b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationConverter.java index 6d2190d8bb..e781d22e03 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationConverter.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationConverter.java @@ -35,7 +35,7 @@ import org.springframework.web.server.ServerWebExchange; public interface ServerAuthenticationConverter { /** - * Converts a {@link ServerWebExchange} to an {@link Authentication} + * Converts a {@link ServerWebExchange} to an {@link Authentication}. * @param exchange The {@link ServerWebExchange} * @return A {@link Mono} representing an {@link Authentication} */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationEntryPointFailureHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationEntryPointFailureHandler.java index c832a194a4..f2206b6ab9 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationEntryPointFailureHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationEntryPointFailureHandler.java @@ -26,7 +26,7 @@ import org.springframework.util.Assert; /** * Adapts a {@link ServerAuthenticationEntryPoint} into a - * {@link ServerAuthenticationFailureHandler} + * {@link ServerAuthenticationFailureHandler}. * * @author Rob Winch * @since 5.0 @@ -54,7 +54,7 @@ public class ServerAuthenticationEntryPointFailureHandler implements ServerAuthe } /** - * Set whether to rethrow {@link AuthenticationServiceException}s (defaults to true) + * Set whether to rethrow {@link AuthenticationServiceException}s (defaults to true). * @param rethrowAuthenticationServiceException whether to rethrow * {@link AuthenticationServiceException}s * @since 5.8 diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationFailureHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationFailureHandler.java index ac7a263768..5e6ea7238b 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationFailureHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationFailureHandler.java @@ -22,7 +22,7 @@ import org.springframework.security.core.AuthenticationException; import org.springframework.security.web.server.WebFilterExchange; /** - * Handles authentication failure + * Handles authentication failure. * * @author Rob Winch * @since 5.0 @@ -30,7 +30,7 @@ import org.springframework.security.web.server.WebFilterExchange; public interface ServerAuthenticationFailureHandler { /** - * Invoked when authentication attempt fails + * Invoked when authentication attempt fails. * @param webFilterExchange the exchange * @param exception the reason authentication failed * @return a completion notification (success or error) diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationSuccessHandler.java index 6108c8ab02..f9f0183a33 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ServerAuthenticationSuccessHandler.java @@ -22,7 +22,7 @@ import org.springframework.security.core.Authentication; import org.springframework.security.web.server.WebFilterExchange; /** - * Handles authentication success + * Handles authentication success. * * @author Rob Winch * @since 5.0 @@ -30,7 +30,7 @@ import org.springframework.security.web.server.WebFilterExchange; public interface ServerAuthenticationSuccessHandler { /** - * Invoked when the application authenticates successfully + * Invoked when the application authenticates successfully. * @param webFilterExchange the exchange * @param authentication the {@link Authentication} * @return a completion notification (success or error) diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver.java b/web/src/main/java/org/springframework/security/web/server/authentication/ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver.java index f38cbb3d1d..adc6cfdab2 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver.java @@ -56,7 +56,7 @@ public final class ServerWebExchangeDelegatingReactiveAuthenticationManagerResol /** * Construct an * {@link ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver} based on - * the provided parameters + * the provided parameters. * @param managers a set of {@link ServerWebExchangeMatcherEntry}s */ ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver( @@ -67,7 +67,7 @@ public final class ServerWebExchangeDelegatingReactiveAuthenticationManagerResol /** * Construct an * {@link ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver} based on - * the provided parameters + * the provided parameters. * @param managers a {@link List} of {@link ServerWebExchangeMatcherEntry}s */ ServerWebExchangeDelegatingReactiveAuthenticationManagerResolver( @@ -90,7 +90,7 @@ public final class ServerWebExchangeDelegatingReactiveAuthenticationManagerResol /** * Set the default {@link ReactiveAuthenticationManager} to use when a request does - * not match + * not match. * @param defaultAuthenticationManager the default * {@link ReactiveAuthenticationManager} to use */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/SessionLimit.java b/web/src/main/java/org/springframework/security/web/server/authentication/SessionLimit.java index b94df896ee..09485060c9 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/SessionLimit.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/SessionLimit.java @@ -39,7 +39,7 @@ public interface SessionLimit extends Function> { SessionLimit UNLIMITED = (authentication) -> Mono.empty(); /** - * Creates a {@link SessionLimit} that always returns the given value for any user + * Creates a {@link SessionLimit} that always returns the given value for any user. * @param maxSessions the maximum number of sessions allowed * @return a {@link SessionLimit} instance that returns the given value. */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/SwitchUserWebFilter.java b/web/src/main/java/org/springframework/security/web/server/authentication/SwitchUserWebFilter.java index 2735993ce9..9744feaffb 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/SwitchUserWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/SwitchUserWebFilter.java @@ -114,7 +114,7 @@ public class SwitchUserWebFilter implements WebFilter { private ServerWebExchangeMatcher exitUserMatcher = createMatcher("/logout/impersonate"); /** - * Creates a filter for the user context switching + * Creates a filter for the user context switching. * @param userDetailsService The UserDetailsService which will be used to * load information for the user that is being switched to. * @param successHandler Used to define custom behaviour on a successful switch or @@ -134,7 +134,7 @@ public class SwitchUserWebFilter implements WebFilter { } /** - * Creates a filter for the user context switching + * Creates a filter for the user context switching. * @param userDetailsService The UserDetailsService which will be used to * load information for the user that is being switched to. * @param successTargetUrl Sets the URL to go to after a successful switch / exit user diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/logout/SecurityContextServerLogoutHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/logout/SecurityContextServerLogoutHandler.java index 1760ac71d2..d8cd301bb2 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/logout/SecurityContextServerLogoutHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/logout/SecurityContextServerLogoutHandler.java @@ -26,7 +26,7 @@ import org.springframework.util.Assert; /** * A {@link ServerLogoutHandler} which removes the SecurityContext using the provided - * {@link ServerSecurityContextRepository} + * {@link ServerSecurityContextRepository}. * * @author Rob Winch * @since 5.0 diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutHandler.java index 2cb39569d7..f3e4812528 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutHandler.java @@ -22,7 +22,7 @@ import org.springframework.security.core.Authentication; import org.springframework.security.web.server.WebFilterExchange; /** - * Handles log out + * Handles log out. * * @author Rob Winch * @since 5.0 @@ -31,7 +31,7 @@ import org.springframework.security.web.server.WebFilterExchange; public interface ServerLogoutHandler { /** - * Invoked when log out is requested + * Invoked when log out is requested. * @param exchange the exchange * @param authentication the {@link Authentication} * @return a completion notification (success or error) diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutSuccessHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutSuccessHandler.java index d0caa3d8c0..73de3fe273 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/logout/ServerLogoutSuccessHandler.java @@ -32,7 +32,7 @@ import org.springframework.security.web.server.WebFilterExchange; public interface ServerLogoutSuccessHandler { /** - * Invoked after log out was successful + * Invoked after log out was successful. * @param exchange the exchange * @param authentication the {@link Authentication} * @return a completion notification (success or error) diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ott/DefaultServerGenerateOneTimeTokenRequestResolver.java b/web/src/main/java/org/springframework/security/web/server/authentication/ott/DefaultServerGenerateOneTimeTokenRequestResolver.java index fac32f4540..61d9233399 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ott/DefaultServerGenerateOneTimeTokenRequestResolver.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ott/DefaultServerGenerateOneTimeTokenRequestResolver.java @@ -52,7 +52,7 @@ public final class DefaultServerGenerateOneTimeTokenRequestResolver } /** - * Sets one-time token expiration time + * Sets one-time token expiration time. * @param expiresIn one-time token expiration time */ public void setExpiresIn(Duration expiresIn) { diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ott/GenerateOneTimeTokenWebFilter.java b/web/src/main/java/org/springframework/security/web/server/authentication/ott/GenerateOneTimeTokenWebFilter.java index fcf3ed7423..d795007103 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ott/GenerateOneTimeTokenWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ott/GenerateOneTimeTokenWebFilter.java @@ -75,7 +75,7 @@ public final class GenerateOneTimeTokenWebFilter implements WebFilter { /** * Use the given {@link ServerGenerateOneTimeTokenRequestResolver} to resolve the - * request, defaults to {@link DefaultServerGenerateOneTimeTokenRequestResolver} + * request, defaults to {@link DefaultServerGenerateOneTimeTokenRequestResolver}. * @param requestResolver {@link ServerGenerateOneTimeTokenRequestResolver} * @since 6.5 */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerGenerateOneTimeTokenRequestResolver.java b/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerGenerateOneTimeTokenRequestResolver.java index aba0e7dfcd..3c28e510ef 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerGenerateOneTimeTokenRequestResolver.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerGenerateOneTimeTokenRequestResolver.java @@ -31,7 +31,7 @@ import org.springframework.web.server.ServerWebExchange; public interface ServerGenerateOneTimeTokenRequestResolver { /** - * Resolves {@link GenerateOneTimeTokenRequest} from {@link ServerWebExchange} + * Resolves {@link GenerateOneTimeTokenRequest} from {@link ServerWebExchange}. * @param exchange {@link ServerWebExchange} to resolve * @return {@link GenerateOneTimeTokenRequest} */ diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerOneTimeTokenGenerationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerOneTimeTokenGenerationSuccessHandler.java index f5a2c381b2..e8b4648850 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerOneTimeTokenGenerationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerOneTimeTokenGenerationSuccessHandler.java @@ -31,7 +31,7 @@ import org.springframework.web.server.ServerWebExchange; public interface ServerOneTimeTokenGenerationSuccessHandler { /** - * Handles generated one-time tokens + * Handles generated one-time tokens. * @param exchange the {@link ServerWebExchange} to use * @param oneTimeToken the {@link OneTimeToken} to handle * @return a completion handling (success or error) diff --git a/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerRedirectOneTimeTokenGenerationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerRedirectOneTimeTokenGenerationSuccessHandler.java index 2f58941797..23b9a8a373 100644 --- a/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerRedirectOneTimeTokenGenerationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authentication/ott/ServerRedirectOneTimeTokenGenerationSuccessHandler.java @@ -28,7 +28,7 @@ import org.springframework.web.server.ServerWebExchange; /** * A {@link ServerOneTimeTokenGenerationSuccessHandler} that performs a redirect to a - * specific location + * specific location. * * @author Max Batischev * @since 6.4 diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationContext.java b/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationContext.java index 452df588b8..7eb92bee11 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationContext.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationContext.java @@ -22,6 +22,9 @@ import java.util.Map; import org.springframework.web.server.ServerWebExchange; /** + * Contains the {@link ServerWebExchange} and any extracted URI template variables used + * during authorization. + * * @author Rob Winch * @since 5.0 */ diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationWebFilter.java b/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationWebFilter.java index 5736a04cd6..4b917358e9 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/AuthorizationWebFilter.java @@ -30,6 +30,9 @@ import org.springframework.web.server.WebFilter; import org.springframework.web.server.WebFilterChain; /** + * A {@link WebFilter} that determines if an authenticated request is authorized to access + * the requested resource. + * * @author Rob Winch * @author Mathieu Ouellet * @since 5.0 diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/DelegatingReactiveAuthorizationManager.java b/web/src/main/java/org/springframework/security/web/server/authorization/DelegatingReactiveAuthorizationManager.java index 3ba7078cb1..47c50b1820 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/DelegatingReactiveAuthorizationManager.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/DelegatingReactiveAuthorizationManager.java @@ -34,6 +34,10 @@ import org.springframework.security.web.server.util.matcher.ServerWebExchangeMat import org.springframework.web.server.ServerWebExchange; /** + * A {@link ReactiveAuthorizationManager} that delegates to a list of + * {@link ReactiveAuthorizationManager} instances based on matching a + * {@link ServerWebExchange}. + * * @author Rob Winch * @author Mathieu Ouellet * @author Evgeniy Cheban diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/ExceptionTranslationWebFilter.java b/web/src/main/java/org/springframework/security/web/server/authorization/ExceptionTranslationWebFilter.java index 3286a5ae45..dd7f409e27 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/ExceptionTranslationWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/ExceptionTranslationWebFilter.java @@ -35,6 +35,9 @@ import org.springframework.web.server.WebFilter; import org.springframework.web.server.WebFilterChain; /** + * A {@link WebFilter} that translates {@link AuthenticationException}s and + * {@link AccessDeniedException}s into the appropriate HTTP response. + * * @author Rob Winch * @author César Revert * @since 5.0 @@ -77,7 +80,7 @@ public class ExceptionTranslationWebFilter implements WebFilter { } /** - * Sets the authentication entry point used when authentication is required + * Sets the authentication entry point used when authentication is required. * @param authenticationEntryPoint the authentication entry point to use. Default is * {@link HttpBasicServerAuthenticationEntryPoint} */ diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/HttpStatusServerAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/server/authorization/HttpStatusServerAccessDeniedHandler.java index 0e7726e5aa..8267239230 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/HttpStatusServerAccessDeniedHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/HttpStatusServerAccessDeniedHandler.java @@ -40,7 +40,7 @@ public class HttpStatusServerAccessDeniedHandler implements ServerAccessDeniedHa private final HttpStatus httpStatus; /** - * Creates an instance with the provided status + * Creates an instance with the provided status. * @param httpStatus the status to use */ public HttpStatusServerAccessDeniedHandler(HttpStatus httpStatus) { diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/IpAddressReactiveAuthorizationManager.java b/web/src/main/java/org/springframework/security/web/server/authorization/IpAddressReactiveAuthorizationManager.java index b3c8493f41..1b3b4e0247 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/IpAddressReactiveAuthorizationManager.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/IpAddressReactiveAuthorizationManager.java @@ -27,7 +27,7 @@ import org.springframework.util.Assert; /** * A {@link ReactiveAuthorizationManager}, that determines if the current request contains - * the specified address or range of addresses + * the specified address or range of addresses. * * @author Guirong Hu * @since 5.7 diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/ServerAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/server/authorization/ServerAccessDeniedHandler.java index d5fa7c5a72..952a6a16ca 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/ServerAccessDeniedHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/ServerAccessDeniedHandler.java @@ -22,6 +22,8 @@ import org.springframework.security.access.AccessDeniedException; import org.springframework.web.server.ServerWebExchange; /** + * Handles a denied access attempt for a reactive web application. + * * @author Rob Winch * @since 5.0 */ diff --git a/web/src/main/java/org/springframework/security/web/server/authorization/ServerWebExchangeDelegatingServerAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/server/authorization/ServerWebExchangeDelegatingServerAccessDeniedHandler.java index babc6c564c..cb1da19d34 100644 --- a/web/src/main/java/org/springframework/security/web/server/authorization/ServerWebExchangeDelegatingServerAccessDeniedHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/authorization/ServerWebExchangeDelegatingServerAccessDeniedHandler.java @@ -30,7 +30,7 @@ import org.springframework.web.server.ServerWebExchange; /** * A {@link ServerAccessDeniedHandler} which delegates to multiple - * {@link ServerAccessDeniedHandler}s based on a {@link ServerWebExchangeMatcher} + * {@link ServerAccessDeniedHandler}s based on a {@link ServerWebExchangeMatcher}. * * @author Josh Cummings * @since 5.1 @@ -45,7 +45,7 @@ public class ServerWebExchangeDelegatingServerAccessDeniedHandler implements Ser }; /** - * Creates a new instance + * Creates a new instance. * @param handlers a list of {@link ServerWebExchangeMatcher}/ * {@link ServerAccessDeniedHandler} pairs that should be used. Each is considered in * the order they are specified and only the first {@link ServerAccessDeniedHandler} @@ -56,7 +56,7 @@ public class ServerWebExchangeDelegatingServerAccessDeniedHandler implements Ser } /** - * Creates a new instance + * Creates a new instance. * @param handlers a list of {@link ServerWebExchangeMatcher}/ * {@link ServerAccessDeniedHandler} pairs that should be used. Each is considered in * the order they are specified and only the first {@link ServerAccessDeniedHandler} diff --git a/web/src/main/java/org/springframework/security/web/server/context/SecurityContextServerWebExchange.java b/web/src/main/java/org/springframework/security/web/server/context/SecurityContextServerWebExchange.java index 7a04020e4b..8691eef067 100644 --- a/web/src/main/java/org/springframework/security/web/server/context/SecurityContextServerWebExchange.java +++ b/web/src/main/java/org/springframework/security/web/server/context/SecurityContextServerWebExchange.java @@ -26,7 +26,7 @@ import org.springframework.web.server.ServerWebExchangeDecorator; /** * Overrides the {@link ServerWebExchange#getPrincipal()} with the provided - * SecurityContext + * SecurityContext. * * @author Rob Winch * @since 5.0 diff --git a/web/src/main/java/org/springframework/security/web/server/context/ServerSecurityContextRepository.java b/web/src/main/java/org/springframework/security/web/server/context/ServerSecurityContextRepository.java index 970f56e3ef..fa0e4c0d85 100644 --- a/web/src/main/java/org/springframework/security/web/server/context/ServerSecurityContextRepository.java +++ b/web/src/main/java/org/springframework/security/web/server/context/ServerSecurityContextRepository.java @@ -32,7 +32,7 @@ import org.springframework.web.server.ServerWebExchange; public interface ServerSecurityContextRepository { /** - * Saves the SecurityContext + * Saves the SecurityContext. * @param exchange the exchange to associate to the SecurityContext * @param context the SecurityContext to save * @return a completion notification (success or error) @@ -40,7 +40,7 @@ public interface ServerSecurityContextRepository { Mono save(ServerWebExchange exchange, @Nullable SecurityContext context); /** - * Loads the SecurityContext associated with the {@link ServerWebExchange} + * Loads the SecurityContext associated with the {@link ServerWebExchange}. * @param exchange the exchange to look up the {@link SecurityContext} * @return the {@link SecurityContext} to lookup or empty if not found. Never null */ diff --git a/web/src/main/java/org/springframework/security/web/server/context/WebSessionServerSecurityContextRepository.java b/web/src/main/java/org/springframework/security/web/server/context/WebSessionServerSecurityContextRepository.java index 2f447dfec8..67372f7117 100644 --- a/web/src/main/java/org/springframework/security/web/server/context/WebSessionServerSecurityContextRepository.java +++ b/web/src/main/java/org/springframework/security/web/server/context/WebSessionServerSecurityContextRepository.java @@ -41,7 +41,7 @@ public class WebSessionServerSecurityContextRepository implements ServerSecurity private static final Log logger = LogFactory.getLog(WebSessionServerSecurityContextRepository.class); /** - * The default session attribute name to save and load the {@link SecurityContext} + * The default session attribute name to save and load the {@link SecurityContext}. */ public static final String DEFAULT_SPRING_SECURITY_CONTEXT_ATTR_NAME = "SPRING_SECURITY_CONTEXT"; @@ -50,7 +50,7 @@ public class WebSessionServerSecurityContextRepository implements ServerSecurity private boolean cacheSecurityContext; /** - * Sets the session attribute name used to save and load the {@link SecurityContext} + * Sets the session attribute name used to save and load the {@link SecurityContext}. * @param springSecurityContextAttrName the session attribute name to use to save and * load the {@link SecurityContext} */ diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/CookieServerCsrfTokenRepository.java b/web/src/main/java/org/springframework/security/web/server/csrf/CookieServerCsrfTokenRepository.java index fbd597d6c9..f9713ed98e 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/CookieServerCsrfTokenRepository.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/CookieServerCsrfTokenRepository.java @@ -126,7 +126,7 @@ public final class CookieServerCsrfTokenRepository implements ServerCsrfTokenRep } /** - * Sets the cookie name + * Sets the cookie name. * @param cookieName The cookie name */ public void setCookieName(String cookieName) { @@ -135,7 +135,7 @@ public final class CookieServerCsrfTokenRepository implements ServerCsrfTokenRep } /** - * Sets the parameter name + * Sets the parameter name. * @param parameterName The parameter name */ public void setParameterName(String parameterName) { @@ -144,7 +144,7 @@ public final class CookieServerCsrfTokenRepository implements ServerCsrfTokenRep } /** - * Sets the header name + * Sets the header name. * @param headerName The header name */ public void setHeaderName(String headerName) { @@ -153,7 +153,7 @@ public final class CookieServerCsrfTokenRepository implements ServerCsrfTokenRep } /** - * Sets the cookie path + * Sets the cookie path. * @param cookiePath The cookie path */ public void setCookiePath(String cookiePath) { diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/CsrfException.java b/web/src/main/java/org/springframework/security/web/server/csrf/CsrfException.java index d8c8b89aae..ac9d96417b 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/CsrfException.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/CsrfException.java @@ -21,7 +21,7 @@ import java.io.Serial; import org.springframework.security.access.AccessDeniedException; /** - * Thrown when an invalid or missing {@link CsrfToken} is found in the ServerWebExchange + * Thrown when an invalid or missing {@link CsrfToken} is found in the ServerWebExchange. * * @author Rob Winch * @since 5.0 diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/CsrfServerLogoutHandler.java b/web/src/main/java/org/springframework/security/web/server/csrf/CsrfServerLogoutHandler.java index 96465f0db4..616b0c651a 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/CsrfServerLogoutHandler.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/CsrfServerLogoutHandler.java @@ -36,7 +36,7 @@ public class CsrfServerLogoutHandler implements ServerLogoutHandler { private final ServerCsrfTokenRepository csrfTokenRepository; /** - * Creates a new instance + * Creates a new instance. * @param csrfTokenRepository The {@link ServerCsrfTokenRepository} to use */ public CsrfServerLogoutHandler(ServerCsrfTokenRepository csrfTokenRepository) { @@ -45,7 +45,7 @@ public class CsrfServerLogoutHandler implements ServerLogoutHandler { } /** - * Clears the {@link CsrfToken} + * Clears the {@link CsrfToken}. * @param exchange the exchange * @param authentication the {@link Authentication} * @return A completion notification (success or error) diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/CsrfToken.java b/web/src/main/java/org/springframework/security/web/server/csrf/CsrfToken.java index 9bc3f512c7..4a36eefcbd 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/CsrfToken.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/CsrfToken.java @@ -19,6 +19,8 @@ package org.springframework.security.web.server.csrf; import java.io.Serializable; /** + * Represents a CSRF token used to protect against CSRF attacks. + * * @author Rob Winch * @since 5.0 */ diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/DefaultCsrfToken.java b/web/src/main/java/org/springframework/security/web/server/csrf/DefaultCsrfToken.java index dfc68fd5ff..41d483ee33 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/DefaultCsrfToken.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/DefaultCsrfToken.java @@ -40,7 +40,7 @@ public final class DefaultCsrfToken implements CsrfToken { private final String headerName; /** - * Creates a new instance + * Creates a new instance. * @param headerName the HTTP header name to use * @param parameterName the HTTP parameter name to use * @param token the value of the token (i.e. expected value of the HTTP parameter of diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRepository.java b/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRepository.java index a1a3800794..dab44f0b3b 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRepository.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRepository.java @@ -34,7 +34,7 @@ import org.springframework.web.server.ServerWebExchange; public interface ServerCsrfTokenRepository { /** - * Generates a {@link CsrfToken} + * Generates a {@link CsrfToken}. * @param exchange the {@link ServerWebExchange} to use * @return the {@link CsrfToken} that was generated. Cannot be null. */ @@ -49,7 +49,7 @@ public interface ServerCsrfTokenRepository { Mono saveToken(ServerWebExchange exchange, @Nullable CsrfToken token); /** - * Loads the expected {@link CsrfToken} from the {@link ServerWebExchange} + * Loads the expected {@link CsrfToken} from the {@link ServerWebExchange}. * @param exchange the {@link ServerWebExchange} to use * @return the {@link CsrfToken} or null if none exists */ diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRequestHandlerLoggerHolder.java b/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRequestHandlerLoggerHolder.java index 62c3c07485..536cb640dc 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRequestHandlerLoggerHolder.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/ServerCsrfTokenRequestHandlerLoggerHolder.java @@ -20,7 +20,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** - * Utility class for holding the logger for {@link ServerCsrfTokenRequestHandler} + * Utility class for holding the logger for {@link ServerCsrfTokenRequestHandler}. */ final class ServerCsrfTokenRequestHandlerLoggerHolder { diff --git a/web/src/main/java/org/springframework/security/web/server/csrf/WebSessionServerCsrfTokenRepository.java b/web/src/main/java/org/springframework/security/web/server/csrf/WebSessionServerCsrfTokenRepository.java index 7d54b516e2..aa0195fbff 100644 --- a/web/src/main/java/org/springframework/security/web/server/csrf/WebSessionServerCsrfTokenRepository.java +++ b/web/src/main/java/org/springframework/security/web/server/csrf/WebSessionServerCsrfTokenRepository.java @@ -80,7 +80,7 @@ public class WebSessionServerCsrfTokenRepository implements ServerCsrfTokenRepos /** * Sets the {@link ServerWebExchange} parameter name that the {@link CsrfToken} is - * expected to appear on + * expected to appear on. * @param parameterName the new parameter name to use */ public void setParameterName(String parameterName) { @@ -99,7 +99,7 @@ public class WebSessionServerCsrfTokenRepository implements ServerCsrfTokenRepos } /** - * Sets the {@link WebSession} attribute name that the {@link CsrfToken} is stored in + * Sets the {@link WebSession} attribute name that the {@link CsrfToken} is stored in. * @param sessionAttributeName the new attribute name to use */ public void setSessionAttributeName(String sessionAttributeName) { diff --git a/web/src/main/java/org/springframework/security/web/server/header/CacheControlServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/CacheControlServerHttpHeadersWriter.java index c4fad5afcf..38cf24228d 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/CacheControlServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/CacheControlServerHttpHeadersWriter.java @@ -37,17 +37,17 @@ import org.springframework.web.server.ServerWebExchange; public class CacheControlServerHttpHeadersWriter implements ServerHttpHeadersWriter { /** - * The value for expires value + * The value for expires value. */ public static final String EXPIRES_VALUE = "0"; /** - * The value for pragma value + * The value for pragma value. */ public static final String PRAGMA_VALUE = "no-cache"; /** - * The value for cache control value + * The value for cache control value. */ public static final String CACHE_CONTROL_VALUE = "no-cache, no-store, max-age=0, must-revalidate"; @@ -59,7 +59,7 @@ public class CacheControlServerHttpHeadersWriter implements ServerHttpHeadersWri public static final String CACHE_CONTRTOL_VALUE = CACHE_CONTROL_VALUE; /** - * The delegate to write all the cache control related headers + * The delegate to write all the cache control related headers. */ private static final ServerHttpHeadersWriter CACHE_HEADERS = StaticServerHttpHeadersWriter.builder() .header(HttpHeaders.CACHE_CONTROL, CacheControlServerHttpHeadersWriter.CACHE_CONTROL_VALUE) diff --git a/web/src/main/java/org/springframework/security/web/server/header/ContentTypeOptionsServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/ContentTypeOptionsServerHttpHeadersWriter.java index 4c967b05f1..ae22fb9b4f 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/ContentTypeOptionsServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/ContentTypeOptionsServerHttpHeadersWriter.java @@ -21,7 +21,7 @@ import reactor.core.publisher.Mono; import org.springframework.web.server.ServerWebExchange; /** - * Adds X-Content-Type-Options: nosniff + * Adds X-Content-Type-Options: nosniff. * * @author Rob Winch * @since 5.0 @@ -33,7 +33,7 @@ public class ContentTypeOptionsServerHttpHeadersWriter implements ServerHttpHead public static final String NOSNIFF = "nosniff"; /** - * The delegate to write all the cache control related headers + * The delegate to write all the cache control related headers. */ private static final ServerHttpHeadersWriter CONTENT_TYPE_HEADERS = StaticServerHttpHeadersWriter.builder() .header(X_CONTENT_OPTIONS, NOSNIFF) diff --git a/web/src/main/java/org/springframework/security/web/server/header/CrossOriginEmbedderPolicyServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/CrossOriginEmbedderPolicyServerHttpHeadersWriter.java index 3fc76e7b1c..95b8086035 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/CrossOriginEmbedderPolicyServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/CrossOriginEmbedderPolicyServerHttpHeadersWriter.java @@ -39,7 +39,7 @@ public final class CrossOriginEmbedderPolicyServerHttpHeadersWriter implements S /** * Sets the {@link CrossOriginEmbedderPolicy} value to be used in the - * {@code Cross-Origin-Embedder-Policy} header + * {@code Cross-Origin-Embedder-Policy} header. * @param embedderPolicy the {@link CrossOriginEmbedderPolicy} to use */ public void setPolicy(CrossOriginEmbedderPolicy embedderPolicy) { diff --git a/web/src/main/java/org/springframework/security/web/server/header/CrossOriginOpenerPolicyServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/CrossOriginOpenerPolicyServerHttpHeadersWriter.java index 6305e57587..5901c0561f 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/CrossOriginOpenerPolicyServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/CrossOriginOpenerPolicyServerHttpHeadersWriter.java @@ -39,7 +39,7 @@ public final class CrossOriginOpenerPolicyServerHttpHeadersWriter implements Ser /** * Sets the {@link CrossOriginOpenerPolicy} value to be used in the - * {@code Cross-Origin-Opener-Policy} header + * {@code Cross-Origin-Opener-Policy} header. * @param openerPolicy the {@link CrossOriginOpenerPolicy} to use */ public void setPolicy(CrossOriginOpenerPolicy openerPolicy) { diff --git a/web/src/main/java/org/springframework/security/web/server/header/CrossOriginResourcePolicyServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/CrossOriginResourcePolicyServerHttpHeadersWriter.java index 111bb8a435..6acc8551c6 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/CrossOriginResourcePolicyServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/CrossOriginResourcePolicyServerHttpHeadersWriter.java @@ -39,7 +39,7 @@ public final class CrossOriginResourcePolicyServerHttpHeadersWriter implements S /** * Sets the {@link CrossOriginResourcePolicy} value to be used in the - * {@code Cross-Origin-Embedder-Policy} header + * {@code Cross-Origin-Embedder-Policy} header. * @param resourcePolicy the {@link CrossOriginResourcePolicy} to use */ public void setPolicy(CrossOriginResourcePolicy resourcePolicy) { diff --git a/web/src/main/java/org/springframework/security/web/server/header/ServerWebExchangeDelegatingServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/ServerWebExchangeDelegatingServerHttpHeadersWriter.java index fcad3e00e7..cb78d01078 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/ServerWebExchangeDelegatingServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/ServerWebExchangeDelegatingServerHttpHeadersWriter.java @@ -35,7 +35,7 @@ public final class ServerWebExchangeDelegatingServerHttpHeadersWriter implements private final ServerWebExchangeMatcherEntry headersWriter; /** - * Creates a new instance + * Creates a new instance. * @param headersWriter the {@link ServerWebExchangeMatcherEntry} holding a * {@link ServerWebExchangeMatcher} and the {@link ServerHttpHeadersWriter} to invoke * if the matcher returns a match. @@ -49,7 +49,7 @@ public final class ServerWebExchangeDelegatingServerHttpHeadersWriter implements } /** - * Creates a new instance + * Creates a new instance. * @param webExchangeMatcher the {@link ServerWebExchangeMatcher} to use. If it * returns a match, the delegateHeadersWriter is invoked. * @param delegateHeadersWriter the {@link ServerHttpHeadersWriter} to invoke if the diff --git a/web/src/main/java/org/springframework/security/web/server/header/XContentTypeOptionsServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/XContentTypeOptionsServerHttpHeadersWriter.java index a08769444d..036c0f8639 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/XContentTypeOptionsServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/XContentTypeOptionsServerHttpHeadersWriter.java @@ -21,7 +21,7 @@ import reactor.core.publisher.Mono; import org.springframework.web.server.ServerWebExchange; /** - * Adds X-Content-Type-Options: nosniff + * Adds X-Content-Type-Options: nosniff. * * @author Rob Winch * @since 5.0 @@ -33,7 +33,7 @@ public class XContentTypeOptionsServerHttpHeadersWriter implements ServerHttpHea public static final String NOSNIFF = "nosniff"; /** - * The delegate to write all the cache control related headers + * The delegate to write all the cache control related headers. */ private static final ServerHttpHeadersWriter CONTENT_TYPE_HEADERS = StaticServerHttpHeadersWriter.builder() .header(X_CONTENT_OPTIONS, NOSNIFF) diff --git a/web/src/main/java/org/springframework/security/web/server/header/XXssProtectionServerHttpHeadersWriter.java b/web/src/main/java/org/springframework/security/web/server/header/XXssProtectionServerHttpHeadersWriter.java index e7f8382323..765ee99368 100644 --- a/web/src/main/java/org/springframework/security/web/server/header/XXssProtectionServerHttpHeadersWriter.java +++ b/web/src/main/java/org/springframework/security/web/server/header/XXssProtectionServerHttpHeadersWriter.java @@ -38,7 +38,7 @@ public class XXssProtectionServerHttpHeadersWriter implements ServerHttpHeadersW private HeaderValue headerValue; /** - * Creates a new instance + * Creates a new instance. */ public XXssProtectionServerHttpHeadersWriter() { this.headerValue = HeaderValue.DISABLED; diff --git a/web/src/main/java/org/springframework/security/web/server/jackson/DefaultCsrfServerTokenMixin.java b/web/src/main/java/org/springframework/security/web/server/jackson/DefaultCsrfServerTokenMixin.java index be1a2251af..4811388608 100644 --- a/web/src/main/java/org/springframework/security/web/server/jackson/DefaultCsrfServerTokenMixin.java +++ b/web/src/main/java/org/springframework/security/web/server/jackson/DefaultCsrfServerTokenMixin.java @@ -19,6 +19,7 @@ package org.springframework.security.web.server.jackson; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson mixin class to serialize/deserialize @@ -30,7 +31,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; * @since 7.0 * @see WebServerJacksonModule */ -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) +@JsonTypeInfo(use = Id.CLASS) class DefaultCsrfServerTokenMixin { /** diff --git a/web/src/main/java/org/springframework/security/web/server/jackson2/DefaultCsrfServerTokenMixin.java b/web/src/main/java/org/springframework/security/web/server/jackson2/DefaultCsrfServerTokenMixin.java index 33ce393cab..1956b8aa61 100644 --- a/web/src/main/java/org/springframework/security/web/server/jackson2/DefaultCsrfServerTokenMixin.java +++ b/web/src/main/java/org/springframework/security/web/server/jackson2/DefaultCsrfServerTokenMixin.java @@ -20,6 +20,8 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeInfo.As; +import com.fasterxml.jackson.annotation.JsonTypeInfo.Id; /** * Jackson mixin class to serialize/deserialize @@ -40,7 +42,7 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo; */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class") +@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY, property = "@class") @JsonIgnoreProperties(ignoreUnknown = true) class DefaultCsrfServerTokenMixin { diff --git a/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCache.java b/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCache.java index 4ce80167b9..aace2031db 100644 --- a/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCache.java +++ b/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCache.java @@ -33,7 +33,7 @@ import org.springframework.web.server.ServerWebExchange; public interface ServerRequestCache { /** - * Save the {@link ServerHttpRequest} + * Save the {@link ServerHttpRequest}. * @param exchange the exchange to save * @return Return a {@code Mono} which only replays complete and error signals * from this {@link Mono}. @@ -41,7 +41,7 @@ public interface ServerRequestCache { Mono saveRequest(ServerWebExchange exchange); /** - * Get the URI that can be redirected to trigger the saved request to be used + * Get the URI that can be redirected to trigger the saved request to be used. * @param exchange the exchange to obtain the saved {@link ServerHttpRequest} from * @return the URI that can be redirected to trigger the saved request to be used */ @@ -49,7 +49,7 @@ public interface ServerRequestCache { /** * If the provided {@link ServerWebExchange} matches the saved - * {@link ServerHttpRequest} gets the saved {@link ServerHttpRequest} + * {@link ServerHttpRequest} gets the saved {@link ServerHttpRequest}. * @param exchange the exchange to obtain the request from * @return the {@link ServerHttpRequest} */ diff --git a/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCacheWebFilter.java b/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCacheWebFilter.java index 474884b235..a43d8b07fb 100644 --- a/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCacheWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/savedrequest/ServerRequestCacheWebFilter.java @@ -24,7 +24,7 @@ import org.springframework.web.server.WebFilter; import org.springframework.web.server.WebFilterChain; /** - * A {@link WebFilter} that replays any matching request in {@link ServerRequestCache} + * A {@link WebFilter} that replays any matching request in {@link ServerRequestCache}. * * @author Rob Winch * @since 5.0 diff --git a/web/src/main/java/org/springframework/security/web/server/transport/HttpsRedirectWebFilter.java b/web/src/main/java/org/springframework/security/web/server/transport/HttpsRedirectWebFilter.java index c95fb192ca..ee4faaae94 100644 --- a/web/src/main/java/org/springframework/security/web/server/transport/HttpsRedirectWebFilter.java +++ b/web/src/main/java/org/springframework/security/web/server/transport/HttpsRedirectWebFilter.java @@ -63,7 +63,7 @@ public final class HttpsRedirectWebFilter implements WebFilter { } /** - * Use this {@link PortMapper} for mapping custom ports + * Use this {@link PortMapper} for mapping custom ports. * @param portMapper the {@link PortMapper} to use */ public void setPortMapper(PortMapper portMapper) { diff --git a/web/src/main/java/org/springframework/security/web/server/util/matcher/AndServerWebExchangeMatcher.java b/web/src/main/java/org/springframework/security/web/server/util/matcher/AndServerWebExchangeMatcher.java index 4bd7a02d39..e2baaf6fd9 100644 --- a/web/src/main/java/org/springframework/security/web/server/util/matcher/AndServerWebExchangeMatcher.java +++ b/web/src/main/java/org/springframework/security/web/server/util/matcher/AndServerWebExchangeMatcher.java @@ -31,7 +31,7 @@ import org.springframework.util.Assert; import org.springframework.web.server.ServerWebExchange; /** - * Matches if all the provided {@link ServerWebExchangeMatcher} match + * Matches if all the provided {@link ServerWebExchangeMatcher} match. * * @author Rob Winch * @author Mathieu Ouellet diff --git a/web/src/main/java/org/springframework/security/web/server/util/matcher/MediaTypeServerWebExchangeMatcher.java b/web/src/main/java/org/springframework/security/web/server/util/matcher/MediaTypeServerWebExchangeMatcher.java index 11aa203c0b..f9adaa418d 100644 --- a/web/src/main/java/org/springframework/security/web/server/util/matcher/MediaTypeServerWebExchangeMatcher.java +++ b/web/src/main/java/org/springframework/security/web/server/util/matcher/MediaTypeServerWebExchangeMatcher.java @@ -52,7 +52,7 @@ public class MediaTypeServerWebExchangeMatcher implements ServerWebExchangeMatch private Set ignoredMediaTypes = Collections.emptySet(); /** - * Creates a new instance + * Creates a new instance. * @param matchingMediaTypes the types to match on */ public MediaTypeServerWebExchangeMatcher(MediaType... matchingMediaTypes) { @@ -62,7 +62,7 @@ public class MediaTypeServerWebExchangeMatcher implements ServerWebExchangeMatch } /** - * Creates a new instance + * Creates a new instance. * @param matchingMediaTypes the types to match on */ public MediaTypeServerWebExchangeMatcher(Collection matchingMediaTypes) { diff --git a/web/src/main/java/org/springframework/security/web/server/util/matcher/OrServerWebExchangeMatcher.java b/web/src/main/java/org/springframework/security/web/server/util/matcher/OrServerWebExchangeMatcher.java index 84f2b1dfc3..88dbacc769 100644 --- a/web/src/main/java/org/springframework/security/web/server/util/matcher/OrServerWebExchangeMatcher.java +++ b/web/src/main/java/org/springframework/security/web/server/util/matcher/OrServerWebExchangeMatcher.java @@ -29,7 +29,7 @@ import org.springframework.util.Assert; import org.springframework.web.server.ServerWebExchange; /** - * Matches if any of the provided {@link ServerWebExchangeMatcher} match + * Matches if any of the provided {@link ServerWebExchangeMatcher} match. * * @author Rob Winch * @author Mathieu Ouellet diff --git a/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatcher.java b/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatcher.java index c6f841303f..78768afd16 100644 --- a/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatcher.java +++ b/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatcher.java @@ -32,14 +32,14 @@ import org.springframework.web.server.ServerWebExchange; public interface ServerWebExchangeMatcher { /** - * Determines if a request matches or not + * Determines if a request matches or not. * @param exchange * @return */ Mono matches(ServerWebExchange exchange); /** - * The result of matching + * The result of matching. */ class MatchResult { @@ -57,7 +57,7 @@ public interface ServerWebExchangeMatcher { } /** - * Gets potential variables and their values + * Gets potential variables and their values. * @return */ public Map getVariables() { @@ -65,7 +65,7 @@ public interface ServerWebExchangeMatcher { } /** - * Creates an instance of {@link MatchResult} that is a match with no variables + * Creates an instance of {@link MatchResult} that is a match with no variables. * @return */ public static Mono match() { @@ -75,7 +75,7 @@ public interface ServerWebExchangeMatcher { /** * * Creates an instance of {@link MatchResult} that is a match with the specified - * variables + * variables. * @param variables * @return */ diff --git a/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatchers.java b/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatchers.java index ed438ee6c2..d2cc71a5cf 100644 --- a/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatchers.java +++ b/web/src/main/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatchers.java @@ -27,7 +27,7 @@ import org.springframework.web.server.ServerWebExchange; import org.springframework.web.util.pattern.PathPattern; /** - * Provides factory methods for creating common {@link ServerWebExchangeMatcher} + * Provides factory methods for creating common {@link ServerWebExchangeMatcher}. * * @author Rob Winch * @since 5.0 @@ -86,7 +86,7 @@ public abstract class ServerWebExchangeMatchers { } /** - * Creates a matcher that will match on any of the provided matchers + * Creates a matcher that will match on any of the provided matchers. * @param matchers the matchers to match on * @return the matcher to use */ @@ -95,7 +95,7 @@ public abstract class ServerWebExchangeMatchers { } /** - * Matches any exchange + * Matches any exchange. * @return the matcher to use */ @SuppressWarnings("Convert2Lambda") diff --git a/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapper.java b/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapper.java index c3053092e7..c089e39e32 100644 --- a/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapper.java +++ b/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapper.java @@ -36,7 +36,7 @@ import org.springframework.util.Assert; /** * A Spring Security-aware HttpServletRequestWrapper, which uses the * SecurityContext-defined Authentication object to implement - * the servlet API security methods: + * the servlet API security methods:. * *

        *
      • {@link #getUserPrincipal()}
      • @@ -73,7 +73,7 @@ public class SecurityContextHolderAwareRequestWrapper extends HttpServletRequest } /** - * Creates a new instance + * Creates a new instance. * @param request the original {@link HttpServletRequest} * @param trustResolver the {@link AuthenticationTrustResolver} to use. Cannot be * null. @@ -89,7 +89,7 @@ public class SecurityContextHolderAwareRequestWrapper extends HttpServletRequest } /** - * Obtain the current active Authentication + * Obtain the current active Authentication. * @return the authentication object or null */ private @Nullable Authentication getAuthentication() { diff --git a/web/src/main/java/org/springframework/security/web/session/ConcurrentSessionFilter.java b/web/src/main/java/org/springframework/security/web/session/ConcurrentSessionFilter.java index 6a6d638833..a09db5d967 100644 --- a/web/src/main/java/org/springframework/security/web/session/ConcurrentSessionFilter.java +++ b/web/src/main/java/org/springframework/security/web/session/ConcurrentSessionFilter.java @@ -90,7 +90,7 @@ public class ConcurrentSessionFilter extends GenericFilterBean { } /** - * Creates a new instance + * Creates a new instance. * @param sessionRegistry the SessionRegistry to use * @param expiredUrl the URL to redirect to * @deprecated use @@ -154,7 +154,7 @@ public class ConcurrentSessionFilter extends GenericFilterBean { } /** - * Determine the URL for expiration + * Determine the URL for expiration. * @param request the HttpServletRequest * @param info the {@link SessionInformation} * @return the URL for expiration @@ -190,7 +190,7 @@ public class ConcurrentSessionFilter extends GenericFilterBean { } /** - * Set list of {@link LogoutHandler} + * Set list of {@link LogoutHandler}. * @param handlers list of {@link LogoutHandler} * @since 5.2.0 */ @@ -200,7 +200,7 @@ public class ConcurrentSessionFilter extends GenericFilterBean { /** * Sets the {@link RedirectStrategy} used with - * {@link #ConcurrentSessionFilter(SessionRegistry, String)} + * {@link #ConcurrentSessionFilter(SessionRegistry, String)}. * @param redirectStrategy the {@link RedirectStrategy} to use * @deprecated use * {@link #ConcurrentSessionFilter(SessionRegistry, SessionInformationExpiredStrategy)} diff --git a/web/src/main/java/org/springframework/security/web/session/HttpSessionCreatedEvent.java b/web/src/main/java/org/springframework/security/web/session/HttpSessionCreatedEvent.java index 547bc7fcdb..c2d41d5e41 100644 --- a/web/src/main/java/org/springframework/security/web/session/HttpSessionCreatedEvent.java +++ b/web/src/main/java/org/springframework/security/web/session/HttpSessionCreatedEvent.java @@ -22,7 +22,7 @@ import org.springframework.security.core.session.SessionCreationEvent; /** * Published by the {@link HttpSessionEventPublisher} when an {@code HttpSession} is - * created by the container + * created by the container. * * @author Ray Krueger * @author Luke Taylor diff --git a/web/src/main/java/org/springframework/security/web/session/HttpSessionDestroyedEvent.java b/web/src/main/java/org/springframework/security/web/session/HttpSessionDestroyedEvent.java index d3ac900ad4..6a3ff18d1e 100644 --- a/web/src/main/java/org/springframework/security/web/session/HttpSessionDestroyedEvent.java +++ b/web/src/main/java/org/springframework/security/web/session/HttpSessionDestroyedEvent.java @@ -27,7 +27,7 @@ import org.springframework.security.core.session.SessionDestroyedEvent; /** * Published by the {@link HttpSessionEventPublisher} when a HttpSession is removed from - * the container + * the container. * * @author Ray Krueger * @author Luke Taylor diff --git a/web/src/main/java/org/springframework/security/web/session/HttpSessionEventPublisher.java b/web/src/main/java/org/springframework/security/web/session/HttpSessionEventPublisher.java index 9e44c85f70..c991331038 100644 --- a/web/src/main/java/org/springframework/security/web/session/HttpSessionEventPublisher.java +++ b/web/src/main/java/org/springframework/security/web/session/HttpSessionEventPublisher.java @@ -75,6 +75,8 @@ public class HttpSessionEventPublisher implements HttpSessionListener, HttpSessi } /** + * Handles the HttpSessionEvent by publishing a {@link HttpSessionIdChangedEvent} to + * the application appContext. * @inheritDoc */ @Override diff --git a/web/src/main/java/org/springframework/security/web/session/InvalidSessionAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/session/InvalidSessionAccessDeniedHandler.java index a7ae89f7b2..b671b60033 100644 --- a/web/src/main/java/org/springframework/security/web/session/InvalidSessionAccessDeniedHandler.java +++ b/web/src/main/java/org/springframework/security/web/session/InvalidSessionAccessDeniedHandler.java @@ -27,7 +27,7 @@ import org.springframework.security.web.access.AccessDeniedHandler; import org.springframework.util.Assert; /** - * An adapter of {@link InvalidSessionStrategy} to {@link AccessDeniedHandler} + * An adapter of {@link InvalidSessionStrategy} to {@link AccessDeniedHandler}. * * @author Rob Winch * @since 3.2 @@ -37,7 +37,7 @@ public final class InvalidSessionAccessDeniedHandler implements AccessDeniedHand private final InvalidSessionStrategy invalidSessionStrategy; /** - * Creates a new instance + * Creates a new instance. * @param invalidSessionStrategy the {@link InvalidSessionStrategy} to delegate to */ public InvalidSessionAccessDeniedHandler(InvalidSessionStrategy invalidSessionStrategy) { diff --git a/web/src/main/java/org/springframework/security/web/session/SessionInformationExpiredEvent.java b/web/src/main/java/org/springframework/security/web/session/SessionInformationExpiredEvent.java index fd474654df..83e3cde741 100644 --- a/web/src/main/java/org/springframework/security/web/session/SessionInformationExpiredEvent.java +++ b/web/src/main/java/org/springframework/security/web/session/SessionInformationExpiredEvent.java @@ -41,7 +41,7 @@ public final class SessionInformationExpiredEvent extends ApplicationEvent { private final @Nullable FilterChain filterChain; /** - * Creates a new instance + * Creates a new instance. * @param sessionInformation the SessionInformation that is expired * @param request the HttpServletRequest * @param response the HttpServletResponse @@ -52,7 +52,7 @@ public final class SessionInformationExpiredEvent extends ApplicationEvent { } /** - * Creates a new instance + * Creates a new instance. * @param sessionInformation the SessionInformation that is expired * @param request the HttpServletRequest * @param response the HttpServletResponse @@ -70,6 +70,7 @@ public final class SessionInformationExpiredEvent extends ApplicationEvent { } /** + * Returns the request. * @return the request */ public HttpServletRequest getRequest() { @@ -77,6 +78,7 @@ public final class SessionInformationExpiredEvent extends ApplicationEvent { } /** + * Returns the response. * @return the response */ public HttpServletResponse getResponse() { @@ -88,6 +90,7 @@ public final class SessionInformationExpiredEvent extends ApplicationEvent { } /** + * Returns the filter chain. * @return the filter chain. Can be {@code null}. * @since 6.4 */ diff --git a/web/src/main/java/org/springframework/security/web/transport/HttpsRedirectFilter.java b/web/src/main/java/org/springframework/security/web/transport/HttpsRedirectFilter.java index a67cd11d63..1ba837b850 100644 --- a/web/src/main/java/org/springframework/security/web/transport/HttpsRedirectFilter.java +++ b/web/src/main/java/org/springframework/security/web/transport/HttpsRedirectFilter.java @@ -72,7 +72,7 @@ public final class HttpsRedirectFilter extends OncePerRequestFilter { } /** - * Use this {@link PortMapper} for mapping custom ports + * Use this {@link PortMapper} for mapping custom ports. * @param portMapper the {@link PortMapper} to use */ public void setPortMapper(PortMapper portMapper) { diff --git a/web/src/main/java/org/springframework/security/web/util/OnCommittedResponseWrapper.java b/web/src/main/java/org/springframework/security/web/util/OnCommittedResponseWrapper.java index abc57bc175..51674bbc20 100644 --- a/web/src/main/java/org/springframework/security/web/util/OnCommittedResponseWrapper.java +++ b/web/src/main/java/org/springframework/security/web/util/OnCommittedResponseWrapper.java @@ -51,6 +51,7 @@ public abstract class OnCommittedResponseWrapper extends HttpServletResponseWrap private long contentWritten; /** + * Creates a new instance. * @param response the response to be wrapped */ public OnCommittedResponseWrapper(HttpServletResponse response) { @@ -131,13 +132,13 @@ public abstract class OnCommittedResponseWrapper extends HttpServletResponseWrap /** * Implement the logic for handling the - * {@link jakarta.servlet.http.HttpServletResponse} being committed + * {@link jakarta.servlet.http.HttpServletResponse} being committed. */ protected abstract void onResponseCommitted(); /** * Makes sure {@link OnCommittedResponseWrapper#onResponseCommitted()} is invoked - * before calling the superclass sendError() + * before calling the superclass sendError(). */ @Override public final void sendError(int sc) throws IOException { @@ -147,7 +148,7 @@ public abstract class OnCommittedResponseWrapper extends HttpServletResponseWrap /** * Makes sure {@link OnCommittedResponseWrapper#onResponseCommitted()} is invoked - * before calling the superclass sendError() + * before calling the superclass sendError(). */ @Override public final void sendError(int sc, @Nullable String msg) throws IOException { @@ -157,7 +158,7 @@ public abstract class OnCommittedResponseWrapper extends HttpServletResponseWrap /** * Makes sure {@link OnCommittedResponseWrapper#onResponseCommitted()} is invoked - * before calling the superclass sendRedirect() + * before calling the superclass sendRedirect(). */ @Override public final void sendRedirect(@Nullable String location) throws IOException { @@ -168,7 +169,7 @@ public abstract class OnCommittedResponseWrapper extends HttpServletResponseWrap /** * Makes sure {@link OnCommittedResponseWrapper#onResponseCommitted()} is invoked * before calling the calling getOutputStream().close() or - * getOutputStream().flush() + * getOutputStream().flush(). */ @Override public ServletOutputStream getOutputStream() throws IOException { @@ -178,7 +179,7 @@ public abstract class OnCommittedResponseWrapper extends HttpServletResponseWrap /** * Makes sure {@link OnCommittedResponseWrapper#onResponseCommitted()} is invoked * before calling the getWriter().close() or - * getWriter().flush() + * getWriter().flush(). */ @Override public PrintWriter getWriter() throws IOException { @@ -187,7 +188,7 @@ public abstract class OnCommittedResponseWrapper extends HttpServletResponseWrap /** * Makes sure {@link OnCommittedResponseWrapper#onResponseCommitted()} is invoked - * before calling the superclass flushBuffer() + * before calling the superclass flushBuffer(). */ @Override public void flushBuffer() throws IOException { diff --git a/web/src/main/java/org/springframework/security/web/util/matcher/AndRequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/matcher/AndRequestMatcher.java index 2655d61719..e06791ada2 100644 --- a/web/src/main/java/org/springframework/security/web/util/matcher/AndRequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/matcher/AndRequestMatcher.java @@ -39,7 +39,7 @@ public final class AndRequestMatcher implements RequestMatcher { private final List requestMatchers; /** - * Creates a new instance + * Creates a new instance. * @param requestMatchers the {@link RequestMatcher} instances to try */ public AndRequestMatcher(List requestMatchers) { @@ -49,7 +49,7 @@ public final class AndRequestMatcher implements RequestMatcher { } /** - * Creates a new instance + * Creates a new instance. * @param requestMatchers the {@link RequestMatcher} instances to try */ public AndRequestMatcher(RequestMatcher... requestMatchers) { diff --git a/web/src/main/java/org/springframework/security/web/util/matcher/DispatcherTypeRequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/matcher/DispatcherTypeRequestMatcher.java index e55cdd44a8..266368ffa8 100644 --- a/web/src/main/java/org/springframework/security/web/util/matcher/DispatcherTypeRequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/matcher/DispatcherTypeRequestMatcher.java @@ -39,7 +39,8 @@ public class DispatcherTypeRequestMatcher implements RequestMatcher { private final @Nullable HttpMethod httpMethod; /** - * Creates an instance which matches requests with the provided {@link DispatcherType} + * Creates an instance which matches requests with the provided + * {@link DispatcherType}. * @param dispatcherType the type to match against */ public DispatcherTypeRequestMatcher(DispatcherType dispatcherType) { @@ -48,7 +49,7 @@ public class DispatcherTypeRequestMatcher implements RequestMatcher { /** * Creates an instance which matches requests with the provided {@link DispatcherType} - * and {@link HttpMethod} + * and {@link HttpMethod}. * @param dispatcherType the type to match against * @param httpMethod the HTTP method to match. May be null to match all methods. */ diff --git a/web/src/main/java/org/springframework/security/web/util/matcher/ELRequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/matcher/ELRequestMatcher.java index 5ab29c7b8a..ef4f1c6e57 100644 --- a/web/src/main/java/org/springframework/security/web/util/matcher/ELRequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/matcher/ELRequestMatcher.java @@ -26,7 +26,7 @@ import org.springframework.security.web.authentication.DelegatingAuthenticationE import org.springframework.util.Assert; /** - * A RequestMatcher implementation which uses a SpEL expression + * A RequestMatcher implementation which uses a SpEL expression. * *

        * With the default EvaluationContext ({@link ELRequestMatcherContext}) you can use @@ -60,7 +60,7 @@ public class ELRequestMatcher implements RequestMatcher { /** * Subclasses can override this methode if they want to use a different EL root - * context + * context. * @return EL root context which is used to evaluate the expression */ public EvaluationContext createELContext(HttpServletRequest request) { diff --git a/web/src/main/java/org/springframework/security/web/util/matcher/MediaTypeRequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/matcher/MediaTypeRequestMatcher.java index c0c73d51c8..8735952f9b 100644 --- a/web/src/main/java/org/springframework/security/web/util/matcher/MediaTypeRequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/matcher/MediaTypeRequestMatcher.java @@ -155,7 +155,7 @@ public final class MediaTypeRequestMatcher implements RequestMatcher { private Set ignoredMediaTypes = Collections.emptySet(); /** - * Creates an instance + * Creates an instance. * @param matchingMediaTypes the {@link MediaType} that will make the http request. * @since 5.2 */ @@ -164,7 +164,7 @@ public final class MediaTypeRequestMatcher implements RequestMatcher { } /** - * Creates an instance + * Creates an instance. * @param matchingMediaTypes the {@link MediaType} that will make the http request. * @since 5.2 */ @@ -173,7 +173,7 @@ public final class MediaTypeRequestMatcher implements RequestMatcher { } /** - * Creates an instance + * Creates an instance. * @param contentNegotiationStrategy the {@link ContentNegotiationStrategy} to use * @param matchingMediaTypes the {@link MediaType} that will make the * {@link RequestMatcher} return true @@ -184,7 +184,7 @@ public final class MediaTypeRequestMatcher implements RequestMatcher { } /** - * Creates an instance + * Creates an instance. * @param contentNegotiationStrategy the {@link ContentNegotiationStrategy} to use * @param matchingMediaTypes the {@link MediaType} that will make the * {@link RequestMatcher} return true diff --git a/web/src/main/java/org/springframework/security/web/util/matcher/NegatedRequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/matcher/NegatedRequestMatcher.java index cb3c031278..34ebb77710 100644 --- a/web/src/main/java/org/springframework/security/web/util/matcher/NegatedRequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/matcher/NegatedRequestMatcher.java @@ -37,7 +37,7 @@ public class NegatedRequestMatcher implements RequestMatcher { private final RequestMatcher requestMatcher; /** - * Creates a new instance + * Creates a new instance. * @param requestMatcher the {@link RequestMatcher} that will be negated. */ public NegatedRequestMatcher(RequestMatcher requestMatcher) { diff --git a/web/src/main/java/org/springframework/security/web/util/matcher/OrRequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/matcher/OrRequestMatcher.java index a9c91d7fe7..cf9b850617 100644 --- a/web/src/main/java/org/springframework/security/web/util/matcher/OrRequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/matcher/OrRequestMatcher.java @@ -37,7 +37,7 @@ public final class OrRequestMatcher implements RequestMatcher { private final List requestMatchers; /** - * Creates a new instance + * Creates a new instance. * @param requestMatchers the {@link RequestMatcher} instances to try */ public OrRequestMatcher(List requestMatchers) { @@ -47,7 +47,7 @@ public final class OrRequestMatcher implements RequestMatcher { } /** - * Creates a new instance + * Creates a new instance. * @param requestMatchers the {@link RequestMatcher} instances to try */ public OrRequestMatcher(RequestMatcher... requestMatchers) { diff --git a/web/src/main/java/org/springframework/security/web/util/matcher/RequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/matcher/RequestMatcher.java index c86c2475de..a76cfcf1d4 100644 --- a/web/src/main/java/org/springframework/security/web/util/matcher/RequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/matcher/RequestMatcher.java @@ -52,7 +52,7 @@ public interface RequestMatcher { /** * The result of matching against an HttpServletRequest contains the status, true or - * false, of the match and if present, any variables extracted from the match + * false, of the match and if present, any variables extracted from the match. * * @since 5.2 */ @@ -68,6 +68,7 @@ public interface RequestMatcher { } /** + * Returns whether the comparison against the HttpServletRequest produced a match. * @return true if the comparison against the HttpServletRequest produced a * successful match */ @@ -77,7 +78,7 @@ public interface RequestMatcher { /** * Returns the extracted variable values where the key is the variable name and - * the value is the variable value + * the value is the variable value. * @return a map containing key-value pairs representing extracted variable names * and variable values */ @@ -86,7 +87,7 @@ public interface RequestMatcher { } /** - * Creates an instance of {@link MatchResult} that is a match with no variables + * Creates an instance of {@link MatchResult} that is a match with no variables. * @return {@link MatchResult} that is a match with no variables */ public static MatchResult match() { @@ -95,7 +96,7 @@ public interface RequestMatcher { /** * Creates an instance of {@link MatchResult} that is a match with the specified - * variables + * variables. * @param variables the specified variables * @return {@link MatchResult} that is a match with the specified variables */ diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AttestationConveyancePreference.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AttestationConveyancePreference.java index 1241faf132..849dfa5103 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AttestationConveyancePreference.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AttestationConveyancePreference.java @@ -87,7 +87,7 @@ public final class AttestationConveyancePreference implements Serializable { } /** - * Gets an instance of {@link AttestationConveyancePreference} + * Gets an instance of {@link AttestationConveyancePreference}. * @param value the {@link #getValue()} * @return an {@link AttestationConveyancePreference} */ diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAssertionResponse.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAssertionResponse.java index a29e1c22f6..ffa3948d7e 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAssertionResponse.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAssertionResponse.java @@ -122,7 +122,7 @@ public final class AuthenticatorAssertionResponse extends AuthenticatorResponse } /** - * Creates a new {@link AuthenticatorAssertionResponseBuilder} + * Creates a new {@link AuthenticatorAssertionResponseBuilder}. * @return the {@link AuthenticatorAssertionResponseBuilder} */ public static AuthenticatorAssertionResponseBuilder builder() { @@ -151,7 +151,7 @@ public final class AuthenticatorAssertionResponse extends AuthenticatorResponse } /** - * Set the {@link #getAuthenticatorData()} property + * Set the {@link #getAuthenticatorData()} property. * @param authenticatorData the authenticator data. * @return the {@link AuthenticatorAssertionResponseBuilder} */ @@ -161,7 +161,7 @@ public final class AuthenticatorAssertionResponse extends AuthenticatorResponse } /** - * Set the {@link #getSignature()} property + * Set the {@link #getSignature()} property. * @param signature the signature * @return the {@link AuthenticatorAssertionResponseBuilder} */ @@ -171,7 +171,7 @@ public final class AuthenticatorAssertionResponse extends AuthenticatorResponse } /** - * Set the {@link #getUserHandle()} property + * Set the {@link #getUserHandle()} property. * @param userHandle the user handle * @return the {@link AuthenticatorAssertionResponseBuilder} */ @@ -181,7 +181,7 @@ public final class AuthenticatorAssertionResponse extends AuthenticatorResponse } /** - * Set the {@link #attestationObject} property + * Set the {@link #attestationObject} property. * @param attestationObject the attestation object * @return the {@link AuthenticatorAssertionResponseBuilder} */ @@ -191,7 +191,7 @@ public final class AuthenticatorAssertionResponse extends AuthenticatorResponse } /** - * Set the {@link #getClientDataJSON()} property + * Set the {@link #getClientDataJSON()} property. * @param clientDataJSON the client data JSON * @return the {@link AuthenticatorAssertionResponseBuilder} */ @@ -201,7 +201,7 @@ public final class AuthenticatorAssertionResponse extends AuthenticatorResponse } /** - * Builds the {@link AuthenticatorAssertionResponse} + * Builds the {@link AuthenticatorAssertionResponse}. * @return the {@link AuthenticatorAssertionResponse} */ public AuthenticatorAssertionResponse build() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAttestationResponse.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAttestationResponse.java index 10793a45a9..dde5f37b45 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAttestationResponse.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorAttestationResponse.java @@ -66,7 +66,7 @@ public final class AuthenticatorAttestationResponse extends AuthenticatorRespons * The transports * returns the transports + * "https://www.w3.org/TR/webauthn-3/#dom-authenticatorattestationresponse-transports-slot">transports. * @return the transports */ public @Nullable List getTransports() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorResponse.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorResponse.java index 7fef56e095..3288274be9 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorResponse.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorResponse.java @@ -33,7 +33,7 @@ public abstract class AuthenticatorResponse implements Serializable { private final Bytes clientDataJSON; /** - * Creates a new instance + * Creates a new instance. * @param clientDataJSON the {@link #getClientDataJSON()} */ AuthenticatorResponse(Bytes clientDataJSON) { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorSelectionCriteria.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorSelectionCriteria.java index 4bd23942c2..e0d2b193f4 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorSelectionCriteria.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/AuthenticatorSelectionCriteria.java @@ -51,7 +51,7 @@ public final class AuthenticatorSelectionCriteria implements Serializable { // compatibility with WebAuthn Level 1 /** - * Creates a new instance + * Creates a new instance. * @param authenticatorAttachment the authenticator attachment * @param residentKey the resident key requirement * @param userVerification the user verification @@ -109,7 +109,7 @@ public final class AuthenticatorSelectionCriteria implements Serializable { } /** - * Creates a new {@link AuthenticatorSelectionCriteriaBuilder} + * Creates a new {@link AuthenticatorSelectionCriteriaBuilder}. * @return a new {@link AuthenticatorSelectionCriteriaBuilder} */ public static AuthenticatorSelectionCriteriaBuilder builder() { @@ -117,7 +117,7 @@ public final class AuthenticatorSelectionCriteria implements Serializable { } /** - * Creates a {@link AuthenticatorSelectionCriteria} + * Creates a {@link AuthenticatorSelectionCriteria}. * * @author Rob Winch * @since 6.4 @@ -166,7 +166,7 @@ public final class AuthenticatorSelectionCriteria implements Serializable { } /** - * Builds a {@link AuthenticatorSelectionCriteria} + * Builds a {@link AuthenticatorSelectionCriteria}. * @return a new {@link AuthenticatorSelectionCriteria} */ public AuthenticatorSelectionCriteria build() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/Bytes.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/Bytes.java index 7827227a49..66d86f0500 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/Bytes.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/Bytes.java @@ -46,7 +46,7 @@ public final class Bytes implements Serializable { private final byte[] bytes; /** - * Creates a new instance + * Creates a new instance. * @param bytes the raw base64UrlString that will be encoded. */ public Bytes(byte[] bytes) { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialPropertiesOutput.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialPropertiesOutput.java index d22966d6ee..c61258a2cd 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialPropertiesOutput.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialPropertiesOutput.java @@ -59,7 +59,7 @@ public class CredentialPropertiesOutput } /** - * The output for {@link CredentialPropertiesOutput} + * The output for {@link CredentialPropertiesOutput}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialRecord.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialRecord.java index 7611e5f06c..b9ae2ea422 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialRecord.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/CredentialRecord.java @@ -34,7 +34,7 @@ public interface CredentialRecord { /** * The credential.type + * "https://www.w3.org/TR/webauthn-3/#abstract-opdef-credential-record-type">credential.type. * @return */ @Nullable PublicKeyCredentialType getCredentialType(); @@ -48,14 +48,14 @@ public interface CredentialRecord { /** * The publicKey + * "https://www.w3.org/TR/webauthn-3/#abstract-opdef-credential-record-publickey">publicKey. * @return */ PublicKeyCose getPublicKey(); /** * The authData.signCount + * "https://www.w3.org/TR/webauthn-3/#abstract-opdef-credential-record-signcount">authData.signCount. * @return */ long getSignatureCount(); @@ -94,7 +94,7 @@ public interface CredentialRecord { boolean isBackupState(); /** - * A reference to the associated {@link PublicKeyCredentialUserEntity#getId()} + * A reference to the associated {@link PublicKeyCredentialUserEntity#getId()}. * @return */ Bytes getUserEntityUserId(); diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutableAuthenticationExtensionsClientInput.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutableAuthenticationExtensionsClientInput.java index cd4cad64df..2e6289571f 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutableAuthenticationExtensionsClientInput.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutableAuthenticationExtensionsClientInput.java @@ -42,7 +42,7 @@ public class ImmutableAuthenticationExtensionsClientInput implements Authenti private final T input; /** - * Creates a new instance + * Creates a new instance. * @param extensionId the extension id. * @param input the input. */ diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCose.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCose.java index 97f29acdc7..c2cfebe12d 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCose.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCose.java @@ -24,7 +24,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.util.Assert; /** - * An immutable {@link PublicKeyCose} + * An immutable {@link PublicKeyCose}. * * @author Rob Winch * @since 6.4 @@ -48,7 +48,7 @@ public class ImmutablePublicKeyCose implements PublicKeyCose { } /** - * Creates a new instance form a Base64 URL encoded String + * Creates a new instance form a Base64 URL encoded String. * @param base64EncodedString the base64EncodedString encoded String * @return */ diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCredentialUserEntity.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCredentialUserEntity.java index 39f62c1e46..b0f2bfb4c4 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCredentialUserEntity.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/ImmutablePublicKeyCredentialUserEntity.java @@ -129,7 +129,7 @@ public final class ImmutablePublicKeyCredentialUserEntity implements PublicKeyCr } /** - * Create a new {@link PublicKeyCredentialUserEntityBuilder} + * Create a new {@link PublicKeyCredentialUserEntityBuilder}. * @return a new {@link PublicKeyCredentialUserEntityBuilder} */ public static PublicKeyCredentialUserEntityBuilder builder() { @@ -202,7 +202,7 @@ public final class ImmutablePublicKeyCredentialUserEntity implements PublicKeyCr } /** - * Builds a new {@link PublicKeyCredentialUserEntity} + * Builds a new {@link PublicKeyCredentialUserEntity}. * @return a new {@link PublicKeyCredentialUserEntity} */ public PublicKeyCredentialUserEntity build() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredential.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredential.java index bba7692e8a..4f6714ede9 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredential.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredential.java @@ -126,7 +126,7 @@ public final class PublicKeyCredential implemen } /** - * Creates a new {@link PublicKeyCredentialBuilder} + * Creates a new {@link PublicKeyCredentialBuilder}. * @param the response type * @return the {@link PublicKeyCredentialBuilder} */ @@ -135,7 +135,7 @@ public final class PublicKeyCredential implemen } /** - * The {@link PublicKeyCredentialBuilder} + * The {@link PublicKeyCredentialBuilder}. * * @param the response type * @author Rob Winch @@ -162,7 +162,7 @@ public final class PublicKeyCredential implemen } /** - * Sets the {@link #getId()} property + * Sets the {@link #getId()} property. * @param id the id * @return the PublicKeyCredentialBuilder */ @@ -224,7 +224,7 @@ public final class PublicKeyCredential implemen } /** - * Creates a new {@link PublicKeyCredential} + * Creates a new {@link PublicKeyCredential}. * @return a new {@link PublicKeyCredential} */ public PublicKeyCredential build() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialCreationOptions.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialCreationOptions.java index 47161f950c..95322fb40b 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialCreationOptions.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialCreationOptions.java @@ -174,7 +174,7 @@ public final class PublicKeyCredentialCreationOptions implements Serializable { } /** - * Creates a new {@link PublicKeyCredentialCreationOptions} + * Creates a new {@link PublicKeyCredentialCreationOptions}. * @return a new {@link PublicKeyCredentialCreationOptions} */ public static PublicKeyCredentialCreationOptionsBuilder builder() { @@ -332,7 +332,7 @@ public final class PublicKeyCredentialCreationOptions implements Serializable { } /** - * Builds a new {@link PublicKeyCredentialCreationOptions} + * Builds a new {@link PublicKeyCredentialCreationOptions}. * @return the new {@link PublicKeyCredentialCreationOptions} */ public PublicKeyCredentialCreationOptions build() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialDescriptor.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialDescriptor.java index 96f4ab9f0b..b45d7e65e0 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialDescriptor.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialDescriptor.java @@ -85,7 +85,7 @@ public final class PublicKeyCredentialDescriptor implements Serializable { } /** - * Creates a new {@link PublicKeyCredentialDescriptorBuilder} + * Creates a new {@link PublicKeyCredentialDescriptorBuilder}. * @return a new {@link PublicKeyCredentialDescriptorBuilder} */ public static PublicKeyCredentialDescriptorBuilder builder() { @@ -93,7 +93,7 @@ public final class PublicKeyCredentialDescriptor implements Serializable { } /** - * Used to create {@link PublicKeyCredentialDescriptor} + * Used to create {@link PublicKeyCredentialDescriptor}. * * @author Rob Winch * @since 6.4 @@ -149,7 +149,7 @@ public final class PublicKeyCredentialDescriptor implements Serializable { } /** - * Create a new {@link PublicKeyCredentialDescriptor} + * Create a new {@link PublicKeyCredentialDescriptor}. * @return a new {@link PublicKeyCredentialDescriptor} */ public PublicKeyCredentialDescriptor build() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRequestOptions.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRequestOptions.java index 4d86a9bd3e..f142364ce1 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRequestOptions.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRequestOptions.java @@ -133,7 +133,7 @@ public final class PublicKeyCredentialRequestOptions implements Serializable { } /** - * Creates a {@link PublicKeyCredentialRequestOptionsBuilder} + * Creates a {@link PublicKeyCredentialRequestOptionsBuilder}. * @return the {@link PublicKeyCredentialRequestOptionsBuilder} */ public static PublicKeyCredentialRequestOptionsBuilder builder() { @@ -196,7 +196,7 @@ public final class PublicKeyCredentialRequestOptions implements Serializable { } /** - * Sets the {@link #getAllowCredentials()} property + * Sets the {@link #getAllowCredentials()} property. * @param allowCredentials the allowed credentials * @return the {@link PublicKeyCredentialRequestOptionsBuilder} */ @@ -219,7 +219,7 @@ public final class PublicKeyCredentialRequestOptions implements Serializable { } /** - * Sets the {@link #getExtensions()} property + * Sets the {@link #getExtensions()} property. * @param extensions the extensions * @return the {@link PublicKeyCredentialRequestOptionsBuilder} */ @@ -229,7 +229,7 @@ public final class PublicKeyCredentialRequestOptions implements Serializable { } /** - * Allows customizing the {@link PublicKeyCredentialRequestOptionsBuilder} + * Allows customizing the {@link PublicKeyCredentialRequestOptionsBuilder}. * @param customizer the {@link Consumer} used to customize the builder * @return the {@link PublicKeyCredentialRequestOptionsBuilder} */ @@ -240,7 +240,7 @@ public final class PublicKeyCredentialRequestOptions implements Serializable { } /** - * Builds a new {@link PublicKeyCredentialRequestOptions} + * Builds a new {@link PublicKeyCredentialRequestOptions}. * @return a new {@link PublicKeyCredentialRequestOptions} */ public PublicKeyCredentialRequestOptions build() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRpEntity.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRpEntity.java index 20049f0fcc..f1ab4f3c73 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRpEntity.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/PublicKeyCredentialRpEntity.java @@ -70,7 +70,7 @@ public final class PublicKeyCredentialRpEntity implements Serializable { } /** - * Creates a new {@link PublicKeyCredentialRpEntityBuilder} + * Creates a new {@link PublicKeyCredentialRpEntityBuilder}. * @return a new {@link PublicKeyCredentialRpEntityBuilder} */ public static PublicKeyCredentialRpEntityBuilder builder() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/UserVerificationRequirement.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/UserVerificationRequirement.java index 71b819e1ab..4df7bb7a41 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/api/UserVerificationRequirement.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/api/UserVerificationRequirement.java @@ -68,7 +68,7 @@ public final class UserVerificationRequirement implements Serializable { } /** - * Gets the value + * Gets the value. * @return the value */ public String getValue() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthentication.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthentication.java index bb5b462e92..0f1adfbd28 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthentication.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthentication.java @@ -80,7 +80,7 @@ public class WebAuthnAuthentication extends AbstractAuthenticationToken { } /** - * A builder of {@link WebAuthnAuthentication} instances + * A builder of {@link WebAuthnAuthentication} instances. * * @since 7.0 */ diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthenticationRequestToken.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthenticationRequestToken.java index e10aba38f8..6e6a64d4c6 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthenticationRequestToken.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/authentication/WebAuthnAuthenticationRequestToken.java @@ -51,7 +51,7 @@ public class WebAuthnAuthenticationRequestToken extends AbstractAuthenticationTo } /** - * Gets the {@link RelyingPartyAuthenticationRequest} + * Gets the {@link RelyingPartyAuthenticationRequest}. * @return the {@link RelyingPartyAuthenticationRequest} */ public RelyingPartyAuthenticationRequest getWebAuthnRequest() { diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Mixin.java index 489acebfff..9581f07f44 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Mixin.java @@ -21,7 +21,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AttestationConveyancePreference; /** - * Jackson mixin for {@link AttestationConveyancePreference} + * Jackson mixin for {@link AttestationConveyancePreference}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Serializer.java index 99a93b4227..a9ba4d679c 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.AttestationConveyancePreference; /** - * Jackson serializer for {@link AttestationConveyancePreference} + * Jackson serializer for {@link AttestationConveyancePreference}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceMixin.java index 41140d54fd..564531f64e 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceMixin.java @@ -21,7 +21,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AttestationConveyancePreference; /** - * Jackson mixin for {@link AttestationConveyancePreference} + * Jackson mixin for {@link AttestationConveyancePreference}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceSerializer.java index 7eea519353..c2c215e06f 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AttestationConveyancePreferenceSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.AttestationConveyancePreference; /** - * Jackson serializer for {@link AttestationConveyancePreference} + * Jackson serializer for {@link AttestationConveyancePreference}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputJackson2Mixin.java index fe443ba82d..0a07dac629 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputJackson2Mixin.java @@ -21,7 +21,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticationExtensionsClientInputs; /** - * Jackson mixin for {@link AuthenticationExtensionsClientInputs} + * Jackson mixin for {@link AuthenticationExtensionsClientInputs}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputMixin.java index 76b5b7113d..2d8f39f610 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputMixin.java @@ -21,7 +21,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticationExtensionsClientInputs; /** - * Jackson mixin for {@link AuthenticationExtensionsClientInputs} + * Jackson mixin for {@link AuthenticationExtensionsClientInputs}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsJackson2Mixin.java index 46704bea7d..96e7e81542 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsJackson2Mixin.java @@ -21,7 +21,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticationExtensionsClientInputs; /** - * Jackson mixin for {@link AuthenticationExtensionsClientInputs} + * Jackson mixin for {@link AuthenticationExtensionsClientInputs}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsMixin.java index 11e9ed9ad7..7cbb1d8894 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientInputsMixin.java @@ -21,7 +21,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticationExtensionsClientInputs; /** - * Jackson mixin for {@link AuthenticationExtensionsClientInputs} + * Jackson mixin for {@link AuthenticationExtensionsClientInputs}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsJackson2Mixin.java index 75ab461e47..10da8a80bc 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsJackson2Mixin.java @@ -21,7 +21,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import org.springframework.security.web.webauthn.api.AuthenticationExtensionsClientOutputs; /** - * Jackson mixin for {@link AuthenticationExtensionsClientOutputs} + * Jackson mixin for {@link AuthenticationExtensionsClientOutputs}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsMixin.java index c01f264426..1dfe9a125d 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticationExtensionsClientOutputsMixin.java @@ -21,7 +21,7 @@ import tools.jackson.databind.annotation.JsonDeserialize; import org.springframework.security.web.webauthn.api.AuthenticationExtensionsClientOutputs; /** - * Jackson mixin for {@link AuthenticationExtensionsClientOutputs} + * Jackson mixin for {@link AuthenticationExtensionsClientOutputs}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseJackson2Mixin.java index 3b6eba49ca..721f7f0b23 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder; import org.springframework.security.web.webauthn.api.AuthenticatorAssertionResponse; /** - * Jackson mixin for {@link AuthenticatorAssertionResponse} + * Jackson mixin for {@link AuthenticatorAssertionResponse}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseMixin.java index 4e6c51dfa6..4121f346e2 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAssertionResponseMixin.java @@ -22,7 +22,7 @@ import tools.jackson.databind.annotation.JsonPOJOBuilder; import org.springframework.security.web.webauthn.api.AuthenticatorAssertionResponse; /** - * Jackson mixin for {@link AuthenticatorAssertionResponse} + * Jackson mixin for {@link AuthenticatorAssertionResponse}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentDeserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentDeserializer.java index 46965fe508..afa962adaa 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentDeserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentDeserializer.java @@ -25,7 +25,7 @@ import tools.jackson.databind.deser.std.StdDeserializer; import org.springframework.security.web.webauthn.api.AuthenticatorAttachment; /** - * Jackson deserializer for {@link AuthenticatorAttachment} + * Jackson deserializer for {@link AuthenticatorAttachment}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Deserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Deserializer.java index 98cbf670bf..004241a328 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Deserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Deserializer.java @@ -27,7 +27,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.web.webauthn.api.AuthenticatorAttachment; /** - * Jackson deserializer for {@link AuthenticatorAttachment} + * Jackson deserializer for {@link AuthenticatorAttachment}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Mixin.java index 409f1a2f47..fba89a22be 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticatorAttachment; /** - * Jackson mixin for {@link AuthenticatorAttachment} + * Jackson mixin for {@link AuthenticatorAttachment}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Serializer.java index 285f0d1dd8..d95d4a2b5f 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.AuthenticatorAttachment; /** - * Jackson serializer for {@link AuthenticatorAttachment} + * Jackson serializer for {@link AuthenticatorAttachment}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentMixin.java index df4a397754..4c3b56e27c 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentMixin.java @@ -22,7 +22,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticatorAttachment; /** - * Jackson mixin for {@link AuthenticatorAttachment} + * Jackson mixin for {@link AuthenticatorAttachment}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentSerializer.java index 9a854420fe..37d69340f1 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttachmentSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.AuthenticatorAttachment; /** - * Jackson serializer for {@link AuthenticatorAttachment} + * Jackson serializer for {@link AuthenticatorAttachment}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseJackson2Mixin.java index 98d23f221d..b0fdf80161 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseJackson2Mixin.java @@ -27,7 +27,7 @@ import org.springframework.security.web.webauthn.api.AuthenticatorAttestationRes import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson mixin for {@link AuthenticatorAttestationResponse} + * Jackson mixin for {@link AuthenticatorAttestationResponse}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseMixin.java index 25c5c8f2c4..a6b0ec4b20 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorAttestationResponseMixin.java @@ -27,7 +27,7 @@ import org.springframework.security.web.webauthn.api.AuthenticatorAttestationRes import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson mixin for {@link AuthenticatorAttestationResponse} + * Jackson mixin for {@link AuthenticatorAttestationResponse}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorSelectionCriteriaMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorSelectionCriteriaMixin.java index 61ed11e711..d612cc86da 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorSelectionCriteriaMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorSelectionCriteriaMixin.java @@ -17,16 +17,17 @@ package org.springframework.security.web.webauthn.jackson; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonInclude.Include; import org.springframework.security.web.webauthn.api.AuthenticatorSelectionCriteria; /** - * Jackson mixin for {@link AuthenticatorSelectionCriteria} + * Jackson mixin for {@link AuthenticatorSelectionCriteria}. * * @author Rob Winch * @since 6.4 */ -@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonInclude(Include.NON_NULL) abstract class AuthenticatorSelectionCriteriaMixin { } diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportDeserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportDeserializer.java index b8cef326d6..cfbedd359f 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportDeserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportDeserializer.java @@ -25,7 +25,7 @@ import tools.jackson.databind.deser.std.StdDeserializer; import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson deserializer for {@link AuthenticatorTransport} + * Jackson deserializer for {@link AuthenticatorTransport}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Deserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Deserializer.java index 3cea2df11e..83cf58cb7f 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Deserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Deserializer.java @@ -27,7 +27,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson deserializer for {@link AuthenticatorTransport} + * Jackson deserializer for {@link AuthenticatorTransport}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Mixin.java index 4f55835069..35bf0ee815 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson mixin for {@link AuthenticatorTransport} + * Jackson mixin for {@link AuthenticatorTransport}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Serializer.java index 229c807174..34cb9bf130 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.SerializerProvider; import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson serializer for {@link AuthenticatorTransport} + * Jackson serializer for {@link AuthenticatorTransport}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportMixin.java index 9be251fce6..543a985a94 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportMixin.java @@ -22,7 +22,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson mixin for {@link AuthenticatorTransport} + * Jackson mixin for {@link AuthenticatorTransport}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportSerializer.java index 3e9999f72c..d586d8fbfd 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/AuthenticatorTransportSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ValueSerializer; import org.springframework.security.web.webauthn.api.AuthenticatorTransport; /** - * Jackson serializer for {@link AuthenticatorTransport} + * Jackson serializer for {@link AuthenticatorTransport}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Mixin.java index b41a2db0e8..e47c46a7ee 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.Bytes; /** - * Jackson mixin for {@link Bytes} + * Jackson mixin for {@link Bytes}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Serializer.java index 88daaa0f17..a5239c746a 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.Bytes; /** - * Jackson serializer for {@link Bytes} + * Jackson serializer for {@link Bytes}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesMixin.java index 74a256f765..aee93b0eff 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesMixin.java @@ -22,7 +22,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.Bytes; /** - * Jackson mixin for {@link Bytes} + * Jackson mixin for {@link Bytes}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesSerializer.java index 0d2041c435..0b6dfb4ffb 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/BytesSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.Bytes; /** - * Jackson serializer for {@link Bytes} + * Jackson serializer for {@link Bytes}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierDeserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierDeserializer.java index 52191b733f..d2733eb189 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierDeserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierDeserializer.java @@ -25,7 +25,7 @@ import tools.jackson.databind.deser.std.StdDeserializer; import org.springframework.security.web.webauthn.api.COSEAlgorithmIdentifier; /** - * Jackson serializer for {@link COSEAlgorithmIdentifier} + * Jackson serializer for {@link COSEAlgorithmIdentifier}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Deserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Deserializer.java index ba2d2a14c7..04a5a7f1e0 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Deserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Deserializer.java @@ -27,7 +27,7 @@ import org.jspecify.annotations.Nullable; import org.springframework.security.web.webauthn.api.COSEAlgorithmIdentifier; /** - * Jackson serializer for {@link COSEAlgorithmIdentifier} + * Jackson serializer for {@link COSEAlgorithmIdentifier}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Mixin.java index f1ef94cacb..490e426881 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.COSEAlgorithmIdentifier; /** - * Jackson mixin for {@link COSEAlgorithmIdentifier} + * Jackson mixin for {@link COSEAlgorithmIdentifier}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Serializer.java index 9f1a3771c9..d2cf54afbd 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.COSEAlgorithmIdentifier; /** - * Jackson serializer for {@link COSEAlgorithmIdentifier} + * Jackson serializer for {@link COSEAlgorithmIdentifier}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierMixin.java index 2b02f42e33..f606c74d5b 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierMixin.java @@ -22,7 +22,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.COSEAlgorithmIdentifier; /** - * Jackson mixin for {@link COSEAlgorithmIdentifier} + * Jackson mixin for {@link COSEAlgorithmIdentifier}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierSerializer.java index a772606357..29b89bdceb 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/COSEAlgorithmIdentifierSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.COSEAlgorithmIdentifier; /** - * Jackson serializer for {@link COSEAlgorithmIdentifier} + * Jackson serializer for {@link COSEAlgorithmIdentifier}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredProtectAuthenticationExtensionsClientInputJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredProtectAuthenticationExtensionsClientInputJackson2Mixin.java index 1dc9e5d481..0fef0cb77e 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredProtectAuthenticationExtensionsClientInputJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredProtectAuthenticationExtensionsClientInputJackson2Mixin.java @@ -19,6 +19,8 @@ package org.springframework.security.web.webauthn.jackson; import com.fasterxml.jackson.databind.annotation.JsonSerialize; /** + * Jackson mixin for serializing {@code CredProtectAuthenticationExtensionsClientInput}. + * * @deprecated as of 7.0 in favor of * {@link org.springframework.security.web.webauthn.jackson.CredProtectAuthenticationExtensionsClientInputMixin} * based on Jackson 3 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputJackson2Mixin.java index f23f42ff17..48ede8f464 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonProperty; import org.springframework.security.web.webauthn.api.CredentialPropertiesOutput; /** - * Jackson mixin for {@link CredentialPropertiesOutput} + * Jackson mixin for {@link CredentialPropertiesOutput}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputMixin.java index ed82a4a5c8..03fe514308 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/CredentialPropertiesOutputMixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonProperty; import org.springframework.security.web.webauthn.api.CredentialPropertiesOutput; /** - * Jackson mixin for {@link CredentialPropertiesOutput} + * Jackson mixin for {@link CredentialPropertiesOutput}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationJackson2Serializer.java index cce50657ac..d93f69527a 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationJackson2Serializer.java @@ -24,7 +24,7 @@ import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.ser.std.StdSerializer; /** - * Jackson serializer for {@link Duration} + * Jackson serializer for {@link Duration}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationSerializer.java index 9eba908b14..ed86fbd714 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/DurationSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.SerializationContext; import tools.jackson.databind.ser.std.StdSerializer; /** - * Jackson serializer for {@link Duration} + * Jackson serializer for {@link Duration}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ImmutablePublicKeyCredentialUserEntityMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ImmutablePublicKeyCredentialUserEntityMixin.java index 16d41469a6..350936eb6b 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ImmutablePublicKeyCredentialUserEntityMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ImmutablePublicKeyCredentialUserEntityMixin.java @@ -22,7 +22,7 @@ import org.springframework.security.web.webauthn.api.Bytes; import org.springframework.security.web.webauthn.api.ImmutablePublicKeyCredentialUserEntity; /** - * Jackson mixin for {@link ImmutablePublicKeyCredentialUserEntity} + * Jackson mixin for {@link ImmutablePublicKeyCredentialUserEntity}. * * @author Toshiaki Maki * @since 7.0.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsJackson2Mixin.java index 2115f7ef58..97613f5971 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsJackson2Mixin.java @@ -19,13 +19,14 @@ package org.springframework.security.web.webauthn.jackson; import java.time.Duration; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonInclude.Include; import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.jspecify.annotations.Nullable; import org.springframework.security.web.webauthn.api.PublicKeyCredentialCreationOptions; /** - * Jackson mixin for {@link PublicKeyCredentialCreationOptions} + * Jackson mixin for {@link PublicKeyCredentialCreationOptions}. * * @author Rob Winch * @since 6.4 @@ -35,7 +36,7 @@ import org.springframework.security.web.webauthn.api.PublicKeyCredentialCreation */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonInclude(Include.NON_NULL) abstract class PublicKeyCredentialCreationOptionsJackson2Mixin { @JsonSerialize(using = DurationJackson2Serializer.class) diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsMixin.java index 4131e95409..7b6ca36bdd 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialCreationOptionsMixin.java @@ -19,18 +19,19 @@ package org.springframework.security.web.webauthn.jackson; import java.time.Duration; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonInclude.Include; import org.jspecify.annotations.Nullable; import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.PublicKeyCredentialCreationOptions; /** - * Jackson mixin for {@link PublicKeyCredentialCreationOptions} + * Jackson mixin for {@link PublicKeyCredentialCreationOptions}. * * @author Rob Winch * @since 6.4 */ -@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonInclude(Include.NON_NULL) abstract class PublicKeyCredentialCreationOptionsMixin { @JsonSerialize(using = DurationSerializer.class) diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialJackson2Mixin.java index 8e5755f434..194ebf0189 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder; import org.springframework.security.web.webauthn.api.PublicKeyCredential; /** - * Jackson mixin for {@link PublicKeyCredential} + * Jackson mixin for {@link PublicKeyCredential}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialMixin.java index ee9498f07e..cc8b48bdd5 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialMixin.java @@ -22,7 +22,7 @@ import tools.jackson.databind.annotation.JsonPOJOBuilder; import org.springframework.security.web.webauthn.api.PublicKeyCredential; /** - * Jackson mixin for {@link PublicKeyCredential} + * Jackson mixin for {@link PublicKeyCredential}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsJackson2Mixin.java index b95160864e..96acf36843 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsJackson2Mixin.java @@ -19,13 +19,14 @@ package org.springframework.security.web.webauthn.jackson; import java.time.Duration; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonInclude.Include; import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.jspecify.annotations.Nullable; import org.springframework.security.web.webauthn.api.PublicKeyCredentialRequestOptions; /** - * Jackson mixin for {@link PublicKeyCredentialRequestOptions} + * Jackson mixin for {@link PublicKeyCredentialRequestOptions}. * * @author Rob Winch * @since 6.4 @@ -35,7 +36,7 @@ import org.springframework.security.web.webauthn.api.PublicKeyCredentialRequestO */ @SuppressWarnings("removal") @Deprecated(forRemoval = true) -@JsonInclude(content = JsonInclude.Include.NON_NULL) +@JsonInclude(content = Include.NON_NULL) class PublicKeyCredentialRequestOptionsJackson2Mixin { @JsonSerialize(using = DurationJackson2Serializer.class) diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsMixin.java index 67425588f3..ede2076466 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialRequestOptionsMixin.java @@ -19,18 +19,19 @@ package org.springframework.security.web.webauthn.jackson; import java.time.Duration; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonInclude.Include; import org.jspecify.annotations.Nullable; import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.PublicKeyCredentialRequestOptions; /** - * Jackson mixin for {@link PublicKeyCredentialRequestOptions} + * Jackson mixin for {@link PublicKeyCredentialRequestOptions}. * * @author Rob Winch * @since 6.4 */ -@JsonInclude(content = JsonInclude.Include.NON_NULL) +@JsonInclude(content = Include.NON_NULL) class PublicKeyCredentialRequestOptionsMixin { @JsonSerialize(using = DurationSerializer.class) diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeDeserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeDeserializer.java index 7af1ae2b35..9932ff2f2e 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeDeserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeDeserializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.deser.std.StdDeserializer; import org.springframework.security.web.webauthn.api.PublicKeyCredentialType; /** - * Jackson deserializer for {@link PublicKeyCredentialType} + * Jackson deserializer for {@link PublicKeyCredentialType}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Deserializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Deserializer.java index 8173243693..2d14d20b00 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Deserializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Deserializer.java @@ -26,7 +26,7 @@ import com.fasterxml.jackson.databind.deser.std.StdDeserializer; import org.springframework.security.web.webauthn.api.PublicKeyCredentialType; /** - * Jackson deserializer for {@link PublicKeyCredentialType} + * Jackson deserializer for {@link PublicKeyCredentialType}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Mixin.java index 09d579a5e8..658e6de68d 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Mixin.java @@ -22,7 +22,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.PublicKeyCredentialType; /** - * Jackson mixin for {@link PublicKeyCredentialType} + * Jackson mixin for {@link PublicKeyCredentialType}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Serializer.java index d2f71a4e83..ca9a715804 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.PublicKeyCredentialType; /** - * Jackson serializer for {@link PublicKeyCredentialType} + * Jackson serializer for {@link PublicKeyCredentialType}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeMixin.java index 3918c22f95..eb20e7ed8d 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeMixin.java @@ -22,7 +22,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.PublicKeyCredentialType; /** - * Jackson mixin for {@link PublicKeyCredentialType} + * Jackson mixin for {@link PublicKeyCredentialType}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeSerializer.java index e2b08d1388..13fc81a3f4 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/PublicKeyCredentialTypeSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.PublicKeyCredentialType; /** - * Jackson serializer for {@link PublicKeyCredentialType} + * Jackson serializer for {@link PublicKeyCredentialType}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyJackson2Mixin.java index fd179609a8..0b18092496 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyJackson2Mixin.java @@ -23,7 +23,7 @@ import org.springframework.security.web.webauthn.api.PublicKeyCredential; import org.springframework.security.web.webauthn.management.RelyingPartyPublicKey; /** - * Jackson mixin for {@link RelyingPartyPublicKey} + * Jackson mixin for {@link RelyingPartyPublicKey}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyMixin.java index 85419ff986..600808b557 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/RelyingPartyPublicKeyMixin.java @@ -23,7 +23,7 @@ import org.springframework.security.web.webauthn.api.PublicKeyCredential; import org.springframework.security.web.webauthn.management.RelyingPartyPublicKey; /** - * Jackson mixin for {@link RelyingPartyPublicKey} + * Jackson mixin for {@link RelyingPartyPublicKey}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Mixin.java index 26ed140b39..c2436b28e2 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Mixin.java @@ -21,7 +21,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.ResidentKeyRequirement; /** - * Jackson mixin for {@link ResidentKeyRequirement} + * Jackson mixin for {@link ResidentKeyRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Serializer.java index 23947e6454..9192028b0c 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.ResidentKeyRequirement; /** - * Jackson serializer for {@link ResidentKeyRequirement} + * Jackson serializer for {@link ResidentKeyRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementMixin.java index ed24f1f43b..b5d115e24c 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementMixin.java @@ -21,7 +21,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.ResidentKeyRequirement; /** - * Jackson mixin for {@link ResidentKeyRequirement} + * Jackson mixin for {@link ResidentKeyRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementSerializer.java index 58c7ff5dc5..e089513721 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/ResidentKeyRequirementSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.ResidentKeyRequirement; /** - * Jackson serializer for {@link ResidentKeyRequirement} + * Jackson serializer for {@link ResidentKeyRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Mixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Mixin.java index d564ee2e66..2e8f615122 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Mixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Mixin.java @@ -21,7 +21,7 @@ import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.UserVerificationRequirement; /** - * Jackson mixin for {@link UserVerificationRequirement} + * Jackson mixin for {@link UserVerificationRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Serializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Serializer.java index 21e40d1acd..86bc15272f 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Serializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementJackson2Serializer.java @@ -25,7 +25,7 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.UserVerificationRequirement; /** - * Jackson serializer for {@link UserVerificationRequirement} + * Jackson serializer for {@link UserVerificationRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementMixin.java index 32e48eacef..32fc286914 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementMixin.java @@ -21,7 +21,7 @@ import tools.jackson.databind.annotation.JsonSerialize; import org.springframework.security.web.webauthn.api.UserVerificationRequirement; /** - * Jackson mixin for {@link UserVerificationRequirement} + * Jackson mixin for {@link UserVerificationRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementSerializer.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementSerializer.java index 6ac2f344b4..32c259a782 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementSerializer.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/UserVerificationRequirementSerializer.java @@ -24,7 +24,7 @@ import tools.jackson.databind.ser.std.StdSerializer; import org.springframework.security.web.webauthn.api.UserVerificationRequirement; /** - * Jackson serializer for {@link UserVerificationRequirement} + * Jackson serializer for {@link UserVerificationRequirement}. * * @author Rob Winch * @since 6.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/WebAuthnAuthenticationMixin.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/WebAuthnAuthenticationMixin.java index a555932338..68b9f4fcb8 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/WebAuthnAuthenticationMixin.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/jackson/WebAuthnAuthenticationMixin.java @@ -26,7 +26,7 @@ import org.springframework.security.web.webauthn.api.PublicKeyCredentialUserEnti import org.springframework.security.web.webauthn.authentication.WebAuthnAuthentication; /** - * Jackson mixin for {@link WebAuthnAuthentication} + * Jackson mixin for {@link WebAuthnAuthentication}. * * @author Toshiaki Maki * @since 7.0.4 diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/PublicKeyCredentialUserEntityRepository.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/PublicKeyCredentialUserEntityRepository.java index 28d9384e50..ea8d48b2a2 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/PublicKeyCredentialUserEntityRepository.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/PublicKeyCredentialUserEntityRepository.java @@ -31,7 +31,7 @@ public interface PublicKeyCredentialUserEntityRepository { /** * Finds the {@link PublicKeyCredentialUserEntity} by - * {@link PublicKeyCredentialUserEntity#getId()} + * {@link PublicKeyCredentialUserEntity#getId()}. * @param id the id to lookup the username by * @return the username or null if not found. */ diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/RelyingPartyRegistrationRequest.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/RelyingPartyRegistrationRequest.java index 363ca0a0eb..4035ad6bac 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/RelyingPartyRegistrationRequest.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/RelyingPartyRegistrationRequest.java @@ -19,6 +19,8 @@ package org.springframework.security.web.webauthn.management; import org.springframework.security.web.webauthn.api.PublicKeyCredentialCreationOptions; /** + * A request to register a credential with the relying party. + * * @author Rob Winch * @since 6.4 * @see WebAuthnRelyingPartyOperations#registerCredential(RelyingPartyRegistrationRequest) diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/UserCredentialRepository.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/UserCredentialRepository.java index 5749ed536a..f0ca2f9228 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/UserCredentialRepository.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/UserCredentialRepository.java @@ -33,13 +33,13 @@ import org.springframework.security.web.webauthn.api.PublicKeyCredentialUserEnti public interface UserCredentialRepository { /** - * Deletes an entry by credential id + * Deletes an entry by credential id. * @param credentialId {@link CredentialRecord#getCredentialId()} */ void delete(Bytes credentialId); /** - * Saves a {@link CredentialRecord} + * Saves a {@link CredentialRecord}. * @param credentialRecord the {@link CredentialRecord} to save. */ void save(CredentialRecord credentialRecord); diff --git a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/WebAuthnRelyingPartyOperations.java b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/WebAuthnRelyingPartyOperations.java index 0e8222dbd9..a83fc9d946 100644 --- a/webauthn/src/main/java/org/springframework/security/web/webauthn/management/WebAuthnRelyingPartyOperations.java +++ b/webauthn/src/main/java/org/springframework/security/web/webauthn/management/WebAuthnRelyingPartyOperations.java @@ -24,7 +24,7 @@ import org.springframework.security.web.webauthn.api.PublicKeyCredentialUserEnti /** * An API for WebAuthn - * Relying Party Operations + * Relying Party Operations. * * @author Rob Winch * @since 6.4 @@ -62,7 +62,7 @@ public interface WebAuthnRelyingPartyOperations { PublicKeyCredentialRequestOptions createCredentialRequestOptions(PublicKeyCredentialRequestOptionsRequest request); /** - * Authenticates the {@link RelyingPartyAuthenticationRequest} passed in + * Authenticates the {@link RelyingPartyAuthenticationRequest} passed in. * @param request the {@link RelyingPartyAuthenticationRequest} * @return the principal name (e.g. username) if authentication was successful * @throws RuntimeException if authentication fails