Fix broken links in Javadoc

This commit removes several links that were broken due to the removal
of various APIs in 6.0.

See gh-27480
This commit is contained in:
Sam Brannen
2021-09-28 13:34:33 +02:00
parent 3dc84c2d92
commit 93efb20a53
24 changed files with 150 additions and 198 deletions

View File

@@ -62,54 +62,51 @@ import org.springframework.lang.Nullable;
* <p>Example usage with
* {@link MappingJackson2HttpMessageConverter}:
*
* <pre class="code">{@code
* <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
* <property name="objectMapper">
* <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
* <pre class="code">
* &lt;bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"&gt;
* &lt;property name="objectMapper"&gt;
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
* p:autoDetectFields="false"
* p:autoDetectGettersSetters="false"
* p:annotationIntrospector-ref="jaxbAnnotationIntrospector" />
* </property>
* </bean>
* }</pre>
* p:annotationIntrospector-ref="jaxbAnnotationIntrospector" /&gt;
* &lt;/property&gt;
* &lt;/bean&gt;</pre>
*
* <p>Example usage with MappingJackson2JsonView:
*
* <pre class="code">{@code
* <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView">
* <property name="objectMapper">
* <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
* <pre class="code">
* &lt;bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"&gt;
* &lt;property name="objectMapper"&gt;
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
* p:failOnEmptyBeans="false"
* p:indentOutput="true">
* <property name="serializers">
* <array>
* <bean class="org.mycompany.MyCustomSerializer" />
* </array>
* </property>
* </bean>
* </property>
* </bean>
* }</pre>
* p:indentOutput="true"&gt;
* &lt;property name="serializers"&gt;
* &lt;array&gt;
* &lt;bean class="org.mycompany.MyCustomSerializer" /&gt;
* &lt;/array&gt;
* &lt;/property&gt;
* &lt;/bean&gt;
* &lt;/property&gt;
* &lt;/bean&gt;</pre>
*
* <p>In case there are no specific setters provided (for some rarely used options),
* you can still use the more general methods {@link #setFeaturesToEnable} and
* {@link #setFeaturesToDisable}.
*
* <pre class="code">{@code
* <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
* <property name="featuresToEnable">
* <array>
* <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.WRAP_ROOT_VALUE"/>
* <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.CLOSE_CLOSEABLE"/>
* </array>
* </property>
* <property name="featuresToDisable">
* <array>
* <util:constant static-field="com.fasterxml.jackson.databind.MapperFeature.USE_ANNOTATIONS"/>
* </array>
* </property>
* </bean>
* }</pre>
* <pre class="code">
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"&gt;
* &lt;property name="featuresToEnable"&gt;
* &lt;array&gt;
* &lt;util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.WRAP_ROOT_VALUE"/&gt;
* &lt;util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.CLOSE_CLOSEABLE"/&gt;
* &lt;/array&gt;
* &lt;/property&gt;
* &lt;property name="featuresToDisable"&gt;
* &lt;array&gt;
* &lt;util:constant static-field="com.fasterxml.jackson.databind.MapperFeature.USE_ANNOTATIONS"/&gt;
* &lt;/array&gt;
* &lt;/property&gt;
* &lt;/bean&gt;</pre>
*
* <p>It also automatically registers the following well-known modules if they are
* detected on the classpath:
@@ -127,11 +124,10 @@ import org.springframework.lang.Nullable;
* <p>In case you want to configure Jackson's {@link ObjectMapper} with a custom {@link Module},
* you can register one or more such Modules by class name via {@link #setModulesToInstall}:
*
* <pre class="code">{@code
* <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
* <property name="modulesToInstall" value="myapp.jackson.MySampleModule,myapp.jackson.MyOtherModule"/>
* </bean
* }</pre>
* <pre class="code">
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"&gt;
* &lt;property name="modulesToInstall" value="myapp.jackson.MySampleModule,myapp.jackson.MyOtherModule"/&gt;
* &lt;/bean&gt;</pre>
*
* <p>Compatible with Jackson 2.9 to 2.12, as of Spring 5.3.
*

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -49,12 +49,6 @@ import jakarta.servlet.http.HttpServletResponse;
* return value gives a clearer signature to callers other than the
* DispatcherServlet, indicating that there will never be a view to render.
*
* <p>As of Spring 2.0, Spring's HTTP-based remote exporters, such as
* {@link org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter}
* and {@link org.springframework.remoting.caucho.HessianServiceExporter},
* implement this interface rather than the more extensive Controller interface,
* for minimal dependencies on Spring-specific web infrastructure.
*
* <p>Note that HttpRequestHandlers may optionally implement the
* {@link org.springframework.web.servlet.mvc.LastModified} interface,
* just like Controllers can, <i>provided that they run within Spring's
@@ -71,8 +65,6 @@ import jakarta.servlet.http.HttpServletResponse;
* @see org.springframework.web.servlet.mvc.Controller
* @see org.springframework.web.servlet.mvc.LastModified
* @see org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter
* @see org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter
* @see org.springframework.remoting.caucho.HessianServiceExporter
*/
@FunctionalInterface
public interface HttpRequestHandler {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -36,13 +36,6 @@ import org.springframework.web.context.WebApplicationContext;
* in Spring's root web application context. The target bean name must match the
* HttpRequestHandlerServlet servlet-name as defined in {@code web.xml}.
*
* <p>This can for example be used to expose a single Spring remote exporter,
* such as {@link org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter}
* or {@link org.springframework.remoting.caucho.HessianServiceExporter},
* per HttpRequestHandlerServlet definition. This is a minimal alternative
* to defining remote exporters as beans in a DispatcherServlet context
* (with advanced mapping and interception facilities being available there).
*
* @author Juergen Hoeller
* @since 2.0
* @see org.springframework.web.HttpRequestHandler

View File

@@ -61,8 +61,6 @@ public interface MultipartFile extends InputStreamSource {
* this one one somewhere for reference, if necessary.
* @return the original filename, or the empty String if no file has been chosen
* in the multipart form, or {@code null} if not defined or not available
* @see org.apache.commons.fileupload.FileItem#getName()
* @see org.springframework.web.multipart.commons.CommonsMultipartFile#setPreserveFilename
* @see <a href="https://tools.ietf.org/html/rfc7578#section-4.2">RFC 7578, Section 4.2</a>
* @see <a href="https://owasp.org/www-community/vulnerabilities/Unrestricted_File_Upload">Unrestricted File Upload</a>
*/
@@ -133,7 +131,6 @@ public interface MultipartFile extends InputStreamSource {
* @throws IOException in case of reading or writing errors
* @throws IllegalStateException if the file has already been moved
* in the filesystem and is not available anymore for another transfer
* @see org.apache.commons.fileupload.FileItem#write(File)
* @see jakarta.servlet.http.Part#write(String)
*/
void transferTo(File dest) throws IOException, IllegalStateException;

View File

@@ -25,7 +25,8 @@ import org.springframework.lang.Nullable;
/**
* Provides additional methods for dealing with multipart content within a
* servlet request, allowing to access uploaded files.
* Implementations also need to override the standard
*
* <p>Implementations also need to override the standard
* {@link jakarta.servlet.ServletRequest} methods for parameter access, making
* multipart parameters available.
*

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -24,10 +24,8 @@ import jakarta.servlet.http.HttpServletRequest;
* Implementations are typically usable both within an application context
* and standalone.
*
* <p>There are two concrete implementations included in Spring, as of Spring 3.1:
* <p>Spring provides the following concrete implementation:
* <ul>
* <li>{@link org.springframework.web.multipart.commons.CommonsMultipartResolver}
* for Apache Commons FileUpload
* <li>{@link org.springframework.web.multipart.support.StandardServletMultipartResolver}
* for the Servlet 3.0+ Part API
* </ul>
@@ -77,7 +75,6 @@ import jakarta.servlet.http.HttpServletRequest;
* @since 29.09.2003
* @see MultipartHttpServletRequest
* @see MultipartFile
* @see org.springframework.web.multipart.commons.CommonsMultipartResolver
* @see org.springframework.web.multipart.support.ByteArrayMultipartFileEditor
* @see org.springframework.web.multipart.support.StringMultipartFileEditor
* @see org.springframework.web.servlet.DispatcherServlet

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -34,8 +34,8 @@ import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
/**
* Abstract base implementation of the MultipartHttpServletRequest interface.
* Provides management of pre-generated MultipartFile instances.
* Abstract base implementation of the {@link MultipartHttpServletRequest} interface.
* <p>Provides management of pre-generated {@link MultipartFile} instances.
*
* @author Juergen Hoeller
* @author Arjen Poutsma

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -35,8 +35,6 @@ import org.springframework.web.multipart.MultipartFile;
* {@link org.springframework.web.multipart.MultipartHttpServletRequest}
* interface. Provides management of pre-generated parameter values.
*
* <p>Used by {@link org.springframework.web.multipart.commons.CommonsMultipartResolver}.
*
* @author Trevor D. Cook
* @author Juergen Hoeller
* @author Arjen Poutsma

View File

@@ -34,11 +34,8 @@ import org.springframework.web.multipart.MultipartResolver;
*
* <p>This resolver variant uses your Servlet container's multipart parser as-is,
* potentially exposing the application to container implementation differences.
* See {@link org.springframework.web.multipart.commons.CommonsMultipartResolver}
* for an alternative implementation using a local Commons FileUpload library
* within the application, providing maximum portability across Servlet containers.
* Also, see this resolver's configuration option for
* {@link #setStrictServletCompliance strict Servlet compliance}, narrowing the
* {@linkplain #setStrictServletCompliance strict Servlet compliance}, narrowing the
* applicability of Spring's {@link MultipartHttpServletRequest} to form data only.
*
* <p><b>Note:</b> In order to use Servlet 3.0 based multipart parsing,
@@ -52,21 +49,19 @@ import org.springframework.web.multipart.MultipartResolver;
*
* <pre class="code">
* public class AppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
* // ...
* &#064;Override
* protected void customizeRegistration(ServletRegistration.Dynamic registration) {
* // ...
* &#064;Override
* protected void customizeRegistration(ServletRegistration.Dynamic registration) {
* // Optionally also set maxFileSize, maxRequestSize, fileSizeThreshold
* registration.setMultipartConfig(new MultipartConfigElement("/tmp"));
* }
* }
* </pre>
* }</pre>
*
* @author Juergen Hoeller
* @since 3.1
* @see #setResolveLazily
* @see #setStrictServletCompliance
* @see HttpServletRequest#getParts()
* @see org.springframework.web.multipart.commons.CommonsMultipartResolver
*/
public class StandardServletMultipartResolver implements MultipartResolver {
@@ -99,10 +94,6 @@ public class StandardServletMultipartResolver implements MultipartResolver {
* switch this flag to "true": Only "multipart/form-data" requests will be
* wrapped with a {@link MultipartHttpServletRequest} then; other kinds of
* requests will be left as-is, allowing for custom processing in user code.
* <p>Note that Commons FileUpload and therefore
* {@link org.springframework.web.multipart.commons.CommonsMultipartResolver}
* supports any "multipart/" request type. However, it restricts processing
* to POST requests which standard Servlet multipart parsers might not do.
* @since 5.3.9
*/
public void setStrictServletCompliance(boolean strictServletCompliance) {