This is an automated email from the ASF dual-hosted git repository.
jleroux pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/trunk by this push:
new aab412b Improved: Fix some bugs Spotbugs reports (OFBIZ-12386)
aab412b is described below
commit aab412b94827e4fcc8c79f7d6ecb528f8695862b
Author: Jacques Le Roux <jacques.le.r...@les7arts.com>
AuthorDate: Sun Dec 5 13:03:50 2021 +0100
Improved: Fix some bugs Spotbugs reports (OFBIZ-12386)
Renames ControlServlet class to OfbizControlServlet, because it shadowed the
simple name of it superclass
It can be exceptionally confusing, create lots of situations in which you
have
to look at import statements to resolve references and creates many
opportunities to accidentally define methods that do not override methods
in their superclasses.
Same for XmlRpcClient.java
---
.../apache/ofbiz/product/category/CatalogUrlSeoFilter.java | 2 +-
.../{ControlServlet.java => OfbizControlServlet.java} | 12 +++++-------
.../ofbiz/base/util/collections/FlexibleServletAccessor.java | 3 ++-
.../org/apache/ofbiz/service/engine/XMLRPCClientEngine.java | 8 ++++----
.../apache/ofbiz/service/test/AbstractXmlRpcTestCase.java | 6 +++---
.../xmlrpc/{XmlRpcClient.java => OfbizXmlRpcClient.java} | 8 ++++----
6 files changed, 19 insertions(+), 20 deletions(-)
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/category/CatalogUrlSeoFilter.java
b/applications/product/src/main/java/org/apache/ofbiz/product/category/CatalogUrlSeoFilter.java
index 72683aa..b1cb981 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/category/CatalogUrlSeoFilter.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/category/CatalogUrlSeoFilter.java
@@ -60,7 +60,7 @@ public class CatalogUrlSeoFilter extends CatalogUrlFilter {
// set the ServletContext in the request for future use
httpRequest.setAttribute("servletContext",
getConfig().getServletContext());
- if (CatalogUrlSeoTransform.forwardUri(httpRequest, httpResponse,
delegator, ControlServlet.getControlServlet())) {
+ if (CatalogUrlSeoTransform.forwardUri(httpRequest, httpResponse,
delegator, OfbizControlServlet.getControlServlet())) {
return;
}
super.doFilter(httpRequest, httpResponse, chain);
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ControlServlet.java
b/applications/product/src/main/java/org/apache/ofbiz/product/category/OfbizControlServlet.java
similarity index 89%
rename from
applications/product/src/main/java/org/apache/ofbiz/product/category/ControlServlet.java
rename to
applications/product/src/main/java/org/apache/ofbiz/product/category/OfbizControlServlet.java
index 99d1dde..d514bd2 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ControlServlet.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/category/OfbizControlServlet.java
@@ -28,15 +28,13 @@ import org.apache.ofbiz.base.util.UtilValidate;
* ControlServlet.java - Master servlet for the web application.
*/
@SuppressWarnings("serial")
-public class ControlServlet extends
org.apache.ofbiz.webapp.control.ControlServlet {
-
- private static final String MODULE = ControlServlet.class.getName();
+public class OfbizControlServlet extends
org.apache.ofbiz.webapp.control.ControlServlet {
private static String defaultPage = null;
private static String pageNotFound = null;
private static String controlServlet = null;
- public ControlServlet() {
+ public OfbizControlServlet() {
super();
}
@@ -69,7 +67,7 @@ public class ControlServlet extends
org.apache.ofbiz.webapp.control.ControlServl
}
public static void setDefaultPage(String defaultPage) {
- ControlServlet.defaultPage = defaultPage;
+ OfbizControlServlet.defaultPage = defaultPage;
}
public static String getPageNotFound() {
@@ -77,7 +75,7 @@ public class ControlServlet extends
org.apache.ofbiz.webapp.control.ControlServl
}
public static void setPageNotFound(String pageNotFound) {
- ControlServlet.pageNotFound = pageNotFound;
+ OfbizControlServlet.pageNotFound = pageNotFound;
}
public static String getControlServlet() {
@@ -85,7 +83,7 @@ public class ControlServlet extends
org.apache.ofbiz.webapp.control.ControlServl
}
public static void setControlServlet(String controlServlet) {
- ControlServlet.controlServlet = controlServlet;
+ OfbizControlServlet.controlServlet = controlServlet;
}
}
diff --git
a/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/FlexibleServletAccessor.java
b/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/FlexibleServletAccessor.java
index 32ab094..521ede6 100644
---
a/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/FlexibleServletAccessor.java
+++
b/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/FlexibleServletAccessor.java
@@ -173,7 +173,8 @@ public class FlexibleServletAccessor<T> implements
Serializable {
return this.name.hashCode();
}
- /** The equals and hashCode methods are implemented just case this object
is ever accidently used as a Map key
+ /**
+ * The equals and hashCode methods are implemented just in case this
object is ever accidently used as a Map key
* @param obj
* @return whether this object is equal to the passed object
*/
diff --git
a/framework/service/src/main/java/org/apache/ofbiz/service/engine/XMLRPCClientEngine.java
b/framework/service/src/main/java/org/apache/ofbiz/service/engine/XMLRPCClientEngine.java
index 4a986dc..b312b0d 100644
---
a/framework/service/src/main/java/org/apache/ofbiz/service/engine/XMLRPCClientEngine.java
+++
b/framework/service/src/main/java/org/apache/ofbiz/service/engine/XMLRPCClientEngine.java
@@ -36,7 +36,7 @@ import org.apache.ofbiz.service.ModelService;
import org.apache.ofbiz.service.ServiceDispatcher;
import org.apache.ofbiz.service.ServiceUtil;
import org.apache.ofbiz.service.config.ServiceConfigUtil;
-import org.apache.ofbiz.service.xmlrpc.XmlRpcClient;
+import org.apache.ofbiz.service.xmlrpc.OfbizXmlRpcClient;
import org.apache.xmlrpc.XmlRpcException;
import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;
@@ -82,7 +82,7 @@ public class XMLRPCClientEngine extends GenericAsyncEngine {
}
XmlRpcClientConfigImpl config = null;
- XmlRpcClient client = null;
+ OfbizXmlRpcClient client = null;
String serviceName = modelService.getInvoke();
String engine = modelService.getEngineName();
String url = null;
@@ -116,9 +116,9 @@ public class XMLRPCClientEngine extends GenericAsyncEngine {
throw new GenericServiceException("Cannot invoke service : engine
parameters are not correct");
}
if (UtilValidate.isNotEmpty(keyStoreComponent) &&
UtilValidate.isNotEmpty(keyStoreName) && UtilValidate.isNotEmpty(keyAlias)) {
- client = new XmlRpcClient(config, keyStoreComponent, keyStoreName,
keyAlias);
+ client = new OfbizXmlRpcClient(config, keyStoreComponent,
keyStoreName, keyAlias);
} else {
- client = new XmlRpcClient(config);
+ client = new OfbizXmlRpcClient(config);
}
List<ModelParam> inModelParamList = modelService.getInModelParamList();
diff --git
a/framework/service/src/main/java/org/apache/ofbiz/service/test/AbstractXmlRpcTestCase.java
b/framework/service/src/main/java/org/apache/ofbiz/service/test/AbstractXmlRpcTestCase.java
index 2390b35..e7c8e23 100644
---
a/framework/service/src/main/java/org/apache/ofbiz/service/test/AbstractXmlRpcTestCase.java
+++
b/framework/service/src/main/java/org/apache/ofbiz/service/test/AbstractXmlRpcTestCase.java
@@ -22,7 +22,7 @@ package org.apache.ofbiz.service.test;
import java.net.MalformedURLException;
import java.net.URL;
-import org.apache.ofbiz.service.xmlrpc.XmlRpcClient;
+import org.apache.ofbiz.service.xmlrpc.OfbizXmlRpcClient;
import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;
import junit.framework.TestCase;
@@ -82,8 +82,8 @@ public class AbstractXmlRpcTestCase extends TestCase {
}
if (keyStoreComponent != null && keyStoreName != null && keyAlias !=
null) {
- return new XmlRpcClient(config, keyStoreComponent, keyStoreName,
keyAlias);
+ return new OfbizXmlRpcClient(config, keyStoreComponent,
keyStoreName, keyAlias);
}
- return new XmlRpcClient(config);
+ return new OfbizXmlRpcClient(config);
}
}
diff --git
a/framework/service/src/main/java/org/apache/ofbiz/service/xmlrpc/XmlRpcClient.java
b/framework/service/src/main/java/org/apache/ofbiz/service/xmlrpc/OfbizXmlRpcClient.java
similarity index 87%
rename from
framework/service/src/main/java/org/apache/ofbiz/service/xmlrpc/XmlRpcClient.java
rename to
framework/service/src/main/java/org/apache/ofbiz/service/xmlrpc/OfbizXmlRpcClient.java
index 9b39845..4cd01cf 100644
---
a/framework/service/src/main/java/org/apache/ofbiz/service/xmlrpc/XmlRpcClient.java
+++
b/framework/service/src/main/java/org/apache/ofbiz/service/xmlrpc/OfbizXmlRpcClient.java
@@ -30,15 +30,15 @@ import org.apache.xmlrpc.client.XmlRpcTransportFactory;
/**
* XmlRpcClient
*/
-public class XmlRpcClient extends org.apache.xmlrpc.client.XmlRpcClient {
+public class OfbizXmlRpcClient extends org.apache.xmlrpc.client.XmlRpcClient {
- private static final String MODULE = XmlRpcClient.class.getName();
+ private static final String MODULE = OfbizXmlRpcClient.class.getName();
private String keyStoreComponent;
private String keyStoreName;
private String keyAlias;
- public XmlRpcClient(XmlRpcClientConfig config, String keyStoreComponent,
String keyStoreName, String keyAlias) {
+ public OfbizXmlRpcClient(XmlRpcClientConfig config, String
keyStoreComponent, String keyStoreName, String keyAlias) {
this(config);
this.keyStoreComponent = keyStoreComponent;
this.keyStoreName = keyStoreName;
@@ -46,7 +46,7 @@ public class XmlRpcClient extends
org.apache.xmlrpc.client.XmlRpcClient {
this.setTransportFactory(this.getClientTransportFactory());
}
- public XmlRpcClient(XmlRpcClientConfig config) {
+ public OfbizXmlRpcClient(XmlRpcClientConfig config) {
super();
this.setConfig(config);
}
