svn commit: r1238363 - in /jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user: UserManagerImpl.java action/AuthorizableAction.java

[an...@apache.org]

Author: angela
Date: Tue Jan 31 10:21:05 2012
New Revision: 1238363

URL: http://svn.apache.org/viewvc?rev=1238363&view=rev
Log:
javadoc

Modified:
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/UserManagerImpl.java
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/action/AuthorizableAction.java

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/UserManagerImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/UserManagerImpl.java?rev=1238363&r1=1238362&r2=1238363&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/UserManagerImpl.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/UserManagerImpl.java Tue Jan 31 10:21:05 2012
@@ -60,6 +60,8 @@ import java.util.Set;
 import java.util.UUID;
 
 /**
+ * <h2>Implementation Characteristics</h2>
+ *
  * Default implementation of the <code>UserManager</code> interface with the
  * following characteristics:
  *
@@ -78,6 +80,8 @@ import java.util.UUID;
  * </li>
  * </ul>
  *
+ * <h3>Authorizable Creation</h3>
+ *
  * The built-in logic applies the following rules:
  * <ul>
  * <li>The names of the hierarchy folders is determined from ID of the
@@ -115,9 +119,12 @@ import java.util.UUID;
  *           + aSmith        [rep:User]
  * </pre>
  *
+ * <h3>Configuration</h3>
+ *
  * This <code>UserManager</code> is able to handle the following configuration
  * options:
  *
+ * <h4>Configuration Parameters</h4>
  * <ul>
  * <li>{@link #PARAM_USERS_PATH}: Defines where user nodes are created.
  * If missing set to {@link #USERS_PATH}.</li>
@@ -142,7 +149,19 @@ import java.util.UUID;
  * <li>{@link #PARAM_AUTO_EXPAND_SIZE}: This parameter only takes effect
  * if {@link #PARAM_AUTO_EXPAND_TREE} is enabled.<br>The value is expected to be
  * a positive long greater than zero. The default value is 1000.</li>
+ * <li>{@link #PARAM_GROUP_MEMBERSHIP_SPLIT_SIZE}: If this parameter is present
+ * group memberships are collected in a node structure below {@link UserConstants#N_MEMBERS}
+ * instead of the default multi valued property {@link UserConstants#P_MEMBERS}.
+ * Its value determines the maximum number of member properties until additional
+ * intermediate nodes are inserted. Valid parameter values are integers &gt; 4.</li>
  * </ul>
+ *
+ * <h4>Authorizable Actions</h4>
+ * In addition to the specified configuration parameters this user manager
+ * implementation allows to define zero to many {@link AuthorizableAction}s.
+ * Authorizable actions provide the ability to execute additional validation or
+ * tasks upon authorizable creation, removal and upon changing a users password.<br/>
+ * See also {@link org.apache.jackrabbit.core.config.UserManagerConfig#getAuthorizableActions()}
  */
 public class UserManagerImpl extends ProtectedItemModifier
         implements UserManager, UserConstants, SessionListener {

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/action/AuthorizableAction.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/action/AuthorizableAction.java?rev=1238363&r1=1238362&r2=1238363&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/action/AuthorizableAction.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/user/action/AuthorizableAction.java Tue Jan 31 10:21:05 2012
@@ -24,7 +24,20 @@ import javax.jcr.RepositoryException;
 import javax.jcr.Session;
 
 /**
- * <code>AuthorizableAction</code>...
+ * The <code>AuthorizableAction</code> interface provide an implementation
+ * specific way to execute additional validation or write tasks upon
+ *
+ * <ul>
+ * <li>{@link #onCreate(org.apache.jackrabbit.api.security.user.User, String, javax.jcr.Session) User creation},</li>
+ * <li>{@link #onCreate(org.apache.jackrabbit.api.security.user.Group, javax.jcr.Session) Group creation},</li>
+ * <li>{@link #onRemove(org.apache.jackrabbit.api.security.user.Authorizable, javax.jcr.Session) Authorizable removal} and</li>
+ * <li>{@link #onPasswordChange(org.apache.jackrabbit.api.security.user.User, String, javax.jcr.Session) User password modification}.</li>
+ * </ul>
+ *
+ * The actions are attached to a given UserManager instance upon creation
+ * by calling {@link org.apache.jackrabbit.core.security.user.UserManagerImpl#setAuthorizableActions(AuthorizableAction[])}.
+ *
+ * @see org.apache.jackrabbit.core.config.UserManagerConfig
  */
 public interface AuthorizableAction {