You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2016/01/02 04:52:54 UTC
[1/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
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)
[4/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Posted by sm...@apache.org.
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)
[7/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Posted by sm...@apache.org.
FC-132 - Fix javadoc issues
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/d33ae957
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/d33ae957
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/d33ae957
Branch: refs/heads/master
Commit: d33ae957fa162ba845cbc3b68ec85f14c70c1df3
Parents: 53e4208
Author: Shawn McKinney <sm...@apache.org>
Authored: Fri Jan 1 21:52:49 2016 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Fri Jan 1 21:52:49 2016 -0600
----------------------------------------------------------------------
.../fortress/core/impl/AccelMgrImpl.java | 111 +--
.../fortress/core/impl/AccessMgrImpl.java | 176 +---
.../fortress/core/impl/AdminMgrImpl.java | 824 +------------------
.../fortress/core/impl/AuditMgrImpl.java | 100 +--
.../fortress/core/impl/ConfigMgrImpl.java | 35 +-
.../fortress/core/impl/DelAccessMgrImpl.java | 94 +--
.../fortress/core/impl/DelAdminMgrImpl.java | 525 +-----------
.../fortress/core/impl/DelReviewMgrImpl.java | 73 +-
.../fortress/core/impl/GroupMgrImpl.java | 68 +-
.../fortress/core/impl/PwPolicyMgrImpl.java | 213 +----
.../fortress/core/impl/ReviewMgrImpl.java | 417 +---------
.../fortress/core/rest/AccessMgrRestImpl.java | 176 +---
.../fortress/core/rest/AdminMgrRestImpl.java | 745 +----------------
.../fortress/core/rest/AuditMgrRestImpl.java | 102 +--
.../fortress/core/rest/ConfigMgrRestImpl.java | 47 +-
.../core/rest/DelAccessMgrRestImpl.java | 103 +--
.../fortress/core/rest/DelAdminMgrRestImpl.java | 545 ++----------
.../core/rest/DelReviewMgrRestImpl.java | 75 +-
.../fortress/core/rest/PwPolicyMgrRestImpl.java | 213 +----
.../fortress/core/rest/ReviewMgrRestImpl.java | 443 ++--------
20 files changed, 389 insertions(+), 4696 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
index 192f3c2..ab165ac 100644
--- a/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
@@ -85,58 +85,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
/**
- * Perform user authentication {@link org.apache.directory.fortress.core.model.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 org.apache.directory.fortress.core.model.Session} that contains target user's RBAC {@link org.apache.directory.fortress.core.model.User#roles} and Admin role {@link org.apache.directory.fortress.core.model.User#adminRoles}.<br />
- * In addition to checking user password validity it will apply configured password policy checks {@link org.apache.directory.fortress.core.model.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 org.apache.directory.fortress.core.model.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 org.apache.directory.fortress.core.model.User}, {@link org.apache.directory.fortress.core.model.UserRole} and {@link org.apache.directory.fortress.core.model.UserAdminRole} entities.
- * <li> process selective role activations into User RBAC Session {@link org.apache.directory.fortress.core.model.User#roles}.
- * <li> check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate(org.apache.directory.fortress.core.model.Session, org.apache.directory.fortress.core.model.Constraint, org.apache.directory.fortress.core.util.time.Time)} on {@link org.apache.directory.fortress.core.model.User#roles}.
- * <li> process selective administrative role activations {@link org.apache.directory.fortress.core.model.User#adminRoles}.
- * <li> return a {@link org.apache.directory.fortress.core.model.Session} that contains a reference to an object stored on the RBAC server..
- * <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 org.apache.directory.fortress.core.model.User#userId} - required
- * <li> {@link org.apache.directory.fortress.core.model.User#password}
- * <li> {@link org.apache.directory.fortress.core.model.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 org.apache.directory.fortress.core.model.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 org.apache.directory.fortress.core.model.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 org.apache.directory.fortress.core.model.User#setRole(String)}.
- * </ul>
- * </p>
- *
- * @param user Contains {@link org.apache.directory.fortress.core.model.User#userId}, {@link org.apache.directory.fortress.core.model.User#password} (optional if {@code isTrusted} is 'true'), optional {@link org.apache.directory.fortress.core.model.User#roles}, optional {@link org.apache.directory.fortress.core.model.User#adminRoles}
- * @param isTrusted if true password is not required.
- * @return Session object will contain authentication result code {@link org.apache.directory.fortress.core.model.Session#errorId},
- * @throws SecurityException in the event of data validation failure, security policy violation or DAO error.
+ * {@inheritDoc}
*/
@Override
public Session createSession( User user, boolean isTrusted )
@@ -149,10 +98,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
/**
- * This function requests the RBAC server to delete the session from cache.
- *
- * @param session object contains the user's returned RBAC session from the createSession method.
- * @throws SecurityException in the event runtime error occurs with system.
+ * {@inheritDoc}
*/
@Override
public void deleteSession( Session session )
@@ -165,12 +111,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
/**
- * 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}
*/
public List<UserRole> sessionRoles(Session session)
throws SecurityException
@@ -182,18 +123,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
/**
- * 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 org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.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 )
@@ -211,12 +141,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
/**
- * 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 )
@@ -227,22 +152,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
/**
- * 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 )
@@ -260,14 +170,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
/**
- * 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 )
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
index 1062715..6ed29e9 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
@@ -79,13 +79,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
private static final PermP permP = new PermP();
/**
- * 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 )
@@ -108,58 +102,7 @@ public class AccessMgrImpl 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 org.apache.directory.fortress.core.model.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 )
@@ -173,18 +116,7 @@ public class AccessMgrImpl 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 org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.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 )
@@ -204,12 +136,7 @@ public class AccessMgrImpl 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 )
@@ -224,13 +151,7 @@ public class AccessMgrImpl 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 )
@@ -245,12 +166,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
/**
- * This function returns the authorized roles associated with a session based on hierarchical relationships. 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 )
@@ -266,22 +182,7 @@ public class AccessMgrImpl 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 )
@@ -326,14 +227,7 @@ public class AccessMgrImpl 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 )
@@ -361,12 +255,7 @@ public class AccessMgrImpl 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 )
@@ -378,52 +267,7 @@ public class AccessMgrImpl 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 )
[6/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Posted by sm...@apache.org.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/AdminMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/AdminMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/AdminMgrImpl.java
index 7895643..aecef43 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/AdminMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/AdminMgrImpl.java
@@ -95,45 +95,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command creates a new RBAC user. The command is valid only if the new user is
- * not already a member of the USERS data set. The USER data set is updated. The new user
- * does not own any session at the time of its creation.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#ou} - contains the name of an already existing User OU node</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#pwPolicy} - contains the name of an already existing OpenLDAP password policy node</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#cn} - maps to INetOrgPerson common name attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#sn} - maps to INetOrgPerson surname attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#description} - maps to INetOrgPerson description attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#title} - maps to INetOrgPerson title attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#employeeType} - maps to INetOrgPerson employeeType attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#phones} * - multi-occurring attribute maps to organizationalPerson telephoneNumber
- * attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#mobiles} * - multi-occurring attribute maps to INetOrgPerson mobile attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#emails} * - multi-occurring attribute maps to INetOrgPerson mail attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#address} * - multi-occurring attribute maps to organizationalPerson postalAddress, st, l,
- * postalCode, postOfficeBox attributes</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#beginTime} - HHMM - determines begin hour user may activate session</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#endTime} - HHMM - determines end hour user may activate session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#beginDate} - YYYYMMDD - determines date when user may sign on</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#endDate} - YYYYMMDD - indicates latest date user may sign on</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of user may sign on</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#timeout} - number in seconds of session inactivity time allowed</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#props} * - multi-occurring attribute contains property key and values are separated with a ':'
- * . e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param user User entity must contain {@link org.apache.directory.fortress.core.model.User#userId} and {@link org.apache.directory.fortress.core.model.User#ou} (required) and optional {@link
- * org.apache.directory.fortress.core.model.User#description},{@link org.apache.directory.fortress.core.model.User#roles} and many others.
- * @return Returns entity containing user data that was added.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public User addUser( User user ) throws SecurityException
@@ -148,21 +110,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command disables an existing user in the RBAC database. The command is valid
- * if and only if the user to be disabled is a member of the USERS data set. The USERS and
- * UA data sets and the assigned_users function are updated.
- * Method performs a "soft" delete. It performs the following:
- * - sets the user status to "deleted"
- * - deassigns all roles from the user
- * - locks the user's password in LDAP
- * - revokes all perms that have been granted to user entity.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user Contains the {@link User#userId} of the User targeted for deletion.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void disableUser( User user ) throws SecurityException
@@ -184,19 +132,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command deletes an existing user from the RBAC database. The command is valid
- * if and only if the user to be deleted is a member of the USERS data set. The USERS and
- * UA data sets and the assigned_users function are updated.
- * This method performs a "hard" delete. It completely removes all data associated with this user from the
- * directory.
- * User entity must exist in directory prior to making this call else exception will be thrown.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user Contains the {@link User#userId} of the User targeted for deletion.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteUser( User user ) throws SecurityException
@@ -216,42 +152,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This method performs an update on User entity in directory. Prior to making this call the entity must exist in
- * directory.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link User#password} - used to authenticate the User</li>
- * <li>{@link User#ou} - contains the name of an already existing User OU node</li>
- * <li>{@link User#pwPolicy} - contains the name of an already existing OpenLDAP password policy node</li>
- * <li>{@link User#cn} - maps to INetOrgPerson common name attribute</li>
- * <li>{@link User#sn} - maps to INetOrgPerson surname attribute</li>
- * <li>{@link User#description} - maps to INetOrgPerson description attribute</li>
- * <li>{@link User#phones} * - multi-occurring attribute maps to organizationalPerson telephoneNumber
- * attribute</li>
- * <li>{@link User#mobiles} * - multi-occurring attribute maps to INetOrgPerson mobile attribute</li>
- * <li>{@link User#emails} * - multi-occurring attribute maps to INetOrgPerson mail attribute</li>
- * <li>{@link User#address} * - multi-occurring attribute maps to organizationalPerson postalAddress, st, l,
- * postalCode, postOfficeBox attributes</li>
- * <li>{@link User#beginTime} - HHMM - determines begin hour user may activate session</li>
- * <li>{@link User#endTime} - HHMM - determines end hour user may activate session.</li>
- * <li>{@link User#beginDate} - YYYYMMDD - determines date when user may sign on</li>
- * <li>{@link User#endDate} - YYYYMMDD - indicates latest date user may sign on</li>
- * <li>{@link User#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link User#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of user may sign on</li>
- * <li>{@link User#timeout} - number in seconds of session inactivity time allowed</li>
- * <li>{@link User#props} * - multi-occurring attribute contains property key and values are separated with a ':'
- * . e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param user must contain {@link User#userId} and optional entity data to update i.e. desc, ou, properties,
- * all attributes that are not set will be ignored.
- * @return Updated user entity data.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public User updateUser( User user ) throws SecurityException
@@ -264,18 +165,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * Method will change user's password. This method will evaluate user's password policies.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * <li>{@link User#password} - contains the User's old password</li>
- * <li>newPassword - contains the User's new password</li>
- * </ul>
- *
- * @param user contains {@link User#userId} and old user password {@link User#password}.
- * @param newPassword contains new user password.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Will be thrown in the event of password policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void changePassword( User user, char[] newPassword ) throws SecurityException
@@ -289,15 +179,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * Method will lock user's password which will prevent the user from authenticating with directory.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user entity contains {@link User#userId} of User to be locked.
- * @throws SecurityException will be thrown in the event of pw policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void lockUserAccount( User user ) throws SecurityException
@@ -310,15 +192,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * Method will unlock user's password which will enable user to authenticate with directory.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user entity contains {@link User#userId} of User to be unlocked.
- * @throws SecurityException will be thrown in the event of pw policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void unlockUserAccount( User user ) throws SecurityException
@@ -331,18 +205,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * Method will reset user's password which will require user to change password before successful authentication
- * with directory.
- * This method will not evaluate password policies on the new user password as it must be changed before use.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * <li>newPassword - contains the User's new password</li>
- * </ul>
- *
- * @param user entity contains {@link User#userId} of User to be reset.
- * @throws SecurityException will be thrown in the event of pw policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void resetPassword( User user, char[] newPassword ) throws SecurityException
@@ -357,15 +220,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * Method will delete user's password policy designation.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * <li>newPassword - contains the User's new password</li>
- * </ul>
- *
- * @param user contains {@link User#userId}.
- * @throws SecurityException will be thrown in the event of password policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePasswordPolicy( User user ) throws SecurityException
@@ -378,30 +233,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command creates a new role. The command is valid if and only if the new role is not
- * already a member of the ROLES data set. The ROLES data set is updated.
- * Initially, no user or permission is assigned to the new role.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to be created.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Role#description} - maps to description attribute on organizationalRole object class</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated
- * into user's RBAC session</li>
- * </ul>
- *
- * @param role must contains {@link org.apache.directory.fortress.core.model.Role#name} (required) and optional {@link org.apache.directory.fortress.core.model.Role#description}.
- * @return Role contains reference to entity operated on.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public Role addRole( Role role ) throws SecurityException
@@ -414,18 +246,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command deletes an existing role from the RBAC database. The command is valid
- * if and only if the role to be deleted is a member of the ROLES data set. This command will
- * also deassign role from all users.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to be deleted.</li>
- * </ul>
- *
- * @param role Contains {@link Role#name} for Role to delete.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteRole( Role role ) throws SecurityException
@@ -468,30 +289,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * Method will update a Role entity in the directory. The role must exist prior to this call.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to be updated.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link Role#description} - maps to description attribute on organizationalRole object class</li>
- * <li>{@link Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session</li>
- * <li>{@link Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC session.</li>
- * <li>{@link Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
- * <li>{@link Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
- * <li>{@link Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated
- * into user's RBAC session</li>
- * </ul>
- *
- * @param role must contains {@link Role#name} and may contain new description or
- * {@link org.apache.directory.fortress.core.model.Constraint}
- * @return Role contains reference to entity operated on.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of validation or system error.
+ * {@inheritDoc}
*/
@Override
public Role updateRole( Role role ) throws SecurityException
@@ -504,57 +302,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command assigns a user to a role.
- * <p>
- * <ul>
- * <li> The command is valid if and only if:
- * <li> The user is a member of the USERS data set
- * <li> The role is a member of the ROLES data set
- * <li> The user is not already assigned to the role
- * <li> The SSD constraints are satisfied after assignment.
- * </ul>
- * </p>
- * <p>
- * Successful completion of this op, the following occurs:
- * </p>
- * <ul>
- * <li> User entity (resides in people container) has role assignment added to aux object class attached to
- * actual user record.
- * <li> Role entity (resides in role container) has userId added as role occupant.
- * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:
- * <ul>
- * <li> timeout - number in seconds of session inactivity time allowed.
- * <li> beginDate - YYYYMMDD - determines date when role may be activated.
- * <li> endDate - YYMMDD - indicates latest date role may be activated.
- * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status
- * <li> endLockDate - YYMMDD - determines end of enforced inactive status.
- * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.
- * <li> endTime - HHMM - determines end hour role may be activated in user's session.*
- * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.
- * </ul>
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link UserRole#name} - contains the name for already existing Role to be assigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#userId} - contains the userId for existing User</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserRole#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session</li>
- * <li>{@link UserRole#endTime} - HHMM - determines end hour role may be activated into user's RBAC session.</li>
- * <li>{@link UserRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC
- * session</li>
- * <li>{@link UserRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC
- * session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link UserRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link UserRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be
- * activated into user's RBAC session</li>
- * </ul>
- *
- * @param uRole must contain {@link UserRole#userId} and {@link UserRole#name} and optional {@code Constraints}.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of validation or system error.
+ * {@inheritDoc}
*/
@Override
public void assignUser( UserRole uRole ) throws SecurityException
@@ -585,22 +333,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command deletes the assignment of the User from the Role entities. The command is
- * valid if and only if the user is a member of the USERS data set, the role is a member of
- * the ROLES data set, and the user is assigned to the role.
- * Any sessions that currently have this role activated will not be effected.
- * Successful completion includes:
- * User entity in USER data set has role assignment removed.
- * Role entity in ROLE data set has userId removed as role occupant.
- * (optional) Temporal constraints will be removed from user aux object if set prior to call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#name} - contains the name for already existing Role to be deassigned</li>
- * <li>{@link UserRole#userId} - contains the userId for existing User</li>
- * </ul>
- *
- * @param uRole must contain {@link org.apache.directory.fortress.core.model.UserRole#userId} and {@link UserRole#name}.
- * @throws SecurityException - in the event data error in user or role objects or system error.
+ * {@inheritDoc}
*/
@Override
public void deassignUser( UserRole uRole ) throws SecurityException
@@ -621,33 +354,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This method will add permission operation to an existing permission object which resides under {@code
- * ou=Permissions,ou=RBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may have {@link org.apache.directory.fortress.core.model.Role} or {@link org.apache.directory.fortress.core.model.User}
- * associations. The target {@link org.apache.directory.fortress.core.model.Permission} must not exist prior to calling.
- * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself
- * as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission
- * add</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission operation being added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is
- * being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains Users that permission operation is being
- * granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g.
- * mykey1:myvalue1</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation,
- * {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target along with optional other attributes..
- * @return copy of Permission entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission addPermission( Permission perm ) throws SecurityException
@@ -660,33 +367,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This method will update permission operation pre-existing in target directory under {@code ou=Permissions,
- * ou=RBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may also contain {@link org.apache.directory.fortress.core.model.Role} or {@link org.apache.directory.fortress.core.impl
- * .User} associations to add or remove using this function.
- * The perm operation must exist before making this call. Only non-null attributes will be updated.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted for the permission
- * update</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is
- * being granted to</li>
- * <li>{@link Permission#users} * - multi occurring attribute contains Users that permission operation is being
- * granted to</li>
- * <li>{@link Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g.
- * mykey1:myvalue1</li>
- * <li>{@link Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName},
- * that identifies target and any optional data to update. Null or empty attributes will be ignored.
- * @return copy of Permission entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission updatePermission( Permission perm ) throws SecurityException
@@ -699,20 +380,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This method will remove permission operation entity from permission object. A Fortress permission is
- * (object->operation).
- * The perm operation must exist before making this call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission
- * delete</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation being removed</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName},
- * that identifies target.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermission( Permission perm ) throws SecurityException
@@ -725,27 +393,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This method will add permission object to perms container in directory. The perm object must not exist before
- * making this call.
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship between itself and children as
- * stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object being added</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g.
- * mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} and {@link org.apache.directory.fortress.core.model.PermObj#ou}. The other attributes are
- * optional.
- * @return copy of PermObj entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj addPermObj( PermObj pObj ) throws SecurityException
@@ -758,27 +406,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This method will update permission object in perms container in directory. The perm object must exist before
- * making this call.
- * A {@link PermObj} instance exists in a hierarchical, one-many relationship between itself and children as
- * stored in ldap tree: ({@link PermObj}*->{@link Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * <li>{@link PermObj#description} - any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
- * <li>{@link PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g.
- * mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link PermObj#objName}. Only non-null attributes will be updated.
- * @return copy of newly updated PermObj entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj updatePermObj( PermObj pObj ) throws SecurityException
@@ -791,15 +419,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This method will remove permission object to perms container in directory. This method will also remove
- * in associated permission objects that are attached to this object.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object targeted for removal</li>
- * </ul>
- *
- * @param pObj must contain the {@link PermObj#objName} of object targeted for removal.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermObj( PermObj pObj ) throws SecurityException
@@ -812,23 +432,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command grants a role the permission to perform an operation on an object to a role.
- * The command is implemented by granting permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * and the role is a member of the ROLES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link Role#name} - contains the role name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName},
- * that identifies target.
- * @param role must contains {@link org.apache.directory.fortress.core.model.Role#name}.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission( Permission perm, Role role ) throws SecurityException
@@ -855,22 +459,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command revokes the permission to perform an operation on an object from the set
- * of permissions assigned to a role. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * the role is a member of the ROLES data set, and the permission is assigned to that role.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link Role#name} - contains the role name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName},
- * that identifies target.
- * @param role must contains {@link Role#name}.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission( Permission perm, Role role ) throws SecurityException
@@ -888,23 +477,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command grants a user the permission to perform an operation on an object to a role.
- * The command is implemented by granting permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * and the user is a member of the USERS data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName},
- * that identifies target.
- * @param user must contain {@link User#userId} of target User entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission( Permission perm, User user ) throws SecurityException
@@ -920,22 +493,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command revokes the permission to perform an operation on an object from the set
- * of permissions assigned to a user. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * the user is a member of the USERS data set, and the permission is assigned to that user.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName},
- * that identifies target.
- * @param user must contain {@link User#userId} of target User entity.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission( Permission perm, User user ) throws SecurityException
@@ -949,42 +507,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command creates a new role childRole, and inserts it in the role hierarchy as an immediate descendant of
- * the existing role parentRole. The command is valid if and only if childRole is not a member of the ROLES data
- * set,
- * and parentRole is a member of the ROLES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.Role#name} - contains the name of existing Role to be parent</li>
- * <li>childRole - {@link Role#name} - contains the name of new Role to be child</li>
- * </ul>
- * <h4>optional parameters childRole</h4>
- * <ul>
- * <li>childRole - {@link Role#description} - maps to description attribute on organizationalRole object class
- * for new child</li>
- * <li>childRole - {@link Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC
- * session for new child</li>
- * <li>childRole - {@link Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC
- * session for new child</li>
- * <li>childRole - {@link Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's
- * RBAC session for new child</li>
- * <li>childRole - {@link Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC
- * session for new child</li>
- * <li>childRole - {@link Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for
- * new child</li>
- * <li>childRole - {@link Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new
- * child</li>
- * <li>childRole - {@link Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be
- * activated into user's RBAC session for new child</li>
- * </ul>
- *
- * @param parentRole This entity must be present in ROLE data set. Success will add role rel with childRole.
- * @param childRole This entity must not be present in ROLE data set. Success will add the new role entity to
- * ROLE data set.
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new childRole and pre-existing parentRole.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addDescendant( Role parentRole, Role childRole ) throws SecurityException
@@ -1006,41 +529,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command creates a new role parentRole, and inserts it in the role hierarchy as an immediate ascendant of
- * the existing role childRole. The command is valid if and only if parentRole is not a member of the ROLES data
- * set,
- * and childRole is a member of the ROLES data set.
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new parentRole and pre-existing childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>childRole - {@link Role#name} - contains the name of existing child Role</li>
- * <li>parentRole - {@link Role#name} - contains the name of new Role to be parent</li>
- * </ul>
- * <h4>optional parameters parentRole</h4>
- * <ul>
- * <li>parentRole - {@link Role#description} - maps to description attribute on organizationalRole object class
- * for new parent</li>
- * <li>parentRole - {@link Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC
- * session for new parent</li>
- * <li>parentRole - {@link Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC
- * session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's
- * RBAC session for new parent</li>
- * <li>parentRole - {@link Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's
- * RBAC session for new parent</li>
- * <li>parentRole - {@link Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for
- * new parent</li>
- * <li>parentRole - {@link Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new
- * parent</li>
- * <li>parentRole - {@link Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be
- * activated into user's RBAC session for new parent</li>
- * </ul>
- *
- * @param parentRole completion of op assigns new child relationship with childRole.
- * @param childRole completion of op assigns new parent relationship with parentRole.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addAscendant( Role childRole, Role parentRole ) throws SecurityException
@@ -1069,22 +558,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
- * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the
- * ROLES data
- * set, parentRole is not an immediate ascendant of childRole, and childRole does not properly inherit parentRole
- * (in order to
- * avoid cycle creation).
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link Role#name} - contains the name of existing Role to be parent</li>
- * <li>childRole - {@link Role#name} - contains the name of existing Role to be child</li>
- * </ul>
- *
- * @param parentRole completion of op deassigns child relationship with childRole.
- * @param childRole completion of op deassigns parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addInheritance( Role parentRole, Role childRole ) throws SecurityException
@@ -1115,19 +589,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command deletes an existing immediate inheritance relationship parentRole <<-- childRole. The command is
- * valid if and only if the roles parentRole and childRole are members of the ROLES data set, and parentRole is an
- * immediate ascendant of childRole. The new inheritance relation is computed as the reflexive-transitive
- * closure of the immediate inheritance relation resulted after deleting the relationship parentRole <<-- childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link Role#name} - contains the name of existing Role to remove parent relationship</li>
- * <li>childRole - {@link Role#name} - contains the name of existing Role to remove child relationship</li>
- * </ul>
- *
- * @param parentRole completion of op removes child relationship with childRole.
- * @param childRole completion of op removes parent relationship with parentRole.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteInheritance( Role parentRole, Role childRole ) throws SecurityException
@@ -1164,30 +626,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command creates a named SSD set of roles and sets the cardinality n of its subsets
- * that cannot have common users. The command is valid if and only if:
- * 1 - the name of the SSD set is not already in use
- * 2 - all the roles in the SSD set are members of the ROLES data set
- * 3 - n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the SSD role
- * set,
- * 4 - the SSD constraint for the new role set is satisfied.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of new SSD role set to be added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be
- * assigned to User from a particular set</li>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing, name, members,
- * and cardinality (default 2)
- * @return reference to newly created SSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet createSsdSet( SDSet ssdSet ) throws SecurityException
@@ -1207,33 +646,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command updates existing SSD set of roles and sets the cardinality n of its subsets
- * that cannot have common users.
- * <p/>
- * The command is valid if and only if:
- * <ul>
- * <li>The name of the SSD set already exists.
- * <li> All the roles in the SSD set are members of the ROLES data set.
- * <li> n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the SSD
- * role set.
- * <li> The SSD constraint for the new role set is satisfied.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of existing SSD role set to be updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be
- * assigned to User from a particular set</li>
- * <li>{@link SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to existing SSD set containing, name, members,
- * and cardinality (default 2)
- * @return reference to SSDSet object targeted for update.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
public SDSet updateSsdSet( SDSet ssdSet ) throws SecurityException
{
@@ -1246,22 +659,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command adds a role to a named SSD set of roles. The cardinality associated with the role set remains
- * unchanged.
- * The command is valid if and only if:
- * 1 - the SSD role set exists, and
- * 2 - the role to be added is a member of the ROLES data set but not of a member of the SSD role set, and
- * 3 - the SSD constraint is satisfied after the addition of the role to the SSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of new {@link SDSet#members} to be added</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing, name
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet addSsdRoleMember( SDSet ssdSet, Role role ) throws SecurityException
@@ -1283,23 +681,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command removes a role from a named SSD set of roles. The cardinality associated with the role set
- * remains unchanged.
- * The command is valid if and only if:
- * 1 - the SSD role set exists, and
- * 2 - the role to be removed is a member of the SSD role set, and
- * 3 - the cardinality associated with the SSD role set is less than the number of elements of the SSD role set.
- * Note that the SSD constraint should be satisfied after the removal of the role from the SSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of existing {@link SDSet#members} to be removed</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing name.
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteSsdRoleMember( SDSet ssdSet, Role role ) throws SecurityException
@@ -1326,15 +708,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command deletes a SSD role set completely. The command is valid if and only if the SSD role set exists.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of existing SSD role set to be removed</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to SSD set targeted for removal.
- * @return reference to deleted SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteSsdSet( SDSet ssdSet ) throws SecurityException
@@ -1380,21 +754,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command sets the cardinality associated with a given SSD role set. The command is valid if and only if:
- * 1 - the SSD role set exists, and
- * 2 - the new cardinality is a natural number greater than or equal to 2 and less than or equal to the number of
- * elements of the SSD role set, and
- * 3 - the SSD constraint is satisfied after setting the new cardinality.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
- * <li>cardinality - contains new cardinality setting for SSD</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing, name
- * @param cardinality integer value contains new cardinality value for data set.
- * @return reference to updated SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet setSsdSetCardinality( SDSet ssdSet, int cardinality ) throws SecurityException
@@ -1411,30 +771,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command creates a named DSD set of roles and sets an associated cardinality n.
- * The DSD constraint stipulates that the DSD role set cannot contain n or more roles
- * simultaneously active in the same session. The command is valid if and only if:
- * 1 - the name of the DSD set is not already in use
- * 2 - all the roles in the DSD set are members of the ROLES data set
- * 3 - n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the DSD role
- * set,
- * 4 - the DSD constraint for the new role set is satisfied.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of new DSD role set to be added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be
- * assigned to User from a particular set</li>
- * <li>{@link SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing, name, members,
- * and cardinality (default 2)
- * @return reference to newly created SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet createDsdSet( SDSet dsdSet ) throws SecurityException
@@ -1453,33 +790,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command updates existing DSD set of roles and sets the cardinality n of its subsets
- * that cannot have common users.
- * <p/>
- * The command is valid if and only if:
- * <ul>
- * <li>The name of the DSD set already exists.
- * <li> All the roles in the DSD set are members of the ROLES data set.
- * <li> n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the DSD
- * role set.
- * <li> The DSD constraint for the new role set is satisfied.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of existing DSD role set to be updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be
- * assigned to User from a particular set</li>
- * <li>{@link SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to existing DSD set containing, name, members,
- * and cardinality (default 2)
- * @return reference to DSDSet object targeted for update.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
public SDSet updateDsdSet( SDSet dsdSet ) throws SecurityException
{
@@ -1492,22 +803,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command adds a role to a named DSD set of roles. The cardinality associated with
- * the role set remains unchanged. The command is valid if and only if:
- * 1 - the DSD role set exists, and
- * 2 - the role to be added is a member of the ROLES data set but not of a member of the DSD role set, and
- * 3 - the DSD constraint is satisfied after the addition of the role to the SSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of new {@link SDSet#members} to be added</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing, name
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated DSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet addDsdRoleMember( SDSet dsdSet, Role role ) throws SecurityException
@@ -1529,22 +825,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command removes a role from a named DSD set of roles. The cardinality associated
- * with the role set remains unchanged. The command is valid if and only if:
- * 1 - the DSD role set exists, and
- * 2 - the role to be removed is a member of the DSD role set, and
- * 3 - the cardinality associated with the DSD role set is less than the number of elements of the DSD role set.
- * Note that the DSD constraint should be satisfied after the removal of the role from the DSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of existing {@link SDSet#members} to be removed</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing name.
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated DSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteDsdRoleMember( SDSet dsdSet, Role role ) throws SecurityException
@@ -1571,16 +852,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * This command deletes a DSD role set completely. The command is valid if and only if the DSD role set exists.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be removed</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to DSD set targeted for removal.
- * @return reference to deleted DSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteDsdSet( SDSet dsdSet ) throws SecurityException
@@ -1596,23 +868,7 @@ public final class AdminMgrImpl extends Manageable implements AdminMgr
/**
- * h * This command sets the cardinality associated with a given DSD role set. The command is valid if and
- * only if:
- * 1 - the SSD role set exists, and
- * 2 - the new cardinality is a natural number greater than or equal to 2 and less than or equal to the number of
- * elements of the SSD role set, and
- * 3 - the SSD constraint is satisfied after setting the new cardinality.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
- * <li>cardinality - contains new cardinality setting for DSD</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing, name
- * @param cardinality integer value contains new cardinality value for data set.
- * @return reference to updated DSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet setDsdSetCardinality( SDSet dsdSet, int cardinality ) throws SecurityException
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/AuditMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/AuditMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/AuditMgrImpl.java
index 27ae1cc..569c288 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/AuditMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/AuditMgrImpl.java
@@ -85,20 +85,7 @@ public class AuditMgrImpl extends Manageable implements AuditMgr
private static final AuditP auditP = new AuditP();
/**
- * This method returns a list of authorization events for a particular user {@link org.apache.directory.fortress.core.model.UserAudit#userId}
- * and given timestamp field {@link org.apache.directory.fortress.core.model.UserAudit#beginDate}.<BR>
- * Method also can discriminate between all events or failed only by setting {@link org.apache.directory.fortress.core.model.UserAudit#failedOnly}.
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAudit#userId} - contains the target userId</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type AuthZ. Each AuthZ object contains one authorization event.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<AuthZ> getUserAuthZs(UserAudit uAudit)
@@ -112,23 +99,7 @@ public class AuditMgrImpl extends Manageable implements AuditMgr
/**
- * This method returns a list of authorization events for a particular user {@link UserAudit#userId},
- * object {@link UserAudit#objName}, and given timestamp field {@link UserAudit#beginDate}.<BR>
- * Method also can discriminate between all events or failed only by setting flag {@link UserAudit#failedOnly}..
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId<</li>
- * <li>{@link UserAudit#objName} - contains the object (authorization resource) name</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type AuthZ. Each AuthZ object contains one authorization event.
- * @throws SecurityException if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<AuthZ> searchAuthZs(UserAudit uAudit)
@@ -142,19 +113,7 @@ public class AuditMgrImpl extends Manageable implements AuditMgr
/**
- * This method returns a list of authentication audit events for a particular user {@link UserAudit#userId},
- * and given timestamp field {@link UserAudit#beginDate}.<BR>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId<</li>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type Bind. Each Bind object contains one bind event.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<Bind> searchBinds(UserAudit uAudit)
@@ -167,21 +126,7 @@ public class AuditMgrImpl extends Manageable implements AuditMgr
}
/**
- * This method returns a list of sessions created for a given user {@link UserAudit#userId},
- * and timestamp {@link UserAudit#beginDate}.<BR>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId<</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type Mod. Each Mod object in list corresponds to one update or delete event on directory.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<Mod> searchUserSessions(UserAudit uAudit)
@@ -194,24 +139,7 @@ public class AuditMgrImpl extends Manageable implements AuditMgr
}
/**
- * This method returns a list of admin operations events for a particular entity {@link UserAudit#dn},
- * object {@link UserAudit#objName} and timestamp {@link UserAudit#beginDate}. If the internal
- * userId {@link UserAudit#internalUserId} is set it will limit search by that field.
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#dn} - contains the LDAP distinguished name for the updated object. For example if caller
- * wants to find out what changes were made to John Doe's user object this would be 'uid=jdoe,ou=People,dc=example,dc=com'</li>
- * <li>{@link UserAudit#objName} - contains the object (authorization resource) name corresponding to the event. For example if caller
- * wants to return events where User object was modified, this would be 'updateUser'</li>
- * <li>{@link UserAudit#internalUserId} - maps to the internalUserId of user who changed the record in LDAP. This maps to {@link org.apache.directory.fortress.core.model.User#internalId}.</li>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#endDate} - contains the date in which to end search</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type Mod. Each Mod object in list corresponds to one update or delete event on directory.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<Mod> searchAdminMods(UserAudit uAudit)
@@ -231,23 +159,7 @@ public class AuditMgrImpl extends Manageable implements AuditMgr
/**
- * This method returns a list of failed authentication events for a particular invalid user {@link UserAudit#userId},
- * and given timestamp {@link UserAudit#beginDate}. If the {@link UserAudit#failedOnly} is true it will
- * return only authentication attempts made with invalid userId.
- * </p>
- * This is possible because Fortress performs read on user before the bind.
- * </p>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId</li>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type AuthZ. Each AuthZ object contains one failed authentication event.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<AuthZ> searchInvalidUsers(UserAudit uAudit)
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/ConfigMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/ConfigMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/ConfigMgrImpl.java
index 4ce5710..6895477 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/ConfigMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/ConfigMgrImpl.java
@@ -43,13 +43,7 @@ public class ConfigMgrImpl implements ConfigMgr
private static final ConfigP cfgP = new ConfigP();
/**
- * Create a new cfg node with given name and properties. The name is required. If node already exists,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_ALREADY_EXISTS} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @param inProps contains {@link Properties} with list of name/value pairs to add to existing config node.
- * @return {@link Properties} containing the collection of name/value pairs just added.
- * @throws org.apache.directory.fortress.core.SecurityException in the event entry already present or other system error.
+ * {@inheritDoc}
*/
@Override
public Properties add(String name, Properties inProps) throws SecurityException
@@ -59,13 +53,7 @@ public class ConfigMgrImpl implements ConfigMgr
/**
- * Update existing cfg node with additional properties, or, replace existing properties. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @param inProps contains {@link Properties} with list of name/value pairs to add or update from existing config node.
- * @return {@link Properties} containing the collection of name/value pairs to be added to existing node.
- * @throws org.apache.directory.fortress.core.SecurityException in the event entry not present or other system error.
+ * {@inheritDoc}
*/
@Override
public Properties update(String name, Properties inProps) throws SecurityException
@@ -74,11 +62,7 @@ public class ConfigMgrImpl implements ConfigMgr
}
/**
- * Removes named cfg node from the directory. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
- *
- * @param name is required and maps to 'cn' attribute on 'device' object class of node targeted for operation.
- * @throws org.apache.directory.fortress.core.SecurityException in the event of system error.
+ * {@inheritDoc}
*/
@Override
public void delete(String name) throws SecurityException
@@ -87,11 +71,7 @@ public class ConfigMgrImpl implements ConfigMgr
}
/**
- * Delete properties from existing cfg node. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @throws org.apache.directory.fortress.core.SecurityException in the event entry not present or other system error.
+ * {@inheritDoc}
*/
@Override
public void delete(String name, Properties inProps) throws SecurityException
@@ -100,12 +80,7 @@ public class ConfigMgrImpl implements ConfigMgr
}
/**
- * Read an existing cfg node with given name and return to caller. The name is required. If node doesn't exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @return {@link Properties} containing the collection of name/value pairs just added. Maps to 'ftProps' attribute in 'ftProperties' object class.
- * @throws SecurityException in the event entry doesn't exist or other system error.
+ * {@inheritDoc}
*/
@Override
public Properties read(String name) throws SecurityException
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/DelAccessMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/DelAccessMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/DelAccessMgrImpl.java
index ddc248f..ed740c6 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/DelAccessMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/DelAccessMgrImpl.java
@@ -66,14 +66,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
private static final String SUPER_ADMIN = Config.getProperty("superadmin.role", "fortress-core-super-admin");
/**
- * This function will determine if the user contains an AdminRole that is authorized assignment control over
- * User-Role Assignment (URA). This adheres to the ARBAC02 functional specification for can-assign URA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession(org.apache.directory.fortress.core.model.User, boolean)} before passing into the method. No variables need to be set by client after returned from createSession.
- * @param user Instantiated User entity requires only valid userId attribute set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws org.apache.directory.fortress.core.SecurityException In the event of data validation error (i.e. invalid userId or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canAssign(Session session, User user, Role role)
@@ -87,14 +80,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function will determine if the user contains an AdminRole that is authorized revoke control over
- * User-Role Assignment (URA). This adheres to the ARBAC02 functional specification for can-revoke URA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @param user Instantiated User entity requires only valid userId attribute set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws SecurityException In the event of data validation error (i.e. invalid userId or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canDeassign(Session session, User user, Role role)
@@ -108,14 +94,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function will determine if the user contains an AdminRole that is authorized assignment control over
- * Permission-Role Assignment (PRA). This adheres to the ARBAC02 functional specification for can-assign-p PRA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws org.apache.directory.fortress.core.SecurityException In the event of data validation error (i.e. invalid perm or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canGrant(Session session, Role role, Permission perm)
@@ -129,14 +108,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function will determine if the user contains an AdminRole that is authorized revoke control over
- * Permission-Role Assignment (PRA). This adheres to the ARBAC02 functional specification for can-revoke-p PRA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws SecurityException In the event of data validation error (i.e. invalid perm or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canRevoke(Session session, Role role, Permission perm)
@@ -150,19 +122,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function overrides same in RBAC's AccessMgrImpl, but instead processes permissions contained within AdminPerm dataset.
- * Function returns a Boolean value containing result of a given administrator's access 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 AdminPerm OBJS data set,
- * and the operation is a member of the AdminPerms 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 object contains obj attribute which is a String and contains the name of the object user is trying to access;
- * perm object contains operation attribute which is also a String and contains the operation name for the object.
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @return True of user has access, false otherwise.
- * @throws SecurityException In the event of data validation error (i.e. invalid perm name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean checkAccess(Session session, Permission perm)
@@ -180,20 +140,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
/**
- * This function adds an adminRole 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 ADMIN ROLES data set
- * <li> the session is a valid Fortress session
- * <li> the user is authorized to that admin role
- * <li> the session is owned by that user.
- * </ul>
- * </p>
- * @param session object contains the user's returned RBAC and ARBAC sessions from the createSession method.
- * @param role object contains the adminRole name to be activated into session.
- * @throws org.apache.directory.fortress.core.SecurityException is thrown if user is not allowed to activate or runtime error occurs with system.
+ * {@inheritDoc}
*/
@Override
public void addActiveRole(Session session, UserAdminRole role)
@@ -227,14 +174,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function deactivates adminRole from the active adminRole 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 adminRole is an active adminRole of that session.
- *
- * @param session object contains the user's returned RBAC and ARBAC sessions from the createSession method.
- * @param role object contains the adminRole name to be deactivated.
- * @throws org.apache.directory.fortress.core.SecurityException is thrown if user is not allowed to deactivate or runtime error occurs with system.
+ * {@inheritDoc}
*/
@Override
public void dropActiveRole(Session session, UserAdminRole role)
@@ -259,11 +199,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function returns the active admin 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<UserAdminRole> containing all adminRoles 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<UserAdminRole> sessionAdminRoles(Session session)
@@ -274,12 +210,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function returns the authorized admin roles associated with a session based on hierarchical relationships. The function is valid if
- * and only if the session is a valid Fortress session.
- *
- * @param session object contains the user's returned ARBAC session from the createSession method.
- * @return Set<String> containing all adminRoles authorized in user's session. This will contain inherited roles.
- * @throws SecurityException is thrown if session invalid or system. error.
+ * {@inheritDoc}
*/
@Override
public Set<String> authorizedAdminRoles(Session session)
@@ -292,12 +223,7 @@ public class DelAccessMgrImpl extends AccessMgrImpl implements DelAccessMgr
}
/**
- * This function returns the ARBAC (administrative) permissions of the session, i.e., the permissions assigned
- * to its authorized admin roles. The function is valid if and only if the session is a valid Fortress session.
- *
- * @param session object contains the user's returned ARBAC session from the createSession method.
- * @return List<Permission> containing admin 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)
[3/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Posted by sm...@apache.org.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/AdminMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/AdminMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/AdminMgrRestImpl.java
index 42ebf43..9bf274b 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/AdminMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/AdminMgrRestImpl.java
@@ -79,44 +79,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command creates a new RBAC user. The command is valid only if the new user is
- * not already a member of the USERS data set. The USER data set is updated. The new user
- * does not own any session at the time of its creation.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#ou} - contains the name of an already existing User OU node</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#pwPolicy} - contains the name of an already existing OpenLDAP password policy node</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#cn} - maps to INetOrgPerson common name attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#sn} - maps to INetOrgPerson surname attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#description} - maps to INetOrgPerson description attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#title} - maps to INetOrgPerson title attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#employeeType} - maps to INetOrgPerson employeeType attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#phones} * - multi-occurring attribute maps to organizationalPerson telephoneNumber attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#mobiles} * - multi-occurring attribute maps to INetOrgPerson mobile attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#emails} * - multi-occurring attribute maps to INetOrgPerson mail attribute</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#address} * - multi-occurring attribute maps to organizationalPerson postalAddress, st, l, postalCode, postOfficeBox attributes</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#beginTime} - HHMM - determines begin hour user may activate session</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#endTime} - HHMM - determines end hour user may activate session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#beginDate} - YYYYMMDD - determines date when user may sign on</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#endDate} - YYYYMMDD - indicates latest date user may sign on</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of user may sign on</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#timeout} - number in seconds of session inactivity time allowed</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#props} * - multi-occurring attribute contains property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the name of already existing role to assign to user</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains the name of already existing adminRole to assign to user</li>
- * </ul>
- *
- * @param user User entity must contain {@link org.apache.directory.fortress.core.model.User#userId} and {@link org.apache.directory.fortress.core.model.User#ou} (required) and optional {@link org.apache.directory.fortress.core.model.User#description},{@link org.apache.directory.fortress.core.model.User#roles} and many others.
- * @return Returns entity containing user data that was added.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public User addUser( User user )
@@ -147,22 +110,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command disables an existing user in the RBAC database. The command is valid
- * if and only if the user to be disabled is a member of the USERS data set. The USERS and
- * UA data sets and the assigned_users function are updated.
- * Method performs a "soft" delete. It performs the following:
- * - sets the user status to "deleted"
- * - deassigns all roles from the user
- * - locks the user's password in LDAP
- * - revokes all perms that have been granted to user entity.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user Contains the {@link User#userId} of the User targeted for deletion.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void disableUser( User user )
@@ -187,18 +135,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command deletes an existing user from the RBAC database. The command is valid
- * if and only if the user to be deleted is a member of the USERS data set. The USERS and
- * UA data sets and the assigned_users function are updated.
- * This method performs a "hard" delete. It completely removes all data associated with this user from the directory.
- * User entity must exist in directory prior to making this call else exception will be thrown.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user Contains the {@link User#userId} of the User targeted for deletion.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteUser( User user )
@@ -223,40 +160,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This method performs an update on User entity in directory. Prior to making this call the entity must exist in
- * directory.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link User#password} - used to authenticate the User</li>
- * <li>{@link User#ou} - contains the name of an already existing User OU node</li>
- * <li>{@link User#pwPolicy} - contains the name of an already existing OpenLDAP password policy node</li>
- * <li>{@link User#cn} - maps to INetOrgPerson common name attribute</li>
- * <li>{@link User#sn} - maps to INetOrgPerson surname attribute</li>
- * <li>{@link User#description} - maps to INetOrgPerson description attribute</li>
- * <li>{@link User#phones} * - multi-occurring attribute maps to organizationalPerson telephoneNumber attribute</li>
- * <li>{@link User#mobiles} * - multi-occurring attribute maps to INetOrgPerson mobile attribute</li>
- * <li>{@link User#emails} * - multi-occurring attribute maps to INetOrgPerson mail attribute</li>
- * <li>{@link User#address} * - multi-occurring attribute maps to organizationalPerson postalAddress, st, l, postalCode, postOfficeBox attributes</li>
- * <li>{@link User#beginTime} - HHMM - determines begin hour user may activate session</li>
- * <li>{@link User#endTime} - HHMM - determines end hour user may activate session.</li>
- * <li>{@link User#beginDate} - YYYYMMDD - determines date when user may sign on</li>
- * <li>{@link User#endDate} - YYYYMMDD - indicates latest date user may sign on</li>
- * <li>{@link User#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link User#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of user may sign on</li>
- * <li>{@link User#timeout} - number in seconds of session inactivity time allowed</li>
- * <li>{@link User#props} * - multi-occurring attribute contains property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link User#roles} * - multi-occurring attribute contains the name of already existing role to assign to user</li>
- * <li>{@link User#adminRoles} * - multi-occurring attribute contains the name of already existing adminRole to assign to user</li>
- * </ul>
- *
- * @param user must contain {@link User#userId} and optional entity data to update i.e. desc, ou, properties, all attributes that are not set will be ignored.
- * @return Updated user entity data.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public User updateUser( User user )
@@ -287,19 +191,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * Method will change user's password. This method will evaluate user's password policies.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * <li>{@link User#password} - contains the User's old password</li>
- * <li>newPassword - contains the User's new password</li>
- * </ul>
- *
- * @param user contains {@link User#userId} and old user password {@link User#password}.
- * @param newPassword contains new user password.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Will be thrown in the event of password policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void changePassword( User user, char[] newPassword )
@@ -326,15 +218,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * Method will lock user's password which will prevent the user from authenticating with directory.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user entity contains {@link User#userId} of User to be locked.
- * @throws SecurityException will be thrown in the event of pw policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void lockUserAccount( User user )
@@ -359,15 +243,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * Method will unlock user's password which will enable user to authenticate with directory.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- *
- * @param user entity contains {@link org.apache.directory.fortress.core.model.User#userId} of User to be unlocked.
- * @throws SecurityException will be thrown in the event of pw policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void unlockUserAccount( User user )
@@ -392,17 +268,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * Method will reset user's password which will require user to change password before successful authentication with directory.
- * This method will not evaluate password policies on the new user password as it must be changed before use.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * <li>newPassword - contains the User's new password</li>
- * </ul>
- *
- * @param user entity contains {@link User#userId} of User to be reset.
- * @throws SecurityException will be thrown in the event of pw policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void resetPassword( User user, char[] newPassword )
@@ -429,15 +295,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * Method will delete user's password policy designation.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * <li>newPassword - contains the User's new password</li>
- * </ul>
- *
- * @param user contains {@link User#userId}.
- * @throws SecurityException will be thrown in the event of password policy violation or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePasswordPolicy( User user )
@@ -449,28 +307,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command creates a new role. The command is valid if and only if the new role is not
- * already a member of the ROLES data set. The ROLES data set is updated.
- * Initially, no user or permission is assigned to the new role.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to be created.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Role#description} - maps to description attribute on organizationalRole object class</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's RBAC session</li>
- * </ul>
- *
- * @param role must contains {@link org.apache.directory.fortress.core.model.Role#name} (required) and optional {@link org.apache.directory.fortress.core.model.Role#description}.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public Role addRole( Role role )
@@ -501,18 +338,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command deletes an existing role from the RBAC database. The command is valid
- * if and only if the role to be deleted is a member of the ROLES data set. This command will
- * also deassign role from all users.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to be deleted.</li>
- * </ul>
- *
- * @param role Contains {@link Role#name} for Role to delete.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteRole( Role role )
@@ -537,27 +363,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * Method will update a Role entity in the directory. The role must exist prior to this call.
- * <p/>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to be updated.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link Role#description} - maps to description attribute on organizationalRole object class</li>
- * <li>{@link Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session</li>
- * <li>{@link Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC session.</li>
- * <li>{@link Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
- * <li>{@link Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
- * <li>{@link Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's RBAC session</li>
- * </ul>
- *
- * @param role must contains {@link Role#name} and may contain new description or {@link org.apache.directory.fortress.core.model.Constraint}
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of validation or system error.
+ * {@inheritDoc}
*/
@Override
public Role updateRole( Role role )
@@ -588,53 +394,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command assigns a user to a role.
- * <p>
- * <ul>
- * <li> The command is valid if and only if:
- * <li> The user is a member of the USERS data set
- * <li> The role is a member of the ROLES data set
- * <li> The user is not already assigned to the role
- * <li> The SSD constraints are satisfied after assignment.
- * </ul>
- * </p>
- * <p>
- * Successful completion of this op, the following occurs:
- * </p>
- * <ul>
- * <li> User entity (resides in people container) has role assignment added to aux object class attached to actual user record.
- * <li> Role entity (resides in role container) has userId added as role occupant.
- * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:
- * <ul>
- * <li> timeout - number in seconds of session inactivity time allowed.
- * <li> beginDate - YYYYMMDD - determines date when role may be activated.
- * <li> endDate - YYMMDD - indicates latest date role may be activated.
- * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status
- * <li> endLockDate - YYMMDD - determines end of enforced inactive status.
- * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.
- * <li> endTime - HHMM - determines end hour role may be activated in user's session.*
- * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.
- * </ul>
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#name} - contains the name for already existing Role to be assigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#userId} - contains the userId for existing User</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#endTime} - HHMM - determines end hour role may be activated into user's RBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's RBAC session</li>
- * </ul>
- *
- * @param uRole must contain {@link org.apache.directory.fortress.core.model.UserRole#userId} and {@link org.apache.directory.fortress.core.model.UserRole#name} and optional {@code Constraints}.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of validation or system error.
+ * {@inheritDoc}
*/
@Override
public void assignUser( UserRole uRole )
@@ -659,22 +419,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command deletes the assignment of the User from the Role entities. The command is
- * valid if and only if the user is a member of the USERS data set, the role is a member of
- * the ROLES data set, and the user is assigned to the role.
- * Any sessions that currently have this role activated will not be effected.
- * Successful completion includes:
- * User entity in USER data set has role assignment removed.
- * Role entity in ROLE data set has userId removed as role occupant.
- * (optional) Temporal constraints will be removed from user aux object if set prior to call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link UserRole#name} - contains the name for already existing Role to be deassigned</li>
- * <li>{@link UserRole#userId} - contains the userId for existing User</li>
- * </ul>
- *
- * @param uRole must contain {@link UserRole#userId} and {@link UserRole#name}.
- * @throws SecurityException - in the event data error in user or role objects or system error.
+ * {@inheritDoc}
*/
@Override
public void deassignUser( UserRole uRole )
@@ -699,25 +444,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This method will add permission operation to an existing permission object which resides under {@code ou=Permissions,ou=RBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may have {@link org.apache.directory.fortress.core.model.Role} or {@link org.apache.directory.fortress.core.model.User} associations. The target {@link org.apache.directory.fortress.core.model.Permission} must not exist prior to calling.
- * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission add</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission operation being added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target along with optional other attributes..
- * @return copy of Permission entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission addPermission( Permission perm )
@@ -748,26 +475,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This method will update permission operation pre-existing in target directory under {@code ou=Permissions,ou=RBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may also contain {@link org.apache.directory.fortress.core.model.Role} or {@link org.apache.directory.fortress.core.model.User} associations to add or remove using this function.
- * The perm operation must exist before making this call. Only non-null attributes will be updated.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted for the permission update</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target and any optional data to update. Null or empty attributes will be ignored.
- * @return copy of permOp entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission updatePermission( Permission perm )
@@ -798,17 +506,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This method will remove permission operation entity from permission object. A Fortress permission is (object->operation).
- * The perm operation must exist before making this call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted for the permission delete</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation being removed</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermission( Permission perm )
@@ -833,23 +531,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This method will add permission object to perms container in directory. The perm object must not exist before making this call.
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object being added</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} and {@link org.apache.directory.fortress.core.model.PermObj#ou}. The other attributes are optional.
- * @return copy of permObj entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj addPermObj( PermObj pObj )
@@ -880,24 +562,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This method will update permission object in perms container in directory. The perm object must exist before making this call.
- * A {@link PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link PermObj}*->{@link Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * <li>{@link PermObj#description} - any safe text</li>
- * <li>{@link PermObj#type} - contains any safe text</li>
- * <li>{@link PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link PermObj#objName}. Only non-null attributes will be updated.
- * @return copy of newly updated permObj entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj updatePermObj( PermObj pObj )
@@ -928,15 +593,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This method will remove permission object to perms container in directory. This method will also remove
- * in associated permission objects that are attached to this object.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object targeted for removal</li>
- * </ul>
- *
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} of object targeted for removal.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermObj( PermObj pObj )
@@ -961,22 +618,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command grants a role the permission to perform an operation on an object to a role.
- * The command is implemented by granting permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * and the role is a member of the ROLES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link Role#name} - contains the role name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @param role must contains {@link Role#name}.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission( Permission perm, Role role )
@@ -1008,21 +650,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command revokes the permission to perform an operation on an object from the set
- * of permissions assigned to a role. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * the role is a member of the ROLES data set, and the permission is assigned to that role.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link Role#name} - contains the role name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @param role must contains {@link Role#name}.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission( Permission perm, Role role )
@@ -1054,22 +682,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command grants a user the permission to perform an operation on an object to a role.
- * The command is implemented by granting permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * and the user is a member of the USERS data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @param user must contain {@link User#userId} of target User entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission( Permission perm, User user )
@@ -1101,21 +714,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command revokes the permission to perform an operation on an object from the set
- * of permissions assigned to a user. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * the user is a member of the USERS data set, and the permission is assigned to that user.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @param user must contain {@link User#userId} of target User entity.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission( Permission perm, User user )
@@ -1147,32 +746,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command creates a new role childRole, and inserts it in the role hierarchy as an immediate descendant of
- * the existing role parentRole. The command is valid if and only if childRole is not a member of the ROLES data set,
- * and parentRole is a member of the ROLES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link Role#name} - contains the name of existing Role to be parent</li>
- * <li>childRole - {@link Role#name} - contains the name of new Role to be child</li>
- * </ul>
- * <h4>optional parameters childRole</h4>
- * <ul>
- * <li>childRole - {@link Role#description} - maps to description attribute on organizationalRole object class for new child</li>
- * <li>childRole - {@link Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session for new child</li>
- * <li>childRole - {@link Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC session for new child</li>
- * <li>childRole - {@link Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session for new child</li>
- * <li>childRole - {@link Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session for new child</li>
- * <li>childRole - {@link Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new child</li>
- * <li>childRole - {@link Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new child</li>
- * <li>childRole - {@link Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new child</li>
- * </ul>
- *
- * @param parentRole This entity must be present in ROLE data set. Success will add role rel with childRole.
- * @param childRole This entity must not be present in ROLE data set. Success will add the new role entity to ROLE data set.
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new childRole and pre-existing parentRole.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addDescendant( Role parentRole, Role childRole )
@@ -1201,32 +775,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command creates a new role parentRole, and inserts it in the role hierarchy as an immediate ascendant of
- * the existing role childRole. The command is valid if and only if parentRole is not a member of the ROLES data set,
- * and childRole is a member of the ROLES data set.
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new parentRole and pre-existing childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>childRole - {@link Role#name} - contains the name of existing child Role</li>
- * <li>parentRole - {@link Role#name} - contains the name of new Role to be parent</li>
- * </ul>
- * <h4>optional parameters parentRole</h4>
- * <ul>
- * <li>parentRole - {@link Role#description} - maps to description attribute on organizationalRole object class for new parent</li>
- * <li>parentRole - {@link Role#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session for new parent</li>
- * <li>parentRole - {@link Role#endTime} - HHMM - determines end hour role may be activated into user's RBAC session for new parent</li>
- * <li>parentRole - {@link Role#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session for new parent</li>
- * <li>parentRole - {@link Role#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session for new parent</li>
- * <li>parentRole - {@link Role#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new parent</li>
- * <li>parentRole - {@link Role#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new parent</li>
- * <li>parentRole - {@link Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new parent</li>
- * </ul>
- *
- * @param parentRole completion of op assigns new child relationship with childRole.
- * @param childRole completion of op assigns new parent relationship with parentRole.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addAscendant( Role childRole, Role parentRole )
@@ -1255,20 +804,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
- * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the ROLES data
- * set, parentRole is not an immediate ascendant of childRole, and childRole does not properly inherit parentRole (in order to
- * avoid cycle creation).
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link Role#name} - contains the name of existing Role to be parent</li>
- * <li>childRole - {@link Role#name} - contains the name of existing Role to be child</li>
- * </ul>
- *
- * @param parentRole completion of op deassigns child relationship with childRole.
- * @param childRole completion of op deassigns parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addInheritance( Role parentRole, Role childRole )
@@ -1297,19 +833,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command deletes an existing immediate inheritance relationship parentRole <<-- childRole. The command is
- * valid if and only if the roles parentRole and childRole are members of the ROLES data set, and parentRole is an
- * immediate ascendant of childRole. The new inheritance relation is computed as the reflexive-transitive
- * closure of the immediate inheritance relation resulted after deleting the relationship parentRole <<-- childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link Role#name} - contains the name of existing Role to remove parent relationship</li>
- * <li>childRole - {@link Role#name} - contains the name of existing Role to remove child relationship</li>
- * </ul>
- *
- * @param parentRole completion of op removes child relationship with childRole.
- * @param childRole completion of op removes parent relationship with parentRole.
- * @throws SecurityException thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteInheritance( Role parentRole, Role childRole )
@@ -1338,27 +862,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command creates a named SSD set of roles and sets the cardinality n of its subsets
- * that cannot have common users. The command is valid if and only if:
- * 1 - the name of the SSD set is not already in use
- * 2 - all the roles in the SSD set are members of the ROLES data set
- * 3 - n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the SSD role set,
- * 4 - the SSD constraint for the new role set is satisfied.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of new SSD role set to be added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be assigned to User from a particular set</li>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing, name, members, and cardinality (default 2)
- * @return reference to newly created SSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet createSsdSet( SDSet ssdSet )
@@ -1389,30 +893,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command updates existing SSD set of roles and sets the cardinality n of its subsets
- * that cannot have common users.
- * <p>
- * The command is valid if and only if:
- * <ul>
- * <li>The name of the SSD set already exists.
- * <li> All the roles in the SSD set are members of the ROLES data set.
- * <li> n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the SSD role set.
- * <li> The SSD constraint for the new role set is satisfied.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of existing SSD role set to be updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be assigned to User from a particular set</li>
- * <li>{@link SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to existing SSD set containing, name, members, and cardinality (default 2)
- * @return reference to SSDSet object targeted for update.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
public SDSet updateSsdSet( SDSet ssdSet )
throws SecurityException
@@ -1442,21 +923,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command adds a role to a named SSD set of roles. The cardinality associated with the role set remains unchanged.
- * The command is valid if and only if:
- * 1 - the SSD role set exists, and
- * 2 - the role to be added is a member of the ROLES data set but not of a member of the SSD role set, and
- * 3 - the SSD constraint is satisfied after the addition of the role to the SSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of new {@link SDSet#members} to be added</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing name.
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet addSsdRoleMember( SDSet ssdSet, Role role )
@@ -1489,22 +956,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command removes a role from a named SSD set of roles. The cardinality associated with the role set remains unchanged.
- * The command is valid if and only if:
- * 1 - the SSD role set exists, and
- * 2 - the role to be removed is a member of the SSD role set, and
- * 3 - the cardinality associated with the SSD role set is less than the number of elements of the SSD role set.
- * Note that the SSD constraint should be satisfied after the removal of the role from the SSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of existing {@link SDSet#members} to be removed</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing name.
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteSsdRoleMember( SDSet ssdSet, Role role )
@@ -1537,15 +989,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command deletes a SSD role set completely. The command is valid if and only if the SSD role set exists.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of new SSD role set to be removed</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to SSD set targeted for removal.
- * @return reference to deleted SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteSsdSet( SDSet ssdSet )
@@ -1576,20 +1020,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command sets the cardinality associated with a given SSD role set. The command is valid if and only if:
- * 1 - the SSD role set exists, and
- * 2 - the new cardinality is a natural number greater than or equal to 2 and less than or equal to the number of elements of the SSD role set, and
- * 3 - the SSD constraint is satisfied after setting the new cardinality.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
- * <li>cardinality - contains new cardinality setting for SSD</li>
- * </ul>
- *
- * @param ssdSet contains an instantiated reference to new SSD set containing name.
- * @param cardinality integer value contains new cardinality value for data set.
- * @return reference to updated SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet setSsdSetCardinality( SDSet ssdSet, int cardinality )
@@ -1621,27 +1052,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command creates a named DSD set of roles and sets an associated cardinality n.
- * The DSD constraint stipulates that the DSD role set cannot contain n or more roles
- * simultaneously active in the same session. The command is valid if and only if:
- * 1 - the name of the DSD set is not already in use
- * 2 - all the roles in the DSD set are members of the ROLES data set
- * 3 - n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the DSD role set,
- * 4 - the DSD constraint for the new role set is satisfied.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of new DSD role set to be added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be assigned to User from a particular set</li>
- * <li>{@link SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing, name, members, and cardinality (default 2)
- * @return reference to newly created SSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet createDsdSet( SDSet dsdSet )
@@ -1672,30 +1083,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command updates existing DSD set of roles and sets the cardinality n of its subsets
- * that cannot have common users.
- * <p>
- * The command is valid if and only if:
- * <ul>
- * <li>The name of the DSD set already exists.
- * <li> All the roles in the DSD set are members of the ROLES data set.
- * <li> n is a natural number greater than or equal to 2 and less than or equal to the cardinality of the DSD role set.
- * <li> The DSD constraint for the new role set is satisfied.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of existing DSD role set to be updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link SDSet#members} * - multi-occurring attribute contains the RBAC Role names to be added to this set</li>
- * <li>{@link SDSet#cardinality} - default is 2 which is one more than maximum number of Roles that may be assigned to User from a particular set</li>
- * <li>{@link SDSet#description} - contains any safe text</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to existing DSD set containing, name, members, and cardinality (default 2)
- * @return reference to DSDSet object targeted for update.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
public SDSet updateDsdSet( SDSet dsdSet )
throws SecurityException
@@ -1725,22 +1113,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command adds a role to a named DSD set of roles. The cardinality associated with
- * the role set remains unchanged. The command is valid if and only if:
- * 1 - the DSD role set exists, and
- * 2 - the role to be added is a member of the ROLES data set but not of a member of the DSD role set, and
- * 3 - the DSD constraint is satisfied after the addition of the role to the SSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of new {@link SDSet#members} to be added</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing name.
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated DSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet addDsdRoleMember( SDSet dsdSet, Role role )
@@ -1773,22 +1146,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command removes a role from a named DSD set of roles. The cardinality associated
- * with the role set remains unchanged. The command is valid if and only if:
- * 1 - the DSD role set exists, and
- * 2 - the role to be removed is a member of the DSD role set, and
- * 3 - the cardinality associated with the DSD role set is less than the number of elements of the DSD role set.
- * Note that the DSD constraint should be satisfied after the removal of the role from the DSD role set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be modified</li>
- * <li>{@link Role#name} - contains the name of existing {@link SDSet#members} to be removed</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing name.
- * @param role contains instantiated Role object with role name field set.
- * @return reference to updated DSDSet object.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteDsdRoleMember( SDSet dsdSet, Role role )
@@ -1821,16 +1179,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command deletes a DSD role set completely. The command is valid if and only if the DSD role set exists.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of new DSD role set to be removed</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing, name
- * @return reference to deleted DSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet deleteDsdSet( SDSet dsdSet )
@@ -1861,21 +1210,7 @@ public final class AdminMgrRestImpl extends Manageable implements AdminMgr
/**
- * This command sets the cardinality associated with a given DSD role set. The command is valid if and only if:
- * 1 - the SSD role set exists, and
- * 2 - the new cardinality is a natural number greater than or equal to 2 and less than or equal to the number of elements of the SSD role set, and
- * 3 - the SSD constraint is satisfied after setting the new cardinality.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be modified</li>
- * <li>cardinality - contains new cardinality setting for SSD</li>
- * </ul>
- *
- * @param dsdSet contains an instantiated reference to new DSD set containing, name
- * @param cardinality integer value contains new cardinality value for data set.
- * @return reference to updated DSDSet object.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public SDSet setDsdSetCardinality( SDSet dsdSet, int cardinality )
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
index 0e86603..bc1cde6 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
@@ -84,20 +84,7 @@ public class AuditMgrRestImpl extends Manageable implements AuditMgr
private static final String CLS_NM = AuditMgrRestImpl.class.getName();
/**
- * This method returns a list of authorization events for a particular user {@link org.apache.directory.fortress.core.model.UserAudit#userId}
- * and given timestamp field {@link org.apache.directory.fortress.core.model.UserAudit#beginDate}.<BR>
- * Method also can discriminate between all events or failed only by setting {@link org.apache.directory.fortress.core.model.UserAudit#failedOnly}.
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId</li>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type AuthZ. Each AuthZ object contains one authorization event.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<AuthZ> getUserAuthZs(UserAudit uAudit)
@@ -133,23 +120,7 @@ public class AuditMgrRestImpl extends Manageable implements AuditMgr
/**
- * This method returns a list of authorization events for a particular user {@link org.apache.directory.fortress.core.model.UserAudit#userId},
- * object {@link org.apache.directory.fortress.core.model.UserAudit#objName}, and given timestamp field {@link org.apache.directory.fortress.core.model.UserAudit#beginDate}.<BR>
- * Method also can discriminate between all events or failed only by setting flag {@link org.apache.directory.fortress.core.model.UserAudit#failedOnly}..
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId<</li>
- * <li>{@link UserAudit#objName} - contains the object (authorization resource) name</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type AuthZ. Each AuthZ object contains one authorization event.
- * @throws SecurityException if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<AuthZ> searchAuthZs(UserAudit uAudit)
@@ -185,19 +156,7 @@ public class AuditMgrRestImpl extends Manageable implements AuditMgr
/**
- * This method returns a list of authentication audit events for a particular user {@link org.apache.directory.fortress.core.model.UserAudit#userId},
- * and given timestamp field {@link org.apache.directory.fortress.core.model.UserAudit#beginDate}.<BR>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId<</li>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type Bind. Each Bind object contains one bind event.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<Bind> searchBinds(UserAudit uAudit)
@@ -231,22 +190,9 @@ public class AuditMgrRestImpl extends Manageable implements AuditMgr
return outRecords;
}
+
/**
- * This method returns a list of sessions created for a given user {@link org.apache.directory.fortress.core.model.UserAudit#userId},
- * and timestamp {@link org.apache.directory.fortress.core.model.UserAudit#beginDate}.<BR>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId<</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type Mod. Each Mod object in list corresponds to one update or delete event on directory.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<Mod> searchUserSessions(UserAudit uAudit)
@@ -280,25 +226,9 @@ public class AuditMgrRestImpl extends Manageable implements AuditMgr
return outRecords;
}
+
/**
- * This method returns a list of admin operations events for a particular entity {@link org.apache.directory.fortress.core.model.UserAudit#dn},
- * object {@link org.apache.directory.fortress.core.model.UserAudit#objName} and timestamp {@link org.apache.directory.fortress.core.model.UserAudit#beginDate}. If the internal
- * userId {@link org.apache.directory.fortress.core.model.UserAudit#internalUserId} is set it will limit search by that field.
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#dn} - contains the LDAP distinguished name for the updated object. For example if caller
- * wants to find out what changes were made to John Doe's user object this would be 'uid=jdoe,ou=People,dc=example,dc=com'</li>
- * <li>{@link UserAudit#objName} - contains the object (authorization resource) name corresponding to the event. For example if caller
- * wants to return events where User object was modified, this would be 'updateUser'</li>
- * <li>{@link UserAudit#internalUserId} - maps to the internalUserId of user who changed the record in LDAP. This maps to {@link org.apache.directory.fortress.core.model.User#internalId}.</li>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#endDate} - contains the date in which to end search</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type Mod. Each Mod object in list corresponds to one update or delete event on directory.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<Mod> searchAdminMods(UserAudit uAudit)
@@ -334,23 +264,7 @@ public class AuditMgrRestImpl extends Manageable implements AuditMgr
/**
- * This method returns a list of failed authentication events for a particular invalid user {@link org.apache.directory.fortress.core.model.UserAudit#userId},
- * and given timestamp {@link org.apache.directory.fortress.core.model.UserAudit#beginDate}. If the {@link org.apache.directory.fortress.core.model.UserAudit#failedOnly} is true it will
- * return only authentication attempts made with invalid userId.
- * </p>
- * This is possible because Fortress performs read on user before the bind.
- * </p>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link UserAudit#userId} - contains the target userId</li>
- * <li>{@link UserAudit#beginDate} - contains the date in which to begin search</li>
- * <li>{@link UserAudit#failedOnly} - if set to 'true', return only failed authorization events</li>
- * </ul>
- *
- * @param uAudit This entity is instantiated and populated before invocation.
- * @return a List of objects of type AuthZ. Each AuthZ object contains one failed authentication event.
- * @throws org.apache.directory.fortress.core.SecurityException
- * if a runtime system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<AuthZ> searchInvalidUsers(UserAudit uAudit)
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/ConfigMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/ConfigMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/ConfigMgrRestImpl.java
index d1a0b79..82fb742 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/ConfigMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/ConfigMgrRestImpl.java
@@ -46,15 +46,9 @@ public class ConfigMgrRestImpl implements ConfigMgr
{
private static final String CLS_NM = ConfigMgrRestImpl.class.getName();
+
/**
- * Create a new cfg node with given name and properties. The name is required. If node already exists,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_ALREADY_EXISTS} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @param inProperties contains {@link Properties} with list of name/value pairs to add to existing config node.
- * @return {@link java.util.Properties} containing the collection of name/value pairs just added.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event entry already present or other system error.
+ * {@inheritDoc}
*/
@Override
public Properties add(String name, Properties inProperties) throws SecurityException
@@ -81,15 +75,9 @@ public class ConfigMgrRestImpl implements ConfigMgr
return retProperties;
}
+
/**
- * Update existing cfg node with additional properties, or, replace existing properties. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @param inProperties contains {@link Properties} with list of name/value pairs to add or udpate from existing config node.
- * @return {@link Properties} containing the collection of name/value pairs to be added to existing node.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event entry not present or other system error.
+ * {@inheritDoc}
*/
@Override
public Properties update(String name, Properties inProperties) throws SecurityException
@@ -116,17 +104,9 @@ public class ConfigMgrRestImpl implements ConfigMgr
return retProperties;
}
+
/**
- * Completely removes named cfg node from the directory.
- * <p/>
- * <font size="3" color="red">This method is destructive and will remove the cfg node completely from directory.<BR>
- * Care should be taken during execution to ensure target name is correct and permanent removal of all parameters located
- * there is intended. There is no 'undo' for this operation.
- * </font>
- *
- * @param name is required and maps to 'cn' attribute on 'device' object class of node targeted for operation.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of system error.
+ * {@inheritDoc}
*/
@Override
public void delete(String name) throws SecurityException
@@ -143,12 +123,9 @@ public class ConfigMgrRestImpl implements ConfigMgr
}
}
+
/**
- * Delete properties from existing cfg node. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @throws org.apache.directory.fortress.core.SecurityException in the event entry not present or other system error.
+ * {@inheritDoc}
*/
@Override
public void delete(String name, Properties inProperties) throws SecurityException
@@ -168,13 +145,9 @@ public class ConfigMgrRestImpl implements ConfigMgr
}
}
+
/**
- * Read an existing cfg node with given name and return to caller. The name is required. If node doesn't exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
- *
- * @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @return {@link Properties} containing the collection of name/value pairs just added. Maps to 'ftProps' attribute in 'ftProperties' object class.
- * @throws SecurityException in the event entry doesn't exist or other system error.
+ * {@inheritDoc}
*/
@Override
public Properties read(String name) throws SecurityException
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/DelAccessMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/DelAccessMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/DelAccessMgrRestImpl.java
index 22da01a..f8d2907 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/DelAccessMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/DelAccessMgrRestImpl.java
@@ -62,15 +62,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
{
private static final String CLS_NM = DelAccessMgrRestImpl.class.getName();
+
/**
- * This function will determine if the user contains an AdminRole that is authorized assignment control over
- * User-Role Assignment (URA). This adheres to the ARBAC02 functional specification for can-assign URA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession(org.apache.directory.fortress.core.model.User, boolean)} before passing into the method. No variables need to be set by client after returned from createSession.
- * @param user Instantiated User entity requires only valid userId attribute set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws org.apache.directory.fortress.core.SecurityException In the event of data validation error (i.e. invalid userId or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canAssign(Session session, User user, Role role)
@@ -102,15 +96,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
return result;
}
+
/**
- * This function will determine if the user contains an AdminRole that is authorized revoke control over
- * User-Role Assignment (URA). This adheres to the ARBAC02 functional specification for can-revoke URA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @param user Instantiated User entity requires only valid userId attribute set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws SecurityException In the event of data validation error (i.e. invalid userId or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canDeassign(Session session, User user, Role role)
@@ -142,15 +130,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
return result;
}
+
/**
- * This function will determine if the user contains an AdminRole that is authorized assignment control over
- * Permission-Role Assignment (PRA). This adheres to the ARBAC02 functional specification for can-assign-p PRA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws org.apache.directory.fortress.core.SecurityException In the event of data validation error (i.e. invalid perm or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canGrant(Session session, Role role, Permission perm)
@@ -184,15 +166,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
return result;
}
+
/**
- * This function will determine if the user contains an AdminRole that is authorized revoke control over
- * Permission-Role Assignment (PRA). This adheres to the ARBAC02 functional specification for can-revoke-p PRA.
- *
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
- * @param role Instantiated Role entity requires only valid role name attribute set.
- * @return boolean value true indicates access allowed.
- * @throws SecurityException In the event of data validation error (i.e. invalid perm or role name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean canRevoke(Session session, Role role, Permission perm)
@@ -226,20 +202,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
return result;
}
+
/**
- * This function overrides same in RBAC's AccessMgrImpl, but instead processes permissions contained within AdminPerm dataset.
- * Function returns a Boolean value containing result of a given administrator's access 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 AdminPerm OBJS data set,
- * and the operation is a member of the AdminPerms 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 object contains obj attribute which is a String and contains the name of the object user is trying to access;
- * perm object contains operation attribute which is also a String and contains the operation name for the object.
- * @param session This object must be instantiated by calling {@link org.apache.directory.fortress.core.AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
- * @return True of user has access, false otherwise.
- * @throws SecurityException In the event of data validation error (i.e. invalid perm name) or system error.
+ * {@inheritDoc}
*/
@Override
public boolean checkAccess(Session session, Permission perm)
@@ -273,20 +238,7 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
/**
- * This function adds an adminRole 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 ADMIN ROLES data set
- * <li> the session is a valid Fortress session
- * <li> the user is authorized to that admin role
- * <li> the session is owned by that user.
- * </ul>
- * </p>
- * @param session object contains the user's returned RBAC and ARBAC sessions from the createSession method.
- * @param role object contains the adminRole name to be activated into session.
- * @throws org.apache.directory.fortress.core.SecurityException is thrown if user is not allowed to activate or runtime error occurs with system.
+ * {@inheritDoc}
*/
@Override
public void addActiveRole(Session session, UserAdminRole role)
@@ -313,15 +265,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
}
}
+
/**
- * This function deactivates adminRole from the active adminRole 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 adminRole is an active adminRole of that session.
- *
- * @param session object contains the user's returned RBAC and ARBAC sessions from the createSession method.
- * @param role object contains the adminRole name to be deactivated.
- * @throws org.apache.directory.fortress.core.SecurityException is thrown if user is not allowed to deactivate or runtime error occurs with system.
+ * {@inheritDoc}
*/
@Override
public void dropActiveRole(Session session, UserAdminRole role)
@@ -348,12 +294,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
}
}
+
/**
- * This function returns the active admin 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<UserAdminRole> containing all adminRoles 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<UserAdminRole> sessionAdminRoles(Session session)
@@ -380,13 +323,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
return roles;
}
+
/**
- * This function returns the authorized admin roles associated with a session based on hierarchical relationships. The function is valid if
- * and only if the session is a valid Fortress session.
- *
- * @param session object contains the user's returned ARBAC session from the createSession method.
- * @return Set<String> containing all adminRoles authorized in user's session. This will contain inherited roles.
- * @throws SecurityException is thrown if session invalid or system. error.
+ * {@inheritDoc}
*/
@Override
public Set<String> authorizedAdminRoles(Session session)
@@ -416,13 +355,9 @@ public class DelAccessMgrRestImpl extends AccessMgrRestImpl implements DelAccess
//throw new java.lang.UnsupportedOperationException();
}
+
/**
- * This function returns the ARBAC (administrative) permissions of the session, i.e., the permissions assigned
- * to its authorized admin roles. The function is valid if and only if the session is a valid Fortress session.
- *
- * @param session object contains the user's returned ARBAC session from the createSession method.
- * @return List<Permission> containing admin 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)
[2/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Posted by sm...@apache.org.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/DelAdminMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/DelAdminMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/DelAdminMgrRestImpl.java
index 5be7d81..6027311 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/DelAdminMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/DelAdminMgrRestImpl.java
@@ -57,37 +57,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
{
private static final String CLS_NM = DelAdminMgrRestImpl.class.getName();
+
/**
- * This command creates a new admin role. The command is valid if and only if the new admin role is not
- * already a member of the ADMIN ROLES data set. The ADMIN ROLES data set is updated.
- * Initially, no user or permission is assigned to the new role.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole being targeted for addition to LDAP</li>
- * </ul>
- * <p/>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#description} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
- *
- * @param role Contains role name and description.
- * @return Override contains reference to entity added.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public AdminRole addRole(AdminRole role)
@@ -116,19 +88,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
return retRole;
}
+
/**
- * This command deletes an existing admin role from the ARBAC database. The command is valid
- * if and only if the role to be deleted is a member of the ADMIN ROLES data set. This command will
- * also deassign role from all users.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole being targeted for removal</li>
- * </ul>
- * <p/>
- *
- * @param role Contains role name.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteRole(AdminRole role)
@@ -151,35 +113,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * Method will update an AdminRole entity in the directory. The role must exist in directory prior to this call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for updating</li>
- * </ul>
- * <p/>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#description} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
- *
- * @param role Contains role name and new description.
- * @return Override contains reference to entity updated.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Description of the Exception
+ * {@inheritDoc}
*/
@Override
public AdminRole updateRole(AdminRole role)
@@ -210,42 +146,7 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
/**
- * This command assigns a user to an admin role.
- * Successful completion of this op, the following occurs:
- * </p>
- * <ul>
- * <li> User entity (resides in people container) has role assignment added to aux object class attached to actual user record.
- * <li> AdminRole entity (resides in admin role container) has userId added as role occupant.
- * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:
- * <ul>
- * <li> timeout - number in seconds of session inactivity time allowed.
- * <li> beginDate - YYYYMMDD - determines date when role may be activated.
- * <li> endDate - YYMMDD - indicates latest date role may be activated.
- * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status
- * <li> endLockDate - YYMMDD - determines end of enforced inactive status.
- * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.
- * <li> endTime - HHMM - determines end hour role may be activated in user's session.*
- * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.
- * </ul>
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing AdminRole to be assigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginTime} - HHMM - determines begin hour AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endTime} - HHMM - determines end hour AdminRole may be activated into user's RBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginDate} - YYYYMMDD - determines date when AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endDate} - YYYYMMDD - indicates latest date AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
- *
- * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and {@link AdminRole#name} and optional {@code Constraints}.
- * @throws SecurityException in the event data error in user or role objects or system error.
+ * {@inheritDoc}
*/
@Override
public void assignUser(UserAdminRole uAdminRole)
@@ -270,20 +171,7 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
/**
- * This method removes assigned admin role from user entity. Both user and admin role entities must exist and have role relationship
- * before calling this method.
- * Successful completion:
- * del Role to User assignment in User data set
- * AND
- * User to Role assignment in Admin Role data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing AdminRole to be deassigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User</li>
- * </ul>
- *
- * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and {@link AdminRole#name}.
- * @throws SecurityException - in the event data error in user or role objects or system error.
+ * {@inheritDoc}
*/
@Override
public void deassignUser(UserAdminRole uAdminRole)
@@ -308,22 +196,7 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
/**
- * Commands adds a new OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be added</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#description} - contains any safe text</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit contains reference to entity added.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit add(OrgUnit entity)
@@ -352,23 +225,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
return retOrg;
}
+
/**
- * Commands updates existing OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be updated</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link OrgUnit#description} - contains any safe text</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit contains reference to entity updated.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit update(OrgUnit entity)
@@ -397,18 +256,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
return retOrg;
}
+
/**
- * Commands deletes existing OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be removed</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit contains reference to entity removed.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit delete(OrgUnit entity)
@@ -439,35 +289,7 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
/**
- * This command creates a new orgunit child, and inserts it in the orgunit hierarchy as an immediate descendant of
- * the existing orgunit parent.
- * <p>
- * The command is valid if and only if:
- * <ul>
- * <li> The child orgunit is not a member of the ORGUNITS data set.
- * <li> The parent orgunit is a member of the ORGUNITS data set.
- * </ul>
- * </p>
- * <p> This method:
- * <ul>
- * <li> Adds new orgunit.
- * <li> Assigns orgunit relationship between new child and pre-existing parent.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be child</li>
- * </ul>
- * <h4>optional parameters child</h4>
- * <ul>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#description} - maps to description attribute on organizationalUnit object class for new child</li>
- * </ul>
- *
- * @param parent This entity must be present in ORGUNIT data set. Success will add rel with child.
- * @param child This entity must not be present in ORGUNIT data set. Success will add the new entity to ORGUNIT data set.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addDescendant(OrgUnit parent, OrgUnit child)
@@ -498,35 +320,7 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
/**
- * This command creates a new orgunit parent, and inserts it in the orgunit hierarchy as an immediate ascendant of
- * the existing child orgunit.
- * <p>
- * The command is valid if and only if:
- * <ul>
- * <li> The parent is not a member of the ORGUNITS data set.
- * <li> The child is a member of the ORGUNITS data set.
- * </ul>
- * </p>
- * <p> This method:
- * <ul>
- * <li> Adds new orgunit.
- * <li> Assigns orgunit relationship between new parent and pre-existing child.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be child</li>
- * </ul>
- * <h4>optional parameters child</h4>
- * <ul>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#description} - maps to description attribute on organizationalUnit object class for new child</li>
- * </ul>
- *
- * @param parent completion of op assigns new child relationship with child orgunit.
- * @param child completion of op assigns new parent relationship with parent orgunit.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addAscendant(OrgUnit child, OrgUnit parent)
@@ -554,26 +348,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command establishes a new immediate inheritance relationship with parent orgunit <<-- child orgunit
- * <p/>
- * The command is valid if and only if:
- * <ul>
- * <li> The parent and child are members of the ORGUNITS data set.
- * <li> The parent is not an immediate ascendant of child.
- * <li> The child does not properly inherit parent (in order to avoid cycle creation).
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be child</li>
- * </ul>
- *
- * @param parent completion of op deassigns child relationship with child orgunit.
- * @param child completion of op deassigns parent relationship with parent orgunit.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addInheritance(OrgUnit parent, OrgUnit child)
@@ -602,27 +379,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command deletes an existing immediate inheritance relationship parent <<-- child.
- * <p/>
- * The command is valid if and only if:
- * <ul>
- * <li> The orgunits parent and child are members of the ORGUNITS data set.
- * <li> The parent is an immediate ascendant of child.
- * <li> The new inheritance relation is computed as the reflexive-transitive closure of the immediate inheritance
- * relation resulted after deleting the relationship parent <<-- child.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to remove as parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to remove as child</li>
- * </ul>
- *
- * @param parent completion of op removes child relationship with childRole.
- * @param child completion of op removes parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteInheritance(OrgUnit parent, OrgUnit child)
@@ -653,34 +412,7 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
/**
- * This command creates a new role childRole, and inserts it in the role hierarchy as an immediate descendant of
- * the existing role parentRole. The command is valid if and only if childRole is not a member of the ADMINROLES data set,
- * and parentRole is a member of the ADMINROLES data set.
- * <p/>
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new childRole and pre-existing parentRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing Role to be parent</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of new Role to be child</li>
- * </ul>
- * <h4>optional parameters childRole</h4>
- * <ul>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#description} - maps to description attribute on organizationalRole object class for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's session for new child</li>
- * </ul>
- *
- * @param parentRole This entity must be present in ADMINROLES data set. Success will add role rel with childRole.
- * @param childRole This entity must not be present in ADMINROLES data set. Success will add the new role entity to ADMINROLES data set.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addDescendant(AdminRole parentRole, AdminRole childRole)
@@ -708,34 +440,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command creates a new role parentRole, and inserts it in the role hierarchy as an immediate ascendant of
- * the existing role childRole. The command is valid if and only if parentRole is not a member of the ROLES data set,
- * and childRole is a member of the ROLES data set.
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new parentRole and pre-existing childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing Role to be child</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of new Role to be added as parent</li>
- * </ul>
- * <h4>optional parameters parentRole</h4>
- * <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#description} - maps to description attribute on organizationalRole object class for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's session for new parent</li>
- * </ul>
- *
- * @param parentRole completion of op assigns new child relationship with childRole.
- * @param childRole completion of op assigns new parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addAscendant(AdminRole childRole, AdminRole parentRole)
@@ -763,21 +470,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
- * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the ROLES data
- * set, parentRole is not an immediate ascendant of childRole, and childRole does not properly inherit parentRole (in order to
- * avoid cycle creation).
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to be parent</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to be child</li>
- * </ul>
- *
- * @param parentRole completion of op deassigns child relationship with childRole.
- * @param childRole completion of op deassigns parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addInheritance(AdminRole parentRole, AdminRole childRole)
@@ -805,21 +500,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command deletes an existing immediate inheritance relationship parentRole <<-- childRole. The command is
- * valid if and only if the roles parentRole and childRole are members of the ROLES data set, and parentRole is an
- * immediate ascendant of childRole. The new inheritance relation is computed as the reflexive-transitive
- * closure of the immediate inheritance relation resulted after deleting the relationship parentRole <<-- childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to remove as parent</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to remove as child</li>
- * </ul>
- *
- * @param parentRole completion of op removes child relationship with childRole.
- * @param childRole completion of op removes parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteInheritance(AdminRole parentRole, AdminRole childRole)
@@ -847,26 +530,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This method will add an administrative permission operation to an existing permission object which resides under {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may have {@link org.apache.directory.fortress.core.model.AdminRole} or {@link org.apache.directory.fortress.core.model.User} associations. The target {@link org.apache.directory.fortress.core.model.Permission} must not exist prior to calling.
- * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission add</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission operation being added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target along with optional other attributes..
- * @return copy of Permission entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission addPermission(Permission perm)
@@ -896,27 +562,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
return retPerm;
}
+
/**
- * This method will update administrative permission operation pre-existing in target directory under {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may also contain {@link org.apache.directory.fortress.core.model.AdminRole} or {@link org.apache.directory.fortress.core.model.User} associations to add or remove using this function.
- * The perm operation must exist before making this call. Only non-null attributes will be updated.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission update</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target and any optional data to update. Null or empty attributes will be ignored.
- * @return copy of permOp entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission updatePermission(Permission perm)
@@ -946,18 +594,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
return retPerm;
}
+
/**
- * This method will remove administrative permission operation entity from permission object. A Fortress permission is (object->operation).
- * The perm operation must exist before making this call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission delete</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation being removed</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermission(Permission perm)
@@ -981,24 +620,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This method will add administrative permission object to admin perms container in directory. The perm object must not exist before making this call.
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object being added</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} and {@link org.apache.directory.fortress.core.model.PermObj#ou}. The other attributes are optional.
- * @return copy of permObj entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj addPermObj(PermObj pObj)
@@ -1028,25 +652,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
return retObj;
}
+
/**
- * This method will update administrative permission object in perms container in directory. The perm object must exist before making this call.
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * <li>{@link PermObj#description} - any safe text</li>
- * <li>{@link PermObj#type} - contains any safe text</li>
- * <li>{@link PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link PermObj#objName}. Only non-null attributes will be updated.
- * @return copy of newly updated permObj entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj updatePermObj(PermObj pObj)
@@ -1076,16 +684,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
return retObj;
}
+
/**
- * This method will remove administrative permission object from perms container in directory. This method will also remove
- * in associated permission objects that are attached to this object.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of existing object targeted for removal</li>
- * </ul>
- *
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} of object targeted for removal.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermObj(PermObj pObj)
@@ -1109,23 +710,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command grants an AdminRole the administrative permission to perform an operation on an object to a role.
- * The command is implemented by granting administrative permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * and the adminRole is a member of the ADMIN_ROLES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the adminRole name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @param role must contains {@link org.apache.directory.fortress.core.model.AdminRole#name}.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission(Permission perm, AdminRole role)
@@ -1155,22 +742,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command revokes the administrative permission to perform an operation on an object from the set
- * of permissions assigned to an AdminRole. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * the role is a member of the ADMIN_ROLES data set, and the permission is assigned to that AdminRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the adminRole name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @param role must contains {@link org.apache.directory.fortress.core.model.AdminRole#name}.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission(Permission perm, AdminRole role)
@@ -1200,23 +774,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command grants a user the administrative permission to perform an operation on an object to a user.
- * The command is implemented by granting administrative permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents an administrative permission,
- * and the user is a member of the USERS data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @param user must contain {@link org.apache.directory.fortress.core.model.User#userId} of target User entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission(Permission perm, User user)
@@ -1246,22 +806,9 @@ public final class DelAdminMgrRestImpl extends Manageable implements DelAdminMgr
}
}
+
/**
- * This command revokes the administrative permission to perform an operation on an object from the set
- * of permissions assigned to a user. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents an administrative permission,
- * the user is a member of the USERS data set, and the permission is assigned to that user.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @param user must contain {@link org.apache.directory.fortress.core.model.User#userId} of target User entity.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission(Permission perm, User user)
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/DelReviewMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/DelReviewMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/DelReviewMgrRestImpl.java
index bf21936..1833380 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/DelReviewMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/DelReviewMgrRestImpl.java
@@ -55,17 +55,9 @@ public class DelReviewMgrRestImpl extends Manageable implements DelReviewMgr
{
private static final String CLS_NM = DelReviewMgrRestImpl.class.getName();
+
/**
- * Method reads Admin Role entity from the admin role container in directory.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for read</li>
- * </ul>
- *
- * @param role contains role name to be read.
- * @return AdminRole entity that corresponds with role name.
- * @throws org.apache.directory.fortress.core.SecurityException
- * will be thrown if role not found or system error occurs.
+ * {@inheritDoc}
*/
@Override
public AdminRole readRole(AdminRole role)
@@ -96,16 +88,7 @@ public class DelReviewMgrRestImpl extends Manageable implements DelReviewMgr
/**
- * Method will return a list of type Admin Role.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains all or some chars in the name of AdminRole(s) targeted for search</li>
- * </ul>
- *
- * @param searchVal contains the all or some of the chars corresponding to admin role entities stored in directory.
- * @return List of type AdminRole 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<AdminRole> findRoles(String searchVal)
@@ -134,18 +117,9 @@ public class DelReviewMgrRestImpl extends Manageable implements DelReviewMgr
return retRoles;
}
+
/**
- * This function returns the set of admin 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 userId matching user entity stored in the directory.
- * @return List of type UserAdminRole containing the user admin role data.
- * @throws org.apache.directory.fortress.core.SecurityException
- * If user not found or system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<UserAdminRole> assignedRoles(User user)
@@ -176,17 +150,7 @@ public class DelReviewMgrRestImpl extends Manageable implements DelReviewMgr
/**
- * This method returns the data set of all users who are assigned the given admin role. This searches the User data set for
- * AdminRole relationship. This method does NOT search for hierarchical Admin Roles relationships.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains the name of AdminRole targeted for search</li>
- * </ul>
- *
- * @param role contains the role name used to search the User data set.
- * @return List of type User containing the users assigned data.
- * @throws org.apache.directory.fortress.core.SecurityException
- * If system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<User> assignedUsers(AdminRole role)
@@ -222,18 +186,7 @@ public class DelReviewMgrRestImpl extends Manageable implements DelReviewMgr
/**
- * Commands reads existing OrgUnit entity from OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name associated with the OrgUnit object targeted for search.</li>
- * <li>{@link OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit entity that corresponds with ou name and type.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit read(OrgUnit entity)
@@ -264,19 +217,7 @@ public class DelReviewMgrRestImpl extends Manageable implements DelReviewMgr
/**
- * Commands searches existing OrgUnit entities from OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type parameter on API.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>searchVal - contains some or all of the chars associated with the OrgUnit objects targeted for search.</li>
- * </ul>
- *
- * @param type either PERM or USER
- * @param searchVal contains the leading chars that map to {@link OrgUnit#name} on existing OrgUnit(s) targeted for search.
- * @return List of type OrgUnit containing the OrgUnit data.
- * @throws org.apache.directory.fortress.core.SecurityException
- *
+ * {@inheritDoc}
*/
@Override
public List<OrgUnit> search(OrgUnit.Type type, String searchVal)
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/rest/PwPolicyMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/PwPolicyMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/PwPolicyMgrRestImpl.java
index 19eb5d1..9ec94a1 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/PwPolicyMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/PwPolicyMgrRestImpl.java
@@ -68,89 +68,7 @@ public class PwPolicyMgrRestImpl extends Manageable implements PwPolicyMgr
/**
- * This method will add a new policy entry to the POLICIES data set. This command is valid
- * if and only if the policy entry is not already present in the POLICIES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being added.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minAge} - This attribute holds the number of seconds that must elapse between
- * modifications to the password. If this attribute is not present, 0
- * seconds is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxAge} - This attribute holds the number of seconds after which a modified
- * password will expire. If this attribute is not present, or if the value is 0 the password
- * does not expire. If not 0, the value must be greater than or equal
- * to the value of the pwdMinAge.
- * </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#inHistory} - This attribute specifies the maximum number of used passwords stored
- * in the pwdHistory attribute. If this attribute is not present, or if the value is 0, used
- * passwords are not stored in the pwdHistory attribute and thus may be reused.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minLength} - When quality checking is enabled, this attribute holds the minimum
- * number of characters that must be used in a password. If this
- * attribute is not present, no minimum password length will be
- * enforced. If the server is unable to check the length (due to a
- * hashed password or otherwise), the server will, depending on the
- * value of the pwdCheckQuality attribute, either accept the password
- * without checking it ('0' or '1') or refuse it ('2').</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#expireWarning} - This attribute specifies the maximum number of seconds before a
- * password is due to expire that expiration warning messages will be
- * returned to an authenticating user. If this attribute is not present, or if the value is 0 no warnings
- * will be returned. If not 0, the value must be smaller than the value
- * of the pwdMaxAge attribute.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#graceLoginLimit} - This attribute specifies the number of times an expired password can
- * be used to authenticate. If this attribute is not present or if the
- * value is 0, authentication will fail. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockout} - This attribute indicates, when its value is "TRUE", that the password
- * may not be used to authenticate after a specified number of
- * consecutive failed bind attempts. The maximum number of consecutive
- * failed bind attempts is specified in pwdMaxFailure. If this attribute is not present, or if the
- * value is "FALSE", the password may be used to authenticate when the number of failed bind
- * attempts has been reached.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockoutDuration} - This attribute holds the number of seconds that the password cannot
- * be used to authenticate due to too many failed bind attempts. If
- * this attribute is not present, or if the value is 0 the password
- * cannot be used to authenticate until reset by a password
- * administrator.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxFailure} - This attribute specifies the number of consecutive failed bind
- * attempts after which the password may not be used to authenticate.
- * If this attribute is not present, or if the value is 0, this policy
- * is not checked, and the value of pwdLockout will be ignored.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#failureCountInterval} - This attribute holds the number of seconds after which the password
- * failures are purged from the failure counter, even though no
- * successful authentication occurred. If this attribute is not present, or if its value is 0, the failure
- * counter is only reset by a successful authentication.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#mustChange} - This attribute specifies with a value of "TRUE" that users must
- * change their passwords when they first bind to the directory after a
- * password is set or reset by a password administrator. If this
- * attribute is not presen request.setContextId(this.contextId);t, or if the value is "FALSE", users are not
- * required to change their password upon binding after the password
- * administrator sets or resets the password. This attribute is not set
- * due to any actions specified by this document, it is typically set by
- * a password administrator after resetting a user's password.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#allowUserChange} - This attribute indicates whether users can change their own
- * passwords, although the change operation is still subject to access
- * control. If this attribute is not present, a value of "TRUE" is
- * assumed. This attribute is intended to be used in the absence of an access control mechanism.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#safeModify} - This attribute specifies whether or not the existing password must be
- * sent along with the new password when being changed. If this
- * attribute is not present, a "FALSE" value is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#checkQuality} - This attribute indicates how the password quality will be verified
- * while being modified or added. If this attribute is not present, or
- * if the value is '0', quality checking will not be enforced. A value
- * of '1' indicates that the server will check the quality, and if the
- * server is unable to check it (due to a hashed password or other
- * reasons) it will be accepted. A value of '2' indicates that the
- * server will check the quality, and if the server is unable to verify
- * it, it will return an error refusing the password. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#attribute} - This holds the name of the attribute to which the password policy is
- * applied. For example, the password policy may be applied to the
- * userPassword attribute </li>
- * </ul>
- *
- * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} and optionally other attributes.
- * @throws SecurityException In the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void add( PwPolicy policy )
@@ -175,89 +93,7 @@ public class PwPolicyMgrRestImpl extends Manageable implements PwPolicyMgr
/**
- * This method will update an exiting policy entry to the POLICIES data set. This command is valid
- * if and only if the policy entry is already present in the POLICIES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being updated.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minAge} - This attribute holds the number of seconds that must elapse between
- * modifications to the password. If this attribute is not present, 0
- * seconds is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxAge} - This attribute holds the number of seconds after which a modified
- * password will expire. If this attribute is not present, or if the value is 0 the password
- * does not expire. If not 0, the value must be greater than or equal
- * to the value of the pwdMinAge.
- * </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#inHistory} - This attribute specifies the maximum number of used passwords stored
- * in the pwdHistory attribute. If this attribute is not present, or if the value is 0, used
- * passwords are not stored in the pwdHistory attribute and thus may be reused.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minLength} - When quality checking is enabled, this attribute holds the minimum
- * number of characters that must be used in a password. If this
- * attribute is not present, no minimum password length will be
- * enforced. If the server is unable to check the length (due to a
- * hashed password or otherwise), the server will, depending on the
- * value of the pwdCheckQuality attribute, either accept the password
- * without checking it ('0' or '1') or refuse it ('2').</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#expireWarning} - This attribute specifies the maximum number of seconds before a
- * password is due to expire that expiration warning messages will be
- * returned to an authenticating user. If this attribute is not present, or if the value is 0 no warnings
- * will be returned. If not 0, the value must be smaller than the value
- * of the pwdMaxAge attribute.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#graceLoginLimit} - This attribute specifies the number of times an expired password can
- * be used to authenticate. If this attribute is not present or if the
- * value is 0, authentication will fail. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockout} - This attribute indicates, when its value is "TRUE", that the password
- * may not be used to authenticate after a specified number of
- * consecutive failed bind attempts. The maximum number of consecutive
- * failed bind attempts is specified in pwdMaxFailure. If this attribute is not present, or if the
- * value is "FALSE", the password may be used to authenticate when the number of failed bind
- * attempts has been reached.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockoutDuration} - This attribute holds the number of seconds that the password cannot
- * be used to authenticate due to too many failed bind attempts. If
- * this attribute is not present, or if the value is 0 the password
- * cannot be used to authenticate until reset by a password
- * administrator.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxFailure} - This attribute specifies the number of consecutive failed bind
- * attempts after which the password may not be used to authenticate.
- * If this attribute is not present, or if the value is 0, this policy
- * is not checked, and the value of pwdLockout will be ignored.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#failureCountInterval} - This attribute holds the number of seconds after which the password
- * failures are purged from the failure counter, even though no
- * successful authentication occurred. If this attribute is not present, or if its value is 0, the failure
- * counter is only reset by a successful authentication.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#mustChange} - This attribute specifies with a value of "TRUE" that users must
- * change their passwords when they first bind to the directory after a
- * password is set or reset by a password administrator. If this
- * attribute is not present, or if the value is "FALSE", users are not
- * required to change their password upon binding after the password
- * administrator sets or resets the password. This attribute is not set
- * due to any actions specified by this document, it is typically set by
- * a password administrator after resetting a user's password.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#allowUserChange} - This attribute indicates whether users can change their own
- * passwords, although the change operation is still subject to access
- * control. If this attribute is not present, a value of "TRUE" is
- * assumed. This attribute is intended to be used in the absence of an access control mechanism.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#safeModify} - This attribute specifies whether or not the existing password must be
- * sent along with the new password when being changed. If this
- * attribute is not present, a "FALSE" value is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#checkQuality} - This attribute indicates how the password quality will be verified
- * while being modified or added. If this attribute is not present, or
- * if the value is '0', quality checking will not be enforced. A value
- * of '1' indicates that the server will check the quality, and if the
- * server is unable to check it (due to a hashed password or other
- * reasons) it will be accepted. A value of '2' indicates that the
- * server will check the quality, and if the server is unable to verify
- * it, it will return an error refusing the password. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#attribute} - This holds the name of the attribute to which the password policy is
- * applied. For example, the password policy may be applied to the
- * userPassword attribute </li>
- * </ul>
- *
- * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} and optionally all non-null attributes will be updated. null attributes will be ignored.
- * @throws SecurityException In the event policy not found , data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void update( PwPolicy policy )
@@ -282,17 +118,7 @@ public class PwPolicyMgrRestImpl extends Manageable implements PwPolicyMgr
/**
- * This method will delete exiting policy entry from the POLICIES data set. This command is valid
- * if and only if the policy entry is already present in the POLICIES data set. Existing users that
- * are assigned this policy will be removed from association.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being removed.</li>
- * </ul>
- *
- * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} of the policy entity to remove.
- * @throws org.apache.directory.fortress.core.SecurityException
- * In the event policy entity not found or system error.
+ * {@inheritDoc}
*/
@Override
public void delete( PwPolicy policy )
@@ -317,15 +143,7 @@ public class PwPolicyMgrRestImpl extends Manageable implements PwPolicyMgr
/**
- * This method will return the password policy entity to the caller. This command is valid
- * if and only if the policy entry is present in the POLICIES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being read.</li>
- * </ul>
- *
- * @return PswdPolicy entity returns fully populated with attributes.
- * @throws SecurityException In the event policy entry not found, data validation or system error.
+ * {@inheritDoc}
*/
@Override
public PwPolicy read( String name )
@@ -356,12 +174,7 @@ public class PwPolicyMgrRestImpl extends Manageable implements PwPolicyMgr
/**
- * This method will return a list of all password policy entities that match a particular search string.
- * This command will return an empty list of no matching entries are found.
- *
- * @param searchVal String contains the leading chars of a policy entity. This search is not case sensitive.
- * @return List<PswdPolicy> contains all matching password policy entities. If no records found this will be empty.
- * @throws SecurityException In the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public List<PwPolicy> search( String searchVal )
@@ -392,13 +205,7 @@ public class PwPolicyMgrRestImpl extends Manageable implements PwPolicyMgr
/**
- * This method will associate a user entity with a password policy entity. This function is valid
- * if and only if the user is a member of the USERS data set and the policyName refers to a
- * policy that is a member of the PWPOLICIES data set.
- *
- * @param userId Contains {@link org.apache.directory.fortress.core.model.User#userId} of a User entity in USERS data set.
- * @param name String contains the {@link org.apache.directory.fortress.core.model.PwPolicy#name} of a pw policy entity contained within the PWPOLICIES data set.
- * @throws SecurityException thrown in the event either user or policy not valid or system error.
+ * {@inheritDoc}
*/
@Override
public void updateUserPolicy( String userId, String name )
@@ -426,13 +233,7 @@ public class PwPolicyMgrRestImpl extends Manageable implements PwPolicyMgr
/**
- * This method will remove the pw policy assignment from a user entity. This function is valid
- * if and only if the user is a member of the USERS data set and the policy attribute is assigned.
- * Removal of pw policy assignment will revert the user's policy to use the global default for OpenLDAP
- * instance that contains user.
- *
- * @param userId Contains {@link User#userId} of a User entity in USERS data set.
- * @throws SecurityException Thrown in the event either user not valid or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePasswordPolicy( String userId )
[5/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Posted by sm...@apache.org.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/DelAdminMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/DelAdminMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/DelAdminMgrImpl.java
index e850ce0..4d82060 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/DelAdminMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/DelAdminMgrImpl.java
@@ -65,36 +65,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
private static final UserP userP = new UserP();
/**
- * This command creates a new admin role. The command is valid if and only if the new admin role is not
- * already a member of the ADMIN ROLES data set. The ADMIN ROLES data set is updated.
- * Initially, no user or permission is assigned to the new role.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole being targeted for addition to LDAP</li>
- * </ul>
- * <p/>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#description} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
- *
- * @param role Contains role name and description.
- * @return AdminRole contains reference to entity operated on.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public AdminRole addRole(AdminRole role)
@@ -107,18 +78,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command deletes an existing admin role from the ARBAC database. The command is valid
- * if and only if the role to be deleted is a member of the ADMIN ROLES data set. This command will
- * also deassign role from all users.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for removal</li>
- * </ul>
- * <p/>
- *
- * @param role Contains role name.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteRole(AdminRole role)
@@ -160,34 +120,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * Method will update an AdminRole entity in the directory. The role must exist in directory prior to this call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for updating</li>
- * </ul>
- * <p/>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link AdminRole#description} - contains any safe text</li>
- * <li>{@link AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
- *
- * @param role Contains role name and new description.
- * @return AdminRole contains reference to entity operated on.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Description of the Exception
+ * {@inheritDoc}
*/
@Override
public AdminRole updateRole(AdminRole role)
@@ -225,42 +158,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * This command assigns a user to an admin role.
- * Successful completion of this op, the following occurs:
- * </p>
- * <ul>
- * <li> User entity (resides in people container) has role assignment added to aux object class attached to actual user record.
- * <li> AdminRole entity (resides in admin role container) has userId added as role occupant.
- * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:
- * <ul>
- * <li> timeout - number in seconds of session inactivity time allowed.
- * <li> beginDate - YYYYMMDD - determines date when role may be activated.
- * <li> endDate - YYMMDD - indicates latest date role may be activated.
- * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status
- * <li> endLockDate - YYMMDD - determines end of enforced inactive status.
- * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.
- * <li> endTime - HHMM - determines end hour role may be activated in user's session.*
- * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.
- * </ul>
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing AdminRole to be assigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginTime} - HHMM - determines begin hour AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endTime} - HHMM - determines end hour AdminRole may be activated into user's RBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginDate} - YYYYMMDD - determines date when AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endDate} - YYYYMMDD - indicates latest date AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
- *
- * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and {@link org.apache.directory.fortress.core.model.AdminRole#name} and optional {@code org.apache.directory.fortress.core.impl.Constraints}.
- * @throws SecurityException in the event data error in user or role objects or system error.
+ * {@inheritDoc}
*/
@Override
public void assignUser(UserAdminRole uAdminRole)
@@ -291,20 +189,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * This method removes assigned admin role from user entity. Both user and admin role entities must exist and have role relationship
- * before calling this method.
- * Successful completion:
- * del Role to User assignment in User data set
- * AND
- * User to Role assignment in Admin Role data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing AdminRole to be deassigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User</li>
- * </ul>
- *
- * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and {@link org.apache.directory.fortress.core.model.AdminRole#name}.
- * @throws SecurityException - in the event data error in user or role objects or system error.
+ * {@inheritDoc}
*/
@Override
public void deassignUser(UserAdminRole uAdminRole)
@@ -323,21 +208,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * Commands adds a new OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be added</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#description} - contains any safe text</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit contains reference to entity added.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit add(OrgUnit entity) throws SecurityException
@@ -350,22 +221,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * Commands updates existing OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be updated</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#description} - contains any safe text</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit contains reference to entity operated on.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit update(OrgUnit entity)
@@ -379,17 +235,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * Commands deletes existing OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be removed</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit contains reference to entity operated on.
- * @throws SecurityException in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit delete(OrgUnit entity)
@@ -464,35 +310,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * This command creates a new orgunit child, and inserts it in the orgunit hierarchy as an immediate descendant of
- * the existing orgunit parent.
- * <p>
- * The command is valid if and only if:
- * <ul>
- * <li> The child orgunit is not a member of the ORGUNITS data set.
- * <li> The parent orgunit is a member of the ORGUNITS data set.
- * </ul>
- * </p>
- * <p> This method:
- * <ul>
- * <li> Adds new orgunit.
- * <li> Assigns orgunit relationship between new child and pre-existing parent.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be child</li>
- * </ul>
- * <h4>optional parameters child</h4>
- * <ul>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#description} - maps to description attribute on organizationalUnit object class for new child</li>
- * </ul>
- *
- * @param parent This entity must be present in ORGUNIT data set. Success will add rel with child.
- * @param child This entity must not be present in ORGUNIT data set. Success will add the new entity to ORGUNIT data set.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addDescendant(OrgUnit parent, OrgUnit child)
@@ -527,35 +345,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command creates a new orgunit parent, and inserts it in the orgunit hierarchy as an immediate ascendant of
- * the existing child orgunit.
- * <p>
- * The command is valid if and only if:
- * <ul>
- * <li> The parent is not a member of the ORGUNITS data set.
- * <li> The child is a member of the ORGUNITS data set.
- * </ul>
- * </p>
- * <p> This method:
- * <ul>
- * <li> Adds new orgunit.
- * <li> Assigns orgunit relationship between new parent and pre-existing child.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be child</li>
- * </ul>
- * <h4>optional parameters child</h4>
- * <ul>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#description} - maps to description attribute on organizationalUnit object class for new child</li>
- * </ul>
- *
- * @param parent completion of op assigns new child relationship with child orgunit.
- * @param child completion of op assigns new parent relationship with parent orgunit.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addAscendant(OrgUnit child, OrgUnit parent)
@@ -592,26 +382,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command establishes a new immediate inheritance relationship with parent orgunit <<-- child orgunit
- * <p>
- * The command is valid if and only if:
- * <ul>
- * <li> The parent and child are members of the ORGUNITS data set.
- * <li> The parent is not an immediate ascendant of child.
- * <li> The child does not properly inherit parent (in order to avoid cycle creation).
- * </ul>
- * </p>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be child</li>
- * </ul>
- *
- * @param parent completion of op deassigns child relationship with child orgunit.
- * @param child completion of op deassigns parent relationship with parent orgunit.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addInheritance(OrgUnit parent, OrgUnit child)
@@ -650,26 +421,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command deletes an existing immediate inheritance relationship parent <<-- child.
- * <p/>
- * The command is valid if and only if:
- * <ul>
- * <li> The orgunits parent and child are members of the ORGUNITS data set.
- * <li> The parent is an immediate ascendant of child.
- * <li> The new inheritance relation is computed as the reflexive-transitive closure of the immediate inheritance
- * relation resulted after deleting the relationship parent <<-- child.
- * </ul>
- * <h4>required parameters</h4>
- * <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to remove as parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to remove as child</li>
- * </ul>
- *
- * @param parent completion of op removes child relationship with childRole.
- * @param child completion of op removes parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteInheritance(OrgUnit parent, OrgUnit child)
@@ -715,34 +467,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * This command creates a new role childRole, and inserts it in the role hierarchy as an immediate descendant of
- * the existing role parentRole. The command is valid if and only if childRole is not a member of the ADMINROLES data set,
- * and parentRole is a member of the ADMINROLES data set.
- * <p/>
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new childRole and pre-existing parentRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link AdminRole#name} - contains the name of existing Role to be parent</li>
- * <li>childRole - {@link AdminRole#name} - contains the name of new Role to be child</li>
- * </ul>
- * <h4>optional parameters childRole</h4>
- * <ul>
- * <li>childRole - {@link AdminRole#description} - maps to description attribute on organizationalRole object class for new child</li>
- * <li>childRole - {@link AdminRole#beginTime} - HHMM - determines begin hour role may be activated into user's session for new child</li>
- * <li>childRole - {@link AdminRole#endTime} - HHMM - determines end hour role may be activated into user's session for new child</li>
- * <li>childRole - {@link AdminRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's session for new child</li>
- * <li>childRole - {@link AdminRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's session for new child</li>
- * <li>childRole - {@link AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new child</li>
- * <li>childRole - {@link AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new child</li>
- * <li>childRole - {@link AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's session for new child</li>
- * </ul>
- *
- * @param parentRole This entity must be present in ADMINROLES data set. Success will add role rel with childRole.
- * @param childRole This entity must not be present in ADMINROLES data set. Success will add the new role entity to ADMINROLES data set.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addDescendant(AdminRole parentRole, AdminRole childRole)
@@ -762,33 +487,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * This command creates a new role parentRole, and inserts it in the role hierarchy as an immediate ascendant of
- * the existing role childRole. The command is valid if and only if parentRole is not a member of the ROLES data set,
- * and childRole is a member of the ROLES data set.
- * This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new parentRole and pre-existing childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>childRole - {@link AdminRole#name} - contains the name of existing Role to be child</li>
- * <li>parentRole - {@link AdminRole#name} - contains the name of new Role to be added as parent</li>
- * </ul>
- * <h4>optional parameters parentRole</h4>
- * <ul>
- * <li>parentRole - {@link AdminRole#description} - maps to description attribute on organizationalRole object class for new parent</li>
- * <li>parentRole - {@link AdminRole#beginTime} - HHMM - determines begin hour role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link AdminRole#endTime} - HHMM - determines end hour role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link AdminRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link AdminRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new parent</li>
- * <li>parentRole - {@link AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new parent</li>
- * <li>parentRole - {@link AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's session for new parent</li>
- * </ul>
- *
- * @param parentRole completion of op assigns new child relationship with childRole.
- * @param childRole completion of op assigns new parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addAscendant(AdminRole childRole, AdminRole parentRole)
@@ -815,20 +514,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * This command establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
- * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the ROLES data
- * set, parentRole is not an immediate ascendant of childRole, and childRole does not properly inherit parentRole (in order to
- * avoid cycle creation).
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link AdminRole#name} - contains the name of existing AdminRole to be parent</li>
- * <li>childRole - {@link AdminRole#name} - contains the name of existing AdminRole to be child</li>
- * </ul>
- *
- * @param parentRole completion of op deassigns child relationship with childRole.
- * @param childRole completion of op deassigns parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void addInheritance(AdminRole parentRole, AdminRole childRole)
@@ -857,20 +543,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
/**
- * This command deletes an existing immediate inheritance relationship parentRole <<-- childRole. The command is
- * valid if and only if the roles parentRole and childRole are members of the ROLES data set, and parentRole is an
- * immediate ascendant of childRole. The new inheritance relation is computed as the reflexive-transitive
- * closure of the immediate inheritance relation resulted after deleting the relationship parentRole <<-- childRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>parentRole - {@link AdminRole#name} - contains the name of existing AdminRole to remove as parent</li>
- * <li>childRole - {@link AdminRole#name} - contains the name of existing AdminRole to remove as child</li>
- * </ul>
- *
- * @param parentRole completion of op removes child relationship with childRole.
- * @param childRole completion of op removes parent relationship with parentRole.
- * @throws org.apache.directory.fortress.core.SecurityException
- * thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void deleteInheritance(AdminRole parentRole, AdminRole childRole)
@@ -906,25 +579,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This method will add an administrative permission operation to an existing permission object which resides under {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may have {@link AdminRole} or {@link org.apache.directory.fortress.core.model.User} associations. The target {@link org.apache.directory.fortress.core.model.Permission} must not exist prior to calling.
- * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself as stored in ldap tree: ({@link PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission add</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission operation being added</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target along with optional other attributes..
- * @return copy of Permission entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission addPermission(Permission perm)
@@ -936,26 +591,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This method will update administrative permission operation pre-existing in target directory under {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may also contain {@link AdminRole} or {@link org.apache.directory.fortress.core.model.User} associations to add or remove using this function.
- * The perm operation must exist before making this call. Only non-null attributes will be updated.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission update</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link Permission#type} - any safe text</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target and any optional data to update. Null or empty attributes will be ignored.
- * @return copy of Permission entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public Permission updatePermission(Permission perm)
@@ -967,17 +603,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This method will remove administrative permission operation entity from permission object. A Fortress permission is (object->operation).
- * The perm operation must exist before making this call.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted for the permission delete</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation being removed</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermission(Permission perm)
@@ -989,23 +615,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This method will add administrative permission object to admin perms container in directory. The perm object must not exist before making this call.
- * A {@link PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link PermObj}*->{@link Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of new object being added</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link PermObj#description} - any safe text</li>
- * <li>{@link PermObj#type} - contains any safe text</li>
- * <li>{@link PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link PermObj#objName} and {@link PermObj#ou}. The other attributes are optional.
- * @return copy of PermObj entity.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj addPermObj(PermObj pObj)
@@ -1017,24 +627,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This method will update administrative permission object in perms container in directory. The perm object must exist before making this call.
- * A {@link PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link PermObj}*->{@link Permission}).
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object being updated</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
- * <li>{@link PermObj#description} - any safe text</li>
- * <li>{@link PermObj#type} - contains any safe text</li>
- * <li>{@link PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * </ul>
- *
- * @param pObj must contain the {@link PermObj#objName}. Only non-null attributes will be updated.
- * @return copy of newly updated PermObj entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public PermObj updatePermObj(PermObj pObj)
@@ -1046,15 +639,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This method will remove administrative permission object from perms container in directory. This method will also remove
- * in associated permission objects that are attached to this object.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object targeted for removal</li>
- * </ul>
- *
- * @param pObj must contain the {@link PermObj#objName} of object targeted for removal.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePermObj(PermObj pObj)
@@ -1066,22 +651,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command grants an AdminRole the administrative permission to perform an operation on an object to a role.
- * The command is implemented by granting administrative permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * and the adminRole is a member of the ADMIN_ROLES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link AdminRole#name} - contains the adminRole name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @param role must contains {@link AdminRole#name}.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission(Permission perm, AdminRole role)
@@ -1093,21 +663,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command revokes the administrative permission to perform an operation on an object from the set
- * of permissions assigned to an AdminRole. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents a permission,
- * the role is a member of the ADMIN_ROLES data set, and the permission is assigned to that AdminRole.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link AdminRole#name} - contains the adminRole name</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link Permission#opName}, that identifies target.
- * @param role must contains {@link AdminRole#name}.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission(Permission perm, AdminRole role)
@@ -1119,22 +675,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command grants a user the administrative permission to perform an operation on an object to a user.
- * The command is implemented by granting administrative permission by setting the access control list of
- * the object involved.
- * The command is valid if and only if the pair (operation, object) represents an administrative permission,
- * and the user is a member of the USERS data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @param user must contain {@link User#userId} of target User entity.
- * @throws org.apache.directory.fortress.core.SecurityException
- * Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void grantPermission(Permission perm, User user)
@@ -1146,21 +687,7 @@ public final class DelAdminMgrImpl extends Manageable implements DelAdminMgr
}
/**
- * This command revokes the administrative permission to perform an operation on an object from the set
- * of permissions assigned to a user. The command is implemented by setting the access control
- * list of the object involved.
- * The command is valid if and only if the pair (operation, object) represents an administrative permission,
- * the user is a member of the USERS data set, and the permission is assigned to that user.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link Permission#objName} - contains the object name</li>
- * <li>{@link Permission#opName} - contains the operation name</li>
- * <li>{@link User#userId} - contains the userId</li>
- * </ul>
- *
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @param user must contain {@link User#userId} of target User entity.
- * @throws SecurityException Thrown in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void revokePermission(Permission perm, User user)
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/DelReviewMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/DelReviewMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/DelReviewMgrImpl.java
index a78529b..292a13a 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/DelReviewMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/DelReviewMgrImpl.java
@@ -55,16 +55,7 @@ public class DelReviewMgrImpl extends Manageable implements DelReviewMgr
private static final AdminRoleP admRP = new AdminRoleP();
/**
- * Method reads Admin Role entity from the admin role container in directory.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the AdminRole being targeted for read</li>
- * </ul>
- *
- * @param role contains role name to be read.
- * @return AdminRole entity that corresponds with role name.
- * @throws org.apache.directory.fortress.core.SecurityException
- * will be thrown if role not found or system error occurs.
+ * {@inheritDoc}
*/
@Override
public AdminRole readRole(AdminRole role)
@@ -78,16 +69,7 @@ public class DelReviewMgrImpl extends Manageable implements DelReviewMgr
/**
- * Method will return a list of type Admin Role.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains all or some chars in the name of AdminRole(s) targeted for search</li>
- * </ul>
- *
- * @param searchVal contains the all or some of the chars corresponding to admin role entities stored in directory.
- * @return List of type AdminRole 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<AdminRole> findRoles(String searchVal)
@@ -102,17 +84,7 @@ public class DelReviewMgrImpl extends Manageable implements DelReviewMgr
}
/**
- * This function returns the set of admin 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 org.apache.directory.fortress.core.model.User#userId} - contains the userId associated with the User object targeted for search.</li>
- * </ul>
- *
- * @param user contains userId matching user entity stored in the directory.
- * @return List of type UserAdminRole containing the user admin role data.
- * @throws org.apache.directory.fortress.core.SecurityException
- * If user not found or system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<UserAdminRole> assignedRoles(User user)
@@ -127,17 +99,7 @@ public class DelReviewMgrImpl extends Manageable implements DelReviewMgr
/**
- * This method returns the data set of all users who are assigned the given admin role. This searches the User data set for
- * AdminRole relationship. This method does NOT search for hierarchical Admin Roles relationships.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link AdminRole#name} - contains the name of AdminRole targeted for search</li>
- * </ul>
- *
- * @param role contains the role name used to search the User data set.
- * @return List of type User containing the users assigned data.
- * @throws org.apache.directory.fortress.core.SecurityException
- * If system error occurs.
+ * {@inheritDoc}
*/
@Override
public List<User> assignedUsers(AdminRole role)
@@ -151,18 +113,7 @@ public class DelReviewMgrImpl extends Manageable implements DelReviewMgr
/**
- * Commands reads existing OrgUnit entity from OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type attribute.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name associated with the OrgUnit object targeted for search.</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * </ul>
- *
- * @param entity contains OrgUnit name and type.
- * @return OrgUnit entity that corresponds with ou name and type.
- * @throws org.apache.directory.fortress.core.SecurityException
- * in the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public OrgUnit read(OrgUnit entity)
@@ -176,19 +127,7 @@ public class DelReviewMgrImpl extends Manageable implements DelReviewMgr
/**
- * Commands searches existing OrgUnit entities from OrgUnit dataset. The OrgUnit can be either User or Perm and is
- * set by setting type parameter on API.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link OrgUnit#type} - contains the type of OU: {@link OrgUnit.Type#USER} or {@link OrgUnit.Type#PERM}</li>
- * <li>searchVal - contains some or all of the chars associated with the OrgUnit objects targeted for search.</li>
- * </ul>
- *
- * @param type either PERM or USER
- * @param searchVal contains the leading chars that map to {@link OrgUnit#name} on existing OrgUnit(s) targeted for search.
- * @return List of type OrgUnit containing the OrgUnit data.
- * @throws org.apache.directory.fortress.core.SecurityException
- *
+ * {@inheritDoc}
*/
@Override
public List<OrgUnit> search(OrgUnit.Type type, String searchVal)
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/GroupMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/GroupMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/GroupMgrImpl.java
index 2956598..78a2c62 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/GroupMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/GroupMgrImpl.java
@@ -48,11 +48,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
private static final GroupP GROUP_P = new GroupP();
/**
- * Create a new group node. Must have a name and at least one member.
- *
- * @param group contains {@link org.apache.directory.fortress.core.model.Group}.
- * @return {@link org.apache.directory.fortress.core.model.Group} containing entity just added.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
@Override
public Group add( Group group ) throws org.apache.directory.fortress.core.SecurityException
@@ -70,13 +66,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Modify existing group node. The name is required. Does not update members or properties.
- * Use {@link GroupMgr#add( Group group, String key, String value )}, {@link GroupMgr#delete( Group group, String key, String value )},
- * {@link GroupMgr#assign( Group group, String member) }, or {@link GroupMgr#deassign( Group group, String member) } for multi-occurring attributes.
- *
- * @param group contains {@link Group}.
- * @return {@link Group} containing entity just modified.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
@Override
public Group update( Group group ) throws SecurityException
@@ -89,11 +79,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Delete existing group node. The name is required.
- *
- * @param group contains {@link Group}.
- * @return {@link Group} containing entity just removed.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
@Override
public Group delete( Group group ) throws SecurityException
@@ -106,13 +92,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Add a property to an existing group node. The name is required.
- *
- * @param group contains {@link Group}.
- * @param key contains the property key.
- * @param value contains contains the property value.
- * @return {@link Group} containing entity just modified.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
public Group add( Group group, String key, String value ) throws SecurityException
{
@@ -124,13 +104,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Delete existing group node. The name is required.
- *
- * @param group contains {@link Group}.
- * @param key contains the property key.
- * @param value contains contains the property value.
- * @return {@link Group} containing entity just modified.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
public Group delete( Group group, String key, String value ) throws SecurityException
{
@@ -142,11 +116,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Read an existing group node. The name is required.
- *
- * @param group contains {@link Group} with name field set with an existing group name.
- * @return {@link Group} containing entity found.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
@Override
public Group read( Group group ) throws SecurityException
@@ -159,11 +129,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Search using a full or partial group node. The name is required.
- *
- * @param group contains {@link Group}.
- * @return List of type {@link Group} containing entities found.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
@Override
public List<Group> find( Group group ) throws SecurityException
@@ -176,11 +142,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Search for groups by userId. Member (maps to userId) and is required.
- *
- * @param user contains userId that maps to Group member attribute.
- * @return {@link Group} containing entity just added.
- * @throws org.apache.directory.fortress.core.SecurityException in the event system error.
+ * {@inheritDoc}
*/
public List<Group> find( User user ) throws SecurityException
{
@@ -193,12 +155,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Assign a user to an existing group node. The name is required and userDn are required.
- *
- * @param group contains {@link Group}.
- * @param member is the relative distinguished name (rdn) of an existing user in ldap.
- * @return {@link Group} containing entity to assign.
- * @throws org.apache.directory.fortress.core.SecurityException in the event entry already present or other system error.
+ * {@inheritDoc}
*/
@Override
public Group assign( Group group, String member ) throws SecurityException
@@ -213,12 +170,7 @@ public class GroupMgrImpl extends Manageable implements GroupMgr
}
/**
- * Deassign a user from an existing group node. The name is required and userDn are required.
- *
- * @param group contains {@link Group}.
- * @param member is the relative distinguished name (rdn) of an existing user in ldap.
- * @return {@link Group} containing entity to deassign
- * @throws org.apache.directory.fortress.core.SecurityException in the event entry already present or other system error.
+ * {@inheritDoc}
*/
@Override
public Group deassign( Group group, String member ) throws SecurityException
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/PwPolicyMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/PwPolicyMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/PwPolicyMgrImpl.java
index 86d7386..a32867c 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/PwPolicyMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/PwPolicyMgrImpl.java
@@ -64,89 +64,7 @@ public class PwPolicyMgrImpl extends Manageable implements PwPolicyMgr
private static final UserP userP = new UserP();
/**
- * This method will add a new policy entry to the POLICIES data set. This command is valid
- * if and only if the policy entry is not already present in the POLICIES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being added.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minAge} - This attribute holds the number of seconds that must elapse between
- * modifications to the password. If this attribute is not present, 0
- * seconds is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxAge} - This attribute holds the number of seconds after which a modified
- * password will expire. If this attribute is not present, or if the value is 0 the password
- * does not expire. If not 0, the value must be greater than or equal
- * to the value of the pwdMinAge.
- * </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#inHistory} - This attribute specifies the maximum number of used passwords stored
- * in the pwdHistory attribute. If this attribute is not present, or if the value is 0, used
- * passwords are not stored in the pwdHistory attribute and thus may be reused.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minLength} - When quality checking is enabled, this attribute holds the minimum
- * number of characters that must be used in a password. If this
- * attribute is not present, no minimum password length will be
- * enforced. If the server is unable to check the length (due to a
- * hashed password or otherwise), the server will, depending on the
- * value of the pwdCheckQuality attribute, either accept the password
- * without checking it ('0' or '1') or refuse it ('2').</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#expireWarning} - This attribute specifies the maximum number of seconds before a
- * password is due to expire that expiration warning messages will be
- * returned to an authenticating user. If this attribute is not present, or if the value is 0 no warnings
- * will be returned. If not 0, the value must be smaller than the value
- * of the pwdMaxAge attribute.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#graceLoginLimit} - This attribute specifies the number of times an expired password can
- * be used to authenticate. If this attribute is not present or if the
- * value is 0, authentication will fail. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockout} - This attribute indicates, when its value is "TRUE", that the password
- * may not be used to authenticate after a specified number of
- * consecutive failed bind attempts. The maximum number of consecutive
- * failed bind attempts is specified in pwdMaxFailure. If this attribute is not present, or if the
- * value is "FALSE", the password may be used to authenticate when the number of failed bind
- * attempts has been reached.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockoutDuration} - This attribute holds the number of seconds that the password cannot
- * be used to authenticate due to too many failed bind attempts. If
- * this attribute is not present, or if the value is 0 the password
- * cannot be used to authenticate until reset by a password
- * administrator.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxFailure} - This attribute specifies the number of consecutive failed bind
- * attempts after which the password may not be used to authenticate.
- * If this attribute is not present, or if the value is 0, this policy
- * is not checked, and the value of pwdLockout will be ignored.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#failureCountInterval} - This attribute holds the number of seconds after which the password
- * failures are purged from the failure counter, even though no
- * successful authentication occurred. If this attribute is not present, or if its value is 0, the failure
- * counter is only reset by a successful authentication.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#mustChange} - This attribute specifies with a value of "TRUE" that users must
- * change their passwords when they first bind to the directory after a
- * password is set or reset by a password administrator. If this
- * attribute is not present, or if the value is "FALSE", users are not
- * required to change their password upon binding after the password
- * administrator sets or resets the password. This attribute is not set
- * due to any actions specified by this document, it is typically set by
- * a password administrator after resetting a user's password.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#allowUserChange} - This attribute indicates whether users can change their own
- * passwords, although the change operation is still subject to access
- * control. If this attribute is not present, a value of "TRUE" is
- * assumed. This attribute is intended to be used in the absence of an access control mechanism.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#safeModify} - This attribute specifies whether or not the existing password must be
- * sent along with the new password when being changed. If this
- * attribute is not present, a "FALSE" value is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#checkQuality} - This attribute indicates how the password quality will be verified
- * while being modified or added. If this attribute is not present, or
- * if the value is '0', quality checking will not be enforced. A value
- * of '1' indicates that the server will check the quality, and if the
- * server is unable to check it (due to a hashed password or other
- * reasons) it will be accepted. A value of '2' indicates that the
- * server will check the quality, and if the server is unable to verify
- * it, it will return an error refusing the password. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#attribute} - This holds the name of the attribute to which the password policy is
- * applied. For example, the password policy may be applied to the
- * userPassword attribute </li>
- * </ul>
- *
- * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} and optionally other attributes.
- * @throws SecurityException In the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void add(PwPolicy policy)
@@ -160,89 +78,7 @@ public class PwPolicyMgrImpl extends Manageable implements PwPolicyMgr
/**
- * This method will update an exiting policy entry to the POLICIES data set. This command is valid
- * if and only if the policy entry is already present in the POLICIES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PwPolicy#name} - Maps to name attribute of pwdPolicy object class being updated.</li>
- * </ul>
- * <h4>optional parameters</h4>
- * <ul>
- * <li>{@link PwPolicy#minAge} - This attribute holds the number of seconds that must elapse between
- * modifications to the password. If this attribute is not present, 0
- * seconds is assumed.</li>
- * <li>{@link PwPolicy#maxAge} - This attribute holds the number of seconds after which a modified
- * password will expire. If this attribute is not present, or if the value is 0 the password
- * does not expire. If not 0, the value must be greater than or equal
- * to the value of the pwdMinAge.
- * </li>
- * <li>{@link PwPolicy#inHistory} - This attribute specifies the maximum number of used passwords stored
- * in the pwdHistory attribute. If this attribute is not present, or if the value is 0, used
- * passwords are not stored in the pwdHistory attribute and thus may be reused.</li>
- * <li>{@link PwPolicy#minLength} - When quality checking is enabled, this attribute holds the minimum
- * number of characters that must be used in a password. If this
- * attribute is not present, no minimum password length will be
- * enforced. If the server is unable to check the length (due to a
- * hashed password or otherwise), the server will, depending on the
- * value of the pwdCheckQuality attribute, either accept the password
- * without checking it ('0' or '1') or refuse it ('2').</li>
- * <li>{@link PwPolicy#expireWarning} - This attribute specifies the maximum number of seconds before a
- * password is due to expire that expiration warning messages will be
- * returned to an authenticating user. If this attribute is not present, or if the value is 0 no warnings
- * will be returned. If not 0, the value must be smaller than the value
- * of the pwdMaxAge attribute.</li>
- * <li>{@link PwPolicy#graceLoginLimit} - This attribute specifies the number of times an expired password can
- * be used to authenticate. If this attribute is not present or if the
- * value is 0, authentication will fail. </li>
- * <li>{@link PwPolicy#lockout} - This attribute indicates, when its value is "TRUE", that the password
- * may not be used to authenticate after a specified number of
- * consecutive failed bind attempts. The maximum number of consecutive
- * failed bind attempts is specified in pwdMaxFailure. If this attribute is not present, or if the
- * value is "FALSE", the password may be used to authenticate when the number of failed bind
- * attempts has been reached.</li>
- * <li>{@link PwPolicy#lockoutDuration} - This attribute holds the number of seconds that the password cannot
- * be used to authenticate due to too many failed bind attempts. If
- * this attribute is not present, or if the value is 0 the password
- * cannot be used to authenticate until reset by a password
- * administrator.</li>
- * <li>{@link PwPolicy#maxFailure} - This attribute specifies the number of consecutive failed bind
- * attempts after which the password may not be used to authenticate.
- * If this attribute is not present, or if the value is 0, this policy
- * is not checked, and the value of pwdLockout will be ignored.</li>
- * <li>{@link PwPolicy#failureCountInterval} - This attribute holds the number of seconds after which the password
- * failures are purged from the failure counter, even though no
- * successful authentication occurred. If this attribute is not present, or if its value is 0, the failure
- * counter is only reset by a successful authentication.</li>
- * <li>{@link PwPolicy#mustChange} - This attribute specifies with a value of "TRUE" that users must
- * change their passwords when they first bind to the directory after a
- * password is set or reset by a password administrator. If this
- * attribute is not present, or if the value is "FALSE", users are not
- * required to change their password upon binding after the password
- * administrator sets or resets the password. This attribute is not set
- * due to any actions specified by this document, it is typically set by
- * a password administrator after resetting a user's password.</li>
- * <li>{@link PwPolicy#allowUserChange} - This attribute indicates whether users can change their own
- * passwords, although the change operation is still subject to access
- * control. If this attribute is not present, a value of "TRUE" is
- * assumed. This attribute is intended to be used in the absence of an access control mechanism.</li>
- * <li>{@link PwPolicy#safeModify} - This attribute specifies whether or not the existing password must be
- * sent along with the new password when being changed. If this
- * attribute is not present, a "FALSE" value is assumed.</li>
- * <li>{@link PwPolicy#checkQuality} - This attribute indicates how the password quality will be verified
- * while being modified or added. If this attribute is not present, or
- * if the value is '0', quality checking will not be enforced. A value
- * of '1' indicates that the server will check the quality, and if the
- * server is unable to check it (due to a hashed password or other
- * reasons) it will be accepted. A value of '2' indicates that the
- * server will check the quality, and if the server is unable to verify
- * it, it will return an error refusing the password. </li>
- * <li>{@link PwPolicy#attribute} - This holds the name of the attribute to which the password policy is
- * applied. For example, the password policy may be applied to the
- * userPassword attribute </li>
- * </ul>
- *
- * @param policy Object must contain {@link PwPolicy#name} and optionally all non-null attributes will be updated. null attributes will be ignored.
- * @throws SecurityException In the event policy not found , data validation or system error.
+ * {@inheritDoc}
*/
@Override
public void update(PwPolicy policy)
@@ -256,16 +92,7 @@ public class PwPolicyMgrImpl extends Manageable implements PwPolicyMgr
/**
- * This method will delete exiting policy entry from the POLICIES data set. This command is valid
- * if and only if the policy entry is already present in the POLICIES data set. Existing users that
- * are assigned this policy will be removed from association.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PwPolicy#name} - Maps to name attribute of pwdPolicy object class being removed.</li>
- * </ul>
- *
- * @param policy Object must contain {@link PwPolicy#name} of the policy entity to remove.
- * @throws org.apache.directory.fortress.core.SecurityException In the event policy entity not found or system error.
+ * {@inheritDoc}
*/
@Override
public void delete(PwPolicy policy)
@@ -280,16 +107,7 @@ public class PwPolicyMgrImpl extends Manageable implements PwPolicyMgr
/**
- * This method will return the password policy entity to the caller. This command is valid
- * if and only if the policy entry is present in the POLICIES data set.
- * <h4>required parameters</h4>
- * <ul>
- * <li>{@link PwPolicy#name} - Maps to name attribute of pwdPolicy object class being read.</li>
- * </ul>
- *
- * @return PswdPolicy entity returns fully populated with attributes.
- * @return PswdPolicy entity returns fully populated with attributes.
- * @throws SecurityException In the event policy entry not found, data validation or system error.
+ * {@inheritDoc}
*/
@Override
public PwPolicy read(String name)
@@ -305,12 +123,7 @@ public class PwPolicyMgrImpl extends Manageable implements PwPolicyMgr
/**
- * This method will return a list of all password policy entities that match a particular search string.
- * This command will return an empty list of no matching entries are found.
- *
- * @param searchVal String contains the leading chars of a policy entity. This search is not case sensitive.
- * @return List<PswdPolicy> contains all matching password policy entities. If no records found this will be empty.
- * @throws SecurityException In the event of data validation or system error.
+ * {@inheritDoc}
*/
@Override
public List<PwPolicy> search(String searchVal)
@@ -326,13 +139,7 @@ public class PwPolicyMgrImpl extends Manageable implements PwPolicyMgr
/**
- * This method will associate a user entity with a password policy entity. This function is valid
- * if and only if the user is a member of the USERS data set and the policyName refers to a
- * policy that is a member of the PWPOLICIES data set.
- *
- * @param userId Contains {@link org.apache.directory.fortress.core.model.User#userId} of a User entity in USERS data set.
- * @param policyName String contains the {@link PwPolicy#name} of a pw policy entity contained within the PWPOLICIES data set.
- * @throws SecurityException thrown in the event either user or policy not valid or system error.
+ * {@inheritDoc}
*/
@Override
public void updateUserPolicy(String userId, String policyName)
@@ -350,13 +157,7 @@ public class PwPolicyMgrImpl extends Manageable implements PwPolicyMgr
/**
- * This method will remove the pw policy assignment from a user entity. This function is valid
- * if and only if the user is a member of the USERS data set and the policy attribute is assigned.
- * Removal of pw policy assignment will revert the user's policy to use the global default for OpenLDAP
- * instance that contains user.
- *
- * @param userId Contains {@link org.apache.directory.fortress.core.model.User#userId} of a User entity in USERS data set.
- * @throws SecurityException Thrown in the event either user not valid or system error.
+ * {@inheritDoc}
*/
@Override
public void deletePasswordPolicy(String userId)