You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by lu...@apache.org on 2024/11/09 08:52:45 UTC
(struts-site) 01/01: Replaces references to fileUpload interceptor with actionFileUpload instead
This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a commit to branch feature/file-upload
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit 2c8c18fc45fe169ae6243eb2bba4c6767d412c67
Author: Lukasz Lenart <lu...@apache.org>
AuthorDate: Sat Nov 9 09:52:36 2024 +0100
Replaces references to fileUpload interceptor with actionFileUpload instead
---
.../action-file-upload-interceptor.md | 2 +-
source/core-developers/action-file-upload.md | 4 +-
source/core-developers/exception-configuration.md | 2 +-
source/core-developers/file-upload-interceptor.md | 3 +
source/core-developers/file-upload.md | 4 +-
source/core-developers/interceptors.md | 82 +++++++++++-----------
source/core-developers/validations-annotation.md | 2 +-
7 files changed, 51 insertions(+), 48 deletions(-)
diff --git a/source/core-developers/action-file-upload-interceptor.md b/source/core-developers/action-file-upload-interceptor.md
index aa3a89d73..06a67c55d 100644
--- a/source/core-developers/action-file-upload-interceptor.md
+++ b/source/core-developers/action-file-upload-interceptor.md
@@ -107,7 +107,7 @@ public class UploadAction extends ActionSupport implements UploadedFilesAware {
**Setting parameters example:**
```xml
-<interceptor-ref name="fileUpload">
+<interceptor-ref name="actionFileUpload">
<param name="allowedTypes">
image/png,image/gif,image/jpeg
</param>
diff --git a/source/core-developers/action-file-upload.md b/source/core-developers/action-file-upload.md
index 511cd440c..2510a5c37 100644
--- a/source/core-developers/action-file-upload.md
+++ b/source/core-developers/action-file-upload.md
@@ -204,7 +204,7 @@ Notice the locations of these settings in the following example:
<action name="doUpload" class="com.example.UploadAction">
<interceptor-ref name="basicStack"/>
- <interceptor-ref name="fileUpload">
+ <interceptor-ref name="actionFileUpload">
<param name="maximumSize">500000</param>
</interceptor-ref>
<interceptor-ref name="validation"/>
@@ -247,7 +247,7 @@ example:
```xml
<action name="doUpload" class="com.example.UploadAction">
<interceptor-ref name="basicStack"/>
- <interceptor-ref name="fileUpload">
+ <interceptor-ref name="actionFileUpload">
<param name="allowedTypes">image/jpeg,image/gif</param>
</interceptor-ref>
<interceptor-ref name="validation"/>
diff --git a/source/core-developers/exception-configuration.md b/source/core-developers/exception-configuration.md
index 1cd6e1385..5785546a6 100644
--- a/source/core-developers/exception-configuration.md
+++ b/source/core-developers/exception-configuration.md
@@ -33,7 +33,7 @@ Below is a snippet from `struts-default.xml` which has the exception mapping alr
<interceptor-ref name="profiling"/>
<interceptor-ref name="scoped-model-driven"/>
<interceptor-ref name="model-driven"/>
- <interceptor-ref name="fileUpload"/>
+ <interceptor-ref name="actionFileUpload"/>
<interceptor-ref name="checkbox"/>
<interceptor-ref name="static-params"/>
<interceptor-ref name="params"/>
diff --git a/source/core-developers/file-upload-interceptor.md b/source/core-developers/file-upload-interceptor.md
index fbc6c9c77..7983b699d 100644
--- a/source/core-developers/file-upload-interceptor.md
+++ b/source/core-developers/file-upload-interceptor.md
@@ -15,6 +15,9 @@ parent:
Since Struts 6.4.0 this interceptor is deprecated, please use [Action File Upload Interceptor](action-file-upload-interceptor) instead!
{:.alert .alert-warning}
+This interceptor has benn removed in Struts 7.0.0!
+{:.alert .alert-danger}
+
See [this page](file-upload) for more examples and advanced configuration.
Interceptor that is based off of `MultiPartRequestWrapper`, which is automatically applied for any request that includes
diff --git a/source/core-developers/file-upload.md b/source/core-developers/file-upload.md
index aa2223ea2..9045f202b 100644
--- a/source/core-developers/file-upload.md
+++ b/source/core-developers/file-upload.md
@@ -306,7 +306,7 @@ Notice the locations of these settings in the following example:
<action name="doUpload" class="com.example.UploadAction">
<interceptor-ref name="basicStack"/>
- <interceptor-ref name="fileUpload">
+ <interceptor-ref name="actionFileUpload">
<param name="maximumSize">500000</param>
</interceptor-ref>
<interceptor-ref name="validation"/>
@@ -349,7 +349,7 @@ example:
```xml
<action name="doUpload" class="com.example.UploadAction">
<interceptor-ref name="basicStack"/>
- <interceptor-ref name="fileUpload">
+ <interceptor-ref name="actionFileUpload">
<param name="allowedTypes">image/jpeg,image/gif</param>
</interceptor-ref>
<interceptor-ref name="validation"/>
diff --git a/source/core-developers/interceptors.md b/source/core-developers/interceptors.md
index 4145c99f3..201a662b7 100644
--- a/source/core-developers/interceptors.md
+++ b/source/core-developers/interceptors.md
@@ -111,47 +111,47 @@ specified below come specified in [struts-default.xml](struts-default-xml). If y
package, then you can use the names below. Otherwise, they must be defined in your package with a name-class pair
specified in the `<interceptors/>` tag.
-| Interceptor | Name | Description |
-|------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [Action File Upload Interceptor](action-file-upload-interceptor) | actionFileUpload | Available since Struts 6.4.0: an Interceptor that adds easy access to file upload support. |
-| [Alias Interceptor](alias-interceptor) | alias | Converts similar parameters that may be named differently between requests. |
-| [Annotation Parameter Filter Interceptor](annotation-parameter-filter-interceptor) | annotationParameterFilter | Annotation based version of [Parameter Filter Interceptor](parameter-filter-interceptor). |
-| [Annotation Workflow Interceptor](annotation-workflow-interceptor) | annotationWorkflow | Invokes any annotated methods on the action. |
-| [Chaining Interceptor](chaining-interceptor) | chain | Makes the previous Action's properties available to the current Action. Commonly used together with <result type="chain"> (in the previous Action). |
+| Interceptor | Name | Description |
+|------------------------------------------------------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Action File Upload Interceptor](action-file-upload-interceptor) | actionFileUpload | Available since Struts 6.4.0: an Interceptor that adds easy access to file upload support. |
+| [Alias Interceptor](alias-interceptor) | alias | Converts similar parameters that may be named differently between requests. |
+| [Annotation Parameter Filter Interceptor](annotation-parameter-filter-interceptor) | annotationParameterFilter | Annotation based version of [Parameter Filter Interceptor](parameter-filter-interceptor). |
+| [Annotation Workflow Interceptor](annotation-workflow-interceptor) | annotationWorkflow | Invokes any annotated methods on the action. |
+| [Chaining Interceptor](chaining-interceptor) | chain | Makes the previous Action's properties available to the current Action. Commonly used together with <result type="chain"> (in the previous Action). |
| [Checckbox Interceptor](checkbox-interceptor) | checkbox | Adds automatic checkbox handling code that detect an unchecked checkbox and add it as a parameter with a default (usually 'false') value. Uses a specially named hidden field to detect unsubmitted checkboxes. The default unchecked value is overridable for non-boolean value'd checkboxes. |
-| [Cross-Origin Embedder Policy Interceptor](coep-interceptor) | coep | Implements the Cross-Origin Embedder Policy on incoming requests used to protect a document from loading any non-same-origin resources which don't explicitly grant the document permission to be loaded. |
-| [Conversion Error Interceptor](conversion-error-interceptor) | conversionError | Adds conversion errors from the ActionContext to the Action's field errors |
-| [Cookie Interceptor](cookie-interceptor) | cookie | Inject cookie with a certain configurable name / value into action. (Since 2.0.7.) |
-| [Cookie Provider Interceptor](cookie-provider-interceptor) | cookieProvider | Transfer cookies from action to response (Since 2.3.15.) |
-| [Cross-Origin Opener Policy Interceptor](coop-interceptor) | coop | Implements the Cross-Origin Opener Policy on incoming requests used to isolate resources against side-channel attacks and information leaks. |
-| [Create Session Interceptor](create-session-interceptor) | createSession | Create an HttpSession automatically, useful with certain Interceptors that require a HttpSession to work properly (like the TokenInterceptor) |
-| [Clear Session Interceptor](clear-session-interceptor) | clearSession | This interceptor clears the HttpSession. |
-| [Content Security Policy Interceptor](csp-interceptor) | csp | Adds support for Content Security policy. |
-| [Debugging Interceptor](debugging-interceptor) | debugging | Provides several different debugging screens to provide insight into the data behind the page. |
-| [Default Workflow Interceptor](default-workflow-interceptor) | workflow | Calls the validate method in your Action class. If Action errors are created then it returns the INPUT view. |
-| [Exception Interceptor](exception-interceptor) | exception | Maps exceptions to a result. |
-| [Execute and Wait Interceptor](execute-and-wait-interceptor) | execAndWait | Executes the Action in the background and then sends the user off to an intermediate waiting page. |
-| [Fetch Metadata Interceptor](fetch-metadata-interceptor) | fetchMetadata | Implements the Resource Isolation Policies on incoming requests used to protect against CSRF, XSSI, and cross-origin information leaks. |
-| [File Upload Interceptor](file-upload-interceptor) | fileUpload | **DEPRECTED** since Struts 6.4.0: an Interceptor that adds easy access to file upload support. |
-| [I18n Interceptor](i18n-interceptor) | i18n | Remembers the locale selected for a user's session. |
-| [Logging Interceptor](logging-interceptor) | logger | Outputs the name of the Action. |
-| [Message Store Interceptor](message-store-interceptor) | store | Store and retrieve action messages / errors / field errors for action that implements ValidationAware interface into session. |
-| [Model Driven Interceptor](model-driven-interceptor) | modelDriven | If the Action implements ModelDriven, pushes the getModel Result onto the Value Stack. |
-| [Multiselect Interceptor](multiselect-interceptor) | multiselect | Like the checkbox interceptor detects that no value was selected for a field with multiple values (like a select) and adds an empty parameter |
-| [NoOp Interceptor](no-op-interceptor) | noop | Does nothing, just passes invocation further, used in empty stack |
-| [Parameter Filter Interceptor](parameter-filter-interceptor) | parameterFilter | Removes parameters from the list of those available to Actions |
-| [Parameters Interceptor](parameters-interceptor) | params | Sets the request parameters onto the Action. |
-| [Parameter Remover Interceptor](parameter-remover-interceptor) | paramRemover | Removes a parameter from parameters map. |
-| [Prepare Interceptor](prepare-interceptor) | prepare | If the Action implements Preparable, calls its prepare method. |
-| [Roles Interceptor](roles-interceptor) | roles | Action will only be executed if the user has the correct JAAS role. |
-| [Scope Interceptor](scope-interceptor) | scope | Simple mechanism for storing Action state in the session or application scope. |
-| [Scoped Model Driven Interceptor](scoped-model-driven-interceptor) | scopedModelDriven | If the Action implements ScopedModelDriven, the interceptor retrieves and stores the model from a scope and sets it on the action calling setModel. |
-| [Servlet Config Interceptor](servlet-config-interceptor) | servletConfig | Provide access to Maps representing HttpServletRequest and HttpServletResponse. |
-| [Static Parameters Interceptor](static-parameters-interceptor) | staticParams | Sets the struts.xml defined parameters onto the action. These are the <param> tags that are direct children of the <action> tag. |
-| [Timer Interceptor](timer-interceptor) | timer | Outputs how long the Action takes to execute (including nested Interceptors and View) |
-| [Token Interceptor](token-interceptor) | token | Checks for valid token presence in Action, prevents duplicate form submission. |
-| [Token Session Interceptor](token-session-interceptor) | tokenSession | Same as Token Interceptor, but stores the submitted data in session when handed an invalid token |
-| [Validation Interceptor](validation-interceptor) | validation | Performs validation using the validators defined in _action_ -validation.xml |
+| [Cross-Origin Embedder Policy Interceptor](coep-interceptor) | coep | Implements the Cross-Origin Embedder Policy on incoming requests used to protect a document from loading any non-same-origin resources which don't explicitly grant the document permission to be loaded. |
+| [Conversion Error Interceptor](conversion-error-interceptor) | conversionError | Adds conversion errors from the ActionContext to the Action's field errors |
+| [Cookie Interceptor](cookie-interceptor) | cookie | Inject cookie with a certain configurable name / value into action. (Since 2.0.7.) |
+| [Cookie Provider Interceptor](cookie-provider-interceptor) | cookieProvider | Transfer cookies from action to response (Since 2.3.15.) |
+| [Cross-Origin Opener Policy Interceptor](coop-interceptor) | coop | Implements the Cross-Origin Opener Policy on incoming requests used to isolate resources against side-channel attacks and information leaks. |
+| [Create Session Interceptor](create-session-interceptor) | createSession | Create an HttpSession automatically, useful with certain Interceptors that require a HttpSession to work properly (like the TokenInterceptor) |
+| [Clear Session Interceptor](clear-session-interceptor) | clearSession | This interceptor clears the HttpSession. |
+| [Content Security Policy Interceptor](csp-interceptor) | csp | Adds support for Content Security policy. |
+| [Debugging Interceptor](debugging-interceptor) | debugging | Provides several different debugging screens to provide insight into the data behind the page. |
+| [Default Workflow Interceptor](default-workflow-interceptor) | workflow | Calls the validate method in your Action class. If Action errors are created then it returns the INPUT view. |
+| [Exception Interceptor](exception-interceptor) | exception | Maps exceptions to a result. |
+| [Execute and Wait Interceptor](execute-and-wait-interceptor) | execAndWait | Executes the Action in the background and then sends the user off to an intermediate waiting page. |
+| [Fetch Metadata Interceptor](fetch-metadata-interceptor) | fetchMetadata | Implements the Resource Isolation Policies on incoming requests used to protect against CSRF, XSSI, and cross-origin information leaks. |
+| [File Upload Interceptor](file-upload-interceptor) | fileUpload | **DEPRECTED** since Struts 6.4.0, **REMOVED** since Struts 7.0.0: an Interceptor that adds easy access to file upload support. |
+| [I18n Interceptor](i18n-interceptor) | i18n | Remembers the locale selected for a user's session. |
+| [Logging Interceptor](logging-interceptor) | logger | Outputs the name of the Action. |
+| [Message Store Interceptor](message-store-interceptor) | store | Store and retrieve action messages / errors / field errors for action that implements ValidationAware interface into session. |
+| [Model Driven Interceptor](model-driven-interceptor) | modelDriven | If the Action implements ModelDriven, pushes the getModel Result onto the Value Stack. |
+| [Multiselect Interceptor](multiselect-interceptor) | multiselect | Like the checkbox interceptor detects that no value was selected for a field with multiple values (like a select) and adds an empty parameter |
+| [NoOp Interceptor](no-op-interceptor) | noop | Does nothing, just passes invocation further, used in empty stack |
+| [Parameter Filter Interceptor](parameter-filter-interceptor) | parameterFilter | Removes parameters from the list of those available to Actions |
+| [Parameters Interceptor](parameters-interceptor) | params | Sets the request parameters onto the Action. |
+| [Parameter Remover Interceptor](parameter-remover-interceptor) | paramRemover | Removes a parameter from parameters map. |
+| [Prepare Interceptor](prepare-interceptor) | prepare | If the Action implements Preparable, calls its prepare method. |
+| [Roles Interceptor](roles-interceptor) | roles | Action will only be executed if the user has the correct JAAS role. |
+| [Scope Interceptor](scope-interceptor) | scope | Simple mechanism for storing Action state in the session or application scope. |
+| [Scoped Model Driven Interceptor](scoped-model-driven-interceptor) | scopedModelDriven | If the Action implements ScopedModelDriven, the interceptor retrieves and stores the model from a scope and sets it on the action calling setModel. |
+| [Servlet Config Interceptor](servlet-config-interceptor) | servletConfig | Provide access to Maps representing HttpServletRequest and HttpServletResponse. |
+| [Static Parameters Interceptor](static-parameters-interceptor) | staticParams | Sets the struts.xml defined parameters onto the action. These are the <param> tags that are direct children of the <action> tag. |
+| [Timer Interceptor](timer-interceptor) | timer | Outputs how long the Action takes to execute (including nested Interceptors and View) |
+| [Token Interceptor](token-interceptor) | token | Checks for valid token presence in Action, prevents duplicate form submission. |
+| [Token Session Interceptor](token-session-interceptor) | tokenSession | Same as Token Interceptor, but stores the submitted data in session when handed an invalid token |
+| [Validation Interceptor](validation-interceptor) | validation | Performs validation using the validators defined in _action_ -validation.xml |
Since 2.0.7, Interceptors and Results with hyphenated names were converted to camelCase. (The former model-driven is
now modelDriven.) The original hyphenated names are retained as "aliases" until Struts 2.1.0. For clarity,
@@ -194,7 +194,7 @@ Interceptor's parameter could be overridden through the following ways :
<interceptor-ref name="i18n"/>
<interceptor-ref name="chain"/>
<interceptor-ref name="modelDriven"/>
- <interceptor-ref name="fileUpload"/>
+ <interceptor-ref name="actionFileUpload"/>
<interceptor-ref name="staticParams"/>
<interceptor-ref name="params"/>
<interceptor-ref name="conversionError"/>
diff --git a/source/core-developers/validations-annotation.md b/source/core-developers/validations-annotation.md
index 5d32417d9..c49091d59 100644
--- a/source/core-developers/validations-annotation.md
+++ b/source/core-developers/validations-annotation.md
@@ -158,7 +158,7 @@ Here's a complete example of updating the default stack:
<interceptor-ref name="profiling"/>
<interceptor-ref name="scopedModelDriven"/>
<interceptor-ref name="modelDriven"/>
- <interceptor-ref name="fileUpload"/>
+ <interceptor-ref name="actionFileUpload"/>
<interceptor-ref name="checkbox"/>
<interceptor-ref name="staticParams"/>
<interceptor-ref name="params">