Merge pull request #1009 from apache/7.0.x/WW-5453-rename-velocity

WW-5453 Rename VelocityManager interface and default implementation
apache · Aug 6, 2024 · 4679792 · 4679792
2 parents 3267a1a + 1b540c2
commit 4679792
Show file tree

Hide file tree

Showing 12 changed files with 464 additions and 466 deletions.
diff --git a/plugins/config-browser/src/main/java/org/apache/struts2/config_browser/ShowBeansAction.java b/plugins/config-browser/src/main/java/org/apache/struts2/config_browser/ShowBeansAction.java
@@ -30,7 +30,7 @@
 import org.apache.struts2.dispatcher.multipart.MultiPartRequest;
 import org.apache.struts2.views.freemarker.FreemarkerManager;
 import org.apache.struts2.views.velocity.VelocityConstants;
-import org.apache.struts2.views.velocity.VelocityManagerInterface;
+import org.apache.struts2.views.velocity.VelocityManager;
 
 import java.util.Map;
 import java.util.Set;
@@ -57,7 +57,7 @@ public void setContainer(Container container) {
         bindings.put(ActionMapper.class.getName(), addBindings(container, ActionMapper.class, StrutsConstants.STRUTS_MAPPER_CLASS));
         bindings.put(MultiPartRequest.class.getName(), addBindings(container, MultiPartRequest.class, StrutsConstants.STRUTS_MULTIPART_PARSER));
         bindings.put(FreemarkerManager.class.getName(), addBindings(container, FreemarkerManager.class, StrutsConstants.STRUTS_FREEMARKER_MANAGER_CLASSNAME));
-        bindings.put(VelocityManagerInterface.class.getName(), addBindings(container, VelocityManagerInterface.class, VelocityConstants.STRUTS_VELOCITY_MANAGER_CLASSNAME));
+        bindings.put(VelocityManager.class.getName(), addBindings(container, VelocityManager.class, VelocityConstants.STRUTS_VELOCITY_MANAGER_CLASSNAME));
         bindings.put(UrlRenderer.class.getName(), addBindings(container, UrlRenderer.class, StrutsConstants.STRUTS_URL_RENDERER));
     }
 

diff --git a/...sh/src/main/java/org/apache/struts2/sitemesh/OldDecorator2NewStrutsVelocityDecorator.java b/...sh/src/main/java/org/apache/struts2/sitemesh/OldDecorator2NewStrutsVelocityDecorator.java
@@ -29,7 +29,7 @@
 import jakarta.servlet.http.HttpServletResponse;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.apache.struts2.views.velocity.VelocityManagerInterface;
+import org.apache.struts2.views.velocity.VelocityManager;
 import org.apache.velocity.context.Context;
 
 import java.io.IOException;
@@ -41,10 +41,10 @@
 public class OldDecorator2NewStrutsVelocityDecorator extends OldDecorator2NewStrutsDecorator {
     private static final Logger LOG = LogManager.getLogger(OldDecorator2NewStrutsFreemarkerDecorator.class);
 
-    private static VelocityManagerInterface velocityManager;
+    private static VelocityManager velocityManager;
 
     @Inject(required = false)
-    public static void setVelocityManager(VelocityManagerInterface mgr) {
+    public static void setVelocityManager(VelocityManager mgr) {
         velocityManager = mgr;
     }
 

diff --git a/plugins/sitemesh/src/main/java/org/apache/struts2/sitemesh/VelocityDecoratorServlet.java b/plugins/sitemesh/src/main/java/org/apache/struts2/sitemesh/VelocityDecoratorServlet.java
@@ -27,24 +27,23 @@
 import com.opensymphony.module.sitemesh.RequestConstants;
 import com.opensymphony.module.sitemesh.util.OutputConverter;
 import com.opensymphony.xwork2.ActionContext;
+import jakarta.servlet.ServletConfig;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.struts2.ServletActionContext;
 import org.apache.struts2.dispatcher.Dispatcher;
 import org.apache.struts2.dispatcher.listener.StrutsListener;
+import org.apache.struts2.views.velocity.StrutsVelocityManager;
 import org.apache.struts2.views.velocity.VelocityManager;
-import org.apache.struts2.views.velocity.VelocityManagerInterface;
 import org.apache.velocity.Template;
 import org.apache.velocity.context.Context;
 import org.apache.velocity.runtime.RuntimeConstants;
 import org.apache.velocity.tools.view.VelocityView;
 import org.apache.velocity.tools.view.VelocityViewServlet;
 
-import jakarta.servlet.ServletConfig;
-import jakarta.servlet.ServletException;
-import jakarta.servlet.http.HttpServletRequest;
-import jakarta.servlet.http.HttpServletResponse;
-
 import java.io.IOException;
 import java.io.StringWriter;
 
@@ -61,7 +60,7 @@ public class VelocityDecoratorServlet extends VelocityViewServlet {
 
     private static final long serialVersionUID = -6731485159371716918L;
 
-    protected VelocityManagerInterface velocityManager;
+    protected VelocityManager velocityManager;
     protected String defaultContentType;
 
     /**
@@ -82,7 +81,7 @@ public void init(ServletConfig config) throws ServletException {
         if (dispatcher == null) {
             throw new IllegalStateException("Unable to find the Dispatcher in the Servlet Context. Is '" + StrutsListener.class.getName() + "' missing in web.xml?");
         }
-        velocityManager = dispatcher.getContainer().getInstance(VelocityManagerInterface.class);
+        velocityManager = dispatcher.getContainer().getInstance(VelocityManager.class);
         velocityManager.init(config.getServletContext());
 
         // do whatever we have to do to init Velocity
@@ -164,7 +163,7 @@ private DecoratorMapper getDecoratorMapper() {
      * @param response servlet reponse to client
      */
     protected Context createContext(HttpServletRequest request, HttpServletResponse response) {
-        Context context = (Context) request.getAttribute(VelocityManager.KEY_VELOCITY_STRUTS_CONTEXT);
+        Context context = (Context) request.getAttribute(StrutsVelocityManager.KEY_VELOCITY_STRUTS_CONTEXT);
         if (context == null) {
             ActionContext ctx = ServletActionContext.getActionContext(request);
             context = velocityManager.createContext(ctx.getValueStack(), request, response);

diff --git a/plugins/sitemesh/src/main/java/org/apache/struts2/sitemesh/VelocityPageFilter.java b/plugins/sitemesh/src/main/java/org/apache/struts2/sitemesh/VelocityPageFilter.java
@@ -25,15 +25,15 @@
 import com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext;
 import com.opensymphony.xwork2.inject.Inject;
 import jakarta.servlet.FilterConfig;
-import org.apache.struts2.views.velocity.VelocityManagerInterface;
+import org.apache.struts2.views.velocity.VelocityManager;
 
 /**
  * Core Filter for integrating SiteMesh into a Java web application.
  */
 public class VelocityPageFilter extends SiteMeshFilter {
 
     @Inject(required = false)
-    public static void setVelocityManager(VelocityManagerInterface mgr) {
+    public static void setVelocityManager(VelocityManager mgr) {
         OldDecorator2NewStrutsVelocityDecorator.setVelocityManager(mgr);
     }