jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r1370160 - in /jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security: principal/PrincipalManager.java user/User.java user/UserManager.java
Date Tue, 07 Aug 2012 10:27:31 GMT
Author: angela
Date: Tue Aug  7 10:27:30 2012
New Revision: 1370160

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

Modified:
    jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java
    jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/User.java
    jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/UserManager.java

Modified: jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java?rev=1370160&r1=1370159&r2=1370160&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java
(original)
+++ jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/principal/PrincipalManager.java
Tue Aug  7 10:27:30 2012
@@ -80,7 +80,9 @@ public interface PrincipalManager {
      * <code>PrincipalManager</code> has been built for.
      *
      * @param principalName the name of the principal to retrieve
-     * @return return the requested principal or <code>null</code> if not exists
+     * @return return the requested principal or <code>null</code> if a
+     * principal with the given name does not exist or is not accessible
+     * for the editing session.
      */
     Principal getPrincipal(String principalName);
 

Modified: jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/User.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/User.java?rev=1370160&r1=1370159&r2=1370160&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/User.java
(original)
+++ jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/User.java
Tue Aug  7 10:27:30 2012
@@ -76,7 +76,7 @@ public interface User extends Authorizab
      *
      * @param reason String describing the reason for disable this user or
      * <code>null</code> if the user account should be enabled again.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     void disable(String reason) throws RepositoryException;
 
@@ -86,7 +86,7 @@ public interface User extends Authorizab
      *
      * @return <code>true</code> if this user is disabled, <code>false</code>
      * otherwise.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     boolean isDisabled() throws RepositoryException;
 
@@ -96,7 +96,7 @@ public interface User extends Authorizab
      * 
      * @return The reason specified upon disabling this user or <code>null</code>
      * if this user is not disabled.
-     * @throws RepositoryException
+     * @throws RepositoryException If an error occurs.
      */
     String getDisabledReason() throws RepositoryException;
 }

Modified: jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/UserManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/UserManager.java?rev=1370160&r1=1370159&r2=1370160&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/UserManager.java
(original)
+++ jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/UserManager.java
Tue Aug  7 10:27:30 2012
@@ -68,9 +68,9 @@ public interface UserManager {
     Authorizable getAuthorizable(String id) throws RepositoryException;
 
     /**
-     * Get the Authorizable by its main Principal.
+     * Get the Authorizable by its Principal.
      *
-     * @param principal
+     * @param principal The principal of the authorizable to retrieve.
      * @return Authorizable or <code>null</code>, if not present.
      * @throws RepositoryException If an error occurs.
      */
@@ -100,7 +100,7 @@ public interface UserManager {
      * {@link Authorizable#getProperty(String)} will be searched for a match.
      *
      * @param relPath A relative property path or name.
-     * @param value
+     * @param value A string value to match.
      * @return All <code>Authorizable</code>s that have a property with the given
      * name exactly matching the given value.
      * @throws RepositoryException If an error occurs.
@@ -121,7 +121,7 @@ public interface UserManager {
      * {@link Authorizable#getProperty(String)} will be searched for a match.
      *
      * @param relPath A relative property path or name.
-     * @param value
+     * @param value A string value to match.
      * @param searchType Any of the following constants:
      * <ul>
      * <li>{@link #SEARCH_TYPE_AUTHORIZABLE}</li>
@@ -149,7 +149,7 @@ public interface UserManager {
      * the specified userID is equal to the principal name and the intermediate
      * path is <code>null</code>.
      *
-     * @param userID The id of the new user.
+     * @param userID The ID of the new user.
      * @param password The initial password of this user.
      * @return The new <code>User</code>.
      * @throws AuthorizableExistsException in case the given userID is already
@@ -165,10 +165,12 @@ public interface UserManager {
      * Except for the <code>intermediatePath</code>, neither of the specified
      * parameters can be <code>null</code>.
      *
-     * @param userID
-     * @param password
-     * @param principal
-     * @param intermediatePath
+     * @param userID The ID of the new user.
+     * @param password The initial password of the new user.
+     * @param principal The principal of the new user.
+     * @param intermediatePath An optional intermediate path used to create the
+     * new user. If the intermediate path is <code>null</code> an internal,
+     * implementation specific structure will be used.
      * @return The new <code>User</code>.
      * @throws AuthorizableExistsException in case the given userID is already
      * in use or another Authorizable with the same principal name exists.
@@ -185,7 +187,7 @@ public interface UserManager {
      * groupID is the name of the <code>Principal</code> the intermediate path
      * is <code>null</code>.
      *
-     * @param groupID The id of the new group; must not be <code>null</code>.
+     * @param groupID The ID of the new group; must not be <code>null</code>.
      * @return The new <code>Group</code>.
      * @throws AuthorizableExistsException in case the given groupID is already
      * in use or another {@link Authorizable} with the same
@@ -212,8 +214,10 @@ public interface UserManager {
      * Same as {@link #createGroup(String, Principal, String)} where the
      * name of the specified principal is used to create the group's ID. 
      *
-     * @param principal
-     * @param intermediatePath
+     * @param principal The principal associated with the new group.
+     * @param intermediatePath An optional intermediate path used to create the
+     * new group. If the intermediate path is <code>null</code> an internal,
+     * implementation specific structure will be used.
      * @return The new <code>Group</code>.
      * @throws AuthorizableExistsException in case the given principal is
      * already in use with another Authorizable.
@@ -227,8 +231,11 @@ public interface UserManager {
      * is not able to deal with the <code>intermediatePath</code> this parameter
      * should be ignored.
      *
-     * @param principal
-     * @param intermediatePath
+     * @param groupID The ID of the new group.
+     * @param principal The principal of the new group.
+     * @param intermediatePath An optional intermediate path used to create the
+     * new group. If the intermediate path is <code>null</code> an internal,
+     * implementation specific structure will be used.
      * @return The new <code>Group</code>.
      * @throws AuthorizableExistsException in case the given principal is already
      * in use with another Authorizable.



Mime
View raw message