svn commit: r1569435 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/SecurityConfiguration.java

[angela]

Author: angela
Date: Tue Feb 18 17:25:59 2014
New Revision: 1569435

URL: http://svn.apache.org/r1569435
Log:
javadoc

Modified:
    
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/SecurityConfiguration.java

Modified: 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/SecurityConfiguration.java
URL: 
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/SecurityConfiguration.java?rev=1569435&r1=1569434&r2=1569435&view=diff
==============================================================================
--- 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/SecurityConfiguration.java
 (original)
+++ 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/SecurityConfiguration.java
 Tue Feb 18 17:25:59 2014
@@ -31,7 +31,7 @@ import org.apache.jackrabbit.oak.spi.lif
 import org.apache.jackrabbit.oak.spi.xml.ProtectedItemImporter;
 
 /**
- * SecurityConfiguration... TODO
+ * Base interface for all security related configurations.
  */
 public interface SecurityConfiguration {
 
@@ -73,15 +73,40 @@ public interface SecurityConfiguration {
     @Nonnull
     RepositoryInitializer getRepositoryInitializer();
 
+    /**
+     * Returns the list of commit hooks that need to be executed for the
+     * specified workspace name.
+     *
+     * @param workspaceName The name of the workspace.
+     * @return A list of commit hooks.
+     */
     @Nonnull
-    List<? extends CommitHook> getCommitHooks(String workspaceName);
+    List<? extends CommitHook> getCommitHooks(@Nonnull String workspaceName);
 
+    /**
+     * Returns the list of validators that need to be executed for the 
specified
+     * workspace name.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param principals The set of principals associated with the subject
+     * that is committing modifications.
+     * @param moveTracker The move tracker associated with the commit.
+     * @return A list of validators.
+     */
     @Nonnull
-    List<? extends ValidatorProvider> getValidators(String workspaceName, 
Set<Principal> principals, MoveTracker moveTracker);
+    List<? extends ValidatorProvider> getValidators(@Nonnull String 
workspaceName,
+                                                    @Nonnull Set<Principal> 
principals,
+                                                    @Nonnull MoveTracker 
moveTracker);
 
+    /**
+     * @return The list of protected item importers defined by this 
configuration.
+     */
     @Nonnull
     List<ProtectedItemImporter> getProtectedItemImporters();
 
+    /**
+     * @return The context defined by this configuration.
+     */
     @Nonnull
     Context getContext();