Skip to content

Commit 3f7f3da

Browse files
committed
Correct JavaDoc Class Reference
1 parent bb2fd24 commit 3f7f3da

File tree

8 files changed

+21
-35
lines changed

8 files changed

+21
-35
lines changed

config/src/main/java/org/springframework/security/config/annotation/authentication/builders/AuthenticationManagerBuilder.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,7 @@ public class AuthenticationManagerBuilder
6767

6868
/**
6969
* Creates a new instance
70-
* @param objectPostProcessor the
71-
* {@link org.springframework.security.config.annotation.ObjectPostProcessor} instance
72-
* to use.
70+
* @param objectPostProcessor the {@link ObjectPostProcessor} instance to use.
7371
*/
7472
public AuthenticationManagerBuilder(ObjectPostProcessor<Object> objectPostProcessor) {
7573
super(objectPostProcessor, true);

config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/ldap/LdapAuthenticationProviderConfigurer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
import org.springframework.security.config.ObjectPostProcessor;
2626
import org.springframework.security.config.annotation.SecurityConfigurerAdapter;
2727
import org.springframework.security.config.annotation.authentication.ProviderManagerBuilder;
28-
import org.springframework.security.config.annotation.web.configurers.ChannelSecurityConfigurer;
2928
import org.springframework.security.core.authority.mapping.GrantedAuthoritiesMapper;
3029
import org.springframework.security.core.authority.mapping.SimpleAuthorityMapper;
3130
import org.springframework.security.crypto.password.NoOpPasswordEncoder;
@@ -133,7 +132,7 @@ public LdapAuthenticationProviderConfigurer<B> ldapAuthoritiesPopulator(
133132
/**
134133
* Adds an {@link ObjectPostProcessor} for this class.
135134
* @param objectPostProcessor
136-
* @return the {@link ChannelSecurityConfigurer} for further customizations
135+
* @return the {@link LdapAuthenticationProviderConfigurer} for further customizations
137136
*/
138137
public LdapAuthenticationProviderConfigurer<B> withObjectPostProcessor(ObjectPostProcessor<?> objectPostProcessor) {
139138
addObjectPostProcessor(objectPostProcessor);

config/src/main/java/org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
import org.springframework.lang.Nullable;
4242
import org.springframework.security.config.ObjectPostProcessor;
4343
import org.springframework.security.config.annotation.web.ServletRegistrationsSupport.RegistrationMapping;
44-
import org.springframework.security.config.annotation.web.configurers.AbstractConfigAttributeRequestMatcherRegistry;
4544
import org.springframework.security.web.servlet.util.matcher.MvcRequestMatcher;
4645
import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
4746
import org.springframework.security.web.util.matcher.AnyRequestMatcher;
@@ -170,7 +169,7 @@ public C dispatcherTypeMatchers(DispatcherType... dispatcherTypes) {
170169

171170
/**
172171
* Associates a list of {@link RequestMatcher} instances with the
173-
* {@link AbstractConfigAttributeRequestMatcherRegistry}
172+
* {@link AbstractRequestMatcherRegistry}
174173
* @param requestMatchers the {@link RequestMatcher} instances
175174
* @return the object that is chained after creating the {@link RequestMatcher}
176175
*/

config/src/main/java/org/springframework/security/config/annotation/web/configurers/DefaultLoginPageConfigurer.java

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,6 @@
3333
* Adds a Filter that will generate a login page if one is not specified otherwise when
3434
* using {@link EnableWebSecurity}.
3535
*
36-
* <p>
37-
* By default an
38-
* {@link org.springframework.security.web.access.channel.InsecureChannelProcessor} and a
39-
* {@link org.springframework.security.web.access.channel.SecureChannelProcessor} will be
40-
* registered.
41-
* </p>
42-
*
4336
* <h2>Security Filters</h2>
4437
*
4538
* The following Filters are conditionally populated
@@ -58,8 +51,6 @@
5851
* The following shared objects are used:
5952
*
6053
* <ul>
61-
* <li>{@link org.springframework.security.web.PortMapper} is used to create the default
62-
* {@link org.springframework.security.web.access.channel.ChannelProcessor} instances</li>
6354
* <li>{@link FormLoginConfigurer} is used to determine if the
6455
* {@link DefaultLoginPageConfigurer} should be added and how to configure it.</li>
6556
* </ul>

messaging/src/main/java/org/springframework/security/messaging/access/intercept/MessageMatcherDelegatingAuthorizationManager.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,9 @@ public Builder.Constraint simpTypeMatchers(SimpMessageType... typesToMatch) {
155155
/**
156156
* Maps a {@link List} of {@link SimpDestinationMessageMatcher} (or
157157
* {@link PathPatternMessageMatcher} if the application has configured a
158-
* {@link org.springframework.security.messaging.util.matcher.PathPatternMessageMatcherBuilderFactoryBean})
159-
* instances without regard to the {@link SimpMessageType}. If no destination is
160-
* found on the Message, then the Matcher returns false.
158+
* {@link PathPatternMessageMatcher.Builder} bean) instances without regard to the
159+
* {@link SimpMessageType}. If no destination is found on the Message, then the
160+
* Matcher returns false.
161161
* @param patterns the patterns to create {@code MessageMatcher}s from.
162162
*/
163163
public Builder.Constraint simpDestMatchers(String... patterns) {
@@ -167,9 +167,9 @@ public Builder.Constraint simpDestMatchers(String... patterns) {
167167
/**
168168
* Maps a {@link List} of {@link SimpDestinationMessageMatcher} (or
169169
* {@link PathPatternMessageMatcher} if the application has configured a
170-
* {@link org.springframework.security.messaging.util.matcher.PathPatternMessageMatcherBuilderFactoryBean})
171-
* instances that match on {@code SimpMessageType.MESSAGE}. If no destination is
172-
* found on the Message, then the Matcher returns false.
170+
* {@link PathPatternMessageMatcher.Builder} bean) instances that match on
171+
* {@code SimpMessageType.MESSAGE}. If no destination is found on the Message,
172+
* then the Matcher returns false.
173173
* @param patterns the patterns to create {@code MessageMatcher}s from.
174174
*/
175175
public Builder.Constraint simpMessageDestMatchers(String... patterns) {
@@ -179,20 +179,20 @@ public Builder.Constraint simpMessageDestMatchers(String... patterns) {
179179
/**
180180
* Maps a {@link List} of {@link SimpDestinationMessageMatcher} (or
181181
* {@link PathPatternMessageMatcher} if the application has configured a
182-
* {@link org.springframework.security.messaging.util.matcher.PathPatternMessageMatcherBuilderFactoryBean})
183-
* instances that match on {@code SimpMessageType.SUBSCRIBE}. If no destination is
184-
* found on the Message, then the Matcher returns false.
182+
* {@link PathPatternMessageMatcher.Builder} bean) instances that match on
183+
* {@code SimpMessageType.SUBSCRIBE}. If no destination is found on the Message,
184+
* then the Matcher returns false.
185185
* @param patterns the patterns to create {@code MessageMatcher}s from.
186186
*/
187187
public Builder.Constraint simpSubscribeDestMatchers(String... patterns) {
188188
return simpDestMatchers(SimpMessageType.SUBSCRIBE, patterns);
189189
}
190190

191191
/**
192-
* Maps a {@link List} of {@link SimpDestinationMessageMatcher} instances, or
192+
* Maps a {@link List} of {@link SimpDestinationMessageMatcher} (or
193193
* {@link PathPatternMessageMatcher} if the application has configured a
194-
* {@link org.springframework.security.messaging.util.matcher.PathPatternMessageMatcherBuilderFactoryBean}.
195-
* If no destination is found on the Message, then the Matcher returns false.
194+
* {@link PathPatternMessageMatcher.Builder} bean) instances. If no destination is
195+
* found on the Message, then the Matcher returns false.
196196
* @param type the {@link SimpMessageType} to match on. If null, the
197197
* {@link SimpMessageType} is not considered for matching.
198198
* @param patterns the patterns to create {@code MessageMatcher}s from.

saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/web/metadata/RequestMatcherMetadataResponseResolver.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ public class RequestMatcherMetadataResponseResolver implements Saml2MetadataResp
6262
private final Saml2MetadataResolver metadata;
6363

6464
/**
65-
* Construct a
66-
* {@link org.springframework.security.saml2.provider.service.metadata.RequestMatcherMetadataResponseResolver}
65+
* Construct a {@link RequestMatcherMetadataResponseResolver}
6766
* @param registrations the source for relying party metadata
6867
* @param metadata the strategy for converting {@link RelyingPartyRegistration}s into
6968
* metadata

web/src/main/java/org/springframework/security/web/access/ExceptionTranslationFilter.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@
5656
* <p>
5757
* If an {@link AuthenticationException} is detected, the filter will launch the
5858
* <code>authenticationEntryPoint</code>. This allows common handling of authentication
59-
* failures originating from any subclass of
60-
* {@link org.springframework.security.access.intercept.AbstractSecurityInterceptor}.
59+
* failures originating from Web or Method Security.
6160
* <p>
6261
* If an {@link AccessDeniedException} is detected, the filter will determine whether or
6362
* not the user is an anonymous user. If they are an anonymous user, the

web/src/main/java/org/springframework/security/web/header/writers/frameoptions/XFrameOptionsHeaderWriter.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
* @author Rob Winch
3131
* @author Ankur Pathak
3232
* @since 3.2
33-
* @see AllowFromStrategy
3433
*/
3534
public final class XFrameOptionsHeaderWriter implements HeaderWriter {
3635

@@ -50,8 +49,9 @@ public XFrameOptionsHeaderWriter() {
5049
/**
5150
* Creates a new instance
5251
* @param frameOptionsMode the {@link XFrameOptionsMode} to use. If using
53-
* {@link XFrameOptionsMode#ALLOW_FROM}, use
54-
* {@link #XFrameOptionsHeaderWriter(AllowFromStrategy)} instead.
52+
* {@link XFrameOptionsMode#ALLOW_FROM}, use Content-Security-Policy with the <a href=
53+
* "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors">frame-ancestors</a>
54+
* directive instead.
5555
*/
5656
public XFrameOptionsHeaderWriter(XFrameOptionsMode frameOptionsMode) {
5757
Assert.notNull(frameOptionsMode, "frameOptionsMode cannot be null");
@@ -70,6 +70,7 @@ public XFrameOptionsHeaderWriter(XFrameOptionsMode frameOptionsMode) {
7070
* browsers. Instead use Content-Security-Policy with the <a href=
7171
* "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors">frame-ancestors</a>
7272
* directive.
73+
* @see AllowFromStrategy
7374
*/
7475
@Deprecated
7576
public XFrameOptionsHeaderWriter(AllowFromStrategy allowFromStrategy) {

0 commit comments

Comments
 (0)