directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject [4/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Date Sat, 02 Jan 2016 03:52:57 GMT
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/ReviewMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/ReviewMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/ReviewMgrImpl.java
index ce840ef..2c91535 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/ReviewMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/ReviewMgrImpl.java
@@ -81,16 +81,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     private static final SdP ssdP = new SdP();
 
     /**
-     * This method returns a matching permission entity to caller.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted</li>
-     * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation</li>
-     * </ul>
-     *
-     * @param permission must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, and optionally object id of targeted permission entity.
-     * @return Permission entity that is loaded with data.
-     * @throws SecurityException if permission not found or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public Permission readPermission(Permission permission)
@@ -105,15 +96,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method reads permission object from perm container in directory.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param permObj entity contains the {@link org.apache.directory.fortress.core.model.PermObj#objName} of target record.
-     * @return PermObj loaded with perm object data.
-     * @throws SecurityException is thrown if object not found or system error.
+     * {@inheritDoc}
      */
     @Override
     public PermObj readPermObj(PermObj permObj)
@@ -127,17 +110,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method returns a list of type Permission that match the perm object search string.
-     * <h4>optional parameters</h4>
-     * <ul>
-     * <li>{@link Permission#objName} - contains one or more characters of existing object being targeted in leading characters.</li>
-     * <li>{@link Permission#opName} - contains one or more characters of existing permission operation in leading characters.</li>
-     * </ul>
-     *
-     * @param permission contains object and operation name search strings.  Each contains 1 or more leading chars that correspond to object or op name.
-     * @return List of type Permission.  Fortress permissions are object->operation mappings.  The permissions may contain
-     *         assigned user, role or group entities as well.
-     * @throws SecurityException thrown in the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> findPermissions(Permission permission)
@@ -150,12 +123,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method returns Permission operations for the provided permission object
-     *
-     * @param permObj entity contains the {@link PermObj#objName} of target record.
-     * @return List of type Permission for provided permission object
-     * @throws SecurityException
-     *          thrown in the event of system error.
+     * {@inheritDoc}
      */
 	@Override
 	public List<Permission> findPermissions(PermObj permObj)
@@ -166,20 +134,9 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
         checkAccess(CLS_NM, methodName);
         return permP.searchOperations( permObj );
 	}
-    
-    /**
-     * Method returns a list of type Permission that match any part of either {@link Permission#objName} or {@link Permission#opName} search strings.
-     * This method differs from findPermissions in that any permission that matches any part of the perm obj or any part of the perm op will be returned in result set (uses substring string matching).
-     * <h4>optional parameters</h4>
-     * <ul>
-     * <li>{@link Permission#objName} - contains one or more characters of existing object being targeted</li>
-     * <li>{@link Permission#opName} - contains one or more characters of existing permission operation</li>
-     * </ul>
-     *
-     * @param permission contains object and operation name search strings.  Each contains 1 or more leading chars that correspond to object or op name.
-     * @return List of type Permission.  Fortress permissions are object->operation mappings.  The permissions may contain
-     *         assigned user, role or group entities as well.
-     * @throws SecurityException thrown in the event of system error.
+
+    /**
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> findAnyPermissions(Permission permission)
@@ -190,18 +147,9 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
         checkAccess(CLS_NM, methodName);
         return permP.searchAny( permission );
     }
-    
+
     /**
-     * Method returns a list of type PermObj that match the perm object search string.
-     * <h4>optional parameters</h4>
-     * <ul>
-     * <li>{@link PermObj#objName} - contains one or more characters of existing object being targeted</li>
-     * </ul>
-     *
-     * @param permObj contains object name search string.  The search val contains 1 or more leading chars that correspond to object name.
-     * @return List of type PermObj.  Fortress permissions are object->operation mappings.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          thrown in the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public List<PermObj> findPermObjs(PermObj permObj)
@@ -214,16 +162,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method returns a list of type Permission that match the perm object search string.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains one or more characters of org unit associated with existing object being targeted</li>
-     * </ul>
-     *
-     * @param ou contains org unit name {@link org.apache.directory.fortress.core.model.OrgUnit#name}.  The search val contains the full name of matching ou in OS-P data set.
-     * @return List of type PermObj.  Fortress permissions are object->operation mappings.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          thrown in the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public List<PermObj> findPermObjs(OrgUnit ou)
@@ -237,15 +176,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method reads Role entity from the role container in directory.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to read.</li>
-     * </ul>
-     *
-     * @param role contains role name, {@link org.apache.directory.fortress.core.model.Role#name}, to be read.
-     * @return Role entity that corresponds with role name.
-     * @throws SecurityException will be thrown if role not found or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public Role readRole(Role role)
@@ -259,12 +190,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method will return a list of type Role matching all or part of Role name, {@link Role#name}.
-     *
-     * @param searchVal contains all or some of the chars corresponding to role entities stored in directory.
-     * @return List of type Role containing role entities that match the search criteria.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public List<Role> findRoles(String searchVal)
@@ -279,14 +205,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method returns a list of roles of type String.  This method can be limited by integer value that indicates max
-     * number of records that may be contained in the result set.  This number can further limit global default but can
-     * not increase the max.  This method is called by the Websphere Realm impl.
-     *
-     * @param searchVal contains all or some leading chars that correspond to roles stored in the role container in the directory.
-     * @param limit     integer value specifies the max records that may be returned in the result set.
-     * @return List of type String containing names of the role entities that match the inbound search criteria.
-     * @throws SecurityException in the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public List<String> findRoles(String searchVal, int limit)
@@ -301,17 +220,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Method returns matching User entity that is contained within the people container in the directory.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId associated with the User object targeted for read.</li>
-     * </ul>
-     *
-     * @param user entity contains a value {@link org.apache.directory.fortress.core.model.User#userId} that matches record in the directory.  userId is globally unique in
-     *             people container.
-     * @return entity containing matching user data.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          if record not found or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public final User readUser(User user)
@@ -325,15 +234,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Return a list of type User of all users in the people container that match all or part of the {@link User#userId} field passed in User entity.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains all or some leading chars that match userId(s) stored in the directory.</li>
-     * </ul>
-     *
-     * @param user contains all or some leading chars that match userIds stored in the directory.
-     * @return List of type User.
-     * @throws SecurityException In the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public final List<User> findUsers(User user)
@@ -346,15 +247,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Return a list of type User of all users in the people container that match the name field passed in OrgUnit entity.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link OrgUnit#name} - contains one or more characters of org unit associated with existing object(s) being targeted</li>
-     * </ul>
-     *
-     * @param ou contains name of User OU, {@link OrgUnit#name} that match ou attribute associated with User entity in the directory.
-     * @return List of type User.
-     * @throws SecurityException In the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public List<User> findUsers(OrgUnit ou)
@@ -368,18 +261,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Return a list of type String of all users in the people container that match the userId field passed in User entity.
-     * This method is used by the Websphere realm component.  The max number of returned users may be set by the integer limit arg.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link User#userId} - contains the userId associated with the User object targeted for read.</li>
-     * <li>limit - max number of objects to return.</li>
-     * </ul>
-     *
-     * @param user  contains all or some leading chars that correspond to users stored in the directory.
-     * @param limit integer value sets the max returned records.
-     * @return List of type String containing matching userIds.
-     * @throws SecurityException in the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public final List<String> findUsers(User user, int limit)
@@ -392,21 +274,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of users assigned to a given role. The function is valid if and
-     * only if the role is a member of the ROLES data set.
-     * The max number of users returned is constrained by limit argument.
-     * This method is used by the Websphere realm component.  This method does NOT use hierarchical impl.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
-     * <li>limit - max number of objects to return.</li>
-     * </ul>
-     *
-     * @param role  Contains {@link Role#name} of Role entity assigned to user.
-     * @param limit integer value sets the max returned records.
-     * @return List of type String containing userIds assigned to a particular role.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of data validation or system error.
+     * {@inheritDoc}
      */
     @Override
     public List<String> assignedUsers(Role role, int limit)
@@ -434,16 +302,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This method returns the data set of all users who are assigned the given role.  This searches the User data set for
-     * Role relationship.  This method does NOT search for hierarchical RBAC Roles relationships.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
-     * </ul>
-     *
-     * @param role contains the role name, {@link Role#name} used to search the User data set.
-     * @return List of type User containing the users assigned data.
-     * @throws SecurityException If system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public List<User> assignedUsers(Role role)
@@ -456,16 +315,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of roles assigned to a given user. The function is valid if and
-     * only if the user is a member of the USERS data set.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
-     * </ul>
-     *
-     * @param user contains {@link User#userId} matching User entity targeted in the directory.
-     * @return List of type UserRole containing the Roles assigned to User.
-     * @throws SecurityException If user not found or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public List<UserRole> assignedRoles(User user)
@@ -479,12 +329,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of roles assigned to a given user. The function is valid if and
-     * only if the user is a member of the USERS data set.
-     *
-     * @param userId matches userId stored in the directory.
-     * @return List of type String containing the role names of all roles assigned to user.
-     * @throws SecurityException If user not found or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public List<String> assignedRoles(String userId)
@@ -499,16 +344,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of users authorized to a given role, i.e., the users that are assigned to a role that
-     * inherits the given role. The function is valid if and only if the given role is a member of the ROLES data set.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
-     * </ul>
-     *
-     * @param role Contains role name, {@link Role#name} of Role entity assigned to User.
-     * @return List of type User containing all user's that having matching role assignment.
-     * @throws SecurityException In the event the role is not present in directory or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public List<User> authorizedUsers(Role role)
@@ -521,16 +357,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of roles authorized for a given user. The function is valid if
-     * and only if the user is a member of the USERS data set.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
-     * </ul>
-     *
-     * @param user contains the {@link User#userId} matching User entity stored in the directory.
-     * @return Set of type String containing the roles assigned and roles inherited.
-     * @throws SecurityException If user not found or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public Set<String> authorizedRoles(User user)
@@ -550,17 +377,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of all permissions (op, obj), granted to or inherited by a
-     * given role. The function is valid if and only if the role is a member of the ROLES data
-     * set.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
-     * </ul>
-     *
-     * @param role contains role name, {@link Role#name} of Role entity Permission is granted to.
-     * @return List of type Permission that contains all perms granted to a role.
-     * @throws SecurityException In the event system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> rolePermissions(Role role)
@@ -570,18 +387,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of all permissions (op, obj), granted to or inherited by a
-     * given role. The function is valid if and only if the role is a member of the ROLES data
-     * set.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
-     * </ul>
-     *
-     * @param role contains role name, {@link Role#name} of Role entity Permission is granted to.
-     * @param noInheritance if true will NOT include inherited roles in the search.
-     * @return List of type Permission that contains all perms granted to a role.
-     * @throws SecurityException In the event system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> rolePermissions(Role role, boolean noInheritance )
@@ -594,17 +400,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of permissions a given user gets through his/her authorized
-     * roles. The function is valid if and only if the user is a member of the USERS data set.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
-     * </ul>
-     *
-     * @param user contains the {@link User#userId} of User targeted for search.
-     * @return List of type Permission containing matching permission entities.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> userPermissions(User user)
@@ -619,16 +415,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Return a list of type String of all roles that have granted a particular permission.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
-     * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
-     * </ul>
-     *
-     * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
-     * @return List of type string containing the role names that have the matching perm granted.
-     * @throws SecurityException in the event permission not found or system error occurs.
+     * {@inheritDoc}
      */
     @Override
     public List<String> permissionRoles(Permission perm)
@@ -651,17 +438,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Return all role names that have been authorized for a given permission.  This will process role hierarchies to determine set of all Roles who have access to a given permission.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted</li>
-     * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
-     * </ul>
-     *
-     * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
-     * @return Set of type String containing all roles names that have been granted a particular permission.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of validation or system error.
+     * {@inheritDoc}
      */
     @Override
     public Set<String> authorizedPermissionRoles(Permission perm)
@@ -680,17 +457,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Return all userIds that have been granted (directly) a particular permission.  This will not consider assigned or authorized Roles.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
-     * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
-     * </ul>
-     *
-     * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
-     * @return List of type String containing all userIds that have been granted a particular permission.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of validation or system error.
+     * {@inheritDoc}
      */
     @Override
     public List<String> permissionUsers(Permission perm)
@@ -713,17 +480,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * Return all userIds that have been authorized for a given permission.  This will process role hierarchies to determine set of all Users who have access to a given permission.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
-     * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
-     * </ul>
-     *
-     * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
-     * @return Set of type String containing all userIds that have been granted a particular permission.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of validation or system error.
+     * {@inheritDoc}
      */
     @Override
     public Set<String> authorizedPermissionUsers(Permission perm)
@@ -759,9 +516,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * @param assignedRoles
-     * @return Set contains both assigned and descendant role names
-     * @throws SecurityException
+     * {@inheritDoc}
      */
     private Set<String> authorizeRoles(Set<String> assignedRoles)
     {
@@ -775,17 +530,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the list of all SSD role sets that have a particular Role as member or Role's
-     * parent as a member.  If the Role parameter is left blank, function will return all SSD role sets.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
-     * </ul>
-     *
-     * @param role Will contain the role name, {@link Role#name}, for targeted SSD set or null to return all
-     * @return List containing all matching SSD's.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public List<SDSet> ssdRoleSets(Role role)
@@ -798,15 +543,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the list of SSDs that match a given ssd name value.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param ssd contains the name for the SSD set targeted, {@link SDSet#name}.
-     * @return List containing all SSDSets that match a given SSDSet name.
-     * @throws SecurityException in the event of data or system error.
+     * {@inheritDoc}
      */
     public List<SDSet> ssdSets(SDSet ssd)
         throws SecurityException
@@ -819,16 +556,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the SSD data set that matches a particular set name.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param set Will contain the name for existing SSD data set
-     * @return SDSet containing all attributes from matching SSD name.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public SDSet ssdRoleSet(SDSet set)
@@ -842,16 +570,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of roles of a SSD role set. The function is valid if and only if the
-     * role set exists.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param ssd contains the name for the SSD set targeted.
-     * @return Map containing all Roles that are members of SSD data set.
-     * @throws SecurityException in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public Set<String> ssdRoleSetRoles(SDSet ssd)
@@ -866,16 +585,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the cardinality associated with a SSD role set. The function is valid if and only if the
-     * role set exists.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param ssd contains the name of the SSD set targeted, {@link SDSet#name}.
-     * @return int value containing cardinality of SSD set.
-     * @throws SecurityException in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public int ssdRoleSetCardinality(SDSet ssd)
@@ -889,17 +599,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the list of all dSD role sets that have a particular Role as member or Role's
-     * parent as a member.  If the Role parameter is left blank, function will return all dSD role sets.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
-     * </ul>
-     *
-     * @param role Will contain the role name, {@link Role#name}, for targeted dSD set or null to return all
-     * @return List containing all matching dSD's.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public List<SDSet> dsdRoleSets(Role role)
@@ -912,16 +612,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the DSD data set that matches a particular set name.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param set Will contain the name for existing DSD data set, {@link SDSet#name}.
-     * @return SDSet containing all attributes from matching DSD name.
-     * @throws org.apache.directory.fortress.core.SecurityException
-     *          in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public SDSet dsdRoleSet(SDSet set)
@@ -935,15 +626,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the list of DSDs that match a given dsd name value.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param ssd contains the name for the SSD set targeted, {@link SDSet#name}.
-     * @return List containing all DSDSets that match a given DSDSet name.
-     * @throws SecurityException in the event of data or system error.
+     * {@inheritDoc}
      */
     public List<SDSet> dsdSets(SDSet ssd)
         throws SecurityException
@@ -956,16 +639,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the set of roles of a DSD role set. The function is valid if and only if the
-     * role set exists.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param dsd contains the name for the DSD set targeted, {@link SDSet#name}.
-     * @return List containing all Roles that are members of DSD data set.
-     * @throws SecurityException in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public Set<String> dsdRoleSetRoles(SDSet dsd)
@@ -980,16 +654,7 @@ public class ReviewMgrImpl extends Manageable implements ReviewMgr
     }
 
     /**
-     * This function returns the cardinality associated with a DSD role set. The function is valid if and only if the
-     * role set exists.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param dsd contains the name of the DSD set targeted, {@link SDSet#name}.
-     * @return int value containing cardinality of DSD set.
-     * @throws SecurityException in the event of data or system error.
+     * {@inheritDoc}
      */
     @Override
     public int dsdRoleSetCardinality(SDSet dsd)

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/AccessMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/AccessMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/AccessMgrRestImpl.java
index 5b3a04d..b0be24a 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/AccessMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/AccessMgrRestImpl.java
@@ -80,13 +80,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     private static final String CLS_NM = AccessMgrImpl.class.getName();
 
     /**
-     * Perform user authentication only.  It does not activate RBAC roles in session but will evaluate
-     * password policies.
-     *
-     * @param userId   Contains the userid of the user signing on.
-     * @param password Contains the user's password.
-     * @return Session object will be returned if authentication successful.  This will not contain user's roles.
-     * @throws SecurityException in the event of data validation failure, security policy violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public Session authenticate(String userId, char[] password)
@@ -113,58 +107,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * Perform user authentication {@link User#password} and role activations.<br />
-     * This method must be called once per user prior to calling other methods within this class.
-     * The successful result is {@link Session} that contains target user's RBAC {@link User#roles} and Admin role {@link User#adminRoles}.<br />
-     * In addition to checking user password validity it will apply configured password policy checks {@link User#pwPolicy}..<br />
-     * Method may also store parms passed in for audit trail {@link org.apache.directory.fortress.core.model.FortEntity}.
-     * <h4> This API will...</h4>
-     * <ul>
-     * <li> authenticate user password if trusted == false.
-     * <li> perform <a href="http://www.openldap.org/">OpenLDAP</a> <a href="http://tools.ietf.org/html/draft-behera-ldap-password-policy-10">password policy evaluation</a>.
-     * <li> fail for any user who is locked by OpenLDAP's policies {@link User#isLocked()}, regardless of trusted flag being set as parm on API.
-     * <li> evaluate temporal {@link org.apache.directory.fortress.core.model.Constraint}(s) on {@link User}, {@link UserRole} and {@link org.apache.directory.fortress.core.model.UserAdminRole} entities.
-     * <li> process selective role activations into User RBAC Session {@link User#roles}.
-     * <li> check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate(Session, org.apache.directory.fortress.core.model.Constraint, org.apache.directory.fortress.core.util.time.Time)} on {@link User#roles}.
-     * <li> process selective administrative role activations {@link User#adminRoles}.
-     * <li> return a {@link Session} containing {@link Session#getUser()}, {@link Session#getRoles()} and (if admin user) {@link Session#getAdminRoles()} if everything checks out good.
-     * <li> throw a checked exception that will be {@link org.apache.directory.fortress.core.SecurityException} or its derivation.
-     * <li> throw a {@link SecurityException} for system failures.
-     * <li> throw a {@link org.apache.directory.fortress.core.PasswordException} for authentication and password policy violations.
-     * <li> throw a {@link org.apache.directory.fortress.core.ValidationException} for data validation errors.
-     * <li> throw a {@link org.apache.directory.fortress.core.FinderException} if User id not found.
-     * </ul>
-     * <h4>
-     * The function is valid if and only if:
-     * </h4>
-     * <ul>
-     * <li> the user is a member of the USERS data set
-     * <li> the password is supplied (unless trusted).
-     * <li> the (optional) active role set is a subset of the roles authorized for that user.
-     * </ul>
-     * <h4>
-     * The following attributes may be set when calling this method
-     * </h4>
-     * <ul>
-     * <li> {@link User#userId} - required
-     * <li> {@link User#password}
-     * <li> {@link User#roles} contains a list of RBAC role names authorized for user and targeted for activation within this session.  Default is all authorized RBAC roles will be activated into this Session.
-     * <li> {@link User#adminRoles} contains a list of Admin role names authorized for user and targeted for activation.  Default is all authorized ARBAC roles will be activated into this Session.
-     * <li> {@link User#props} collection of name value pairs collected on behalf of User during signon.  For example hostname:myservername or ip:192.168.1.99
-     * </ul>
-     * <h4>
-     * Notes:
-     * </h4>
-     * <ul>
-     * <li> roles that violate Dynamic Separation of Duty Relationships will not be activated into session.
-     * <li> role activations will proceed in same order as supplied to User entity setter, see {@link User#setRole(String)}.
-     * </ul>
-     * </p>
-     *
-     * @param user Contains {@link User#userId}, {@link User#password} (optional if {@code isTrusted} is 'true'), optional {@link User#roles}, optional {@link User#adminRoles}
-     * @param isTrusted if true password is not required.
-     * @return Session object will contain authentication result code {@link Session#errorId}, RBAC role activations {@link Session#getRoles()}, Admin Role activations {@link Session#getAdminRoles()},OpenLDAP pw policy codes {@link Session#warnings}, {@link Session#expirationSeconds}, {@link Session#graceLogins} and more.
-     * @throws SecurityException in the event of data validation failure, security policy violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public Session createSession(User user, boolean isTrusted)
@@ -198,18 +141,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * Perform user impl authorization.  This function returns a Boolean value meaning whether the subject of a given session is
-     * allowed or not to perform a given operation on a given object. The function is valid if and
-     * only if the session is a valid Fortress session, the object is a member of the OBJS data set,
-     * and the operation is a member of the OPS data set. The session's subject has the permission
-     * to perform the operation on that object if and only if that permission is assigned to (at least)
-     * one of the session's active roles. This implementation will verify the roles or userId correspond
-     * to the subject's active roles are registered in the object's access control list.
-     *
-     * @param perm  must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, of permission User is trying to access.
-     * @param session This object must be instantiated by calling {@link AccessMgrImpl#createSession} method before passing into the method.  No variables need to be set by client after returned from createSession.
-     * @return True if user has access, false otherwise.
-     * @throws SecurityException in the event of data validation failure, security policy violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public boolean checkAccess(Session session, Permission perm)
@@ -239,12 +171,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * This function returns the permissions of the session, i.e., the permissions assigned
-     * to its authorized roles. The function is valid if and only if the session is a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession method.
-     * @return List<Permission> containing permissions (op, obj) active for user's session.
-     * @throws SecurityException in the event runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> sessionPermissions(Session session)
@@ -272,13 +199,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * This function returns the active roles associated with a session. The function is valid if
-     * and only if the session is a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession method.
-     * @return List<UserRole> containing all roles active in user's session.  This will NOT contain inherited roles.
-     * @throws SecurityException
-     *          is thrown if session invalid or system. error.
+     * {@inheritDoc}
      */
     @Override
     public List<UserRole> sessionRoles(Session session)
@@ -306,12 +227,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * This function returns the authorized roles associated with a session. The function is valid if
-     * and only if the session is a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession method.
-     * @return Set<String> containing all roles active in user's session.  This will contain inherited roles.
-     * @throws SecurityException is thrown if session invalid or system. error.
+     * {@inheritDoc}
      */
     @Override
     public Set<String> authorizedRoles(Session session)
@@ -341,22 +257,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * This function adds a role as an active role of a session whose owner is a given user.
-     * <p>
-     * The function is valid if and only if:
-     * <ul>
-     * <li> the user is a member of the USERS data set
-     * <li> the role is a member of the ROLES data set
-     * <li> the role inclusion does not violate Dynamic Separation of Duty Relationships
-     * <li> the session is a valid Fortress session
-     * <li> the user is authorized to that role
-     * <li> the session is owned by that user.
-     * </ul>
-     * </p>
-     *
-     * @param session object contains the user's returned RBAC session from the createSession method.
-     * @param role object contains the role name, {@link UserRole#name}, to be activated into session.
-     * @throws SecurityException is thrown if user is not allowed to activate or runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public void addActiveRole(Session session, UserRole role)
@@ -384,14 +285,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * This function deletes a role from the active role set of a session owned by a given user.
-     * The function is valid if and only if the user is a member of the USERS data set, the
-     * session object contains a valid Fortress session, the session is owned by the user,
-     * and the role is an active role of that session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession method.
-     * @param role object contains the role name, {@link UserRole#name}, to be deactivated.
-     * @throws SecurityException is thrown if user is not allowed to deactivate or runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public void dropActiveRole(Session session, UserRole role)
@@ -419,12 +313,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * This function returns the userId value that is contained within the session object.
-     * The function is valid if and only if the session object contains a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession method.
-     * @return The userId value
-     * @throws SecurityException is thrown if user session not active or runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public String getUserId(Session session)
@@ -453,52 +342,7 @@ public class AccessMgrRestImpl extends Manageable implements AccessMgr
     }
 
     /**
-     * This function returns the user object that is contained within the session object.
-     * The function is valid if and only if the session object contains a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession method.
-     * @return The user value
-     *         Sample User data contained in Session object:
-     *         <ul> <code>Session</code>
-     *         <li> <code>session.getUserId() => demoUser4</code>
-     *         <li> <code>session.getInternalUserId() => be2dd2e:12a82ba707e:-7fee</code>
-     *         <li> <code>session.getMessage() => Fortress checkPwPolicies userId <demouser4> VALIDATION GOOD</code>
-     *         <li> <code>session.getErrorId() => 0</code>
-     *         <li> <code>session.getWarningId() => 11</code>
-     *         <li> <code>session.getExpirationSeconds() => 469831</code>
-     *         <li> <code>session.getGraceLogins() => 0</code>
-     *         <li> <code>session.getIsAuthenticated() => true</code>
-     *         <li> <code>session.getLastAccess() => 1283623680440</code>
-     *         <li> <code>session.getSessionId() => -7410986f:12addeea576:-7fff</code>
-     *         <li>  ------------------------------------------
-     *         <li> <code>User user = session.getUser();</code>
-     *         <ul> <li> <code>user.getUserId() => demoUser4</code>
-     *         <li> <code>user.getInternalId() => be2dd2e:12a82ba707e:-7fee</code>
-     *         <li> <code>user.getCn() => JoeUser4</code>
-     *         <li> <code>user.getDescription() => Demo Test User 4</code>
-     *         <li> <code>user.getOu() => test</code>
-     *         <li> <code>user.getSn() => User4</code>
-     *         <li> <code>user.getBeginDate() => 20090101</code>
-     *         <li> <code>user.getEndDate() => none</code>
-     *         <li> <code>user.getBeginLockDate() => none</code>
-     *         <li> <code>user.getEndLockDate() => none</code>
-     *         <li> <code>user.getDayMask() => 1234567</code>
-     *         <li> <code>user.getTimeout() => 60</code>
-     *         <li> <code>List<UserRole> roles = session.getRoles();</code>
-     *         <ul> <li><code>UserRole userRole = roles.get(i);</code>
-     *         <li> <code>userRole.getName() => role1</code>
-     *         <li> <code>userRole.getBeginTime() => 0000</code>
-     *         <li> <code>userRole.getEndTime() => 0000</code>
-     *         <li> <code>userRole.getBeginDate() => none</code>
-     *         <li> <code>userRole.getEndDate() => none</code>
-     *         <li> <code>userRole.getBeginLockDate() => null</code>
-     *         <li> <code>userRole.getEndLockDate() => null</code>
-     *         <li> <code>userRole.getDayMask() => null</code>
-     *         <li> <code>userRole.getTimeout() => 0</code>
-     *         </ul>
-     *         </ul>
-     *         </ul>
-     * @throws SecurityException is thrown if user session not active or runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public User getUser(Session session)


Mime
View raw message