Bug: 481097 - Exposing the currently connected server URI to client

Adds a new method getCurrentServerURI() to MqttClient and MqttAsyncClient that allows you to check which server you are connected to.
This is especially useful when you are providing a list of servers to the MqttConnectOptions as getServerURI only tells you the URI that you initialised the Client with.
Signed-off-by: James Sutton <james.sutton@uk.ibm.com>

Author: jpwsutton

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttAsyncClient.java

@@ -637,6 +637,21 @@ public String getClientId() {
 	public String getServerURI() {
 		return serverURI;
 	}
+	
+	/**
+	 * Returns the currently connected Server URI
+	 * Implemented due to: https://bugs.eclipse.org/bugs/show_bug.cgi?id=481097
+	 * 
+	 * Where getServerURI only returns the URI that was provided in
+	 * MqttAsyncClient's constructor, getCurrentServerURI returns the URI of the
+	 * Server that the client is currently connected to. This would be different in scenarios
+	 * where multiple server URIs have been provided to the MqttConnectOptions.
+	 * 
+	 * @return the currently connected server URI
+	 */
+	public String getCurrentServerURI(){
+		return comms.getNetworkModules()[comms.getNetworkModuleIndex()].getServerURI();
+	}
 
 	/**
 	 * Get a topic object which can be used to publish messages.

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttClient.java

@@ -459,6 +459,21 @@ public IMqttDeliveryToken[] getPendingDeliveryTokens() {
 	public String getServerURI() {
 		return aClient.getServerURI();
 	}
+	
+	/**
+	 * Returns the currently connected Server URI
+	 * Implemented due to: https://bugs.eclipse.org/bugs/show_bug.cgi?id=481097
+	 * 
+	 * Where getServerURI only returns the URI that was provided in
+	 * MqttAsyncClient's constructor, getCurrentServerURI returns the URI of the
+	 * Server that the client is currently connected to. This would be different in scenarios
+	 * where multiple server URIs have been provided to the MqttConnectOptions.
+	 * 
+	 * @return the currently connected server URI
+	 */
+	public String getCurrentServerURI(){
+		return aClient.getCurrentServerURI();
+	}
 
 	/* (non-Javadoc)
 	 * @see org.eclipse.paho.client.mqttv3.IMqttClient#getTopic(java.lang.String)

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/LocalNetworkModule.java

@@ -88,4 +88,8 @@ public void stop() throws IOException {
 			}
 		}
 	}
+	
+	public String getServerURI() {
+		return "local://" + brokerName;
+	}
 }

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/NetworkModule.java

@@ -30,4 +30,6 @@ public interface NetworkModule {
 	public OutputStream getOutputStream() throws IOException;
 
 	public void stop() throws IOException;
+
+	public String getServerURI();
 }

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/SSLNetworkModule.java

@@ -33,14 +33,18 @@ public class SSLNetworkModule extends TCPNetworkModule {
 
 	private String[] enabledCiphers;
 	private int handshakeTimeoutSecs;
-
+	
+	private String host;
+	private int port;
 	/**
 	 * Constructs a new SSLNetworkModule using the specified host and
 	 * port.  The supplied SSLSocketFactory is used to supply the network
 	 * socket.
 	 */
 	public SSLNetworkModule(SSLSocketFactory factory, String host, int port, String resourceContext) {
 		super(factory, host, port, resourceContext);
+		this.host = host;
+		this.port = port;
 		log.setResourceName(resourceContext);
 	}
 
@@ -90,4 +94,8 @@ public void start() throws IOException, MqttException {
 		// reset timeout to default value
 		socket.setSoTimeout(soTimeout);   
 	}
+	
+	public String getServerURI() {
+		return "ssl://" + host + ":" + port;
+	}
 }

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/TCPNetworkModule.java

@@ -104,4 +104,8 @@ public void stop() throws IOException {
 	public void setConnectTimeout(int timeout) {
 		this.conTimeout = timeout;
 	}
+
+	public String getServerURI() {
+		return "tcp://" + host + ":" + port;
+	}
 }

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/websocket/WebSocketNetworkModule.java

@@ -104,4 +104,8 @@ public void stop() throws IOException {
 		super.stop();
 	}
 
+	public String getServerURI() {
+		return "ws://" + host + ":" + port;
+	}
+	
 }

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/internal/websocket/WebSocketSecureNetworkModule.java

@@ -101,6 +101,9 @@ public void stop() throws IOException {
 		super.stop();
 	}
 
+	public String getServerURI() {
+		return "wss://" + host + ":" + port;
+	}
 
 
 }