This is an automated email from the ASF dual-hosted git repository.
smolnar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/knox.git
The following commit(s) were added to refs/heads/master by this push:
new 529bf24c9 KNOX-3044 - Port numbers are written with ',' format in logs
(#919)
529bf24c9 is described below
commit 529bf24c92bdab0b4dcd171198efc68522594964
Author: senthh <[email protected]>
AuthorDate: Thu Jul 4 11:49:20 2024 +0530
KNOX-3044 - Port numbers are written with ',' format in logs (#919)
---
.../org/apache/knox/gateway/GatewayMessages.java | 16 ++++++-------
.../org/apache/knox/gateway/GatewayServer.java | 28 +++++++++++++++-------
2 files changed, 27 insertions(+), 17 deletions(-)
diff --git
a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
index 7206c6271..6b97ac713 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
@@ -46,7 +46,7 @@ public interface GatewayMessages {
void failedToStartGateway( @StackTrace( level = MessageLevel.FATAL )
Exception e );
@Message( level = MessageLevel.INFO, text = "Started gateway on port {0}." )
- void startedGateway( int port );
+ void startedGateway( String port );
@Message( level = MessageLevel.INFO, text = "Stopping gateway..." )
void stoppingGateway();
@@ -472,7 +472,7 @@ public interface GatewayMessages {
@Message(level = MessageLevel.ERROR,
text = "No topology mapped to port: {0}")
- void noTopologyMappedToPort(int port);
+ void noTopologyMappedToPort(String port);
@Message(level = MessageLevel.ERROR,
text = "Could not find topology {0} specified in port mapping
config")
@@ -480,7 +480,7 @@ public interface GatewayMessages {
@Message(level = MessageLevel.DEBUG,
text = "Creating a connector for topology {0} listening on port
{1}.")
- void createJettyConnector(String topology, int port);
+ void createJettyConnector(String topology, String port);
@Message(level = MessageLevel.DEBUG,
text = "Creating a handler for topology {0}.")
@@ -498,26 +498,26 @@ public interface GatewayMessages {
@Message(level = MessageLevel.ERROR,
text = "Port {0} configured for Topology - {1} is already in use.")
- void portAlreadyInUse(int port, String topology);
+ void portAlreadyInUse(String port, String topology);
@Message(level = MessageLevel.ERROR,
text = "Port {0} is already in use.")
- void portAlreadyInUse(int port);
+ void portAlreadyInUse(String port);
@Message(level = MessageLevel.INFO,
text = "Started gateway, topology \"{0}\" listening on port
\"{1}\".")
- void startedGateway(String topology, int port);
+ void startedGateway(String topology, String port);
@Message(level = MessageLevel.ERROR,
text = "Topology \"{0}\" failed to start listening on port
\"{1}\".")
- void startedGatewayPortConflict(String topology, int port);
+ void startedGatewayPortConflict(String topology, String port);
@Message(level = MessageLevel.ERROR,
text =
" Could not find topology \"{0}\" mapped to port \"{1}\"
configured in gateway-config.xml. "
+ "This invalid topology mapping will be ignored by the
gateway. "
+ "Gateway restart will be required if in the future
\"{0}\" topology is added.")
- void topologyPortMappingCannotFindTopology(String topology, int port);
+ void topologyPortMappingCannotFindTopology(String topology, String port);
@Message(level = MessageLevel.ERROR,
text = "Port mapped topology {0} cannot be configured as default
topology")
diff --git
a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
index e81385363..b335d64a8 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
@@ -380,9 +380,9 @@ public class GatewayServer {
}
}
if (networkConnector.getName() == null) {
- log.startedGateway(networkConnector.getLocalPort());
+
log.startedGateway(convertPortToString(networkConnector.getLocalPort()));
} else {
- log.startedGateway(networkConnector.getName(),
networkConnector.getLocalPort());
+ log.startedGateway(networkConnector.getName(),
convertPortToString(networkConnector.getLocalPort()));
}
}
}
@@ -548,9 +548,9 @@ public class GatewayServer {
// Throw an exception if port in use
if (isPortInUse(port)) {
if (topologyName == null) {
- log.portAlreadyInUse(port);
+ log.portAlreadyInUse(convertPortToString(port));
} else {
- log.portAlreadyInUse(port, topologyName);
+ log.portAlreadyInUse(convertPortToString(port), topologyName);
}
throw new IOException(String.format(Locale.ROOT, "Port %d already in
use.", port));
}
@@ -560,7 +560,7 @@ public class GatewayServer {
// If we have Default Topology old and new configuration (Port Mapping)
throw error.
if (config.getGatewayPortMappings().containsValue(port)
&& !StringUtils.isBlank(config.getDefaultTopologyName())) {
- log.portAlreadyInUse(port);
+ log.portAlreadyInUse(convertPortToString(port));
throw new IOException(String.format(Locale.ROOT,
" Please map port %d using either \"gateway.port.mapping.sandbox\"
or "
+ "\"default.app.topology.name\" property, "
@@ -573,7 +573,7 @@ public class GatewayServer {
for (Connector connector : connectors) {
if (connector instanceof ServerConnector
&& ((ServerConnector) connector).getPort() == port) {
- log.portAlreadyInUse(port, topologyName);
+ log.portAlreadyInUse(convertPortToString(port), topologyName);
throw new IOException(String.format(Locale.ROOT,
" Port %d used by topology %s is used by other topology, ports
for topologies (if defined) have to be unique. ",
port, topologyName));
@@ -673,7 +673,7 @@ public class GatewayServer {
// Add connector for only valid topologies, i.e. deployed topologies.
// and NOT for Default Topology listening on standard gateway port.
if(deployedTopologyList.contains(entry.getKey()) && (entry.getValue()
!= config.getGatewayPort()) ) {
- log.createJettyConnector(entry.getKey().toLowerCase(Locale.ROOT),
entry.getValue());
+ log.createJettyConnector(entry.getKey().toLowerCase(Locale.ROOT),
convertPortToString(entry.getValue()));
try {
connectors = createConnector(jetty, config, entry.getValue(),
entry.getKey().toLowerCase(Locale.ROOT));
for (Connector connector : connectors) {
@@ -682,7 +682,7 @@ public class GatewayServer {
} catch(final IOException e) {
/* in case of port conflict we log error and move on */
if( e.toString().contains("ports for topologies (if defined) have
to be unique.") ) {
-
log.startedGatewayPortConflict(entry.getKey().toLowerCase(Locale.ROOT),
entry.getValue());
+
log.startedGatewayPortConflict(entry.getKey().toLowerCase(Locale.ROOT),
convertPortToString(entry.getValue()));
} else {
throw e;
}
@@ -756,6 +756,16 @@ public class GatewayServer {
}
}
+ /**
+ * Check whether a port is free
+ *
+ * @param port port to convert
+ * @return value of port in String
+ */
+ private static String convertPortToString(int port) {
+ return String.valueOf(port);
+ }
+
/**
* Checks whether the topologies defined in gateway-xml as part of Topology
* Port mapping feature exists. If it does not Log a message and move on.
@@ -766,7 +776,7 @@ public class GatewayServer {
for(final Map.Entry<String, Integer> entry : configTopologies.entrySet()) {
// If the topologies defined in gateway-config.xml are not found in
gateway
if (!topologies.contains(entry.getKey())) {
- log.topologyPortMappingCannotFindTopology(entry.getKey(),
entry.getValue());
+ log.topologyPortMappingCannotFindTopology(entry.getKey(),
convertPortToString(entry.getValue()));
}
}
}
