svn commit: r944112 - /incubator/shiro/trunk/core/src/main/java/org/apache/shiro/mgt/DefaultSecurityManager.java

[lh...@apache.org]

Author: lhazlewood
Date: Fri May 14 05:13:05 2010
New Revision: 944112

URL: http://svn.apache.org/viewvc?rev=944112&view=rev
Log:
SHIRO-157 - minor JavaDoc updates

Modified:
    incubator/shiro/trunk/core/src/main/java/org/apache/shiro/mgt/DefaultSecurityManager.java

Modified: incubator/shiro/trunk/core/src/main/java/org/apache/shiro/mgt/DefaultSecurityManager.java
URL: http://svn.apache.org/viewvc/incubator/shiro/trunk/core/src/main/java/org/apache/shiro/mgt/DefaultSecurityManager.java?rev=944112&r1=944111&r2=944112&view=diff
==============================================================================
--- incubator/shiro/trunk/core/src/main/java/org/apache/shiro/mgt/DefaultSecurityManager.java (original)
+++ incubator/shiro/trunk/core/src/main/java/org/apache/shiro/mgt/DefaultSecurityManager.java Fri May 14 05:13:05 2010
@@ -185,7 +185,15 @@ public class DefaultSecurityManager exte
         }
     }
 
-    private void bindPrincipalsToSession(PrincipalCollection principals, Session session) {
+    /**
+     * Saves the specified identity to the given session, making the session no longer anonymous.
+     *
+     * @param principals the Subject identity to save to the session
+     * @param session    the Session to retain the Subject identity.
+     * @throws IllegalArgumentException if the principals are null or empty or the session is null
+     * @since 1.0
+     */
+    private void bindPrincipalsToSession(PrincipalCollection principals, Session session) throws IllegalArgumentException {
         if (session == null) {
             throw new IllegalArgumentException("Session argument cannot be null.");
         }