Polishing (in particular updating javadoc references to Apache Commons)

(cherry picked from commit bc6a98c)
This commit is contained in:
Juergen Hoeller
2015-03-13 18:19:10 +01:00
parent f42c53d9be
commit b352dbfdeb
31 changed files with 209 additions and 205 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 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.
@@ -66,9 +66,8 @@ import org.springframework.web.servlet.ViewResolver;
* controllers. Dispatches to registered handlers for processing a portlet request.
*
* <p>This portlet is very flexible: It can be used with just about any workflow,
* with the installation of the appropriate adapter classes. It offers the
* following functionality that distinguishes it from other request-driven
* portlet MVC frameworks:
* with the installation of the appropriate adapter classes. It offers the following
* functionality that distinguishes it from other request-driven Portlet MVC frameworks:
*
* <ul>
* <li>It is based around a JavaBeans configuration mechanism.
@@ -77,8 +76,8 @@ import org.springframework.web.servlet.ViewResolver;
* as part of an application - to control the routing of requests to handler objects.
* Default is a {@link org.springframework.web.portlet.mvc.annotation.DefaultAnnotationHandlerMapping}.
* HandlerMapping objects can be defined as beans in the portlet's application context,
* implementing the HandlerMapping interface, overriding the default HandlerMapping if present.
* HandlerMappings can be given any bean name (they are tested by type).
* implementing the HandlerMapping interface, overriding the default HandlerMapping
* if present. HandlerMappings can be given any bean name (they are tested by type).
*
* <li>It can use any {@link HandlerAdapter}; this allows for using any handler interface.
* The default adapter is {@link org.springframework.web.portlet.mvc.SimpleControllerHandlerAdapter}
@@ -102,27 +101,24 @@ import org.springframework.web.servlet.ViewResolver;
* (they are tested by type).
*
* <li>The dispatcher's strategy for resolving multipart requests is determined by a
* {@link org.springframework.web.portlet.multipart.PortletMultipartResolver} implementation.
* An implementations for Jakarta Commons FileUpload is included:
* {@link org.springframework.web.portlet.multipart.PortletMultipartResolver}
* implementation. An implementations for Apache Commons FileUpload is included:
* {@link org.springframework.web.portlet.multipart.CommonsPortletMultipartResolver}.
* The MultipartResolver bean name is "portletMultipartResolver"; default is none.
* </ul>
*
* <p><b>NOTE: The {@code @RequestMapping} annotation will only be processed
* if a corresponding {@code HandlerMapping} (for type level annotations)
* and/or {@code HandlerAdapter} (for method level annotations)
* is present in the dispatcher.</b> This is the case by default.
* However, if you are defining custom {@code HandlerMappings} or
* {@code HandlerAdapters}, then you need to make sure that a
* corresponding custom {@code DefaultAnnotationHandlerMapping}
* and/or {@code AnnotationMethodHandlerAdapter} is defined as well
* - provided that you intend to use {@code @RequestMapping}.
* <p><b>NOTE: The {@code @RequestMapping} annotation will only be processed if a
* corresponding {@code HandlerMapping} (for type-level annotations) and/or
* {@code HandlerAdapter} (for method-level annotations) is present in the dispatcher.</b>
* This is the case by default. However, if you are defining custom {@code HandlerMappings}
* or {@code HandlerAdapters}, then you need to make sure that a corresponding custom
* {@code DefaultAnnotationHandlerMapping} and/or {@code AnnotationMethodHandlerAdapter}
* is defined as well - provided that you intend to use {@code @RequestMapping}.
*
* <p><b>A web application can define any number of DispatcherPortlets.</b>
* Each portlet will operate in its own namespace, loading its own application
* context with mappings, handlers, etc. Only the root application context
* as loaded by {@link org.springframework.web.context.ContextLoaderListener},
* if any, will be shared.
* Each portlet will operate in its own namespace, loading its own application context
* with mappings, handlers, etc. Only the root application context as loaded by
* {@link org.springframework.web.context.ContextLoaderListener}, if any, will be shared.
*
* <p>Thanks to Rainer Schmitz, Nick Lothian and Eric Dalquist for their suggestions!
*

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2015 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,7 +36,7 @@ import org.springframework.web.portlet.util.PortletUtils;
/**
* {@link PortletMultipartResolver} implementation for
* <a href="http://jakarta.apache.org/commons/fileupload">Jakarta Commons FileUpload</a>
* <a href="http://commons.apache.org/proper/commons-fileupload">Apache Commons FileUpload</a>
* 1.2 or above.
*
* <p>Provides "maxUploadSize", "maxInMemorySize" and "defaultEncoding" settings as

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2015 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.
@@ -30,25 +30,23 @@ import org.springframework.web.multipart.MultipartException;
* <p>There is one concrete implementation included in Spring:
* <ul>
* <li>{@link org.springframework.web.multipart.commons.CommonsMultipartResolver}
* for Jakarta Commons FileUpload
* for Apache Commons FileUpload
* </ul>
*
* <p>There is no default resolver implementation used for Spring
* {@link org.springframework.web.portlet.DispatcherPortlet DispatcherPortlets},
* as an application might choose to parse its multipart requests itself. To
* define an implementation, create a bean with the id
* {@link org.springframework.web.portlet.DispatcherPortlet#MULTIPART_RESOLVER_BEAN_NAME "portletMultipartResolver"}
* define an implementation, create a bean with the id "portletMultipartResolver"
* in a {@code DispatcherPortlet's} application context. Such a resolver
* gets applied to all requests handled by that {@code DispatcherPortlet}.
*
* <p>If a {@code DispatcherPortlet} detects a multipart request, it will
* resolve it via the configured
* {@link org.springframework.web.multipart.MultipartResolver} and pass on a
* wrapped Portlet {@link ActionRequest}.
* {@link org.springframework.web.portlet.mvc.Controller Controllers} can then
* {@link org.springframework.web.portlet.multipart.PortletMultipartResolver}
* and pass on a wrapped Portlet {@link ActionRequest}. Controllers can then
* cast their given request to the {@link MultipartActionRequest} interface,
* being able to access {@code MultipartFiles}. Note that this cast is
* only supported in case of an actual multipart request.
* being able to access {@code MultipartFiles}. Note that this cast is only
* supported in case of an actual multipart request.
*
* <pre class="code"> public void handleActionRequest(ActionRequest request, ActionResponse response) {
* MultipartActionRequest multipartRequest = (MultipartActionRequest) request;
@@ -59,13 +57,12 @@ import org.springframework.web.multipart.MultipartException;
* Instead of direct access, command or form controllers can register a
* {@link org.springframework.web.multipart.support.ByteArrayMultipartFileEditor}
* or {@link org.springframework.web.multipart.support.StringMultipartFileEditor}
* with their data binder, to automatically apply multipart content to command
* with their data binder, to automatically apply multipart content to form
* bean properties.
*
* <p>Note: There is hardly ever a need to access the
* {@code MultipartResolver} itself from application code. It will simply
* do its work behind the scenes, making {@code MultipartActionRequests}
* available to controllers.
* <p>Note: There is hardly ever a need to access the {@code MultipartResolver}
* itself from application code. It will simply do its work behind the scenes,
* making {@code MultipartActionRequests} available to controllers.
*
* @author Juergen Hoeller
* @since 2.0