Commits

rainerh  committed 7d94096

Update all S2 Wiki docs and S2/XW JavaDocs to reflect camelCase interceptor and result names.

Issue Number: WW-2491

git-svn-id: http://svn.opensymphony.com/svn/xwork/trunk@1768e221344d-f017-0410-9bd5-d282ab1896d7

  • Participants
  • Parent commits d7ca195

Comments (0)

Files changed (16)

File docs/wikidocs/AnnotationWorkflowInterceptor.html

 <p>Configure a stack in xwork.xml that replaces the PrepareInterceptor with the AnnotationWorkflowInterceptor:</p>
 <div class="code"><div class="codeContent">
 <pre class="code-xml"><span class="code-tag">&lt;interceptor-stack name=<span class="code-quote">"annotatedStack"</span>&gt;</span>
-<span class="code-tag">&lt;interceptor-ref name=<span class="code-quote">"static-params"</span>/&gt;</span>
+<span class="code-tag">&lt;interceptor-ref name=<span class="code-quote">"staticParams"</span>/&gt;</span>
 <span class="code-tag">&lt;interceptor-ref name=<span class="code-quote">"params"</span>/&gt;</span>
 <span class="code-tag">&lt;interceptor-ref name=<span class="code-quote">"conversionError"</span>/&gt;</span>
 <span class="code-tag">&lt;interceptor-ref name=<span class="code-quote">"annotationWorkflow"</span>/&gt;</span>

File docs/wikidocs/XWork Interceptors.html

 	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
 		    <tr>
 			    <td valign="top" class="pagebody">
-				    <p>Interceptor is a core component with XWork2. XWork2 has been designed with action interception in mind from ground up. Basically and interceptor wrappes around XWork2 Action. It is cappable of influencing the overall result, and hence affecting which result eventually get executed. In the process it have access to XWork2 Action, its proxy (ActionProxy), ActionInvocation etc. such that the interceptor could inspect the internals of XWork2 before comming up with a overall conclusion of what it should do.</p>
-
-<h3><a name="XWorkInterceptors-DefaultinterceptorsthatcomeswithXWork2"></a>Default interceptors that comes with XWork2</h3>
-
-<div class="code"><div class="codeContent">
-<pre class="code-xml"><span class="code-tag">&lt;interceptor name=<span class="code-quote">"timer"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.TimerInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"logger"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.LoggingInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"chain"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ChainingInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"static-params"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"params"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ParametersInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"model-driven"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"scoped-model-driven"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"validation"</span> class=<span class="code-quote">"com.opensymphony.xwork2.validator.ValidationInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"workflow"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"prepare"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.PrepareInterceptor"</span>/&gt;</span>
-         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"conversionError"</span>  class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ConversionErrorInterceptor"</span>/&gt;</span>
-<span class="code-tag">&lt;interceptor name=<span class="code-quote">"alias"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.AliasInterceptor"</span>/&gt;</span></pre>
+				    <p>Interceptor is a core component with XWork2. XWork2 has been designed with action interception in mind from ground up. Basically and interceptor wrappes around XWork2 Action. It is cappable of influencing the overall result, and hence affecting which result eventually get executed. In the process it have access to XWork2 Action, its proxy (ActionProxy), ActionInvocation etc. such that the interceptor could inspect the internals of XWork2 before comming up with a overall conclusion of what it should do.</p>
+
+<h3><a name="XWorkInterceptors-DefaultinterceptorsthatcomeswithXWork2"></a>Default interceptors that comes with XWork2</h3>
+
+<div class="code"><div class="codeContent">
+<pre class="code-xml"><span class="code-tag">&lt;interceptor name=<span class="code-quote">"timer"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.TimerInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"logger"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.LoggingInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"chain"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ChainingInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"staticParams"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"params"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ParametersInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"modelDriven"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"scopedModelDriven"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"validation"</span> class=<span class="code-quote">"com.opensymphony.xwork2.validator.ValidationInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"workflow"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"prepare"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.PrepareInterceptor"</span>/&gt;</span>
+         <span class="code-tag">&lt;interceptor name=<span class="code-quote">"conversionError"</span>  class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.ConversionErrorInterceptor"</span>/&gt;</span>
+<span class="code-tag">&lt;interceptor name=<span class="code-quote">"alias"</span> class=<span class="code-quote">"com.opensymphony.xwork2.interceptor.AliasInterceptor"</span>/&gt;</span></pre>
 </div></div>
 
                     			    </td>

File src/java/com/opensymphony/xwork2/interceptor/ExceptionMappingInterceptor.java

  * &lt;xwork&gt;
  *   &lt;package name="something" extends="xwork-default"&gt;
  *      &lt;interceptors&gt;
- *          &lt;interceptor-stack name="exceptionmapping-stack"&gt;
+ *          &lt;interceptor-stack name="exceptionmappingStack"&gt;
  *              &lt;interceptor-ref name="exception"&gt;
  *                  &lt;param name="logEnabled"&gt;true&lt;/param&gt;
  *                  &lt;param name="logCategory"&gt;com.mycompany.app.unhandled&lt;/param&gt;
  *                  &lt;param name="logLevel"&gt;WARN&lt;/param&gt;	        		
  *              &lt;/interceptor-ref&gt;	
  *              &lt;interceptor-ref name="i18n"/&gt;
- *              &lt;interceptor-ref name="static-params"/&gt;
+ *              &lt;interceptor-ref name="staticParams"/&gt;
  *              &lt;interceptor-ref name="params"/&gt;
  *              &lt;interceptor-ref name="validation"&gt;
  *                  &lt;param name="excludeMethods"&gt;input,back,cancel,browse&lt;/param&gt;
  *          &lt;/interceptor-stack&gt;
  *      &lt;/interceptors&gt;
  *
- *      &lt;default-interceptor-ref name="exceptionmapping-stack"/&gt;
+ *      &lt;default-interceptor-ref name="exceptionmappingStack"/&gt;
  *    
  *      &lt;global-results&gt;
  *           &lt;result name="unhandledException"&gt;/unhandled-exception.jsp&lt;/result&gt;

File src/java/com/opensymphony/xwork2/interceptor/ParameterRemoverInterceptor.java

  *   		&lt;param name="paramNames"&gt;aParam,anotherParam&lt;/param&gt;
  *   		&lt;param name="paramValues"&gt;--,-1&lt;/param&gt;
  * 	&lt;/interceptor-ref&gt;
- * 	&lt;interceptor-ref name="default-stack" /&gt;
+ * 	&lt;interceptor-ref name="defaultStack" /&gt;
  * 	...
  * &lt;/action&gt;
  *  

File src/java/com/opensymphony/xwork2/interceptor/ScopedModelDrivenInterceptor.java

  * <!-- START SNIPPET: example -->
  * 
  * &lt;-- Basic usage --&gt;
- * &lt;interceptor name="scoped-model-driven" class="com.opensymphony.interceptor.ScopedModelDrivenInterceptor" /&gt;
+ * &lt;interceptor name="scopedModelDriven" class="com.opensymphony.interceptor.ScopedModelDrivenInterceptor" /&gt;
  * 
  * &lt;-- Using all available parameters --&gt;
  * &lt;interceptor name="gangsterForm" class="com.opensymphony.interceptor.ScopedModelDrivenInterceptor"&gt;

File src/java/com/opensymphony/xwork2/interceptor/StaticParametersInterceptor.java

  * <pre>
  * <!-- START SNIPPET: example -->
  * &lt;action name="someAction" class="com.examples.SomeAction"&gt;
- *     &lt;interceptor-ref name="static-params"&gt;
+ *     &lt;interceptor-ref name="staticParams"&gt;
  *          &lt;param name="parse"&gt;true&lt;/param&gt;
  *     &lt;/interceptor-ref&gt;
  *     &lt;result name="success"&gt;good_result.ftl&lt;/result&gt;

File src/java/com/opensymphony/xwork2/interceptor/annotations/AnnotationWorkflowInterceptor.java

  * <pre>
  * <!-- START SNIPPET: stack -->
  * &lt;interceptor-stack name="annotatedStack"&gt;
- * 	&lt;interceptor-ref name="static-params"/&gt;
+ * 	&lt;interceptor-ref name="staticParams"/&gt;
  * 	&lt;interceptor-ref name="params"/&gt;
  * 	&lt;interceptor-ref name="conversionError"/&gt;
  * 	&lt;interceptor-ref name="annotationWorkflow"/&gt;

File src/java/xwork-default.xml

             <interceptor name="timer" class="com.opensymphony.xwork2.interceptor.TimerInterceptor"/>
             <interceptor name="logger" class="com.opensymphony.xwork2.interceptor.LoggingInterceptor"/>
             <interceptor name="chain" class="com.opensymphony.xwork2.interceptor.ChainingInterceptor"/>
-            <interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
             <interceptor name="params" class="com.opensymphony.xwork2.interceptor.ParametersInterceptor"/>
-            <interceptor name="filter-params" class="com.opensymphony.xwork2.interceptor.ParameterFilterInterceptor"/>
-            <interceptor name="remove-params" class="com.opensymphony.xwork2.interceptor.ParameterRemoverInterceptor"/>
-            <interceptor name="model-driven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
-            <interceptor name="scoped-model-driven"
+            <interceptor name="filterParams" class="com.opensymphony.xwork2.interceptor.ParameterFilterInterceptor"/>
+            <interceptor name="removeParams" class="com.opensymphony.xwork2.interceptor.ParameterRemoverInterceptor"/>
+            <interceptor name="modelDriven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
+            <interceptor name="scopedModelDriven"
                          class="com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor"/>
             <interceptor name="validation" class="com.opensymphony.xwork2.validator.ValidationInterceptor"/>
             <interceptor name="workflow" class="com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor"/>
 
             <!-- END SNIPPET: xwork2-default-interceptors -->
 
+            <!--interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="filter-params" class="com.opensymphony.xwork2.interceptor.ParameterFilterInterceptor"/>
+            <interceptor name="remove-params" class="com.opensymphony.xwork2.interceptor.ParameterRemoverInterceptor"/>
+            <interceptor name="model-driven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
+            <interceptor name="scoped-model-driven"
+                         class="com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor"/-->
 
             <!-- START SNIPPET: xwork2-default-interceptor-stack -->
 
             <interceptor-stack name="emptyStack"/>
 
             <interceptor-stack name="defaultStack">
-                <interceptor-ref name="static-params"/>
+                <interceptor-ref name="staticParams"/>
                 <interceptor-ref name="params"/>
                 <interceptor-ref name="conversionError"/>
             </interceptor-stack>

File src/test/com/opensymphony/xwork2/config/providers/MockConfigurationProvider.java

         results.put(Action.ERROR, new ResultConfig.Builder(Action.ERROR, MockResult.class.getName()).build());
 
         interceptors = new ArrayList();
-        interceptors.add(new InterceptorMapping("static-params", 
+        interceptors.add(new InterceptorMapping("staticParams", 
                 objectFactory.buildInterceptor(new InterceptorConfig.Builder("model", StaticParametersInterceptor.class.getName()).build(), new HashMap())));
         interceptors.add(new InterceptorMapping("model", 
                 objectFactory.buildInterceptor(new InterceptorConfig.Builder("model", ModelDrivenInterceptor.class.getName()).build(), new HashMap())));

File src/test/com/opensymphony/xwork2/config/providers/xwork-include-after-package.xml

 <xwork>
     <package name="namespace4" extends="namespace1" namespace="/namespace4">
         <interceptors>
-            <interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
         </interceptors>
 
         <action name="action4" class="com.opensymphony.xwork2.SimpleAction">

File src/test/com/opensymphony/xwork2/config/providers/xwork-include-before-package.xml

 
     <package name="namespace1" extends="default" namespace="/namespace1">
         <interceptors>
-            <interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
         </interceptors>
 
         <action name="action1" class="com.opensymphony.xwork2.SimpleAction">

File src/test/com/opensymphony/xwork2/config/providers/xwork-test-multilevel.xml

 
     <package name="namespace1" extends="default" namespace="/namespace1">
         <interceptors>
-            <interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
         </interceptors>
 
         <action name="action1" class="com.opensymphony.xwork2.SimpleAction">
         <action name="action3" class="com.opensymphony.xwork2.SimpleAction">
             <result name="success" type="chain"/>
             <interceptor-ref name="params"/>
-            <interceptor-ref name="static-params"/>
+            <interceptor-ref name="staticParams"/>
         </action>
     </package>
 

File src/test/xwork-proxyinvoke.xml

             <interceptor name="logger" class="com.opensymphony.xwork2.interceptor.LoggingInterceptor"/>
             <interceptor name="chain" class="com.opensymphony.xwork2.interceptor.ChainingInterceptor"/>
             <interceptor name="params" class="com.opensymphony.xwork2.interceptor.ParametersInterceptor"/>
-            <interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
-            <interceptor name="model-driven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
+            <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="modelDriven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
             <interceptor name="validation" class="com.opensymphony.xwork2.validator.ValidationInterceptor"/>
 			<interceptor name="alias" class="com.opensymphony.xwork2.interceptor.AliasInterceptor"/>
             <interceptor name="test" class="com.opensymphony.xwork2.mock.MockInterceptor">
             </interceptor>
 
             <interceptor-stack name="defaultStack">
-                <interceptor-ref name="static-params"/>
-                <interceptor-ref name="model-driven"/>
+                <interceptor-ref name="staticParams"/>
+                <interceptor-ref name="modelDriven"/>
                 <interceptor-ref name="params"/>
             </interceptor-stack>
 

File src/test/xwork-sample.xml

                 <param name="actionName">bar</param>
             </result>
             <result name="success" type="mock" />
-            <interceptor-ref name="static-params"/>
+            <interceptor-ref name="staticParams"/>
         </action>
         <action name="myCommand" class="com.opensymphony.xwork2.SimpleAction" method="commandMethod">
             <param name="bar">456</param>
     <package name="wildcardNamespaces" extends="default" namespace="/animals/*">
         <action name="commandTest" class="com.opensymphony.xwork2.SimpleAction">
             <result name="success" type="mock" />
-            <interceptor-ref name="static-params"/>
+            <interceptor-ref name="staticParams"/>
         </action>
     </package>
 

File src/test/xwork-test-default.xml

             <interceptor name="logger" class="com.opensymphony.xwork2.interceptor.LoggingInterceptor"/>
             <interceptor name="chain" class="com.opensymphony.xwork2.interceptor.ChainingInterceptor"/>
             <interceptor name="params" class="com.opensymphony.xwork2.interceptor.ParametersInterceptor"/>
-            <interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
-            <interceptor name="model-driven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
+            <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="modelDriven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
             <interceptor name="validation" class="com.opensymphony.xwork2.validator.ValidationInterceptor"/>
 			<interceptor name="alias" class="com.opensymphony.xwork2.interceptor.AliasInterceptor"/>
             <interceptor name="test" class="com.opensymphony.xwork2.mock.MockInterceptor">
             </interceptor>
 
             <interceptor-stack name="defaultStack">
-                <interceptor-ref name="static-params"/>
-                <interceptor-ref name="model-driven"/>
+                <interceptor-ref name="staticParams"/>
+                <interceptor-ref name="modelDriven"/>
                 <interceptor-ref name="params"/>
             </interceptor-stack>
 

File src/test/xwork-test-validation.xml

             <interceptor name="logger" class="com.opensymphony.xwork2.interceptor.LoggingInterceptor"/>
             <interceptor name="chain" class="com.opensymphony.xwork2.interceptor.ChainingInterceptor"/>
             <interceptor name="params" class="com.opensymphony.xwork2.interceptor.ParametersInterceptor"/>
-            <interceptor name="static-params" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
-            <interceptor name="model-driven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
+            <interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
+            <interceptor name="modelDriven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
             <interceptor name="validation" class="com.opensymphony.xwork2.validator.ValidationInterceptor">
                 <param name="validateAnnotatedMethodOnly">true</param>
             </interceptor>
             </interceptor>
 
             <interceptor-stack name="defaultStack">
-                <interceptor-ref name="static-params"/>
-                <interceptor-ref name="model-driven"/>
+                <interceptor-ref name="staticParams"/>
+                <interceptor-ref name="modelDriven"/>
                 <interceptor-ref name="params"/>
             </interceptor-stack>
 
             </interceptor-stack>
 
             <interceptor-stack name="validationStack">
-                <interceptor-ref name="static-params"/>
-                <interceptor-ref name="model-driven"/>
+                <interceptor-ref name="staticParams"/>
+                <interceptor-ref name="modelDriven"/>
                 <interceptor-ref name="params"/>
                 <interceptor-ref name="validation"/>
             </interceptor-stack>