From 043ede821236cb8f3935ad6d3c9e06b1e42e5ee8 Mon Sep 17 00:00:00 2001
From: markt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Date: Thu, 3 Jan 2008 22:04:48 +0000
Subject: [PATCH] Improve fix for 43840 with better error handling, a better
 variable name and a bit of other clean-up.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@608654 13f79535-47bb-0310-9956-ffa450edef68
---
 .../catalina/ha/session/LocalStrings.properties    |  1 +
 .../catalina/ha/session/SerializablePrincipal.java | 37 +++++++++++++++-------
 .../ha/session/TestSerializablePrincipal.java      |  3 ++
 3 files changed, 29 insertions(+), 12 deletions(-)

diff --git a/java/org/apache/catalina/ha/session/LocalStrings.properties b/java/org/apache/catalina/ha/session/LocalStrings.properties
index 45e1478ec..18d222ad7 100644
--- a/java/org/apache/catalina/ha/session/LocalStrings.properties
+++ b/java/org/apache/catalina/ha/session/LocalStrings.properties
@@ -109,3 +109,4 @@ standardSession.setAttribute.iae=setAttribute: Non-serializable attribute
 standardSession.setAttribute.ise=setAttribute: Session already invalidated
 standardSession.setAttribute.namenull=setAttribute: name parameter cannot be null
 standardSession.sessionCreated=Created Session id = {0}
+serializablePrincipal.readPrincipal.cnfe=readPrincipal: Failed to recreate user Principal
\ No newline at end of file
diff --git a/java/org/apache/catalina/ha/session/SerializablePrincipal.java b/java/org/apache/catalina/ha/session/SerializablePrincipal.java
index ebd2c9fee..ff2cedaa4 100644
--- a/java/org/apache/catalina/ha/session/SerializablePrincipal.java
+++ b/java/org/apache/catalina/ha/session/SerializablePrincipal.java
@@ -19,6 +19,7 @@
 package org.apache.catalina.ha.session;
 
 
+import java.io.IOException;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.io.Serializable;
@@ -30,6 +31,7 @@ import java.util.List;
 
 import org.apache.catalina.Realm;
 import org.apache.catalina.realm.GenericPrincipal;
+import org.apache.catalina.util.StringManager;
 
 
 /**
@@ -42,6 +44,14 @@ import org.apache.catalina.realm.GenericPrincipal;
  */
 public class SerializablePrincipal  implements java.io.Serializable {
 
+    protected static org.apache.juli.logging.Log log =
+        org.apache.juli.logging.LogFactory.getLog(SerializablePrincipal.class);
+    
+    /**
+     * The string manager for this package.
+     */
+    protected static StringManager sm =
+        StringManager.getManager(Constants.Package);
 
     // ----------------------------------------------------------- Constructors
 
@@ -201,7 +211,8 @@ public class SerializablePrincipal  implements java.io.Serializable {
                 userPrincipal);
     }
     
-    public static GenericPrincipal readPrincipal(ObjectInput in, Realm realm) throws java.io.IOException{
+    public static GenericPrincipal readPrincipal(ObjectInput in, Realm realm)
+            throws IOException, ClassNotFoundException {
         String name = in.readUTF();
         boolean hasPwd = in.readBoolean();
         String pwd = null;
@@ -209,21 +220,23 @@ public class SerializablePrincipal  implements java.io.Serializable {
         int size = in.readInt();
         String[] roles = new String[size];
         for ( int i=0; i<size; i++ ) roles[i] = in.readUTF();
-        Principal innerPrincipal = null;
-        boolean hasInnerPrincipal = in.readBoolean();
-        if (hasInnerPrincipal) {
+        Principal userPrincipal = null;
+        boolean hasUserPrincipal = in.readBoolean();
+        if (hasUserPrincipal) {
             try {
-                innerPrincipal = (Principal) in.readObject();
+                userPrincipal = (Principal) in.readObject();
             } catch (ClassNotFoundException e) {
-                // Failed to read inner Principal
-                e.printStackTrace();
+                log.error(sm.getString(
+                        "serializablePrincipal.readPrincipal.cnfe"), e);
+                throw e;
             }
         }
         return new GenericPrincipal(realm,name,pwd,Arrays.asList(roles),
-                innerPrincipal);
+                userPrincipal);
     }
     
-    public static void writePrincipal(GenericPrincipal p, ObjectOutput out) throws java.io.IOException {
+    public static void writePrincipal(GenericPrincipal p, ObjectOutput out)
+            throws IOException {
         out.writeUTF(p.getName());
         out.writeBoolean(p.getPassword()!=null);
         if ( p.getPassword()!= null ) out.writeUTF(p.getPassword());
@@ -231,10 +244,10 @@ public class SerializablePrincipal  implements java.io.Serializable {
         if ( roles == null ) roles = new String[0];
         out.writeInt(roles.length);
         for ( int i=0; i<roles.length; i++ ) out.writeUTF(roles[i]);
-        boolean hasInnerPrincipal = (p != p.getUserPrincipal() &&
+        boolean hasUserPrincipal = (p != p.getUserPrincipal() &&
                 p.getUserPrincipal() instanceof Serializable);
-        out.writeBoolean(hasInnerPrincipal);
-        if (hasInnerPrincipal) out.writeObject(p.getUserPrincipal());
+        out.writeBoolean(hasUserPrincipal);
+        if (hasUserPrincipal) out.writeObject(p.getUserPrincipal());
     }
 
 
diff --git a/test/org/apache/catalina/ha/session/TestSerializablePrincipal.java b/test/org/apache/catalina/ha/session/TestSerializablePrincipal.java
index 5f99cb124..4f572d88f 100644
--- a/test/org/apache/catalina/ha/session/TestSerializablePrincipal.java
+++ b/test/org/apache/catalina/ha/session/TestSerializablePrincipal.java
@@ -82,6 +82,9 @@ public class TestSerializablePrincipal extends TestCase {
         } catch (IOException e) {
             e.printStackTrace();
             fail("ioe de-serializing principal");
+        } catch (ClassNotFoundException e) {
+            e.printStackTrace();
+            fail("cnfe de-serializing principal");
         }
         
         // Now test how similar original and de-serialized versions are
-- 
2.11.0