OF-2644: Do not use getters in Session#toString implementations

This prevents stack overflow when the getters use the toString implementation (for example, for debug logging).
igniterealtime · Aug 28, 2023 · 4ede455 · 4ede455
1 parent 5486250
commit 4ede455
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 39 deletions.
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalClientSession.java b/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalClientSession.java
@@ -902,16 +902,16 @@ public String toString()
             }
         }
         return this.getClass().getSimpleName() +"{" +
-            "address=" + getAddress() +
-            ", streamID=" + getStreamID() +
-            ", status=" + getStatus() +
+            "address=" + address +
+            ", streamID=" + streamID +
+            ", status=" + status +
             ", isEncrypted=" + isEncrypted() +
             ", isDetached=" + isDetached() +
-            ", serverName='" + getServerName() + '\'' +
-            ", isInitialized=" + isInitialized() +
-            ", hasAuthToken=" + (getAuthToken() != null) +
+            ", serverName='" + serverName + '\'' +
+            ", isInitialized=" + initialized +
+            ", hasAuthToken=" + (authToken != null) +
             ", peer address='" + peerAddress +'\'' +
-            ", presence='" + getPresence().toString() + '\'' +
+            ", presence='" + presence.toString() + '\'' +
             '}';
     }
 }
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalComponentSession.java b/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalComponentSession.java
@@ -432,12 +432,12 @@ public LocalComponentSession getSession() {
     public String toString()
     {
         return this.getClass().getSimpleName() +"{" +
-            "address=" + getAddress() +
-            ", streamID=" + getStreamID() +
-            ", status=" + getStatus() +
+            "address=" + address +
+            ", streamID=" + streamID +
+            ", status=" + status +
             ", isEncrypted=" + isEncrypted() +
             ", isDetached=" + isDetached() +
-            ", serverName='" + getServerName() + '\'' +
+            ", serverName='" + serverName + '\'' +
             ", defaultSubdomain='" + defaultSubdomain + '\'' +
             '}';
     }

diff --git a/...er/src/main/java/org/jivesoftware/openfire/session/LocalConnectionMultiplexerSession.java b/...er/src/main/java/org/jivesoftware/openfire/session/LocalConnectionMultiplexerSession.java
@@ -306,12 +306,12 @@ void deliver(Packet packet) throws UnauthorizedException {
     public String toString()
     {
         return this.getClass().getSimpleName() +"{" +
-            "address=" + getAddress() +
-            ", streamID=" + getStreamID() +
-            ", status=" + getStatus() +
+            "address=" + address +
+            ", streamID=" + streamID +
+            ", status=" + status +
             ", isEncrypted=" + isEncrypted() +
             ", isDetached=" + isDetached() +
-            ", serverName='" + getServerName() + '\'' +
+            ", serverName='" + serverName + '\'' +
             '}';
     }
 }
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalIncomingServerSession.java b/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalIncomingServerSession.java
@@ -431,14 +431,14 @@ public String getAvailableStreamFeatures() {
     public String toString()
     {
         return this.getClass().getSimpleName() +"{" +
-            "address=" + getAddress() +
-            ", streamID=" + getStreamID() +
-            ", status=" + getStatus() +
+            "address=" + address +
+            ", streamID=" + streamID +
+            ", status=" + status +
             ", isEncrypted=" + isEncrypted() +
             ", isDetached=" + isDetached() +
-            ", authenticationMethod=" + getAuthenticationMethod() +
-            ", localDomain=" + getLocalDomain() +
-            ", defaultIdentity=" + getDefaultIdentity() +
+            ", authenticationMethod=" + authenticationMethod +
+            ", localDomain=" + localDomain +
+            ", defaultIdentity=" + fromDomain +
             ", validatedDomains=" + validatedDomains.stream().collect( Collectors.joining( ", ", "{", "}")) +
             '}';
     }

diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalOutgoingServerSession.java b/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalOutgoingServerSession.java
@@ -408,12 +408,12 @@ public Collection<DomainPair> getOutgoingDomainPairs() {
     public String toString()
     {
         return this.getClass().getSimpleName() +"{" +
-            "address=" + getAddress() +
-            ", streamID=" + getStreamID() +
-            ", status=" + getStatus() +
+            "address=" + address +
+            ", streamID=" + streamID +
+            ", status=" + status +
             ", isEncrypted=" + isEncrypted() +
             ", isDetached=" + isDetached() +
-            ", authenticationMethod=" + getAuthenticationMethod() +
+            ", authenticationMethod=" + authenticationMethod +
             ", outgoingDomainPairs=" + getOutgoingDomainPairs().stream().map( DomainPair::toString ).collect(Collectors.joining(", ", "{", "}")) +
             '}';
     }

diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalServerSession.java b/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalServerSession.java
@@ -34,7 +34,7 @@ public class LocalServerSession extends LocalSession implements ServerSession {
     /**
      * The method that was used to authenticate this session. Null when the session is not authenticated.
      */
-    private AuthenticationMethod authenticationMethod = null;
+    protected AuthenticationMethod authenticationMethod = null;
 
     public LocalServerSession(String serverName, Connection connection,
             StreamID streamID) {
@@ -127,12 +127,12 @@ public void setAuthenticationMethod(@Nonnull final AuthenticationMethod authenti
     public String toString()
     {
         return this.getClass().getSimpleName() +"{" +
-            "address=" + getAddress() +
-            ", streamID=" + getStreamID() +
-            ", status=" + getStatus() +
+            "address=" + address +
+            ", streamID=" + streamID +
+            ", status=" + status +
             ", isEncrypted=" + isEncrypted() +
             ", isDetached=" + isDetached() +
-            ", isUsingServerDialback=" + isUsingServerDialback() +
+            ", authenticationMethod=" + authenticationMethod +
             '}';
     }
 }
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalSession.java b/xmppserver/src/main/java/org/jivesoftware/openfire/session/LocalSession.java
@@ -60,11 +60,12 @@ public abstract class LocalSession implements Session {
     /**
      * The Address this session is authenticated as.
      */
-    private JID address;
+    protected JID address;
+
     /**
      * The stream id for this session (random and unique).
      */
-    private StreamID streamID;
+    protected final StreamID streamID;
 
     /**
      * The current session status.
@@ -78,9 +79,9 @@ public abstract class LocalSession implements Session {
 
     protected SessionManager sessionManager;
 
-    private String serverName;
+    protected final String serverName;
 
-    private long startDate = System.currentTimeMillis();
+    protected final long startDate = System.currentTimeMillis();
 
     private long lastActiveDate;
 
@@ -243,6 +244,7 @@ public Connection getConnection() {
      */
     @Override
     public Status getStatus() {
+        System.out.println("This session " + this + " was asked to provide its status, which is " + this.status);
         return status;
     }
 
@@ -533,13 +535,13 @@ public String getHostName() throws UnknownHostException {
     @Override
     public String toString()
     {
-        return this.getClass().getSimpleName() +"{" +
-            "address=" + getAddress() +
-            ", streamID=" + getStreamID() +
-            ", status=" + getStatus() +
+        return this.getClass().getSimpleName() + "{" +
+            "address=" + address +
+            ", streamID=" + streamID +
+            ", status=" + status +
             ", isEncrypted=" + isEncrypted() +
             ", isDetached=" + isDetached() +
-            ", serverName='" + getServerName() + '\'' +
+            ", serverName='" + serverName + '\'' +
             '}';
     }