You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2016/01/10 20:50:52 UTC
[1/4] directory-fortress-enmasse git commit: Some more javadoc fixes
Repository: directory-fortress-enmasse
Updated Branches:
refs/heads/master 604cc9dc7 -> 8c0029656
http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/blob/a3092a07/src/main/java/org/apache/directory/fortress/rest/FortressService.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/rest/FortressService.java b/src/main/java/org/apache/directory/fortress/rest/FortressService.java
index 11c6cd0..6e4d8ce 100644
--- a/src/main/java/org/apache/directory/fortress/rest/FortressService.java
+++ b/src/main/java/org/apache/directory/fortress/rest/FortressService.java
@@ -1868,7 +1868,8 @@ public interface FortressService
* <h5>{@link org.apache.directory.fortress.core.model.SDSet} required parameters</h5>
* <ul>
* <li>
- * {@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of existing SSD role set targeted for update
+ * {@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of existing SSD role set
+ * targeted for update
* </li>
* </ul>
* </li>
@@ -2834,7 +2835,10 @@ public interface FortressService
* <li>
* <h5>{@link org.apache.directory.fortress.core.model.User} required parameters</h5>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.User#userId} - contains the userId associated with the
+ * User object targeted for search.
+ * </li>
* </ul>
* </li>
* </ul>
@@ -3071,7 +3075,8 @@ public interface FortressService
/**
- * Return all userIds that have been authorized for a given permission. This will process role hierarchies to determine set of all Users who have access to a given permission.
+ * Return all userIds that have been authorized for a given permission. This will process role hierarchies to determine
+ * set of all Users who have access to a given permission.
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
@@ -3191,7 +3196,8 @@ public interface FortressService
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to an object of type {@link org.apache.directory.fortress.core.model.SDSet} containing matching SSD set.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to an object of type
+ * {@link org.apache.directory.fortress.core.model.SDSet} containing matching SSD set.
*/
FortResponse ssdRoleSet( FortRequest request );
@@ -3296,19 +3302,36 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Role} entity</li>
- * <h5>{@link org.apache.directory.fortress.core.model.Role} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Role} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.Role} required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role
+ * targeted for search.
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entities} contains a reference to a List of type {@link org.apache.directory.fortress.core.model.SDSet} containing all matching DSD sets.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entities} contains a reference to a List of type
+ * {@link org.apache.directory.fortress.core.model.SDSet} containing all matching DSD sets.
*/
FortResponse dsdRoleSets( FortRequest request );
@@ -3318,19 +3341,36 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.SDSet} entity</li>
- * <h5>{@link org.apache.directory.fortress.core.model.SDSet} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.SDSet} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.SDSet} required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of existing object being
+ * targeted
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to an object of type {@link org.apache.directory.fortress.core.model.SDSet} containing matching DSD set.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to an object of type
+ * {@link org.apache.directory.fortress.core.model.SDSet} containing matching DSD set.
*/
FortResponse dsdRoleSet( FortRequest request );
@@ -3341,19 +3381,36 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.SDSet} entity</li>
- * <h5>{@link org.apache.directory.fortress.core.model.SDSet} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.SDSet} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.SDSet} required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name of existing object being
+ * targeted
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#values} contains a reference to a List of type String containing all member roles of DSD set.
+ * @return reference to {@code FortResponse}, {@link FortResponse#values} contains a reference to a List of type
+ * String containing all member roles of DSD set.
*/
FortResponse dsdRoleSetRoles( FortRequest request );
@@ -3379,23 +3436,38 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.SDSet} entity</li>
- * <h5>{@link org.apache.directory.fortress.core.model.SDSet} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name to use for the search.</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.SDSet} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.SDSet} required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.SDSet#name} - contains the name to use for the search.
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entities} contains a reference to a List of type {@link org.apache.directory.fortress.core.model.SDSet} containing all matching DSD sets.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entities} contains a reference to a List of type
+ * {@link org.apache.directory.fortress.core.model.SDSet} containing all matching DSD sets.
*/
FortResponse dsdSets( FortRequest request );
-
//------------ AccessMgr ----------------------------------------------------------------------------------------------
/**
@@ -3404,16 +3476,27 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User} entity</li>
- * <h5>{@link org.apache.directory.fortress.core.model.User} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.User} required parameters</h5>
+ * <ul>
+ * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
+ * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#session} object will be returned if authentication successful. This will not contain user's roles.
+ * @return reference to {@code FortResponse}, {@link FortResponse#session} object will be returned if authentication
+ * successful. This will not contain user's roles.
*/
FortResponse authenticate( FortRequest request );
@@ -3421,105 +3504,209 @@ public interface FortressService
/**
* Perform user authentication {@link org.apache.directory.fortress.core.model.User#password} and role activations.<br>
* This method must be called once per user prior to calling other methods within this class.
- * The successful result is {@link org.apache.directory.fortress.core.model.Session} that contains target user's RBAC {@link org.apache.directory.fortress.core.model.User#roles} and Admin role {@link org.apache.directory.fortress.core.model.User#adminRoles}.<br>
- * In addition to checking user password validity it will apply configured password policy checks {@link org.apache.directory.fortress.core.model.User#pwPolicy}..<br>
+ * The successful result is {@link org.apache.directory.fortress.core.model.Session} that contains target user's RBAC
+ * {@link org.apache.directory.fortress.core.model.User#roles} and Admin role
+ * {@link org.apache.directory.fortress.core.model.User#adminRoles}.<br>
+ * In addition to checking user password validity it will apply configured password policy checks
+ * {@link org.apache.directory.fortress.core.model.User#pwPolicy}..<br>
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User} entity</li>
- * <h5>{@link org.apache.directory.fortress.core.model.User} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
- * </ul>
- * <h5>User optional parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the names of assigned RBAC roles targeted for activation into Session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains the names of assigned ARBAC roles targeted for activation into Session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#props} collection of name value pairs collected on behalf of User during signon. For example hostname:myservername or ip:192.168.1.99
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.User} required parameters</h5>
+ * <ul>
+ * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
+ * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
+ * </ul>
+ * <h5>User optional parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the
+ * names of assigned RBAC roles targeted for activation into Session.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains
+ * the names of assigned ARBAC roles targeted for activation into Session.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.User#props} collection of name value pairs collected on
+ * behalf of User during signon. For example hostname:myservername or ip:192.168.1.99
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
- * <h4> This API will...</h4>
+ * <h4>This API will...</h4>
* <ul>
- * <li> authenticate user password.
- * <li> perform <a href="http://www.openldap.org/">OpenLDAP</a> <a href="http://tools.ietf.org/html/draft-behera-ldap-password-policy-10">password policy evaluation</a>.
- * <li> fail for any user who is locked by OpenLDAP's policies {@link org.apache.directory.fortress.core.model.User#isLocked()}.
- * <li> evaluate temporal {@link org.apache.directory.fortress.core.model.Constraint}(s) on {@link org.apache.directory.fortress.core.model.User}, {@link org.apache.directory.fortress.core.model.UserRole} and {@link org.apache.directory.fortress.core.model.UserAdminRole} entities.
- * <li> process selective role activations into User RBAC Session {@link org.apache.directory.fortress.core.model.User#roles}.
- * <li> check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate} on {@link org.apache.directory.fortress.core.model.User#roles}.
- * <li> process selective administrative role activations {@link org.apache.directory.fortress.core.model.User#adminRoles}.
- * <li> return a {@link org.apache.directory.fortress.core.model.Session} containing {@link org.apache.directory.fortress.core.model.Session#getUser()}, {@link org.apache.directory.fortress.core.model.Session#getRoles()} and (if admin user) {@link org.apache.directory.fortress.core.model.Session#getAdminRoles()} if everything checks out good.
- * <li> return a checked exception that will be {@link org.apache.directory.fortress.core.SecurityException} or its derivation.
- * <li> return a {@link org.apache.directory.fortress.core.SecurityException} for system failures.
- * <li> return a {@link org.apache.directory.fortress.core.PasswordException} for authentication and password policy violations.
- * <li> return a {@link org.apache.directory.fortress.core.ValidationException} for data validation errors.
- * <li> return a {@link org.apache.directory.fortress.core.FinderException} if User id not found.
- * <li> (optionally) store parms passed in by client for audit trail purposes.
+ * <li>authenticate user password.</li>
+ * <li>perform <a href="http://www.openldap.org/">OpenLDAP</a>
+ * <a href="http://tools.ietf.org/html/draft-behera-ldap-password-policy-10">password policy evaluation</a>.
+ * </li>
+ * <li>
+ * fail for any user who is locked by OpenLDAP's policies
+ * {@link org.apache.directory.fortress.core.model.User#isLocked()}.
+ * </li>
+ * <li>
+ * evaluate temporal {@link org.apache.directory.fortress.core.model.Constraint}(s) on
+ * {@link org.apache.directory.fortress.core.model.User}, {@link org.apache.directory.fortress.core.model.UserRole}
+ * and {@link org.apache.directory.fortress.core.model.UserAdminRole} entities.
+ * </li>
+ * <li>
+ * process selective role activations into User RBAC Session
+ * {@link org.apache.directory.fortress.core.model.User#roles}.
+ * </li>
+ * <li>
+ * check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate} on
+ * {@link org.apache.directory.fortress.core.model.User#roles}.
+ * </li>
+ * <li>
+ * process selective administrative role activations {@link org.apache.directory.fortress.core.model.User#adminRoles}.
+ * </li>
+ * <li>
+ * return a {@link org.apache.directory.fortress.core.model.Session} containing
+ * {@link org.apache.directory.fortress.core.model.Session#getUser()},
+ * {@link org.apache.directory.fortress.core.model.Session#getRoles()} and (if admin user)
+ * {@link org.apache.directory.fortress.core.model.Session#getAdminRoles()} if everything checks out good.
+ * </li>
+ * <li>
+ * return a checked exception that will be {@link org.apache.directory.fortress.core.SecurityException}
+ * or its derivation.
+ * </li>
+ * <li>return a {@link org.apache.directory.fortress.core.SecurityException} for system failures.</li>
+ * <li>
+ * return a {@link org.apache.directory.fortress.core.PasswordException} for authentication and password policy
+ * violations.
+ * </li>
+ * <li>return a {@link org.apache.directory.fortress.core.ValidationException} for data validation errors.</li>
+ * <li>return a {@link org.apache.directory.fortress.core.FinderException} if User id not found.</li>
+ * <li>(optionally) store parms passed in by client for audit trail purposes.</li>
* </ul>
- * <h4>
- * The function is valid if and only if:
- * </h4>
+ * <h4>The function is valid if and only if:</h4>
* <ul>
- * <li> the user is a member of the USERS data set
- * <li> the password is supplied (unless trusted).
- * <li> the (optional) active role set is a subset of the roles authorized for that user.
+ * <li>the user is a member of the USERS data set</li>
+ * <li>the password is supplied (unless trusted).</li>
+ * <li>the (optional) active role set is a subset of the roles authorized for that user.</li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#session} object will contain authentication result code {@link 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.
+ * @return reference to {@code FortResponse}, {@link FortResponse#session} object will contain authentication result
+ * code {@link 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.
*/
FortResponse createSession( FortRequest request );
/**
- * This service accepts userId for validation and returns RBAC session. This service will not check the password nor perform password policy validations.<br>
- * The successful result is {@link org.apache.directory.fortress.core.model.Session} that contains target user's RBAC {@link org.apache.directory.fortress.core.model.User#roles} and Admin role {@link org.apache.directory.fortress.core.model.User#adminRoles}.<br>
+ * This service accepts userId for validation and returns RBAC session. This service will not check the password nor
+ * perform password policy validations.<br>
+ * The successful result is {@link org.apache.directory.fortress.core.model.Session} that contains target user's
+ * RBAC {@link org.apache.directory.fortress.core.model.User#roles} and Admin role
+ * {@link org.apache.directory.fortress.core.model.User#adminRoles}.<br>
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User} entity</li>
- * <h5>{@link org.apache.directory.fortress.core.model.User} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
- * </ul>
- * <h5>User optional parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the names of assigned RBAC roles targeted for activation into Session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains the names of assigned ARBAC roles targeted for activation into Session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#props} collection of name value pairs collected on behalf of User during signon. For example hostname:myservername or ip:192.168.1.99
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.User} required parameters</h5>
+ * <ul>
+ * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
+ * </ul>
+ * <h5>User optional parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains
+ * the names of assigned RBAC roles targeted for activation into Session.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains
+ * the names of assigned ARBAC roles targeted for activation into Session.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.User#props} collection of name value pairs collected
+ * on behalf of User during signon. For example hostname:myservername or ip:192.168.1.99
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
- * <h4> This API will...</h4>
+ * <h4>This API will...</h4>
* <ul>
- * <li> fail for any user who is locked by OpenLDAP's policies {@link org.apache.directory.fortress.core.model.User#isLocked()}.
- * <li> evaluate temporal {@link org.apache.directory.fortress.core.model.Constraint}(s) on {@link org.apache.directory.fortress.core.model.User}, {@link org.apache.directory.fortress.core.model.UserRole} and {@link org.apache.directory.fortress.core.model.UserAdminRole} entities.
- * <li> process selective role activations into User RBAC Session {@link org.apache.directory.fortress.core.model.User#roles}.
- * <li> check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate} on {@link org.apache.directory.fortress.core.model.User#roles}.
- * <li> process selective administrative role activations {@link org.apache.directory.fortress.core.model.User#adminRoles}.
- * <li> return a {@link org.apache.directory.fortress.core.model.Session} containing {@link org.apache.directory.fortress.core.model.Session#getUser()}, {@link org.apache.directory.fortress.core.model.Session#getRoles()} and (if admin user) {@link org.apache.directory.fortress.core.model.Session#getAdminRoles()} if everything checks out good.
- * <li> return a checked exception that will be {@link org.apache.directory.fortress.core.SecurityException} or its derivation.
- * <li> return a {@link org.apache.directory.fortress.core.SecurityException} for system failures.
- * <li> return a {@link org.apache.directory.fortress.core.ValidationException} for data validation errors.
- * <li> return a {@link org.apache.directory.fortress.core.FinderException} if User id not found.
- * <li> (optionally) store parms passed in by client for audit trail purposes.
+ * <li>
+ * fail for any user who is locked by OpenLDAP's policies
+ * {@link org.apache.directory.fortress.core.model.User#isLocked()}.
+ * </li>
+ * <li>
+ * evaluate temporal {@link org.apache.directory.fortress.core.model.Constraint}(s) on
+ * {@link org.apache.directory.fortress.core.model.User}, {@link org.apache.directory.fortress.core.model.UserRole}
+ * and {@link org.apache.directory.fortress.core.model.UserAdminRole} entities.
+ * </li>
+ * <li>
+ * process selective role activations into User RBAC Session
+ * {@link org.apache.directory.fortress.core.model.User#roles}.
+ * </li>
+ * <li>
+ * check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate} on
+ * {@link org.apache.directory.fortress.core.model.User#roles}.
+ * </li>
+ * <li>
+ * process selective administrative role activations
+ * {@link org.apache.directory.fortress.core.model.User#adminRoles}.
+ * </li>
+ * <li>
+ * return a {@link org.apache.directory.fortress.core.model.Session} containing
+ * {@link org.apache.directory.fortress.core.model.Session#getUser()},
+ * {@link org.apache.directory.fortress.core.model.Session#getRoles()} and (if admin user)
+ * {@link org.apache.directory.fortress.core.model.Session#getAdminRoles()} if everything checks out good.
+ * </li>
+ * <li>
+ * return a checked exception that will be {@link org.apache.directory.fortress.core.SecurityException} or
+ * its derivation.
+ * </li>
+ * <li>return a {@link org.apache.directory.fortress.core.SecurityException} for system failures.</li>
+ * <li>return a {@link org.apache.directory.fortress.core.ValidationException} for data validation errors.</li>
+ * <li>return a {@link org.apache.directory.fortress.core.FinderException} if User id not found.</li>
+ * <li>(optionally) store parms passed in by client for audit trail purposes.</li>
* </ul>
- * <h4>
- * The function is valid if and only if:
- * </h4>
+ * <h4>The function is valid if and only if:</h4>
* <ul>
- * <li> the user is a member of the USERS data set
- * <li> the (optional) active role set is a subset of the roles authorized for that user.
+ * <li> the user is a member of the USERS data set</li>
+ * <li> the (optional) active role set is a subset of the roles authorized for that user.</li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#session} object will contain authentication result code {@link 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.
+ * @return reference to {@code FortResponse}, {@link FortResponse#session} object will contain authentication result
+ * code {@link 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.
*/
FortResponse createSessionTrusted( FortRequest request );
/**
- * Perform user RBAC authorization. This function returns a Boolean value meaning whether the subject of a given session is
- * allowed or not to perform a given operation on a given object. The function is valid if and
+ * Perform user RBAC authorization. This function returns a Boolean value meaning whether the subject of a given
+ * session is allowed or not to perform a given operation on a given object. The function is valid if and
* only if the session is a valid Fortress session, the object is a member of the OBJS data set,
* and the operation is a member of the OPS data set. The session's subject has the permission
* to perform the operation on that object if and only if that permission is assigned to (at least)
@@ -3528,17 +3715,38 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission} entity</li>
- * <li>{@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling {@link FortressServiceImpl#createSession} method before use in this service.</li>
- * <h5>{@link org.apache.directory.fortress.core.model.Permission} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission}
+ * entity
+ * </li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling
+ * {@link FortressServiceImpl#createSession} method before use in this service.
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.Permission} required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing
+ * object being targeted
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing
+ * permission operation
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#isAuthorized} boolean will be 'true' if User authorized, otherwise 'false'. Updated {@link FortResponse#session} will be included in response as well.
+ * @return reference to {@code FortResponse}, {@link FortResponse#isAuthorized} boolean will be 'true' if User
+ * authorized, otherwise 'false'. Updated {@link FortResponse#session} will be included in response as well.
*/
FortResponse checkAccess( FortRequest request );
@@ -3549,11 +3757,14 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling {@link FortressServiceImpl#createSession} method before use in this service.</li>
+ * <li>{@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling
+ * {@link FortressServiceImpl#createSession} method before use in this service.</li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entities} containing a List of type {@link org.apache.directory.fortress.core.model.Permission}. Updated {@link FortResponse#session} will be included in response as well.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entities} containing a List of type
+ * {@link org.apache.directory.fortress.core.model.Permission}. Updated {@link FortResponse#session} will be included
+ * in response as well.
*/
FortResponse sessionPermissions( FortRequest request );
@@ -3571,22 +3782,28 @@ public interface FortressService
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entities} containing a List of type {@link org.apache.directory.fortress.core.model.UserRole}. Updated {@link FortResponse#session} will be included in response as well.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entities} containing a List of type
+ * {@link org.apache.directory.fortress.core.model.UserRole}. Updated {@link FortResponse#session} will be included
+ * in response as well.
*/
FortResponse sessionRoles( FortRequest request );
/**
- * This function returns the authorized roles associated with a session based on hierarchical relationships. The function is valid if
- * and only if the session is a valid Fortress session.
+ * This function returns the authorized roles associated with a session based on hierarchical relationships. The
+ * function is valid if and only if the session is a valid Fortress session.
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling {@link FortressServiceImpl#createSession} method before use in this service.</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling
+ * {@link FortressServiceImpl#createSession} method before use in this service.
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#valueSet} containing a Set of type String containing role names authorized for User. Updated {@link FortResponse#session} will be included in response as well.
+ * @return reference to {@code FortResponse}, {@link FortResponse#valueSet} containing a Set of type String containing
+ * role names authorized for User. Updated {@link FortResponse#session} will be included in response as well.
*/
FortResponse authorizedSessionRoles( FortRequest request );
@@ -3596,21 +3813,38 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling {@link FortressServiceImpl#createSession} method before use in this service.</li>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole} entity.</li>
- * <h5>{@link org.apache.directory.fortress.core.model.UserRole} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#name} - contains the Role name targeted for activation into User's session</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling
+ * {@link FortressServiceImpl#createSession} method before use in this service.
+ * </li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole}
+ * entity.
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.UserRole} required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserRole#name} - contains the Role name targeted for
+ * activation into User's session
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* The function is valid if and only if:
* <ul>
- * <li> the user is a member of the USERS data set
- * <li> the role is a member of the ROLES data set
- * <li> the role inclusion does not violate Dynamic Separation of Duty Relationships
- * <li> the session is a valid Fortress session
- * <li> the user is authorized to that role
- * <li> the session is owned by that user.
+ * <li>the user is a member of the USERS data set</li>
+ * <li>the role is a member of the ROLES data set</li>
+ * <li>the role inclusion does not violate Dynamic Separation of Duty Relationships</li>
+ * <li>the session is a valid Fortress session</li>
+ * <li>the user is authorized to that role</li>
+ * <li>the session is owned by that user.</li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
@@ -3627,15 +3861,32 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling {@link FortressServiceImpl#createSession} method before use in this service.</li>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole} entity.</li>
- * <h5>{@link org.apache.directory.fortress.core.model.UserRole} required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserRole#name} - contains the Role name targeted for removal from User's session</li>
- * </ul>
- * </ul>
- *
- * @param request contains a reference to {@code FortRequest}
+ * <li>
+ * {@link FortRequest#session} - contains a reference to User's RBAC session that is created by calling
+ * {@link FortressServiceImpl#createSession} method before use in this service.
+ * </li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole}
+ * entity.
+ * </li>
+ * </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>{@link org.apache.directory.fortress.core.model.UserRole} required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserRole#name} - contains the Role name targeted for
+ * removal from User's session
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ *
+ * @param request contains a reference to {@code FortRequest}
* @return reference to {@code FortResponse}, Updated {@link FortResponse#session} will be included in response.
*/
FortResponse dropActiveRole( FortRequest request );
@@ -3687,36 +3938,94 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.AdminRole} object</li>
- * <h5>AdminRole required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole being targeted for addition to LDAP</li>
- * </ul>
- * <h5>AdminRole optional parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#description} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.AdminRole}
+ * object
+ * </li>
+ * </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>AdminRole required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole
+ * being targeted for addition to LDAP
+ * </li>
+ * </ul>
+ * <h5>AdminRole optional parameters</h5>
+ * <ul>
+ * <li>{@link org.apache.directory.fortress.core.model.AdminRole#description} - contains any safe text</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#osPs} * - multi-occurring attribute used to
+ * set associations to existing PERMS OrgUnits
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#osUs} * - multi-occurring attribute used to
+ * set associations to existing USERS OrgUnits
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginRange} - contains the name of an existing
+ * RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole
+ * activated) controls
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endRange} - contains the name of an existing
+ * RBAC Role that represents that highest role in hierarchy that administrator may control
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginInclusive} - if 'true' the RBAC Role
+ * specified in beginRange is also controlled by the posessor of this AdminRole
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endInclusive} - if 'true' the RBAC Role
+ * specified in endRange is also controlled by the administratrator
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour
+ * adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour adminRole
+ * may be activated into user's ARBAC session.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when
+ * adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date
+ * adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines
+ * beginning of enforced inactive status
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end
+ * of enforced inactive status
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday,
+ * etc - specifies which day role may be activated into user's ARBAC session
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to a {@link org.apache.directory.fortress.core.model.AdminRole}.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to a
+ * {@link org.apache.directory.fortress.core.model.AdminRole}.
*/
FortResponse addAdminRole( FortRequest request );
@@ -3728,19 +4037,37 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.AdminRole} object</li>
- * <h5>AdminRole required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole being targeted for removal from LDAP</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.AdminRole}
+ * object
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>AdminRole required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole
+ * being targeted for removal from LDAP
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to a {@link org.apache.directory.fortress.core.model.AdminRole}.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to a
+ * {@link org.apache.directory.fortress.core.model.AdminRole}.
*/
FortResponse deleteAdminRole( FortRequest request );
@@ -3750,36 +4077,94 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.AdminRole} object</li>
- * <h5>AdminRole required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole being targeted for update to LDAP</li>
- * </ul>
- * <h5>AdminRole optional parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#description} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.AdminRole}
+ * object
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>AdminRole required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of the new AdminRole
+ * being targeted for update to LDAP
+ * </li>
+ * </ul>
+ * <h5>AdminRole optional parameters</h5>
+ * <ul>
+ * <li>{@link org.apache.directory.fortress.core.model.AdminRole#description} - contains any safe text</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#osPs} * - multi-occurring attribute used to set
+ * associations to existing PERMS OrgUnits
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#osUs} * - multi-occurring attribute used to set
+ * associations to existing USERS OrgUnits
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginRange} - contains the name of an existing
+ * RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole
+ * activated) controls
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endRange} - contains the name of an existing
+ * RBAC Role that represents that highest role in hierarchy that administrator may control
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginInclusive} - if 'true' the RBAC Role
+ * specified in beginRange is also controlled by the posessor of this AdminRole
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endInclusive} - if 'true' the RBAC Role
+ * specified in endRange is also controlled by the administratrator
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour
+ * adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour
+ * adminRole may be activated into user's ARBAC session.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date
+ * when adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date
+ * adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines
+ * beginning of enforced inactive status
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end
+ * of enforced inactive status
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday,
+ * etc - specifies which day role may be activated into user's ARBAC session
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
- * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to a {@link org.apache.directory.fortress.core.model.AdminRole}.
+ * @return reference to {@code FortResponse}, {@link FortResponse#entity} contains a reference to a
+ * {@link org.apache.directory.fortress.core.model.AdminRole}.
*/
FortResponse updateAdminRole( FortRequest request );
@@ -3795,43 +4180,89 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserAdminRole} object</li>
- * <h5>UserAdminRole required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing AdminRole to be assigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User</li>
- * </ul>
- * <h5>UserAdminRole optional parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginTime} - HHMM - determines begin hour AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endTime} - HHMM - determines end hour AdminRole may be activated into user's RBAC session.</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginDate} - YYYYMMDD - determines date when AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endDate} - YYYYMMDD - indicates latest date AdminRole may be activated into user's RBAC session</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
- * </ul>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserAdminRole}
+ * object
+ * </li>
+ * </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>UserAdminRole required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already
+ * existing AdminRole to be assigned
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for
+ * existing User
+ * </li>
+ * </ul>
+ * <h5>UserAdminRole optional parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#beginTime} - HHMM - determines begin
+ * hour AdminRole may be activated into user's RBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#endTime} - HHMM - determines end hour
+ * AdminRole may be activated into user's RBAC session.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#beginDate} - YYYYMMDD - determines date
+ * when AdminRole may be activated into user's RBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#endDate} - YYYYMMDD - indicates latest
+ * date AdminRole may be activated into user's RBAC session
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#beginLockDate} - YYYYMMDD - determines
+ * beginning of enforced inactive status
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#endLockDate} - YYYYMMDD - determines
+ * end of enforced inactive status
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#dayMask} - 1234567, 1 = Sunday,
+ * 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
* <p>
* Successful completion of this op, the following occurs:
* <ul>
- * <li> User entity (resides in people container) has role assignment added to aux object class attached to actual user record.
- * <li> AdminRole entity (resides in adminRole container) has userId added as role occupant.
- * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:
- * <ul>
- * <li> timeout - number in seconds of session inactivity time allowed.
- * <li> beginDate - YYYYMMDD - determines date when role may be activated.
- * <li> endDate - YYMMDD - indicates latest date role may be activated.
- * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status
- * <li> endLockDate - YYMMDD - determines end of enforced inactive status.
- * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.
- * <li> endTime - HHMM - determines end hour role may be activated in user's session.*
- * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.
- * </ul>
+ * <li>
+ * User entity (resides in people container) has role assignment added to aux object class attached to actual
+ * user record.
+ * </li>
+ * <li> AdminRole entity (resides in adminRole container) has userId added as role occupant.</li>
+ * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:</li>
+ * <li>
+ * <ul>
+ * <li> timeout - number in seconds of session inactivity time allowed.</li>
+ * <li> beginDate - YYYYMMDD - determines date when role may be activated.</li>
+ * <li> endDate - YYMMDD - indicates latest date role may be activated.</li>
+ * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li> endLockDate - YYMMDD - determines end of enforced inactive status.</li>
+ * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.</li>
+ * <li> endTime - HHMM - determines end hour role may be activated in user's session.*</li>
+ * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.</li>
+ * </ul>
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
@@ -3841,25 +4272,46 @@ public interface FortressService
/**
- * This method removes assigned admin role from user entity. Both user and admin role entities must exist and have role relationship
- * before calling this method.
- * Successful completion:
- * del Role to User assignment in User data set
- * AND
- * User to Role assignment in Admin Role data set.
+ * This method removes assigned admin role from user entity. Both user and admin role entities must exist and have
+ * role relationship before calling this method.
+ * <p>
+ * Successful completion :<br>
+ * del Role to User assignment in User data set<br>
+ * AND<br>
+ * User to Role assignment in Admin Role data set.<br>
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserAdminRole} object</li>
- * <h5>UserAdminRole required parameters</h5>
- * <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing AdminRole to be deassigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserAdminRole}
+ * object
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>UserAdminRole required parameters</h5>
+ * <ul>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already
+ * existing AdminRole to be deassigned
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing
+ * User
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
@@ -3870,43 +4322,87 @@ public interface FortressService
/**
* This commands creates a new role childRole, and inserts it in the role hierarchy as an immediate descendant of
- * the existing role parentRole. The command is valid if and only if childRole is not a member of the ADMINROLES data set,
- * and parentRole is a member of the ADMINROLES data set.
+ * the existing role parentRole. The command is valid if and only if childRole is not a member of the ADMINROLES data
+ * set, and parentRole is a member of the ADMINROLES data set.
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.RoleRelationship} entity</li>
- * <h5>RoleRelationship required parameters</h5>
- * <ul>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the name of existing parent role</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the name of new child role</li>
- * </ul>
- * <h5>optional parameters {@code org.apache.directory.fortress.core.model.RoleRelationship#child}</h5>
- * <ul>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#description} - maps to description attribute on organizationalRole object class for new child</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session for new child</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#endTime} - HHMM - determines end hour role may be activated into user's RBAC session for new child</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session for new child</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session for new child</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new child</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new child</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new child</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to
+ * {@link org.apache.directory.fortress.core.model.RoleRelationship} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>RoleRelationship required parameters</h5>
+ * <ul>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the name of
+ * existing parent role
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the name of new
+ * child role
+ * </li>
+ * </ul>
+ * <h5>optional parameters {@code org.apache.directory.fortress.core.model.RoleRelationship#child}</h5>
+ * <ul>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#description} - maps to description
+ * attribute on organizationalRole object class for new child
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginTime} - HHMM - determines
+ * begin hour role may be activated into user's RBAC session for new child
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endTime} - HHMM - determines end
+ * hour role may be activated into user's RBAC session for new child
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginDate} - YYYYMMDD - determines
+ * date when role may be activated into user's RBAC session for new child
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endDate} - YYYYMMDD - indicates
+ * latest date role may be activated into user's RBAC session for new child
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginLockDate} - YYYYMMDD -
+ * determines beginning of enforced inactive status for new child
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endLockDate} - YYYYMMDD -
+ * determines end of enforced inactive status for new child
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#dayMask} - 1234567, 1 = Sunday,
+ * 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new child
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
* The command is valid if and only if:
* <ul>
- * <li> The childRole is not a member of the ADMINROLES data set.
- * <li> The parentRole is a member of the ADMINROLES data set.
+ * <li>The childRole is not a member of the ADMINROLES data set.</li>
+ * <li>The parentRole is a member of the ADMINROLES data set.</li>
* </ul>
* <p>
* This method:
* <ul>
- * <li> Adds new adminRole.
- * <li> Assigns role relationship between new childRole and pre-existing parentRole.
+ * <li>Adds new adminRole.</li>
+ * <li>Assigns role relationship between new childRole and pre-existing parentRole.</li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
@@ -3922,37 +4418,79 @@ public interface FortressService
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.RoleRelationship} entity</li>
- * <h5>RoleRelationship required parameters</h5>
- * <ul>
- * <li>childRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the name of existing child AdminRole</li>
- * <li>parentRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the name of new AdminRole to be parent</li>
- * </ul>
- * <h5>optional parameters {@link org.apache.directory.fortress.core.model.RoleRelationship#parent}</h5>
- * <ul>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#description} - maps to description attribute on organizationalRole object class for new parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginTime} - HHMM - determines begin hour role may be activated into user's RBAC session for new parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endTime} - HHMM - determines end hour role may be activated into user's RBAC session for new parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginDate} - YYYYMMDD - determines date when role may be activated into user's RBAC session for new parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endDate} - YYYYMMDD - indicates latest date role may be activated into user's RBAC session for new parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new parent</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to
+ * {@link org.apache.directory.fortress.core.model.RoleRelationship} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>RoleRelationship required parameters</h5>
+ * <ul>
+ * <li>
+ * childRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the
+ * name of existing child AdminRole</li>
+ * <li>
+ * parentRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the
+ * name of new AdminRole to be parent</li>
+ * </ul>
+ * <h5>optional parameters {@link org.apache.directory.fortress.core.model.RoleRelationship#parent}</h5>
+ * <ul>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#description} - maps to description
+ * attribute on organizationalRole object class for new parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginTime} - HHMM - determines
+ * begin hour role may be activated into user's RBAC session for new parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endTime} - HHMM - determines end
+ * hour role may be activated into user's RBAC session for new parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginDate} - YYYYMMDD -
+ * determines date when role may be activated into user's RBAC session for new parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endDate} - YYYYMMDD - indicates
+ * latest date role may be activated into user's RBAC session for new parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginLockDate} - YYYYMMDD -
+ * determines beginning of enforced inactive status for new parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endLockDate} - YYYYMMDD -
+ * determines end of enforced inactive status for new parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#dayMask} - 1234567, 1 = Sunday,
+ * 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new parent
+ * </li>
+ * </ul>
+ * </li>
+ * </ul>
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
+ * <li>
+ * {@link FortRequest#session} - contains a reference to administrative session and if included service will
+ * enforce ARBAC constraints
+ * </li>
* </ul>
* The command is valid if and only if:
* <ul>
- * <li> The parentRole is not a member of the ADMINROLES data set.
- * <li> The childRole is a member of the ADMINROLES data set.
+ * <li>The parentRole is not a member of the ADMINROLES data set.</li>
+ * <li>The childRole is a member of the ADMINROLES data set.</li>
* </ul>
* This method:
* <ul>
- * <li> Adds new adminRole.
- * <li> Assigns role relationship between new parentRole and pre-existing childRole.
+ * <li>Adds new adminRole.</li>
+ * <li>Assigns role relationship between new parentRole and pre-existing childRole.</li>
* </ul>
*
* @param request contains a reference to {@code FortRequest}
@@ -3963,28 +4501,48 @@ public interface FortressService
/**
* This commands establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
- * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the ADMINROLES data
- * set, parentRole is not an immediate ascendant of childRole, and childRole does not properly inherit parentRole (in order to
- * avoid cycle creation).
+ * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the
+ * ADMINROLES data set, parentRole is not an immediate ascendant of childRole, and childRole does not properly
+ * inherit parentRole (in order to avoid cycle creation).
* <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.RoleRelationship} entity</li>
- * <h5>RoleRelationship required parameters</h5>
- * <ul>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the name of existing AdminRole to be parent</li>
- * <li>{@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the name of existing AdminRole to be child</li>
+ * <li>
+ * {@link FortRequest#entity} - contains a reference to
+ * {@link org.apache.directory.fortress.core.model.RoleRelationship} entity
+ * </li>
* </ul>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <ul style="list-style-type:none">
+ * <li>
+ * <h5>RoleRelationship required parameters</h5>
+ * <ul>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the name
+ * of existing AdminRole to be parent
+ * </li>
+ * <li>
+ * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the name of
+ * exi
<TRUNCATED>
[3/4] directory-fortress-enmasse git commit: Merge branch 'master' of
http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse
Posted by el...@apache.org.
http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/blob/8c002965/src/main/java/org/apache/directory/fortress/rest/FortressService.java
----------------------------------------------------------------------
diff --cc src/main/java/org/apache/directory/fortress/rest/FortressService.java
index 6e4d8ce,9301dc5..0000000
deleted file mode 100644,100644
--- a/src/main/java/org/apache/directory/fortress/rest/FortressService.java
+++ /dev/null
@@@ -1,6473 -1,5260 +1,0 @@@
--/*
-- * Licensed to the Apache Software Foundation (ASF) under one
-- * or more contributor license agreements. See the NOTICE file
-- * distributed with this work for additional information
-- * regarding copyright ownership. The ASF licenses this file
-- * to you under the Apache License, Version 2.0 (the
-- * "License"); you may not use this file except in compliance
-- * with the License. You may obtain a copy of the License at
-- *
-- * http://www.apache.org/licenses/LICENSE-2.0
-- *
-- * Unless required by applicable law or agreed to in writing,
-- * software distributed under the License is distributed on an
-- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-- * KIND, either express or implied. See the License for the
-- * specific language governing permissions and limitations
-- * under the License.
-- *
-- */
--package org.apache.directory.fortress.rest;
--
--import org.apache.directory.fortress.core.model.FortRequest;
--import org.apache.directory.fortress.core.model.FortResponse;
--
--/**
-- * Interface for EnMasse Service methods.
-- *
-- * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
-- */
--public interface FortressService
--{
-- //------------ AdminMgr -----------------------------------------------------------------------------------------------
-- /**
-- * This command creates a new RBAC user. The command is valid only if the new user is
-- * not already a member of the USERS data set. The USER data set is updated. The new user
-- * does not own any session at the time of its creation.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
-- * object
-- * </li>
-- * </ul>
- *
- *
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * </li>
-- * <li>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#ou} - contains the name of an already existing
- * {@link org.apache.directory.fortress.core.model.User#ou} - contains the name of an already existing
-- * User OU node
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User optional parameters</h5>
-- * </li>
-- * <li>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#pwPolicy} - contains the name of an already existing
- * {@link org.apache.directory.fortress.core.model.User#pwPolicy} - contains the name of an already existing
-- * OpenLDAP password policy node
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#cn} - maps to INetOrgPerson common name
- * {@link org.apache.directory.fortress.core.model.User#cn} - maps to INetOrgPerson common name
-- * attribute
-- * </li>
-- * <li>{@link org.apache.directory.fortress.core.model.User#sn} - maps to INetOrgPerson surname attribute</li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#description} - maps to INetOrgPerson description
- * {@link org.apache.directory.fortress.core.model.User#description} - maps to INetOrgPerson description
-- * attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#phones} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#phones} * - multi-occurring attribute maps to
-- * organizationalPerson telephoneNumber attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#mobiles} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#mobiles} * - multi-occurring attribute maps to
-- * INetOrgPerson mobile attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#emails} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#emails} * - multi-occurring attribute maps to
-- * INetOrgPerson mail attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#address} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#address} * - multi-occurring attribute maps to
-- * organizationalPerson postalAddress, st, l, postalCode, postOfficeBox attributes
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#beginTime} - HHMM - determines begin hour user
- * {@link org.apache.directory.fortress.core.model.User#beginTime} - HHMM - determines begin hour user
-- * may activate session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#endTime} - HHMM - determines end hour user may
- * {@link org.apache.directory.fortress.core.model.User#endTime} - HHMM - determines end hour user may
-- * activate session.
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#beginDate} - YYYYMMDD - determines date when user
- * {@link org.apache.directory.fortress.core.model.User#beginDate} - YYYYMMDD - determines date when user
-- * may sign on
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#endDate} - YYYYMMDD - indicates latest date user
- * {@link org.apache.directory.fortress.core.model.User#endDate} - YYYYMMDD - indicates latest date user
-- * may sign on
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#beginLockDate} - YYYYMMDD - determines beginning
- * {@link org.apache.directory.fortress.core.model.User#beginLockDate} - YYYYMMDD - determines beginning
-- * of enforced inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#endLockDate} - YYYYMMDD - determines end of enforced
- * {@link org.apache.directory.fortress.core.model.User#endLockDate} - YYYYMMDD - determines end of enforced
-- * inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
- * {@link org.apache.directory.fortress.core.model.User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
-- * specifies which day of user may sign on
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#timeout} - number in seconds of session inactivity
- * {@link org.apache.directory.fortress.core.model.User#timeout} - number in seconds of session inactivity
-- * time allowed
-- * </li>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.User#props} * - multi-occurring attribute contains
-- * property key and values are separated with a ':'. e.g. mykey1:myvalue1
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the
- * {@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the
-- * name of already existing role to assign to user
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains
- * {@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains
-- * the name of already existing adminRole to assign to user
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h3>optional parameters</h3>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse addUser( FortRequest request );
--
-
-
-- /**
-- * This command deletes an existing user from the RBAC database. The command is valid
-- * if and only if the user to be deleted is a member of the USERS data set. The USERS and
-- * UA data sets and the assigned_users function are updated.
-- * This method performs a "hard" delete. It completely removes all data associated with this user from the directory.
-- * User entity must exist in directory prior to making this call else exception will be thrown.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse deleteUser( FortRequest request );
--
-
-
-- /**
-- * This command deletes an existing user from the RBAC database. The command is valid
-- * if and only if the user to be deleted is a member of the USERS data set. The USERS and
-- * UA data sets and the assigned_users function are updated.
-- * Method performs a "soft" delete. It performs the following:
-- * <ul>
-- * <li>sets the user status to "deleted"</li>
-- * <li>deassigns all roles from the user</li>
-- * <li>locks the user's password in LDAP</li>
-- * <li>revokes all perms that have been granted to user entity.</li>
-- * </ul>
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * </ul>
-- * </li>
-- * </ul>
- * </li>
- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse disableUser( FortRequest request );
--
-
-
-- /**
-- * This method performs an update on User entity in directory. Prior to making this call the entity must exist in
-- * directory.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * </ul>
-- * </li>
-- * <li>
-- * <h5>User optional parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#password} - used to authenticate the User</li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#ou} - contains the name of an already existing User
- * {@link org.apache.directory.fortress.core.model.User#ou} - contains the name of an already existing User
-- * OU node
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#pwPolicy} - contains the name of an already existing
- * {@link org.apache.directory.fortress.core.model.User#pwPolicy} - contains the name of an already existing
-- * OpenLDAP password policy node
-- * </li>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.User#cn} - maps to INetOrgPerson common name attribute
-- * </li>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.User#sn} - maps to INetOrgPerson surname attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#description} - maps to INetOrgPerson description
- * {@link org.apache.directory.fortress.core.model.User#description} - maps to INetOrgPerson description
-- * attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#phones} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#phones} * - multi-occurring attribute maps to
-- * organizationalPerson telephoneNumber attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#mobiles} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#mobiles} * - multi-occurring attribute maps to
-- * INetOrgPerson mobile attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#emails} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#emails} * - multi-occurring attribute maps to
-- * INetOrgPerson mail attribute
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#address} * - multi-occurring attribute maps to
- * {@link org.apache.directory.fortress.core.model.User#address} * - multi-occurring attribute maps to
-- * organizationalPerson postalAddress, st, l, postalCode, postOfficeBox attributes
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#beginTime} - HHMM - determines begin hour user may
- * {@link org.apache.directory.fortress.core.model.User#beginTime} - HHMM - determines begin hour user may
-- * activate session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#endTime} - HHMM - determines end hour user may
- * {@link org.apache.directory.fortress.core.model.User#endTime} - HHMM - determines end hour user may
-- * activate session.
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#beginDate} - YYYYMMDD - determines date when user
- * {@link org.apache.directory.fortress.core.model.User#beginDate} - YYYYMMDD - determines date when user
-- * may sign on
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#endDate} - YYYYMMDD - indicates latest date user
- * {@link org.apache.directory.fortress.core.model.User#endDate} - YYYYMMDD - indicates latest date user
-- * may sign on
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#beginLockDate} - YYYYMMDD - determines beginning
- * {@link org.apache.directory.fortress.core.model.User#beginLockDate} - YYYYMMDD - determines beginning
-- * of enforced inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#endLockDate} - YYYYMMDD - determines end of enforced
- * {@link org.apache.directory.fortress.core.model.User#endLockDate} - YYYYMMDD - determines end of enforced
-- * inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
- * {@link org.apache.directory.fortress.core.model.User#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
-- * specifies which day of user may sign on
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#timeout} - number in seconds of session inactivity
- * {@link org.apache.directory.fortress.core.model.User#timeout} - number in seconds of session inactivity
-- * time allowed
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#props} * - multi-occurring attribute contains property
- * {@link org.apache.directory.fortress.core.model.User#props} * - multi-occurring attribute contains property
-- * key and values are separated with a ':'. e.g. mykey1:myvalue1
- *
- *
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the name
- * {@link org.apache.directory.fortress.core.model.User#roles} * - multi-occurring attribute contains the name
-- * of already existing role to assign to user
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains the
- * {@link org.apache.directory.fortress.core.model.User#adminRoles} * - multi-occurring attribute contains the
-- * name of already existing adminRole to assign to user
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse updateUser( FortRequest request );
--
-
-
-- /**
-- * Method will change user's password. This method will evaluate user's password policies.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to
- * {@link FortRequest#entity} - contains a reference to
-- * {@link org.apache.directory.fortress.core.model.User} object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * <li>{@link org.apache.directory.fortress.core.model.User#password} - contains the User's old password</li>
-- * <li>newPassword - contains the User's new password</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse changePassword( FortRequest request );
--
-
-
-- /**
-- * Method will lock user's password which will prevent the user from authenticating with directory.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse lockUserAccount( FortRequest request );
--
-
-
-- /**
-- * Method will unlock user's password which will enable user to authenticate with directory.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse unlockUserAccount( FortRequest request );
--
-
-
-- /**
- * Method will reset user's password which will require user to change password before successful authentication
- * Method will reset user's password which will require user to change password before successful authentication
-- * with directory.
-- * This method will not evaluate password policies on the new user password as it must be changed before use.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
-- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.User} object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>User required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - maps to INetOrgPerson uid</li>
-- * <li>newPassword - contains the User's new password</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse resetPassword( FortRequest request );
--
-
-
-- /**
-- * This command creates a new role. The command is valid if and only if the new role is not
-- * already a member of the ROLES data set. The ROLES data set is updated.
-- * Initially, no user or permission is assigned to the new role.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
-- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Role} object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Role required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to
- * {@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to
-- * be created.
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Role optional parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#description} - maps to description attribute on
- * {@link org.apache.directory.fortress.core.model.Role#description} - maps to description attribute on
-- * organizationalRole object class
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#beginTime} - HHMM - determines begin hour role may
- * {@link org.apache.directory.fortress.core.model.Role#beginTime} - HHMM - determines begin hour role may
-- * be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#endTime} - HHMM - determines end hour role may be
- * {@link org.apache.directory.fortress.core.model.Role#endTime} - HHMM - determines end hour role may be
-- * activated into user's RBAC session.
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#beginDate} - YYYYMMDD - determines date when role
- * {@link org.apache.directory.fortress.core.model.Role#beginDate} - YYYYMMDD - determines date when role
-- * may be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#endDate} - YYYYMMDD - indicates latest date role
- * {@link org.apache.directory.fortress.core.model.Role#endDate} - YYYYMMDD - indicates latest date role
-- * may be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#beginLockDate} - YYYYMMDD - determines beginning
- * {@link org.apache.directory.fortress.core.model.Role#beginLockDate} - YYYYMMDD - determines beginning
-- * of enforced inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#endLockDate} - YYYYMMDD - determines end of enforced
- * {@link org.apache.directory.fortress.core.model.Role#endLockDate} - YYYYMMDD - determines end of enforced
-- * inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
- * {@link org.apache.directory.fortress.core.model.Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
-- * specifies which day role may be activated into user's RBAC session
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse addRole( FortRequest request );
-
-
-
-
-- /**
-- * This command deletes an existing role from the RBAC database. The command is valid
-- * if and only if the role to be deleted is a member of the ROLES data set. This command will
-- * also deassign role from all users.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Role}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Role}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Role required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role
- * {@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role
-- * to be removed.
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>Role optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse deleteRole( FortRequest request );
--
-
-
-- /**
-- * Method will update a Role entity in the directory. The role must exist in role container prior to this call. *
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
-- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Role} object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Role required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to be
- * {@link org.apache.directory.fortress.core.model.Role#name} - contains the name to use for the Role to be
-- * updated.
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Role optional parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#description} - maps to description attribute
- * {@link org.apache.directory.fortress.core.model.Role#description} - maps to description attribute
-- * on organizationalRole object class
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#beginTime} - HHMM - determines begin hour role
- * {@link org.apache.directory.fortress.core.model.Role#beginTime} - HHMM - determines begin hour role
-- * may be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#endTime} - HHMM - determines end hour role may
- * {@link org.apache.directory.fortress.core.model.Role#endTime} - HHMM - determines end hour role may
-- * be activated into user's RBAC session.
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#beginDate} - YYYYMMDD - determines date when role
- * {@link org.apache.directory.fortress.core.model.Role#beginDate} - YYYYMMDD - determines date when role
-- * may be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#endDate} - YYYYMMDD - indicates latest date role
- * {@link org.apache.directory.fortress.core.model.Role#endDate} - YYYYMMDD - indicates latest date role
-- * may be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#beginLockDate} - YYYYMMDD - determines beginning
- * {@link org.apache.directory.fortress.core.model.Role#beginLockDate} - YYYYMMDD - determines beginning
-- * of enforced inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#endLockDate} - YYYYMMDD - determines end of
- * {@link org.apache.directory.fortress.core.model.Role#endLockDate} - YYYYMMDD - determines end of
-- * enforced inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
- * {@link org.apache.directory.fortress.core.model.Role#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
-- * specifies which day role may be activated into user's RBAC session
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will
- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints</li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse updateRole( FortRequest request );
--
-
-
-- /**
-- * This command assigns a user to a role.
-- * <ul>
-- * <li> The command is valid if and only if:
-- * <li> The user is a member of the USERS data set
-- * <li> The role is a member of the ROLES data set
-- * <li> The user is not already assigned to the role
-- * <li> The SSD constraints are satisfied after assignment.
-- * </ul>
-- * Successful completion of this op, the following occurs:
-- * <ul>
-- * <li>
- * User entity (resides in people container) has role assignment added to aux object class attached to actual user
- * User entity (resides in people container) has role assignment added to aux object class attached to actual user
-- * record.
-- * </li>
-- * <li> Role entity (resides in role container) has userId added as role occupant.</li>
-- * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:</li>
-- * <li>
-- * <ul>
-- * <li> timeout - number in seconds of session inactivity time allowed.</li>
-- * <li> beginDate - YYYYMMDD - determines date when role may be activated.</li>
-- * <li> endDate - YYMMDD - indicates latest date role may be activated.</li>
-- * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status</li>
-- * <li> endLockDate - YYMMDD - determines end of enforced inactive status.</li>
-- * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.</li>
-- * <li> endTime - HHMM - determines end hour role may be activated in user's session.*</li>
-- * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>UserRole required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#name} - contains the name for already existing
- * {@link org.apache.directory.fortress.core.model.UserRole#name} - contains the name for already existing
-- * Role to be assigned
-- * </li>
-- * <li>{@link org.apache.directory.fortress.core.model.UserRole#userId} - contains the userId for existing User</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>UserRole optional parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#beginTime} - HHMM - determines begin hour role
- * {@link org.apache.directory.fortress.core.model.UserRole#beginTime} - HHMM - determines begin hour role
-- * may be activated into user's RBAC session.
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#endTime} - HHMM - determines end hour role may
- * {@link org.apache.directory.fortress.core.model.UserRole#endTime} - HHMM - determines end hour role may
-- * be activated into user's RBAC session.
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#beginDate} - YYYYMMDD - determines date when
- * {@link org.apache.directory.fortress.core.model.UserRole#beginDate} - YYYYMMDD - determines date when
-- * role may be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#endDate} - YYYYMMDD - indicates latest date role
- * {@link org.apache.directory.fortress.core.model.UserRole#endDate} - YYYYMMDD - indicates latest date role
-- * may be activated into user's RBAC session
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#beginLockDate} - YYYYMMDD - determines beginning
- * {@link org.apache.directory.fortress.core.model.UserRole#beginLockDate} - YYYYMMDD - determines beginning
-- * of enforced inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#endLockDate} - YYYYMMDD - determines end of
- * enforced
- * {@link org.apache.directory.fortress.core.model.UserRole#endLockDate} - YYYYMMDD - determines end of
- * enforced
-- * inactive status
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
- * {@link org.apache.directory.fortress.core.model.UserRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc -
-- * specifies which day role may be activated into user's RBAC session
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will enforce
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will enforce
-- * ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse assignUser( FortRequest request );
--
-
-
-- /**
-- * This command deletes the assignment of the User from the Role entities. The command is
-- * valid if and only if the user is a member of the USERS data set, the role is a member of
-- * the ROLES data set, and the user is assigned to the role.
-- * Any sessions that currently have this role activated will not be effected.
-- * Successful completion includes:
-- * User entity in USER data set has role assignment removed.
-- * Role entity in ROLE data set has userId removed as role occupant.
-- * (optional) Temporal constraints will be removed from user aux object if set prior to call.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.UserRole}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>UserRole required parameters</h5>
-- * <ul>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.UserRole#name} - contains the name for already existing
-- * Role to be deassigned
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.UserRole#userId} - contains the userId for existing
- * {@link org.apache.directory.fortress.core.model.UserRole#userId} - contains the userId for existing
-- * User
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse deassignUser( FortRequest request );
--
-
-
-- /**
- * This method will add permission operation to an existing permission object which resides under
- * 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
- * The perm operation entity may have {@link org.apache.directory.fortress.core.model.Role} or
- * {@link org.apache.directory.fortress.core.model.User} associations. The target
-- * {@link org.apache.directory.fortress.core.model.Permission} must not exist prior to calling.
- * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself
- * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself
-- * as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->
-- * {@link org.apache.directory.fortress.core.model.Permission}).
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Permission required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object
- * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object
-- * being targeted for the permission add
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission
- * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission
-- * operation being added
-- * </li>
-- * </ul>
-- * <h5>Permission optional parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains
- * {@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains
-- * RBAC Roles that permission operation is being granted to
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains
- * {@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains
-- * Users that permission operation is being granted to
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and
- * {@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and
-- * values are separated with a ':'. e.g. mykey1:myvalue1
-- * </li>
-- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will enforce
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will enforce
-- * ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse addPermission( FortRequest request );
--
-
-
-- /**
- * This method will update permission operation pre-existing in target directory under
- * This method will update permission operation pre-existing in target directory under
-- * {@code ou=Permissions,ou=RBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may also contain {@link org.apache.directory.fortress.core.model.Role}
- * The perm operation entity may also contain {@link org.apache.directory.fortress.core.model.Role}
-- * or {@link org.apache.directory.fortress.core.model.User} associations to add or remove using this function.
-- * The perm operation must exist before making this call. Only non-null attributes will be updated.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Permission required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object
- * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object
-- * being targeted for the permission update
-- * </li>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission
-- * operation being updated
-- * </li>
-- * </ul>
-- * <h5>Permission optional parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains
- * {@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains
-- * RBAC Roles that permission operation is being granted to
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains
- * {@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains
-- * Users that permission operation is being granted to
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and
- * {@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and
-- * values are separated with a ':'. e.g. mykey1:myvalue1
-- * </li>
-- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse updatePermission( FortRequest request );
--
-
-
-- /**
- * This method will remove permission operation entity from permission object. A Fortress permission is
- * This method will remove permission operation entity from permission object. A Fortress permission is
-- * (object->operation).
-- * The perm operation must exist before making this call.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.Permission}
-- * object
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>Permission required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing
- * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing
-- * object being targeted for the permission removal
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission
- * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission
-- * operation being deleted
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse deletePermission( FortRequest request );
--
-
-
-- /**
- * This method will add permission object to perms container in directory. The perm object must not exist before
- * making this call. A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical,
- * one-many relationship between itself and children as stored in ldap tree:
- * This method will add permission object to perms container in directory. The perm object must not exist before
- * making this call. A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical,
- * one-many relationship between itself and children as stored in ldap tree:
-- * ({@link org.apache.directory.fortress.core.model.PermObj}*->
-- * {@link org.apache.directory.fortress.core.model.Permission}).
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermObj}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermObj}
-- * entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>PermObj required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object being
- * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object being
-- * added
-- * </li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS
- * {@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS
-- * OrgUnit this object is associated with
-- * </li>
-- * </ul>
-- * <h5>PermObj optional parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and
- * {@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and
-- * values are separated with a ':'. e.g. mykey1:myvalue1
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will enforce
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will enforce
-- * ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse addPermObj( FortRequest request );
--
-
-
-- /**
- * This method will update permission object in perms container in directory. The perm object must exist before making
- * This method will update permission object in perms container in directory. The perm object must exist before making
-- * this call.
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship
-- * between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->
-- * {@link org.apache.directory.fortress.core.model.Permission}).
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermObj}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermObj}
-- * entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>PermObj required parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object
- * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object
-- * being updated
-- * </li>
-- * </ul>
-- * <h5>PermObj optional parameters</h5>
-- * <ul>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS
- * {@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS
-- * OrgUnit this object is associated with
-- * </li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
-- * <li>
- * {@link org.apache.directory.fortress.core.model.PermObj#props} * -
- * {@link org.apache.directory.fortress.core.model.PermObj#props} * -
-- * multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service
- * {@link FortRequest#session} - contains a reference to administrative session and if included service
-- * will enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse updatePermObj( FortRequest request );
--
-
-
-- /**
-- * This method will remove permission object to perms container in directory. This method will also remove
-- * in associated permission objects that are attached to this object.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermObj}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermObj}
-- * entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>PermObj required parameters</h5>
-- * <ul>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object
-- * being removed
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h5>optional parameters</h5>
-- * <ul>
-- * <li>
-- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse deletePermObj( FortRequest request );
--
-
-
-- /**
-- * This command grants a role the permission to perform an operation on an object to a role.
-- * The command is implemented by granting permission by setting the access control list of
-- * the object involved.
-- * The command is valid if and only if the pair (operation, object) represents a permission,
-- * and the role is a member of the ROLES data set.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
-- * entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>PermGrant required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objName} - contains the object name</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#opName} - contains the operation name</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#roleNm} - contains the role name</li>
-- * </ul>
-- * <h5>PermGrant optional parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objId} - contains the object id</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse grant( FortRequest request );
--
-
-
-- /**
-- * This command revokes the permission to perform an operation on an object from the set
-- * of permissions assigned to a role. The command is implemented by setting the access control
-- * list of the object involved.
-- * The command is valid if and only if the pair (operation, object) represents a permission,
-- * the role is a member of the ROLES data set, and the permission is assigned to that role.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
-- * entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>PermGrant required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objName} - contains the object name</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#opName} - contains the operation name</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#roleNm} - contains the role name</li>
-- * </ul>
-- * <h5>PermGrant optional parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objId} - contains the object id</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse revoke( FortRequest request );
--
-
-
-- /**
-- * This command grants a user the permission to perform an operation on an object to a role.
-- * The command is implemented by granting permission by setting the access control list of
-- * the object involved.
-- * The command is valid if and only if the pair (operation, object) represents a permission,
-- * and the user is a member of the USERS data set.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
-- * entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>PermGrant required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objName} - contains the object name</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#opName} - contains the operation name</li>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.PermGrant#userId} - contains the userId for existing User
-- * </li>
-- * </ul>
-- * <h5>PermGrant optional parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objId} - contains the object id</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse grantUser( FortRequest request );
--
-
-
-- /**
-- * This command revokes the permission to perform an operation on an object from the set
-- * of permissions assigned to a user. The command is implemented by setting the access control
-- * list of the object involved.
-- * The command is valid if and only if the pair (operation, object) represents a permission,
-- * the user is a member of the USERS data set, and the permission is assigned to that user.
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
- * {@link FortRequest#entity} - contains a reference to {@link org.apache.directory.fortress.core.model.PermGrant}
-- * entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>PermGrant required parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objName} - contains the object name</li>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#opName} - contains the operation name</li>
-- * <li>
-- * {@link org.apache.directory.fortress.core.model.PermGrant#userId} - contains the userId for existing User
-- * </li>
-- * </ul>
-- * <h5>PermGrant optional parameters</h5>
-- * <ul>
-- * <li>{@link org.apache.directory.fortress.core.model.PermGrant#objId} - contains the object id</li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse revokeUser( FortRequest request );
--
-
-
-- /**
-- * This commands creates a new role childRole, and inserts it in the role hierarchy as an immediate descendant of
-- * the existing role parentRole.
-- * <p>
-- * The command is valid if and only if:
-- * <ul>
-- * <li> The childRole is not a member of the ROLES data set.
-- * <li> The parentRole is a member of the ROLES data set.
-- * </ul>
-- * This method:
-- * <ul>
-- * <li> Adds new role.
-- * <li> Assigns role relationship between new childRole and pre-existing parentRole.
-- * </ul>
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to
- * {@link FortRequest#entity} - contains a reference to
-- * {@link org.apache.directory.fortress.core.model.RoleRelationship} entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>RoleRelationship required parameters</h5>
-- * <ul>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the name of
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains the name of
-- * existing parent role
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the name of new
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains the name of new
-- * child role
-- * </li>
-- * </ul>
-- * <h5>optional parameters {@link org.apache.directory.fortress.core.model.RoleRelationship#child}</h5>
-- * <ul>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#description} - maps to description
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#description} - maps to description
-- * attribute on organizationalRole object class for new child
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginTime} - HHMM - determines
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginTime} - HHMM - determines
-- * begin hour role may be activated into user's RBAC session for new child
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endTime} - HHMM - determines end
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endTime} - HHMM - determines end
-- * hour role may be activated into user's RBAC session for new child
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginDate} - YYYYMMDD - determines
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginDate} - YYYYMMDD - determines
-- * date when role may be activated into user's RBAC session for new child
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endDate} - YYYYMMDD - indicates
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endDate} - YYYYMMDD - indicates
-- * latest date role may be activated into user's RBAC session for new child
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginLockDate} - YYYYMMDD -
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#beginLockDate} - YYYYMMDD -
-- * determines beginning of enforced inactive status for new child
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endLockDate} - YYYYMMDD -
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#endLockDate} - YYYYMMDD -
-- * determines end of enforced inactive status for new child
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#dayMask} - 1234567, 1 = Sunday,
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#child#dayMask} - 1234567, 1 = Sunday,
-- * 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new child
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
- * {@link FortRequest#session} - contains a reference to administrative session and if included service will
-- * enforce ARBAC constraints
-- * </li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse addDescendant( FortRequest request );
--
-
-
-- /**
-- * This commands creates a new role parentRole, and inserts it in the role hierarchy as an immediate ascendant of
-- * the existing role childRole.
-- * <p>
-- * The command is valid if and only if:
-- * <ul>
-- * <li> The parentRole is not a member of the ROLES data set.
-- * <li> The childRole is a member of the ROLES data set.
-- * </ul>
- * <p>
- * <p>
-- * This method:
-- * <ul>
-- * <li> Adds new role.
-- * <li> Assigns role relationship between new parentRole and pre-existing childRole.
-- * </ul>
-- * <h3></h3>
-- * <h4>required parameters</h4>
-- * <ul>
-- * <li>
- * {@link FortRequest#entity} - contains a reference to
- * {@link FortRequest#entity} - contains a reference to
-- * {@link org.apache.directory.fortress.core.model.RoleRelationship} entity
-- * </li>
-- * </ul>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <ul style="list-style-type:none">
-- * <li>
-- * <h5>RoleRelationship required parameters</h5>
-- * <ul>
- * <li>childRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains
- * <li>childRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#child#name} - contains
-- * the name of existing child Role</li>
- * <li>parentRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains
- * <li>parentRole - {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#name} - contains
-- * the name of new Role to be parent</li>
-- * </ul>
-- * <h5>optional parameters {@link org.apache.directory.fortress.core.model.RoleRelationship#parent}</h5>
-- * <ul>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#description} - maps to
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#description} - maps to
-- * description attribute on organizationalRole object class for new parent
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginTime} - HHMM - determines
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginTime} - HHMM - determines
-- * begin hour role may be activated into user's RBAC session for new parent
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endTime} - HHMM - determines
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endTime} - HHMM - determines
-- * end hour role may be activated into user's RBAC session for new parent
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginDate} - YYYYMMDD -
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginDate} - YYYYMMDD -
-- * determines date when role may be activated into user's RBAC session for new parent
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endDate} - YYYYMMDD - indicates
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endDate} - YYYYMMDD - indicates
-- * latest date role may be activated into user's RBAC session for new parent
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginLockDate} - YYYYMMDD -
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#beginLockDate} - YYYYMMDD -
-- * determines beginning of enforced inactive status for new parent
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endLockDate} - YYYYMMDD -
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#endLockDate} - YYYYMMDD -
-- * determines end of enforced inactive status for new parent
-- * </li>
-- * <li>
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#dayMask} - 1234567, 1 = Sunday,
- * {@code org.apache.directory.fortress.core.model.RoleRelationship#parent#dayMask} - 1234567, 1 = Sunday,
-- * 2 = Monday, etc - specifies which day role may be activated into user's RBAC session for new parent
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * </li>
-- * </ul>
-- * <h4>optional parameters</h4>
-- * <ul>
-- * <li>{@link FortRequest#session} - contains a reference to administrative session and if included service will enforce ARBAC constraints</li>
-- * </ul>
-- *
-- * @param request contains a reference to {@code FortRequest}
-- * @return reference to {@code FortResponse}
-- */
-- FortResponse addAscendant( FortRequest request );
--
-
-
-- /**
-- * This commands establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
-- * roles parentRole, childRole.
-- * <p>
-- * The command is valid if and only if:
-- * <ul>
-- * <li> The parentRole and childRole are members of the ROLES data set.
-- * <li> The parentRole
<TRUNCATED>
[4/4] directory-fortress-enmasse git commit: Merge branch 'master' of
http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse
Posted by el...@apache.org.
Merge branch 'master' of http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse
Conflicts:
src/main/java/org/apache/directory/fortress/rest/FortressService.java
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/commit/8c002965
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/tree/8c002965
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/diff/8c002965
Branch: refs/heads/master
Commit: 8c0029656ecd41677df48f3e0f7467551f4d694f
Parents: a3092a0 604cc9d
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Sun Jan 10 20:49:48 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Sun Jan 10 20:49:48 2016 +0100
----------------------------------------------------------------------
.../fortress/rest/FortressService.java | 6473 ------------------
.../fortress/rest/FortressServiceImpl.java | 3235 +--------
2 files changed, 244 insertions(+), 9464 deletions(-)
----------------------------------------------------------------------
[2/4] directory-fortress-enmasse git commit: Some more javadoc fixes
Posted by el...@apache.org.
Some more javadoc fixes
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/commit/a3092a07
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/tree/a3092a07
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/diff/a3092a07
Branch: refs/heads/master
Commit: a3092a07740a0dfd6bd649002377d245d8cdbbea
Parents: fb7d20c
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Tue Dec 22 12:12:16 2015 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Tue Dec 22 12:12:16 2015 +0100
----------------------------------------------------------------------
.../fortress/rest/FortressInterceptor.java | 2 +-
.../fortress/rest/FortressService.java | 2702 +++++++++++++-----
2 files changed, 1990 insertions(+), 714 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse/blob/a3092a07/src/main/java/org/apache/directory/fortress/rest/FortressInterceptor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/rest/FortressInterceptor.java b/src/main/java/org/apache/directory/fortress/rest/FortressInterceptor.java
index 6562740..50ef59c 100644
--- a/src/main/java/org/apache/directory/fortress/rest/FortressInterceptor.java
+++ b/src/main/java/org/apache/directory/fortress/rest/FortressInterceptor.java
@@ -61,7 +61,7 @@ public class FortressInterceptor extends SimpleAuthorizingInterceptor
/**
*
- * @param name
+ * @param name The annotation class name
*/
public void setAnnotationClassName( String name )
{