Refactor(form-processing): Update for Struts 7 compatibility

fp024 · fp024 · commit c3a49777c026 · 2025-04-17T20:06:08.000+09:00
- Removed cancel2() method to prevent unnecessary value binding to personBean.age.
- Corrected namespace in form action tags for accuracy.
- Added @StrutsParameter annotations to action parameter methods.
- Implemented OGNL allowlist to comply with stricter security policies.
- Updated web.xml to schema version 6.0.
diff --git a/form-processing/src/main/java/org/apache/struts/helloworld/action/HelloWorldAction.java b/form-processing/src/main/java/org/apache/struts/helloworld/action/HelloWorldAction.java
@@ -2,6 +2,7 @@
 
 import org.apache.struts.helloworld.model.MessageStore;
 import org.apache.struts2.ActionSupport;
+import org.apache.struts2.interceptor.parameter.StrutsParameter;
 
 /**
  * Acts as a Struts 2 controller that responds
@@ -37,6 +38,7 @@ public String getUserName() {
         return userName;
     }
 
+    @StrutsParameter
     public void setUserName(String userName) {
         this.userName = userName;
     }
diff --git a/form-processing/src/main/java/org/apache/struts/register/action/Register.java b/form-processing/src/main/java/org/apache/struts/register/action/Register.java
@@ -2,8 +2,8 @@
 
 import org.apache.struts.register.model.Person;
 import org.apache.struts2.ActionSupport;
+import org.apache.struts2.interceptor.parameter.StrutsParameter;
 
-import java.util.ArrayList;
 import java.util.List;
 
 public class Register extends ActionSupport {
@@ -17,15 +17,10 @@ public String execute2() throws Exception {
     }
 
     public String input() throws Exception {
-        this.options = new ArrayList<>();
-        this.options.add(3);
         return INPUT;
     }
 
-    public String cancel2() throws Exception {
-        return SUCCESS;
-    }
-
+    @StrutsParameter(depth = 1)
     public Person getPersonBean() {
         return personBean;
     }
@@ -34,6 +29,7 @@ public void setPersonBean(Person person) {
         personBean = person;
     }
 
+    @StrutsParameter(depth = 1)
     public List<Integer> getOptions() {
         return options;
     }
diff --git a/form-processing/src/main/resources/struts.xml b/form-processing/src/main/resources/struts.xml
@@ -6,6 +6,7 @@
     <constant name="struts.devMode" value="true" />
     <constant name="struts.enable.DynamicMethodInvocation" value="true"/>
     <constant name="struts.mapper.action.prefix.enabled" value="true"/>
+    <constant name="struts.allowlist.classes" value="org.apache.struts.helloworld.model.MessageStore"/>
 
     <package name="basicstruts" namespace="/" extends="struts-default">
         <default-action-ref name="index"/>
@@ -33,7 +34,7 @@
         <action name="register" class="org.apache.struts.register.action.Register" method="input">
             <result name="input">/WEB-INF/register.jsp</result>
         </action>
-        <action name="register-cancel" class="org.apache.struts.register.action.Register" method="cancel2">
+        <action name="register-cancel">
             <result type="redirectAction">index</result>
         </action>
         <action name="register-submit" class="org.apache.struts.register.action.Register" method="execute2">
diff --git a/form-processing/src/main/webapp/WEB-INF/index.jsp b/form-processing/src/main/webapp/WEB-INF/index.jsp
@@ -20,6 +20,6 @@
       <s:submit value="Submit" />
     </s:form>
 
-    <p><a href="register">Please register</a> for our prize drawing.</p>
+    <p><a href="<s:url action='register'/>">Please register</a> for our prize drawing.</p>
   </body>
 </html>
diff --git a/form-processing/src/main/webapp/WEB-INF/register.jsp b/form-processing/src/main/webapp/WEB-INF/register.jsp
@@ -9,7 +9,7 @@
 <body>
 <h3>Register for a prize by completing this form.</h3>
 
-<s:form action="register-submit" namespace="test">
+<s:form action="register-submit" namespace="/test">
     <s:textfield name="personBean.firstName" label="First name"/>
     <s:textfield name="personBean.lastName" label="Last name"/>
     <s:textfield name="personBean.email" label="Email"/>
diff --git a/form-processing/src/main/webapp/WEB-INF/web.xml b/form-processing/src/main/webapp/WEB-INF/web.xml
@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<web-app id="WebApp_ID" version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
+<web-app id="WebApp_ID" version="6.0"
+    xmlns="https://jakarta.ee/xml/ns/jakartaee"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd">
     <display-name>Form_Processing_Struts2_Mvn</display-name>
 
     <filter>

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`import org.apache.struts.helloworld.model.MessageStore;`
`4`	`4`	`import org.apache.struts2.ActionSupport;`
	`5`	`+import org.apache.struts2.interceptor.parameter.StrutsParameter;`
`5`	`6`
`6`	`7`	`/**`
`7`	`8`	`* Acts as a Struts 2 controller that responds`
`@@ -37,6 +38,7 @@ public String getUserName() {`
`37`	`38`	`return userName;`
`38`	`39`	`}`
`39`	`40`
	`41`	`+ @StrutsParameter`
`40`	`42`	`public void setUserName(String userName) {`
`41`	`43`	`this.userName = userName;`
`42`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`
`3`	`3`	`import org.apache.struts.register.model.Person;`
`4`	`4`	`import org.apache.struts2.ActionSupport;`
	`5`	`+import org.apache.struts2.interceptor.parameter.StrutsParameter;`
`5`	`6`
`6`		`-import java.util.ArrayList;`
`7`	`7`	`import java.util.List;`
`8`	`8`
`9`	`9`	`public class Register extends ActionSupport {`
`@@ -17,15 +17,10 @@ public String execute2() throws Exception {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`public String input() throws Exception {`
`20`		`- this.options = new ArrayList<>();`
`21`		`- this.options.add(3);`
`22`	`20`	`return INPUT;`
`23`	`21`	`}`
`24`	`22`
`25`		`- public String cancel2() throws Exception {`
`26`		`- return SUCCESS;`
`27`		`- }`
`28`		`-`
	`23`	`+ @StrutsParameter(depth = 1)`
`29`	`24`	`public Person getPersonBean() {`
`30`	`25`	`return personBean;`
`31`	`26`	`}`
`@@ -34,6 +29,7 @@ public void setPersonBean(Person person) {`
`34`	`29`	`personBean = person;`
`35`	`30`	`}`
`36`	`31`
	`32`	`+ @StrutsParameter(depth = 1)`
`37`	`33`	`public List<Integer> getOptions() {`
`38`	`34`	`return options;`
`39`	`35`	`}`