directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject [2/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Date Sat, 02 Jan 2016 03:52:55 GMT
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 )


Mime
View raw message