directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject [1/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Date Sat, 02 Jan 2016 03:52:54 GMT
Repository: directory-fortress-core
Updated Branches:
  refs/heads/master 53e42081a -> d33ae957f


http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/ReviewMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/ReviewMgrRestImpl.java
b/src/main/java/org/apache/directory/fortress/core/rest/ReviewMgrRestImpl.java
index f9c9ac7..c7e8dae 100755
--- a/src/main/java/org/apache/directory/fortress/core/rest/ReviewMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/ReviewMgrRestImpl.java
@@ -79,17 +79,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
 {
     private static final String CLS_NM = ReviewMgrRestImpl.class.getName();
 
+
     /**
-     * This method returns a matching permission entity to caller.
-     * <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 permission must contain the object, {@link Permission#objName}, and operation,
{@link 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)
@@ -118,16 +110,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retPerm;
     }
 
+
     /**
-     * Method reads permission object from perm container in directory.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link PermObj#objName} - contains the name of existing object being targeted</li>
-     * </ul>
-     *
-     * @param permObj entity contains the {@link 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)
@@ -156,18 +141,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retObj;
     }
 
+
     /**
-     * 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</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> findPermissions(Permission permission)
@@ -196,13 +172,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retPerms;
     }
 
+
     /**
-     * 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)
@@ -231,19 +203,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retPerms;
     }
 
+
     /**
-     * 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)
@@ -272,17 +234,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retPerms;
     }
 
+
     /**
-     * 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)
@@ -311,17 +265,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retObjs;
     }
 
+
     /**
-     * Method returns a list of type Permission that match the perm object search string.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link 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)
@@ -352,16 +298,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retObjs;
     }
 
+
     /**
-     * Method reads Role entity from the role container in directory.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link Role#name} - contains the name to use for the Role to read.</li>
-     * </ul>
-     *
-     * @param role contains role name, {@link 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)
@@ -390,13 +329,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRole;
     }
 
+
     /**
-     * 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)
@@ -425,15 +360,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRoles;
     }
 
+
     /**
-     * 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 Role containing role entities that match the search criteria.
-     * @throws SecurityException in the event of system error.
+     * {@inheritDoc}
      */
     @Override
     public List<String> findRoles(String searchVal, int limit)
@@ -463,18 +392,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRoles;
     }
 
+
     /**
-     * Method returns matching User entity that is contained within the people container
in the directory.
-     * <h4>required parameters</h4>
-     * <ul>
-     * <li>{@link User#userId} - contains the userId associated with the User object
targeted for read.</li>
-     * </ul>
-     *
-     * @param user entity contains a value {@link 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)
@@ -505,15 +425,7 @@ public class ReviewMgrRestImpl 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 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)
@@ -542,16 +454,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUsers;
     }
 
+
     /**
-     * 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 org.apache.directory.fortress.core.model.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)
@@ -582,19 +487,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUsers;
     }
 
+
     /**
-     * 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)
@@ -624,22 +519,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUsers;
     }
 
+
     /**
-     * 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)
@@ -674,17 +556,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUsers;
     }
 
+
     /**
-     * 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)
@@ -713,17 +587,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUsers;
     }
 
+
     /**
-     * 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)
@@ -752,13 +618,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUserRoles;
     }
 
+
     /**
-     * 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)
@@ -787,17 +649,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUserRoles;
     }
 
+
     /**
-     * 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)
@@ -830,17 +684,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUsers;
     }
 
+
     /**
-     * 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)
@@ -871,18 +717,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRoleNames;
     }
 
+
     /**
-     * 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)
@@ -891,19 +728,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return rolePermissions( role, false );
     }
 
+
     /**
-     * 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 )
@@ -933,18 +760,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retPerms;
     }
 
+
     /**
-     * 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)
@@ -973,17 +791,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retPerms;
     }
 
+
     /**
-     * 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 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)
@@ -1012,18 +822,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRoleNames;
     }
 
+
     /**
-     * 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 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)
@@ -1054,18 +855,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRoleNames;
     }
 
+
     /**
-     * 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)
@@ -1094,18 +886,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUsers;
     }
 
+
     /**
-     * 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)
@@ -1136,18 +919,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retUserIds;
     }
 
+
     /**
-     * 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)
@@ -1180,17 +954,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retSsdRoleSets;
     }
 
+
     /**
-     * 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)
@@ -1219,16 +985,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retSet;
     }
 
+
     /**
-     * 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
@@ -1260,17 +1019,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
          return retSsdSets;
     }
 
+
     /**
-     * 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)
@@ -1301,17 +1052,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRoleNames;
     }
 
+
     /**
-     * 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)
@@ -1340,18 +1083,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retSet.getCardinality();
     }
 
+
     /**
-     * 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)
@@ -1384,17 +1118,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retDsdRoleSets;
     }
 
+
     /**
-     * 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)
@@ -1423,16 +1149,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retSet;
     }
 
+
     /**
-     * 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 dsd contains the name for the DSD 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 dsd)
         throws SecurityException
@@ -1464,17 +1183,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
          return retDsdSets;
     }
 
+
     /**
-     * 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)
@@ -1505,17 +1216,9 @@ public class ReviewMgrRestImpl extends Manageable implements ReviewMgr
         return retRoleNames;
     }
 
+
     /**
-     * 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)


Mime
View raw message