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 2019/12/10 23:03:34 UTC
[directory-fortress-core] branch master updated: FC-275 - some java
doc cleanup
This is an automated email from the ASF dual-hosted git repository.
smckinney pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-fortress-core.git
The following commit(s) were added to refs/heads/master by this push:
new 2c63970 FC-275 - some java doc cleanup
2c63970 is described below
commit 2c6397059dc9926cb28f14b5444fd06fe23bdfc6
Author: smckinney <sm...@apache.org>
AuthorDate: Tue Dec 10 17:03:28 2019 -0600
FC-275 - some java doc cleanup
---
.../apache/directory/fortress/core/AccelMgr.java | 46 +-
.../apache/directory/fortress/core/AdminMgr.java | 508 ++++++++++-----------
.../apache/directory/fortress/core/ConfigMgr.java | 32 +-
.../apache/directory/fortress/core/ReviewMgr.java | 158 +++----
.../directory/fortress/core/SecurityException.java | 4 +-
.../directory/fortress/core/cli/package.html | 3 +-
.../directory/fortress/core/model/AdminRole.java | 8 +-
.../directory/fortress/core/model/AuthZ.java | 24 +-
8 files changed, 389 insertions(+), 394 deletions(-)
diff --git a/src/main/java/org/apache/directory/fortress/core/AccelMgr.java b/src/main/java/org/apache/directory/fortress/core/AccelMgr.java
index 1153e81..eee5413 100644
--- a/src/main/java/org/apache/directory/fortress/core/AccelMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/AccelMgr.java
@@ -71,15 +71,15 @@ public interface AccelMgr extends Manageable
{
/**
- * Perform user authentication {@link User#password} and role activations.
+ * Perform user authentication 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 User#roles} and
- * Admin role {@link User#adminRoles}.
+ * User#roles and
+ * Admin role User#adminRole.
* <br>
* In addition to checking user password validity it will apply configured password policy checks
- * {@link org.apache.directory.fortress.core.model.User#pwPolicy}.
+ * 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}.
* <h3></h3>
@@ -101,7 +101,7 @@ public interface AccelMgr extends Manageable
* 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>
- * <li>process selective role activations into User RBAC Session {@link User#roles}.</li>
+ * <li>process selective role activations into User RBAC Session User#roles.</li>
* <li>
* check Dynamic Separation of Duties
* {@link org.apache.directory.fortress.core.impl.DSDChecker#validate(
@@ -109,9 +109,9 @@ public interface AccelMgr extends Manageable
* org.apache.directory.fortress.core.model.Constraint,
* org.apache.directory.fortress.core.util.time.Time,
* org.apache.directory.fortress.core.util.VUtil.ConstraintType)}
- * on {@link org.apache.directory.fortress.core.model.User#roles}.
+ * on org.apache.directory.fortress.core.model.User#roles.
* </li>
- * <li> process selective administrative role activations {@link User#adminRoles}.</li>
+ * <li> process selective administrative role activations User#adminRoles.</li>
* <li>
* return a {@link org.apache.directory.fortress.core.model.Session} containing
* {@link org.apache.directory.fortress.core.model.Session#getUser()},
@@ -136,19 +136,19 @@ public interface AccelMgr extends Manageable
* The following attributes may be set when calling this method
* </h4>
* <ul>
- * <li> {@link User#userId} - required</li>
- * <li> {@link org.apache.directory.fortress.core.model.User#password}</li>
+ * <li> @link User#userId - required</li>
+ * <li> org.apache.directory.fortress.core.model.User#password</li>
* <li>
- * {@link org.apache.directory.fortress.core.model.User#roles} contains a list of RBAC role names authorized
+ * 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>
* <li>
- * {@link org.apache.directory.fortress.core.model.User#adminRoles} contains a list of Admin role names authorized
+ * 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>
* <li>
- * {@link User#props} collection of name value pairs collected on behalf of User during signon. For example
+ * User#props collection of name value pairs collected on behalf of User during signon. For example
* hostname:myservername or ip:192.168.1.99
* </li>
* </ul>
@@ -158,21 +158,21 @@ public interface AccelMgr extends Manageable
* <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)}.
+ * role activations will proceed in same order as supplied to User entity setter, see User#setRole(String).
* </li>
* </ul>
*
- * @param user Contains {@link User#userId}, {@link org.apache.directory.fortress.core.model.User#password}
- * (optional if {@code isTrusted} is 'true'), optional {@link User#roles}, optional
- * {@link org.apache.directory.fortress.core.model.User#adminRoles}
+ * @param user Contains User#userId, org.apache.directory.fortress.core.model.User#password
+ * (optional if {@code isTrusted} is 'true'), optional User#roles, optional
+ * 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},
+ * org.apache.directory.fortress.core.model.Session#errorId,
* RBAC role activations {@link org.apache.directory.fortress.core.model.Session#getRoles()},
* Admin Role activations {@link org.apache.directory.fortress.core.model.Session#getAdminRoles()},
- * OpenLDAP pw policy codes {@link org.apache.directory.fortress.core.model.Session#warnings},
- * {@link org.apache.directory.fortress.core.model.Session#expirationSeconds},
- * {@link org.apache.directory.fortress.core.model.Session#graceLogins} and more.
+ * OpenLDAP pw policy codes org.apache.directory.fortress.core.model.Session#warnings,
+ * org.apache.directory.fortress.core.model.Session#expirationSeconds,
+ * org.apache.directory.fortress.core.model.Session#graceLogins and more.
* @throws SecurityException
* in the event of data validation failure, security policy violation or DAO error.
*/
@@ -212,7 +212,7 @@ public interface AccelMgr extends Manageable
* 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
+ * @param perm must contain the object, Permission#objName, and operation, Permission#opName, of
* permission User is trying to access.
* @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing
* into the method. No variables need to be set by client after returned from createSession.
@@ -251,7 +251,7 @@ public interface AccelMgr extends Manageable
* </ul>
*
* @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.
+ * @param role object contains the role name, UserRole#name, to be activated into session.
* @throws SecurityException is thrown if user is not allowed to activate or runtime error occurs with system.
*/
void addActiveRole( Session session, UserRole role )
@@ -265,7 +265,7 @@ public interface AccelMgr extends Manageable
* 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 org.apache.directory.fortress.core.model.UserRole#name},
+ * @param role object contains the role name, org.apache.directory.fortress.core.model.UserRole#name,
* to be deactivated.
* @throws SecurityException is thrown if user is not allowed to deactivate or runtime error occurs with system.
*/
diff --git a/src/main/java/org/apache/directory/fortress/core/AdminMgr.java b/src/main/java/org/apache/directory/fortress/core/AdminMgr.java
index ef0eaab..a6b838d 100755
--- a/src/main/java/org/apache/directory/fortress/core/AdminMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/AdminMgr.java
@@ -81,48 +81,48 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
- * <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>User#userId - maps to INetOrgPerson uid</li>
+ * <li>User#password - used to authenticate the User</li>
+ * <li>User#ou - contains the name of an already existing User OU node</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <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#title} - maps to INetOrgPerson title attribute</li>
- * <li>{@link User#employeeType} - maps to INetOrgPerson employeeType attribute</li>
- * <li>{@link User#phones} * - multivalued attribute maps to organizationalPerson telephoneNumber attribute</li>
- * <li>{@link User#mobiles} * - multivalued attribute maps to INetOrgPerson mobile attribute</li>
- * <li>{@link User#emails} * - multivalued attribute maps to INetOrgPerson mail attribute</li>
+ * <li>User#pwPolicy - contains the name of an already existing OpenLDAP password policy node</li>
+ * <li>User#cn - maps to INetOrgPerson common name attribute</li>
+ * <li>User#sn - maps to INetOrgPerson surname attribute</li>
+ * <li>User#description - maps to INetOrgPerson description attribute</li>
+ * <li>User#title - maps to INetOrgPerson title attribute</li>
+ * <li>User#employeeType - maps to INetOrgPerson employeeType attribute</li>
+ * <li>User#phones * - multivalued attribute maps to organizationalPerson telephoneNumber attribute</li>
+ * <li>User#mobiles * - multivalued attribute maps to INetOrgPerson mobile attribute</li>
+ * <li>User#emails * - multivalued attribute maps to INetOrgPerson mail attribute</li>
* <li>
- * {@link User#address} * - multivalued attribute maps to organizationalPerson postalAddress, st,
+ * User#address * - multivalued 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 minutes) of session inactivity time allowed</li>
+ * <li>User#beginTime - HHMM - determines begin hour user may activate session</li>
+ * <li>User#endTime - HHMM - determines end hour user may activate session.</li>
+ * <li>User#beginDate - YYYYMMDD - determines date when user may sign on</li>
+ * <li>User#endDate - YYYYMMDD - indicates latest date user may sign on</li>
+ * <li>User#beginLockDate - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>User#endLockDate - YYYYMMDD - determines end of enforced inactive status</li>
+ * <li>User#dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of user may sign on</li>
+ * <li>User#timeout - number (in minutes) of session inactivity time allowed</li>
* <li>
- * {@link User#props} * - multivalued attribute contains property key and values are separated with a ':'.
+ * User#props * - multivalued attribute contains property key and values are separated with a ':'.
* e.g. mykey1:myvalue1
* </li>
* <li>
- * {@link User#roles} * - multivalued attribute contains the name of already existing role to assign to user
+ * User#roles * - multivalued attribute contains the name of already existing role to assign to user
* </li>
* <li>
- * {@link User#adminRoles} * - multivalued attribute contains the name of already existing adminRole to assign
+ * User#adminRoles * - multivalued attribute contains the name of already existing adminRole to assign
* to user
* </li>
* </ul>
*
- * @param user User entity must contain {@link User#userId} and {@link User#ou} (required) and optional
- * {@link User#description},{@link User#roles} and many others.
+ * @param user User entity must contain User#userId and User#ou (required) and optional
+ * User#description,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.
*/
@@ -144,10 +144,10 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
+ * <li>User#userId - maps to INetOrgPerson uid</li>
* </ul>
*
- * @param user Contains the {@link User#userId} of the User targeted for deletion.
+ * @param user Contains the User#userId of the User targeted for deletion.
* @throws SecurityException thrown in the event of data validation or system error.
*/
void disableUser( User user )
@@ -163,10 +163,10 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
+ * <li>User#userId - maps to INetOrgPerson uid</li>
* </ul>
*
- * @param user Contains the {@link User#userId} of the User targeted for deletion.
+ * @param user Contains the User#userId of the User targeted for deletion.
* @throws SecurityException thrown in the event of data validation or system error.
*/
void deleteUser( User user )
@@ -179,47 +179,47 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
+ * <li>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#title} - maps to INetOrgPerson title attribute</li>
- * <li>{@link User#employeeType} - maps to INetOrgPerson employeeType attribute</li>
- * <li>{@link User#phones} * - multivalued attribute maps to organizationalPerson telephoneNumber attribute</li>
- * <li>{@link User#mobiles} * - multivalued attribute maps to INetOrgPerson mobile attribute</li>
- * <li>{@link User#emails} * - multivalued attribute maps to INetOrgPerson mail attribute</li>
+ * <li>User#password - used to authenticate the User</li>
+ * <li>User#ou - contains the name of an already existing User OU node</li>
+ * <li>User#pwPolicy - contains the name of an already existing OpenLDAP password policy node</li>
+ * <li>User#cn - maps to INetOrgPerson common name attribute</li>
+ * <li>User#sn - maps to INetOrgPerson surname attribute</li>
+ * <li>User#description - maps to INetOrgPerson description attribute</li>
+ * <li>User#title - maps to INetOrgPerson title attribute</li>
+ * <li>User#employeeType - maps to INetOrgPerson employeeType attribute</li>
+ * <li>User#phones * - multivalued attribute maps to organizationalPerson telephoneNumber attribute</li>
+ * <li>User#mobiles * - multivalued attribute maps to INetOrgPerson mobile attribute</li>
+ * <li>User#emails * - multivalued attribute maps to INetOrgPerson mail attribute</li>
* <li>
- * {@link User#address} * - multivalued attribute maps to organizationalPerson postalAddress, st, l,
+ * User#address * - multivalued 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 minutes) of session inactivity time allowed</li>
+ * <li>User#beginTime - HHMM - determines begin hour user may activate session</li>
+ * <li>User#endTime - HHMM - determines end hour user may activate session.</li>
+ * <li>User#beginDate - YYYYMMDD - determines date when user may sign on</li>
+ * <li>User#endDate - YYYYMMDD - indicates latest date user may sign on</li>
+ * <li>User#beginLockDate - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>User#endLockDate - YYYYMMDD - determines end of enforced inactive status</li>
+ * <li>User#dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of user may sign on</li>
+ * <li>User#timeout - number (in minutes) of session inactivity time allowed</li>
* <li>
- * {@link User#props} * - multivalued attribute contains property key and values are separated with a ':'.
+ * User#props * - multivalued attribute contains property key and values are separated with a ':'.
* e.g. mykey1:myvalue1
* </li>
* <li>
- * {@link User#roles} * - multivalued attribute contains the name of already existing role to assign to user
+ * User#roles * - multivalued attribute contains the name of already existing role to assign to user
* </li>
* <li>
- * {@link User#adminRoles} * - multivalued attribute contains the name of already existing adminRole to assign
+ * User#adminRoles * - multivalued 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
+ * @param user must contain 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 validation or system error.
@@ -233,12 +233,12 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>User#userId - maps to INetOrgPerson uid</li>
+ * <li>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 user contains User#userId and old user password User#password.
* @param newPassword contains new user password.
* @throws SecurityException will be thrown in the event of password policy violation or system error.
*/
@@ -251,10 +251,10 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
+ * <li>User#userId - maps to INetOrgPerson uid</li>
* </ul>
*
- * @param user entity contains {@link User#userId} of User to be locked.
+ * @param user entity contains User#userId of User to be locked.
* @throws SecurityException will be thrown in the event of pw policy violation or system error.
*/
void lockUserAccount( User user )
@@ -266,10 +266,10 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
+ * <li>User#userId - maps to INetOrgPerson uid</li>
* </ul>
*
- * @param user entity contains {@link User#userId} of User to be unlocked.
+ * @param user entity contains User#userId of User to be unlocked.
* @throws SecurityException will be thrown in the event of pw policy violation or system error.
*/
void unlockUserAccount( User user )
@@ -283,11 +283,11 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
+ * <li>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.
+ * @param user entity contains User#userId of User to be reset.
* @param newPassword The new password to set
* @throws SecurityException will be thrown in the event of pw policy violation or system error.
*/
@@ -300,11 +300,11 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - maps to INetOrgPerson uid</li>
+ * <li>User#userId - maps to INetOrgPerson uid</li>
* <li>newPassword - contains the User's new password</li>
* </ul>
*
- * @param user contains {@link User#userId}.
+ * @param user contains User#userId.
* @throws SecurityException will be thrown in the event of password policy violation or system error.
*/
void deletePasswordPolicy( User user )
@@ -318,24 +318,24 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to be created.</li>
+ * <li>Role#name - contains the name to use for the Role to be created.</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>Role#description - maps to description attribute on organizationalRole object class</li>
+ * <li>Role#beginTime - HHMM - determines begin hour role may be activated into user's RBAC session</li>
+ * <li>Role#endTime - HHMM - determines end hour role may be activated into user's RBAC session.</li>
+ * <li>Role#beginDate - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
+ * <li>Role#endDate - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
+ * <li>Role#beginLockDate - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>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
+ * 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} (required) and optional {@link Role#description}.
+ * @param role must contains Role#name (required) and optional Role#description.
* @return copy of the added Role
* @throws SecurityException thrown in the event of data validation or system error.
*/
@@ -350,9 +350,9 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to be deleted.</li>
+ * <li>Role#name - contains the name to use for the Role to be deleted.</li>
* </ul>
- * @param role Must contain {@link Role#name} for Role to delete.
+ * @param role Must contain Role#name for Role to delete.
* @throws SecurityException thrown in the event of data validation or system error.
*/
void deleteRole( Role role )
@@ -364,23 +364,23 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to be updated.</li>
+ * <li>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>Role#description - maps to description attribute on organizationalRole object class</li>
+ * <li>Role#beginTime - HHMM - determines begin hour role may be activated into user's RBAC session</li>
+ * <li>Role#endTime - HHMM - determines end hour role may be activated into user's RBAC session.</li>
+ * <li>Role#beginDate - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
+ * <li>Role#endDate - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
+ * <li>Role#beginLockDate - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>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
+ * {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
+ * @param role Must contains 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 SecurityException in the event of validation or system error.
@@ -427,24 +427,24 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link UserRole#name} - contains the name for already existing Role to be assigned</li>
- * <li>{@link UserRole#userId} - contains the userId for existing User</li>
+ * <li>UserRole#name - contains the name for already existing Role to be assigned</li>
+ * <li>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 UserRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link UserRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
+ * <li>UserRole#beginTime - HHMM - determines begin hour role may be activated into user's RBAC session</li>
+ * <li>UserRole#endTime - HHMM - determines end hour role may be activated into user's RBAC session.</li>
+ * <li>UserRole#beginDate - YYYYMMDD - determines date when role may be activated into user's RBAC session</li>
+ * <li>UserRole#endDate - YYYYMMDD - indicates latest date role may be activated into user's RBAC session</li>
+ * <li>UserRole#beginLockDate - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>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
+ * 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}.
+ * @param uRole must contain UserRole#userId and UserRole#name and optional {@code Constraints}.
* @throws SecurityException in the event of validation or system error.
*/
void assignUser( UserRole uRole )
@@ -454,12 +454,12 @@ public interface AdminMgr extends Manageable
* This method enables a role to be constrainted by attributes.
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name for already existing Role to be constrained</li>
- * <li>{@link RoleConstraint#key} - contains the name of the constraint, e.g. locale, organization, or accountnumber</li>
+ * <li>Role#name - contains the name for already existing Role to be constrained</li>
+ * <li>RoleConstraint#key - contains the name of the constraint, e.g. locale, organization, or accountnumber</li>
* </ul>
*
- * @param role must contain {@link Role#name}
- * @param roleConstraint must contain {@link RoleConstraint#key}
+ * @param role must contain Role#name
+ * @param roleConstraint must contain RoleConstraint#key
* @throws SecurityException in the event of validation or system error.
*/
public void enableRoleConstraint( Role role, RoleConstraint roleConstraint )
@@ -469,12 +469,12 @@ public interface AdminMgr extends Manageable
* This method disables a role to be constrainted by attributes.
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name for already existing Role to be unconstrained</li>
- * <li>{@link RoleConstraint#key} - contains the name of the constraint, e.g. locale, organization, or accountnumber</li>
+ * <li>Role#name - contains the name for already existing Role to be unconstrained</li>
+ * <li>RoleConstraint#key - contains the name of the constraint, e.g. locale, organization, or accountnumber</li>
* </ul>
*
- * @param role must contain {@link Role#name}
- * @param roleConstraint must contain {@link RoleConstraint#key}
+ * @param role must contain Role#name
+ * @param roleConstraint must contain RoleConstraint#key
* @throws SecurityException in the event of validation or system error.
*/
public void disableRoleConstraint( Role role, RoleConstraint roleConstraint )
@@ -484,15 +484,15 @@ public interface AdminMgr extends Manageable
* This method adds a roleConstraint (ftRC) to the user ldap entry. (ftRC=ROLE_NAME$type$CONSTRAINT_TYPE$CONSTRAINT_PASETNAME$CONSTRAINT_VALUE)
* <h4>required parameters</h4>
* <ul>
- * <li>{@link UserRole#name} - contains the name for already existing Role to be assigned</li>
- * <li>{@link UserRole#userId} - contains the userId for existing User</li>
- * <li>{@link RoleConstraint#type} - contains the type of role constraint (filter, other)</li>
- * <li>{@link RoleConstraint#value} - contains the value of the role constraint which is currently not validated in any way</li>
- * <li>{@link RoleConstraint#key} - contains the name of the permission attribute set this constraint is applicable for</li>
+ * <li>UserRole#name - contains the name for already existing Role to be assigned</li>
+ * <li>UserRole#userId - contains the userId for existing User</li>
+ * <li>RoleConstraint#type - contains the type of role constraint (filter, other)</li>
+ * <li>RoleConstraint#value - contains the value of the role constraint which is currently not validated in any way</li>
+ * <li>RoleConstraint#key - contains the name of the permission attribute set this constraint is applicable for</li>
* </ul>
*
- * @param uRole must contain {@link UserRole#userId} and {@link UserRole#name}
- * @param roleConstraint must contain {@link RoleConstraint#type} and {@link RoleConstraint#value} and {@link RoleConstraint#paSetName}
+ * @param uRole must contain UserRole#userId and UserRole#name
+ * @param roleConstraint must contain RoleConstraint#type, RoleConstraint#value and RoleConstraint#paSetName
* @return RoleConstraint that was added to user role assignment
* @throws SecurityException in the event of validation or system error.
*/
@@ -503,15 +503,15 @@ public interface AdminMgr extends Manageable
* Thie method removes a roleConstraint (ftRC) from the user ldap entry.
* <h4>required parameters</h4>
* <ul>
- * <li>{@link UserRole#name} - contains the name for already existing Role to be assigned</li>
- * <li>{@link UserRole#userId} - contains the userId for existing User</li>
- * <li>{@link RoleConstraint#type} - contains the type of role constraint (filter, other)</li>
- * <li>{@link RoleConstraint#value} - contains the value of the role constraint which is currently not validated in any way</li>
- * <li>{@link RoleConstraint#paSetName} - contains the name of the permission attribute set this constraint is applicable for</li>
+ * <li>UserRole#name - contains the name for already existing Role to be assigned</li>
+ * <li>UserRole#userId - contains the userId for existing User</li>
+ * <li>RoleConstraint#type - contains the type of role constraint (filter, other)</li>
+ * <li>RoleConstraint#value - contains the value of the role constraint which is currently not validated in any way</li>
+ * <li>RoleConstraint#paSetName - contains the name of the permission attribute set this constraint is applicable for</li>
* </ul>
*
- * @param uRole must contain {@link UserRole#userId} and {@link UserRole#name}
- * @param roleConstraint must contain {@link RoleConstraint#type} and {@link RoleConstraint#value} and {@link RoleConstraint#paSetName}
+ * @param uRole must contain UserRole#userId and UserRole#name
+ * @param roleConstraint must contain RoleConstraint#type, RoleConstraint#value and RoleConstraint#paSetName
* @throws SecurityException in the event of validation or system error.
*/
void removeRoleConstraint( UserRole uRole, RoleConstraint roleConstraint )
@@ -521,14 +521,14 @@ public interface AdminMgr extends Manageable
* Thie method removes a roleConstraint (ftRC) from the user ldap entry.
* <h4>required parameters</h4>
* <ul>
- * <li>{@link UserRole#name} - contains the name for already existing Role to be assigned</li>
- * <li>{@link UserRole#userId} - contains the userId for existing User</li>
- * <li>{@link RoleConstraint#type} - contains the type of role constraint (filter, other)</li>
- * <li>{@link RoleConstraint#value} - contains the value of the role constraint which is currently not validated in any way</li>
- * <li>{@link RoleConstraint#paSetName} - contains the userId for existing User, contains the name of the permission attribute set this constraint is applicable for</li>
+ * <li>UserRole#name - contains the name for already existing Role to be assigned</li>
+ * <li>UserRole#userId - contains the userId for existing User</li>
+ * <li>RoleConstraint#type - contains the type of role constraint (filter, other)</li>
+ * <li>RoleConstraint#value - contains the value of the role constraint which is currently not validated in any way</li>
+ * <li>RoleConstraint#paSetName - contains the userId for existing User, contains the name of the permission attribute set this constraint is applicable for</li>
* </ul>
*
- * @param uRole must contain {@link UserRole#userId} and {@link UserRole#name}
+ * @param uRole must contain UserRole#userId} and UserRole#name}
* @param roleConstraintId id of the role constraint to remove
* @throws SecurityException in the event of validation or system error.
*/
@@ -549,10 +549,10 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>UserRole#name - contains the name for already existing Role to be deassigned</li>
+ * <li>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}.
+ * @param uRole must contain org.apache.directory.fortress.core.model.UserRole#userId} and UserRole#name}.
* @throws SecurityException - in the event data error in user or role objects or system error.
*/
void deassignUser( UserRole uRole )
@@ -563,34 +563,34 @@ public interface AdminMgr extends Manageable
* 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 Permission} must not exist
+ * {@link org.apache.directory.fortress.core.model.User} associations. The target 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 Permission}).
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted for the permission add</li>
- * <li>{@link Permission#opName} - contains the name of new permission operation being added</li>
+ * <li>Permission#objName - contains the name of existing object being targeted for the permission add</li>
+ * <li>Permission#opName - contains the name of new permission operation being added</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
* <li>
- * {@link Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being
+ * 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
+ * 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.
+ * 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>
+ * <li>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 Permission#opName}, that identifies target along with optional other attributes..
+ * @param perm must contain the object, org.apache.directory.fortress.core.model.Permission#objName}, and operation, 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.
*/
@@ -604,10 +604,10 @@ public interface AdminMgr extends Manageable
* The attribute set may contain 0 to many {@link org.apache.directory.fortress.core.model.PermissionAttribute}
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermissionAttributeSet#name} - contains the name of the permission attribute set</li>
+ * <li>PermissionAttributeSet#name - contains the name of the permission attribute set</li>
* </ul>
*
- * @param permAttributeSet must contain {@link PermissionAttributeSet#name}
+ * @param permAttributeSet must contain PermissionAttributeSet#name}
* @return PermissionAttributeSet that was created
* @throws SecurityException - thrown in the event of perm attribute set data or system error.
*/
@@ -618,10 +618,10 @@ public interface AdminMgr extends Manageable
* This method will delete a permission attribute set object.
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermissionAttributeSet#name} - contains the name of the permission attribute set</li>
+ * <li>PermissionAttributeSet#name - contains the name of the permission attribute set</li>
* </ul>
*
- * @param permAttributeSet must contain {@link PermissionAttributeSet#name}
+ * @param permAttributeSet must contain PermissionAttributeSet#name}
* @throws SecurityException - thrown in the event of perm attribute set data or system error.
*/
void deletePermissionAttributeSet( PermissionAttributeSet permAttributeSet )
@@ -632,19 +632,19 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermissionAttribute#attributeName} - contains the name of existing object being targeted for the permission update</li>
- * <li>{@link PermissionAttribute#dataType} - contains the data type of the permission attribute values (string,int,long,float)</li>
+ * <li>PermissionAttribute#attributeName - contains the name of existing object being targeted for the permission update</li>
+ * <li>PermissionAttribute#dataType - contains the data type of the permission attribute values (string,int,long,float)</li>
* <li>attributeSetName - contains the name of existing permission attribute set being modified</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link PermissionAttribute#required} - Flag to specify this attribute is required, defaults to false.</li>
- * <li>{@link PermissionAttribute#operator} - Can specify an operator this attribute must use.</li>
- * <li>{@link PermissionAttribute#validValues} - CSV of valid values. Currently up to interpreting application to understand these.</li>
- * <li>{@link PermissionAttribute#defaultValue} - A default value for the attribute value if none is specified.</li>
+ * <li>PermissionAttribute#required - Flag to specify this attribute is required, defaults to false.</li>
+ * <li>PermissionAttribute#operator - Can specify an operator this attribute must use.</li>
+ * <li>PermissionAttribute#validValues - CSV of valid values. Currently up to interpreting application to understand these.</li>
+ * <li>PermissionAttribute#defaultValue - A default value for the attribute value if none is specified.</li>
* </ul>
*
- * @param permAttribute must contain {@link PermissionAttribute#attributeName} and {@link PermissionAttribute#dataType}
+ * @param permAttribute must contain PermissionAttribute#attributeName} and PermissionAttribute#dataType}
* @param attributeSetName The name of the permission attribute set this ftPA should be added.
* @return PermissionAttribute entity created
* @throws SecurityException - thrown in the event of data or system error
@@ -657,11 +657,11 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermissionAttribute#attributeName} - contains the name of existing object being targeted for the permission update</li>
+ * <li>PermissionAttribute#attributeName - contains the name of existing object being targeted for the permission update</li>
* <li>attributeSetName - contains the name of existing permission attribute set being modified</li>
* </ul>
*
- * @param permAttribute must contain {@link PermissionAttribute#attributeName}
+ * @param permAttribute must contain PermissionAttribute#attributeName}
* @param attributeSetName The name of the permission attribute set this pa should be removed from
* @throws SecurityException - thrown in the event of data or system error
*/
@@ -673,19 +673,19 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermissionAttribute#attributeName} - contains the name of existing object being targeted for the permission update</li>
- * <li>{@link PermissionAttribute#dataType} - contains the data type of the permission attribute values (string,int,long,float)</li>
+ * <li>PermissionAttribute#attributeName - contains the name of existing object being targeted for the permission update</li>
+ * <li>PermissionAttribute#dataType - contains the data type of the permission attribute values (string,int,long,float)</li>
* <li>attributeSetName - contains the name of existing permission attribute set being modified</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link PermissionAttribute#required} - Flag to specify this attribute is required, defaults to false.</li>
- * <li>{@link PermissionAttribute#operator} - Can specify an operator this attribute must use.</li>
- * <li>{@link PermissionAttribute#validValues} - CSV of valid values. Currently up to interpreting application to understand these.</li>
- * <li>{@link PermissionAttribute#defaultValue} - A default value for the attribute value if none is specified.</li>
+ * <li>PermissionAttribute#required - Flag to specify this attribute is required, defaults to false.</li>
+ * <li>PermissionAttribute#operator - Can specify an operator this attribute must use.</li>
+ * <li>PermissionAttribute#validValues - CSV of valid values. Currently up to interpreting application to understand these.</li>
+ * <li>PermissionAttribute#defaultValue - A default value for the attribute value if none is specified.</li>
* </ul>
*
- * @param permAttribute must contain {@link PermissionAttribute#attributeName} and {@link PermissionAttribute#dataType}
+ * @param permAttribute must contain PermissionAttribute#attributeName} and PermissionAttribute#dataType}
* @param attributeSetName The name of the permission attribute set this ftPA should be updated.
* @return PermissionAttribute entity created
* @throws SecurityException - thrown in the event of data or system error
@@ -702,27 +702,27 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the name of existing object being targeted for the permission update</li>
+ * <li>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
+ * 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
+ * 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.
+ * 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>
+ * <li>Permission#type - any safe text</li>
* </ul>
*
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that
+ * @param perm must contain the object, Permission#objName}, and operation, Permission#opName}, that
* identifies target and any optional data to update. Null or empty attributes will be ignored.
* @return copy of Permission entity.
* @throws SecurityException
@@ -739,11 +739,11 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the name of existing object being targeted for the permission delete</li>
+ * <li>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
+ * @param perm must contain the object, Permission#objName}, and operation, Permission#opName}, that
* identifies target.
* @throws SecurityException - thrown in the event of perm object data or system error.
*/
@@ -755,23 +755,23 @@ public interface AdminMgr extends Manageable
* This method will add permission object to 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}).
+ * ldap tree: ({@link PermObj}*->Permission}).
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermObj#objName} - contains the name of new object being added</li>
- * <li>{@link PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
+ * <li>PermObj#objName - contains the name of new object being added</li>
+ * <li>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>PermObj#description - any safe text</li>
+ * <li>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
+ * 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.
+ * @param pObj must contain the PermObj#objName} and 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.
*/
@@ -787,19 +787,19 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object being updated</li>
+ * <li>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>PermObj#ou - contains the name of an existing PERMS OrgUnit this object is associated with</li>
+ * <li>PermObj#description - any safe text</li>
+ * <li>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
+ * 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.
+ * @param pObj must contain the PermObj#objName}. Only non-null attributes will be updated.
* @return copy of newly updated PermObj entity.
* @throws SecurityException
* - thrown in the event of perm object data or system error.
@@ -814,10 +814,10 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object targeted for removal</li>
+ * <li>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.
+ * @param pObj must contain the PermObj#objName} of object targeted for removal.
* @throws SecurityException - thrown in the event of perm object data or system error.
*/
void deletePermObj( PermObj pObj )
@@ -833,14 +833,14 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the object name</li>
+ * <li>Permission#opName - contains the operation name</li>
+ * <li>Role#name - contains the role name</li>
* </ul>
*
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that
+ * @param perm must contain the object, Permission#objName}, and operation, Permission#opName}, that
* identifies target.
- * @param role must contains {@link Role#name}.
+ * @param role must contains Role#name}.
* @throws SecurityException Thrown in the event of data validation or system error.
*/
void grantPermission( Permission perm, Role role )
@@ -856,14 +856,14 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the object name</li>
+ * <li>Permission#opName - contains the operation name</li>
+ * <li>Role#name - contains the role name</li>
* </ul>
*
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that
+ * @param perm must contain the object, Permission#objName}, and operation, Permission#opName}, that
* identifies target.
- * @param role must contains {@link Role#name}.
+ * @param role must contains Role#name}.
* @throws SecurityException Thrown in the event of data validation or system error.
*/
void revokePermission( Permission perm, Role role )
@@ -879,14 +879,14 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the object name</li>
+ * <li>Permission#opName - contains the operation name</li>
+ * <li>User#userId - contains the userId</li>
* </ul>
*
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName},
+ * @param perm must contain the object, Permission#objName}, and operation, Permission#opName},
* that identifies target.
- * @param user must contain {@link User#userId} of target User entity.
+ * @param user must contain User#userId} of target User entity.
* @throws SecurityException Thrown in the event of data validation or system error.
*/
void grantPermission( Permission perm, User user )
@@ -902,14 +902,14 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the object name</li>
+ * <li>Permission#opName - contains the operation name</li>
+ * <li>User#userId - contains the userId</li>
* </ul>
*
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that
+ * @param perm must contain the object, Permission#objName}, and operation, Permission#opName}, that
* identifies target.
- * @param user must contain {@link User#userId} of target User entity.
+ * @param user must contain User#userId} of target User entity.
* @throws SecurityException Thrown in the event of data validation or system error.
*/
void revokePermission( Permission perm, User user )
@@ -934,40 +934,40 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>parentRole - Role#name - contains the name of existing Role to be parent</li>
+ * <li>childRole - 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
+ * childRole - 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
+ * childRole - 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
+ * childRole - 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
+ * childRole - 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
+ * childRole - 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
+ * childRole - 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
+ * childRole - 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
+ * childRole - 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>
@@ -1000,40 +1000,40 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>childRole - Role#name - contains the name of existing child Role</li>
+ * <li>parentRole - 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
+ * parentRole - 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
+ * parentRole - 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
+ * parentRole - 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
+ * parentRole - 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
+ * parentRole - 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
+ * parentRole - 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
+ * parentRole - 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
+ * parentRole - 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>
@@ -1059,8 +1059,8 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>parentRole - Role#name - contains the name of existing Role to be parent</li>
+ * <li>childRole - Role#name - contains the name of existing Role to be child</li>
* </ul>
*
* @param parentRole completion of op deassigns child relationship with childRole.
@@ -1086,8 +1086,8 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>parentRole - Role#name - contains the name of existing Role to remove parent relationship</li>
+ * <li>childRole - Role#name - contains the name of existing Role to remove child relationship</li>
* </ul>
*
* @param parentRole completion of op removes child relationship with childRole.
@@ -1114,16 +1114,16 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of new SSD role set to be added</li>
+ * <li>SDSet#name - contains the name of new SSD role set to be added</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link SDSet#members} * - multivalued attribute contains the RBAC Role names to be added to this set</li>
+ * <li>SDSet#members} * - multivalued 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
+ * 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>
+ * <li>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)
@@ -1150,16 +1150,16 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing SSD role set to be updated</li>
+ * <li>SDSet#name - contains the name of existing SSD role set to be updated</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link SDSet#members} * - multivalued attribute contains the RBAC Role names to be added to this set</li>
+ * <li>SDSet#members} * - multivalued 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
+ * 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>
+ * <li>SDSet#description - contains any safe text</li>
* </ul>
*
* @param ssdSet contains an instantiated reference to existing SSD set containing, name, members, and cardinality
@@ -1183,8 +1183,8 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>SDSet#name - contains the name of SSD role set to be modified</li>
+ * <li>Role#name - contains the name of new SDSet#members} to be added</li>
* </ul>
*
* @param ssdSet contains an instantiated reference to new SSD set containing, name
@@ -1211,8 +1211,8 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>SDSet#name - contains the name of SSD role set to be modified</li>
+ * <li>Role#name - contains the name of existing SDSet#members} to be removed</li>
* </ul>
*
* @param ssdSet contains an instantiated reference to new SSD set containing name.
@@ -1229,7 +1229,7 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be removed</li>
+ * <li>SDSet#name - contains the name of SSD role set to be removed</li>
* </ul>
*
* @param ssdSet contains an instantiated reference to SSD set targeted for removal.
@@ -1255,7 +1255,7 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of SSD role set to be modified</li>
+ * <li>SDSet#name - contains the name of SSD role set to be modified</li>
* <li>cardinality - contains new cardinality setting for SSD</li>
* </ul>
*
@@ -1286,16 +1286,16 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of new DSD role set to be added</li>
+ * <li>SDSet#name - contains the name of new DSD role set to be added</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link SDSet#members} * - multivalued attribute contains the RBAC Role names to be added to this set</li>
+ * <li>SDSet#members} * - multivalued 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
+ * 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>
+ * <li>SDSet#description - contains any safe text</li>
* </ul>
*
* @param dsdSet contains an instantiated reference to new DSD set containing, name, members, and cardinality
@@ -1323,16 +1323,16 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing DSD role set to be updated</li>
+ * <li>SDSet#name - contains the name of existing DSD role set to be updated</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link SDSet#members} * - multivalued attribute contains the RBAC Role names to be added to this set</li>
+ * <li>SDSet#members} * - multivalued 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
+ * 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>
+ * <li>SDSet#description - contains any safe text</li>
* </ul>
*
* @param dsdSet contains an instantiated reference to existing DSD set containing, name, members, and cardinality
@@ -1357,8 +1357,8 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>SDSet#name - contains the name of DSD role set to be modified</li>
+ * <li>Role#name - contains the name of new 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.
@@ -1383,8 +1383,8 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>SDSet#name - contains the name of DSD role set to be modified</li>
+ * <li>Role#name - contains the name of existing SDSet#members} to be removed</li>
* </ul>
*
* @param dsdSet contains an instantiated reference to new DSD set containing name.
@@ -1401,7 +1401,7 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be removed</li>
+ * <li>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.
@@ -1427,7 +1427,7 @@ public interface AdminMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of DSD role set to be modified</li>
+ * <li>SDSet#name - contains the name of DSD role set to be modified</li>
* <li>cardinality - contains new cardinality setting for SSD</li>
* </ul>
*
diff --git a/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java b/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java
index d928c4b..f585cd9 100755
--- a/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java
@@ -48,17 +48,17 @@ public interface ConfigMgr
* <h4>required parameters</h4>
* @param cfg contains the name and optional attributes.
* <ul>
- * <li>{@link Configuration#name} - contains the name of new object being added</li>
+ * <li>Configuration#name - contains the name of new object being added</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link Configuration#props} - List of name / value pairs corresponding to fortress configuration entries.</li>
- * <li>{@link Configuration#uidNumber} - String containing valid integer value for sequence number</li>
- * <li>{@link Configuration#gidNumber} - String containing valid integer value for sequence number</li>
+ * <li>Configuration#props - List of name / value pairs corresponding to fortress configuration entries.</li>
+ * <li>Configuration#uidNumber - String containing valid integer value for sequence number</li>
+ * <li>Configuration#gidNumber - String containing valid integer value for sequence number</li>
* <li>
* </ul>
*
- * @return {@link Configuration} - contains the configuration entity that was added.
+ * @return Configuration - contains the configuration entity that was added.
* @throws org.apache.directory.fortress.core.SecurityException in the event entry already present or other system error.
*/
Configuration add(Configuration cfg) throws SecurityException;
@@ -66,22 +66,22 @@ public interface 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.
+ * If node does not exist, a org.apache.directory.fortress.core.SecurityException with error
+ * org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND will be thrown.
* <h4>required parameters</h4>
* @param cfg contains the name and optional attributes.
* <ul>
- * <li>{@link Configuration#name} - contains the name of new object being added</li>
+ * <li>Configuration#name - contains the name of new object being added</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link Configuration#props} - List of name / value pairs corresponding to fortress configuration entries.</li>
- * <li>{@link Configuration#uidNumber} - String containing valid integer value for sequence number</li>
- * <li>{@link Configuration#gidNumber} - String containing valid integer value for sequence number</li>
+ * <li>Configuration#props - List of name / value pairs corresponding to fortress configuration entries.</li>
+ * <li>Configuration#uidNumber - String containing valid integer value for sequence number</li>
+ * <li>Configuration#gidNumber - String containing valid integer value for sequence number</li>
* <li>
* </ul>
*
- * @return {@link Configuration} - contains the configuration entity that was added.
+ * @return Configuration - contains the configuration entity that was added.
* @throws org.apache.directory.fortress.core.SecurityException in the event entry not present or other system error.
*/
Configuration update(Configuration cfg) throws SecurityException;
@@ -101,8 +101,8 @@ public interface ConfigMgr
/**
* Completely 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.
+ * 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.
@@ -112,7 +112,7 @@ public interface 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
+ * 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.
@@ -124,7 +124,7 @@ public interface 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
+ * 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.
diff --git a/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java b/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java
index dae8315..e2c8723 100755
--- a/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java
@@ -70,7 +70,7 @@ import org.apache.directory.fortress.core.model.UserRole;
* <img src="./doc-files/RbacDSD.png" alt="">
* <hr>
* <p>
- * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)}
+ * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)
* or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
@@ -83,11 +83,11 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the name of existing object being targeted</li>
+ * <li>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
+ * @param permission must contain the object, Permission#objName}, and operation, Permission#opName}, and
* optionally object id of targeted permission entity.
* @return Permission entity that is loaded with data.
* @throws SecurityException
@@ -102,10 +102,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object being targeted</li>
+ * <li>PermObj#objName - contains the name of existing object being targeted</li>
* </ul>
*
- * @param permObj entity contains the {@link PermObj#objName} of target record.
+ * @param permObj entity contains the PermObj#objName of target record.
* @return PermObj loaded with perm object data.
* @throws SecurityException is thrown if object not found or system error.
*/
@@ -117,10 +117,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermissionAttributeSet#name} - contains the name of existing object being targeted</li>
+ * <li>PermissionAttributeSet#name - contains the name of existing object being targeted</li>
* </ul>
*
- * @param permAttributeSet entity contains the {@link PermissionAttributeSet#name} of target record.
+ * @param permAttributeSet entity contains the PermissionAttributeSet#name of target record.
* @return PermissionAttributeSet loaded with perm attribute set data.
* @throws SecurityException is thrown if object not found or system error.
*/
@@ -133,8 +133,8 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains one or more characters of existing object being targeted</li>
+ * <li>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
@@ -149,7 +149,7 @@ public interface ReviewMgr extends Manageable
/**
* Method returns Permission operations for the provided permission object
*
- * @param permObj entity contains the {@link PermObj#objName} of target record.
+ * @param permObj entity contains the PermObj#objName of target record.
* @return List of type Permission for provided permission object
* @throws SecurityException
* thrown in the event of system error.
@@ -173,7 +173,7 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link PermObj#objName} - contains one or more characters of existing object being targeted</li>
+ * <li>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
@@ -191,11 +191,11 @@ public interface ReviewMgr extends Manageable
* <h4>required parameters</h4>
* <ul>
* <li>
- * {@link OrgUnit#name} - contains one or more characters of org unit associated with existing object being targeted
+ * 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
+ * @param ou contains org unit name 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 SecurityException thrown in the event of system error.
@@ -209,10 +209,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to read.</li>
+ * <li>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.
+ * @param role contains role name, 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.
*/
@@ -221,7 +221,7 @@ public interface ReviewMgr extends Manageable
/**
- * Method will return a list of type Role matching all or part of Role name, {@link Role#name}.
+ * Method will return a list of type Role matching all or part of Role name, 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.
@@ -251,10 +251,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for read.</li>
+ * <li>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
+ * @param user entity contains a value User#userId that matches record in the directory. userId is globally
* unique in people container.
* @return entity containing matching user data.
* @throws SecurityException if record not found or system error occurs.
@@ -264,12 +264,12 @@ public interface ReviewMgr extends Manageable
/**
- * Return a list of type User of all users in the people container that match all or part of the {@link User#userId}
+ * Return a list of type User of all users in the people container that match all or part of the User#userId
* field passed in User entity.
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains all or some leading chars that match userId(s) stored in the directory.</li>
+ * <li>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.
@@ -286,12 +286,12 @@ public interface ReviewMgr extends Manageable
* <h4>required parameters</h4>
* <ul>
* <li>
- * {@link OrgUnit#name} - contains one or more characters of org unit associated with existing object(s) being
+ * 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
+ * @param ou contains name of User OU, 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.
@@ -307,7 +307,7 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for read.</li>
+ * <li>User#userId - contains the userId associated with the User object targeted for read.</li>
* <li>limit - max number of objects to return.</li>
* </ul>
*
@@ -328,11 +328,11 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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 role Contains 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 SecurityException in the event of data validation or system error.
@@ -347,10 +347,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>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.
+ * @param user contains 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.
*/
@@ -364,10 +364,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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.
+ * @param role contains the role name, 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.
*/
@@ -380,10 +380,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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.
+ * @param role contains the role name, Role#name used to search the User data set.
* @param roleConstraint constraint to filter the roles return
* @return List of type User containing the users assigned data.
* @throws SecurityException If system error occurs.
@@ -420,10 +420,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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.
+ * @param role Contains role name, 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.
*/
@@ -437,10 +437,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>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.
+ * @param user contains the 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.
*/
@@ -455,10 +455,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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 role contains role name, 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.
*/
@@ -473,10 +473,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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 role contains role name, 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.
@@ -491,15 +491,15 @@ public interface ReviewMgr extends Manageable
* * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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 role contains role name, 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 PermissionAttributeSet that contains all Permission Attribute valid for the role.
* @throws SecurityException In the event system error occurs.
*/
- List<PermissionAttributeSet> rolePermissionAttributeSets( Role role, boolean noInhertiance )
+ List<PermissionAttributeSet> rolePermissionAttributeSets( Role role, boolean noInheritance )
throws SecurityException;
/**
@@ -508,10 +508,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>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.
+ * @param user contains the User#userId of User targeted for search.
* @return List of type Permission containing matching permission entities.
* @throws SecurityException in the event of validation or system error.
*/
@@ -524,11 +524,11 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the name of existing object being targeted</li>
+ * <li>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.
+ * @param perm must contain the object, Permission#objName}, and operation, 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.
*/
@@ -541,11 +541,11 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the name of existing object being targeted</li>
+ * <li>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.
+ * @param perm must contain the object, Permission#objName}, and operation, 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 SecurityException in the event of validation or system error.
*/
@@ -558,11 +558,11 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the name of existing object being targeted</li>
+ * <li>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.
+ * @param perm must contain the object, Permission#objName}, and operation, 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 SecurityException in the event of validation or system error.
*/
@@ -575,11 +575,11 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <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>
+ * <li>Permission#objName - contains the name of existing object being targeted</li>
+ * <li>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.
+ * @param perm must contain the object, Permission#objName}, and operation, 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 SecurityException in the event of validation or system error.
*/
@@ -593,10 +593,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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
+ * @param role Will contain the role name, Role#name}, for targeted SSD set or null to return all
* @return List containing all matching SSD's.
* @throws SecurityException in the event of data or system error.
*/
@@ -609,10 +609,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>SDSet#name - contains the name of existing object being targeted</li>
* </ul>
*
- * @param set Will contain the name for existing SSD data set, {@link SDSet#name}.
+ * @param set Will contain the name for existing SSD data set, SDSet#name}.
* @return SDSet containing all attributes from matching SSD name.
* @throws SecurityException in the event of data or system error.
*/
@@ -625,10 +625,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>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}.
+ * @param ssd contains the name for the SSD set targeted, SDSet#name}.
* @return List containing all SSDSets that match a given SSDSet name.
* @throws SecurityException in the event of data or system error.
*/
@@ -642,10 +642,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>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}.
+ * @param ssd contains the name for the SSD set targeted, SDSet#name}.
* @return Set containing all Roles that are members of SSD data set.
* @throws SecurityException in the event of data or system error.
*/
@@ -659,10 +659,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>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}.
+ * @param ssd contains the name of the SSD set targeted, SDSet#name}.
* @return int value containing cardinality of SSD set.
* @throws SecurityException in the event of data or system error.
*/
@@ -676,10 +676,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>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
+ * @param role Will contain the role name, Role#name}, for targeted dSD set or null to return all
* @return List containing all matching dSD's.
* @throws SecurityException in the event of data or system error.
*/
@@ -692,10 +692,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>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}.
+ * @param set Will contain the name for existing DSD data set, SDSet#name}.
* @return SDSet containing all attributes from matching DSD name.
* @throws SecurityException in the event of data or system error.
*/
@@ -708,10 +708,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>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}.
+ * @param dsd contains the name for the DSD set targeted, SDSet#name}.
* @return List containing all DSDSets that match a given DSDSet name.
* @throws SecurityException in the event of data or system error.
*/
@@ -725,10 +725,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>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}.
+ * @param dsd contains the name for the DSD set targeted, SDSet#name}.
* @return Set containing all Roles that are members of DSD data set.
* @throws SecurityException in the event of data or system error.
*/
@@ -742,10 +742,10 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>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}.
+ * @param dsd contains the name of the DSD set targeted, SDSet#name}.
* @return int value containing cardinality of DSD set.
* @throws SecurityException in the event of data or system error.
*/
@@ -757,8 +757,8 @@ public interface ReviewMgr extends Manageable
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the name of existing user being targeted</li>
- * <li>{@link PermissionAttributeSet#name} - contains the name of permission attribute set</li>
+ * <li>User#userId - contains the name of existing user being targeted</li>
+ * <li>PermissionAttributeSet#name - contains the name of permission attribute set</li>
* </ul>
*
* @param user The user to filter role constraints
diff --git a/src/main/java/org/apache/directory/fortress/core/SecurityException.java b/src/main/java/org/apache/directory/fortress/core/SecurityException.java
index 8668205..b528e6a 100755
--- a/src/main/java/org/apache/directory/fortress/core/SecurityException.java
+++ b/src/main/java/org/apache/directory/fortress/core/SecurityException.java
@@ -40,9 +40,9 @@ package org.apache.directory.fortress.core;
* </ul>
* <p>
* For certain APIs like {@link AccessMgr#createSession(org.apache.directory.fortress.core.model.User, boolean)}, or
- * {@link AccessMgr#authenticate(String, char[])}, the caller may need to differentiate by one of the above subclasses, e.g.
+ * {@link AccessMgr#authenticate(String, String)}, the caller may need to differentiate by one of the above subclasses, e.g.
* {@link PasswordException}, to facilitate password expiring condition or allow user to retry authentication after entering
- * it incorrectly. If specific exception processing is not the aim, or if differentiating conditions by {@link #errorId} is
+ * it incorrectly. If specific exception processing is not the aim, or if differentiating conditions by SecurityException#errorId is
* acceptable, callers are allowed to catch (or throw) as type {@link SecurityException}.
* <p>
* All exceptions generated by Fortress will be set with error code {@link SecurityException#getErrorId()} indicating fault
diff --git a/src/main/java/org/apache/directory/fortress/core/cli/package.html b/src/main/java/org/apache/directory/fortress/core/cli/package.html
index 8577d0d..c6ff25b 100755
--- a/src/main/java/org/apache/directory/fortress/core/cli/package.html
+++ b/src/main/java/org/apache/directory/fortress/core/cli/package.html
@@ -127,8 +127,7 @@ Currently the following groups of functions are supported:
</li>
<li>Y : mobiles * - multivalued attribute maps to INetOrgPerson mobile attribute</li>
<li>@ : emails * - multivalued attribute maps to INetOrgPerson mail attribute</li>
- <li>> : address * - multivalued attribute maps to organizationalPerson postalAddress attribute
- </li>
+ <li>> : address * - multivalued attribute maps to organizationalPerson postalAddress attribute</li>
<li>< : state - maps to organizationalPerson st attribute</li>
<li>3 : city - maps to organizationalPerson l attribute</li>
<li>z : postalCode - maps to postalCode description attribute</li>
diff --git a/src/main/java/org/apache/directory/fortress/core/model/AdminRole.java b/src/main/java/org/apache/directory/fortress/core/model/AdminRole.java
index 0e8020d..ea27fcf 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/AdminRole.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/AdminRole.java
@@ -39,17 +39,17 @@ import org.apache.commons.lang.StringUtils;
* <h4>Fortress Processing Layers</h4>
* <ol>
* <li>Manager layer: {@link org.apache.directory.fortress.core.impl.DelAdminMgrImpl}, {@link org.apache.directory.fortress.core.impl.DelAccessMgrImpl}, {@link org.apache.directory.fortress.core.impl.DelReviewMgrImpl},...</li>
- * <li>Process layer: {@link org.apache.directory.fortress.core.impl.AdminRoleP}, {@link org.apache.directory.fortress.core.impl.OrgUnitP},...</li>
- * <li>DAO layer: {@link org.apache.directory.fortress.core.impl.AdminRoleDAO}, {@link org.apache.directory.fortress.core.impl.OrgUnitDAO},...</li>
+ * <li>Process layer: org.apache.directory.fortress.core.impl.AdminRoleP, org.apache.directory.fortress.core.impl.OrgUnitP,...</li>
+ * <li>DAO layer: org.apache.directory.fortress.core.impl.AdminRoleDAO, org.apache.directory.fortress.core.impl.OrgUnitDAO,...</li>
* </ol>
* Fortress clients first instantiate and populate a data entity before invoking any of the Manager APIs. The caller must
* provide enough information to uniquely identity the entity target within ldap.<br>
- * For example, this entity requires {@link #name} set before passing into {@link org.apache.directory.fortress.core.impl.DelAdminMgrImpl} or {@link org.apache.directory.fortress.core.impl.DelReviewMgrImpl} APIs.
+ * For example, this entity requires AdminRole#name set before passing into {@link org.apache.directory.fortress.core.impl.DelAdminMgrImpl} or {@link org.apache.directory.fortress.core.impl.DelReviewMgrImpl} APIs.
* Create methods usually require more attributes (than Read) due to constraints enforced between entities.
* <p>
* This entity extends the {@link org.apache.directory.fortress.core.model.Role} entity and is used to store the ARBAC AdminRole assignments that comprise the many-to-many relationships between Users and Administrative Permissions.
* In addition it is used to store the ARBAC {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM} and {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} OU information that adheres to the AdminRole entity in the ARBAC02 model.
- * <br>The unique key to locate AdminRole entity (which is subsequently assigned both to Users and administrative Permissions) is {@link AdminRole#name}.<br>
+ * <br>The unique key to locate AdminRole entity (which is subsequently assigned both to Users and administrative Permissions) is AdminRole#name.<br>
* <p>
* There is a many-to-many relationship between User's, Administrative Roles and Administrative Permissions.
* <h3>{@link org.apache.directory.fortress.core.model.User}*<->*{@link AdminRole}*<->*{@link org.apache.directory.fortress.core.model.Permission}</h3>
diff --git a/src/main/java/org/apache/directory/fortress/core/model/AuthZ.java b/src/main/java/org/apache/directory/fortress/core/model/AuthZ.java
index beeed00..06509ce 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/AuthZ.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/AuthZ.java
@@ -145,7 +145,6 @@ public class AuthZ extends FortEntity implements Serializable
/**
* Return the user dn containing the identity of log user who added the audit record. This will be the system user that
* is configured for performing slapd access log operations on behalf of Fortress.
- * The config property name {@link org.apache.directory.fortress.core.ldap.LdapDataProvider#LDAP_LOG_POOL_UID} contains the audit log system user id.
*
* @return value that maps to 'creatorsName' attribute on 'auditSearch' object class.
*/
@@ -158,7 +157,6 @@ public class AuthZ extends FortEntity implements Serializable
/**
* Set the user dn containing the identity of log user who added the audit record. This will be the system user that
* is configured for performing slapd access log operations on behalf of Fortress.
- * The config property name {@link org.apache.directory.fortress.core.ldap.LdapDataProvider#LDAP_LOG_POOL_UID} contains the audit log system user id.
*
* @param creatorsName maps to 'creatorsName' attribute on 'auditSearch' object class.
*/
@@ -259,7 +257,6 @@ public class AuthZ extends FortEntity implements Serializable
/**
* Return the user dn containing the identity of log user who last modified the audit record. This will be the system user that
* is configured for performing slapd access log operations on behalf of Fortress.
- * The config property name {@link org.apache.directory.fortress.core.ldap.LdapDataProvider#LDAP_LOG_POOL_UID} contains the audit log system user id.
*
* @return value that maps to 'modifiersName' attribute on 'auditSearch' object class.
*/
@@ -272,7 +269,6 @@ public class AuthZ extends FortEntity implements Serializable
/**
* Set the user dn containing the identity of log user who modified the audit record. This will be the system user that
* is configured for performing slapd access log operations on behalf of Fortress.
- * The config property name {@link org.apache.directory.fortress.core.ldap.LdapDataProvider#LDAP_LOG_POOL_UID} contains the audit log system user id.
*
* @param modifiersName maps to 'modifiersName' attribute on 'auditSearch' object class.
*/
@@ -333,7 +329,7 @@ public class AuthZ extends FortEntity implements Serializable
* performed the operation. This will usually be the same name as was
* established at the start of a session by a Bind request (if any) but
* may be altered in various circumstances.
- * For Fortress bind operations this will map to {@link User#userId}
+ * For Fortress bind operations this will map to User#userId
*
* @return value that maps to 'reqAuthzID' on 'auditSearch' object class.
*/
@@ -348,7 +344,7 @@ public class AuthZ extends FortEntity implements Serializable
* performed the operation. This will usually be the same name as was
* established at the start of a session by a Bind request (if any) but
* may be altered in various circumstances.
- * For Fortress bind operations this will map to {@link User#userId}
+ * For Fortress bind operations this will map to User#userId
*
*/
public void setReqAuthzID( String reqAuthzID )
@@ -662,10 +658,10 @@ public class AuthZ extends FortEntity implements Serializable
* <p>
* For Fortress authorization events this will contain the following:
* <ul>
- * <li>userId: {@link User#userId}
- * <li>activated roles: {@link UserRole#name}
- * <li>object name: {@link Permission#objName}
- * <li>operation name: {@link Permission#opName}
+ * <li>userId: User#userId
+ * <li>activated roles: UserRole#name
+ * <li>object name: Permission#objName
+ * <li>operation name: Permission#opName
* </ul>
*
* @return value that maps to 'reqFilter' attribute on 'auditSearch' object class.
@@ -681,10 +677,10 @@ public class AuthZ extends FortEntity implements Serializable
* <p>
* For Fortress authorization events this will contain the following:
* <ul>
- * <li>userId: {@link User#userId}
- * <li>activated roles: {@link UserRole#name}
- * <li>object name: {@link Permission#objName}
- * <li>operation name: {@link Permission#opName}
+ * <li>userId: User#userId
+ * <li>activated roles: UserRole#name
+ * <li>object name: Permission#objName
+ * <li>operation name: Permission#opName
* </ul>
*
* @param reqFilter maps to same name on 'auditSearch' object class.