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/06 16:51:10 UTC
[01/10] directory-fortress-core git commit: Fixed Javadoc issues.
Repository: directory-fortress-core
Updated Branches:
refs/heads/master 7a1a756a1 -> f5faeb0fc
Fixed Javadoc issues.
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/b2a52297
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/b2a52297
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/b2a52297
Branch: refs/heads/master
Commit: b2a52297a1c3228b79adbdea219bb27d8df042bc
Parents: cbca605
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Tue Jan 5 23:33:21 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Tue Jan 5 23:33:21 2016 +0100
----------------------------------------------------------------------
.../fortress/core/AuditMgrFactory.java | 4 +--
.../fortress/core/AuthorizationException.java | 3 ++-
.../directory/fortress/core/CfgException.java | 9 ++++---
.../directory/fortress/core/ConfigMgr.java | 28 ++++++++++++--------
.../fortress/core/ConfigMgrFactory.java | 7 +++--
.../fortress/core/CreateException.java | 6 +++--
6 files changed, 34 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/b2a52297/src/main/java/org/apache/directory/fortress/core/AuditMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/AuditMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/AuditMgrFactory.java
index a769c33..d486ac9 100755
--- a/src/main/java/org/apache/directory/fortress/core/AuditMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/AuditMgrFactory.java
@@ -29,10 +29,10 @@ import org.apache.directory.fortress.core.util.VUtil;
/**
* Creates an instance of the AuditMgr object.
- * <p/>
+ * <p>
* The default implementation class is specified as {@link AuditMgrImpl} but can be overridden by
* adding the {@link GlobalIds#AUDIT_IMPLEMENTATION} config property.
- * <p/>
+ * <p>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/b2a52297/src/main/java/org/apache/directory/fortress/core/AuthorizationException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/AuthorizationException.java b/src/main/java/org/apache/directory/fortress/core/AuthorizationException.java
index bb08b19..bef290c 100755
--- a/src/main/java/org/apache/directory/fortress/core/AuthorizationException.java
+++ b/src/main/java/org/apache/directory/fortress/core/AuthorizationException.java
@@ -35,7 +35,8 @@ public class AuthorizationException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
*
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public AuthorizationException( int errorId, String msg )
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/b2a52297/src/main/java/org/apache/directory/fortress/core/CfgException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/CfgException.java b/src/main/java/org/apache/directory/fortress/core/CfgException.java
index 6828e78..b52e55e 100755
--- a/src/main/java/org/apache/directory/fortress/core/CfgException.java
+++ b/src/main/java/org/apache/directory/fortress/core/CfgException.java
@@ -21,7 +21,8 @@ package org.apache.directory.fortress.core;
/**
- * This exception extends {@link SecurityException} and is thrown when Fortress cannot find correct cfg for a particular entity.
+ * This exception extends {@link SecurityException} and is thrown when Fortress cannot find correct cfg for a particular
+ * entity.
* See the {@link GlobalErrIds} javadoc for list of error ids.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
@@ -34,7 +35,8 @@ public class CfgException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public CfgException( int errorId, String msg )
@@ -45,7 +47,8 @@ public class CfgException extends SecurityException
/**
* Create exception with error id, message and related exception.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
* @param previousException contains reference to related exception which usually is system related, i.e. ldap.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/b2a52297/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java b/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java
index e37a673..bebce59 100755
--- a/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/ConfigMgr.java
@@ -29,13 +29,12 @@ import java.util.Properties;
* This interface prescribes CRUD methods used to manage properties stored within the ldap directory.
* The Fortress config nodes are used to remotely share Fortress client specific properties between processes.
* Fortress places no limits on the number of unique configurations that can be present at one time in the directory.
- * The Fortress client will specify the preferred cfg node by name via a property named, {@link org.apache.directory.fortress.core.GlobalIds#CONFIG_REALM}.
+ * The Fortress client will specify the preferred cfg node by name via a property named,
+ * {@link org.apache.directory.fortress.core.GlobalIds#CONFIG_REALM}.
* Each process using Fortress client is free to share an existing node with other processes or create its own unique config
* instance using the methods within this class.<BR>
- * <p/>
+ * <p>
* This class is thread safe.
- * <p/>
-
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -43,7 +42,8 @@ public interface ConfigMgr
{
/**
* Create a new cfg node with given name and properties. The name is required. If node already exists,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_ALREADY_EXISTS} will be thrown.
+ * a {@link org.apache.directory.fortress.core.SecurityException} with error
+ * {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_ALREADY_EXISTS} will be thrown.
*
* @param name attribute is required and maps to 'cn' attribute in 'device' object class.
* @param inProps contains {@link Properties} with list of name/value pairs to add to existing config node.
@@ -54,8 +54,9 @@ public interface ConfigMgr
/**
- * Update existing cfg node with additional properties, or, replace existing properties. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
+ * Update existing cfg node with additional properties, or, replace existing properties. The name is required.
+ * If node does not exist, a {@link org.apache.directory.fortress.core.SecurityException} with error
+ * {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
*
* @param name attribute is required and maps to 'cn' attribute in 'device' object class.
* @param inProps contains {@link Properties} with list of name/value pairs to add or update from existing config node.
@@ -67,7 +68,8 @@ public interface ConfigMgr
/**
* Completely removes named cfg node from the directory. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
+ * a {@link org.apache.directory.fortress.core.SecurityException} with error
+ * {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
*
* @param name is required and maps to 'cn' attribute on 'device' object class of node targeted for operation.
* @throws org.apache.directory.fortress.core.SecurityException in the event of system error.
@@ -77,9 +79,11 @@ public interface ConfigMgr
/**
* Delete properties from existing cfg node. The name is required. If node does not exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
+ * a {@link org.apache.directory.fortress.core.SecurityException} with error
+ * {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
*
* @param name attribute is required and maps to 'cn' attribute in 'device' object class.
+ * @param inProps TODO
* @throws org.apache.directory.fortress.core.SecurityException in the event entry not present or other system error.
*/
void delete( String name, Properties inProps ) throws SecurityException;
@@ -87,10 +91,12 @@ public interface ConfigMgr
/**
* Read an existing cfg node with given name and return to caller. The name is required. If node doesn't exist,
- * a {@link org.apache.directory.fortress.core.SecurityException} with error {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
+ * a {@link org.apache.directory.fortress.core.SecurityException} with error
+ * {@link org.apache.directory.fortress.core.GlobalErrIds#FT_CONFIG_NOT_FOUND} will be thrown.
*
* @param name attribute is required and maps to 'cn' attribute in 'device' object class.
- * @return {@link Properties} containing the collection of name/value pairs just added. Maps to 'ftProps' attribute in 'ftProperties' object class.
+ * @return {@link Properties} containing the collection of name/value pairs just added. Maps to 'ftProps' attribute
+ * in 'ftProperties' object class.
* @throws org.apache.directory.fortress.core.SecurityException in the event entry doesn't exist or other system error.
*/
Properties read( String name ) throws SecurityException;
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/b2a52297/src/main/java/org/apache/directory/fortress/core/ConfigMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ConfigMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/ConfigMgrFactory.java
index 9438f06..02f62a6 100755
--- a/src/main/java/org/apache/directory/fortress/core/ConfigMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/ConfigMgrFactory.java
@@ -26,11 +26,10 @@ import org.apache.directory.fortress.core.rest.ConfigMgrRestImpl;
/**
* Creates an instance of the ConfigMgr object.
- * <p/>
- * The default implementation class is specified as {@link org.apache.directory.fortress.core.impl.ConfigMgrImpl} but can be overridden by
+ * <p>
+ * The default implementation class is specified as {@link org.apache.directory.fortress.core.impl.ConfigMgrImpl} but
+ * can be overridden by
* adding the {@link org.apache.directory.fortress.core.GlobalIds#CONFIG_IMPLEMENTATION} config property.
- * <p/>
-
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/b2a52297/src/main/java/org/apache/directory/fortress/core/CreateException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/CreateException.java b/src/main/java/org/apache/directory/fortress/core/CreateException.java
index c3375e1..961e11a 100755
--- a/src/main/java/org/apache/directory/fortress/core/CreateException.java
+++ b/src/main/java/org/apache/directory/fortress/core/CreateException.java
@@ -34,7 +34,8 @@ public class CreateException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public CreateException( int errorId, String msg )
@@ -45,7 +46,8 @@ public class CreateException extends SecurityException
/**
* Create exception with error id, message and related exception.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
* @param previousException contains reference to related exception which usually is system related, i.e. ldap.
*/
[02/10] directory-fortress-core git commit: Fixed the Javadoc
Posted by el...@apache.org.
Fixed the Javadoc
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/f7dd2497
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/f7dd2497
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/f7dd2497
Branch: refs/heads/master
Commit: f7dd2497250f87074370d88feef2c0e84067b78c
Parents: b2a5229
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Wed Jan 6 07:40:10 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Wed Jan 6 07:40:10 2016 +0100
----------------------------------------------------------------------
.../directory/fortress/core/DelAccessMgr.java | 68 ++++++++++++--------
.../fortress/core/DelAccessMgrFactory.java | 3 +-
2 files changed, 41 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7dd2497/src/main/java/org/apache/directory/fortress/core/DelAccessMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/DelAccessMgr.java b/src/main/java/org/apache/directory/fortress/core/DelAccessMgr.java
index c9eefb1..6dbe186 100755
--- a/src/main/java/org/apache/directory/fortress/core/DelAccessMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/DelAccessMgr.java
@@ -31,18 +31,22 @@ import java.util.Set;
/**
- * This interface prescribes the API for performing runtime delegated access control operations on objects that are provisioned Fortress ARBAC entities
- * that reside in LDAP directory.
- * These APIs map directly to similar named APIs specified by ARBAC02 functions. The ARBAC Functional specification describes delegated administrative
- * operations for the creation and maintenance of ARBAC element sets and relations. Delegated administrative review functions for performing administrative queries
- * and system functions for creating and managing ARBAC attributes on user sessions and making delegated administrative access control decisions.
+ * This interface prescribes the API for performing runtime delegated access control operations on objects that are
+ * provisioned Fortress ARBAC entities that reside in LDAP directory.
+ * These APIs map directly to similar named APIs specified by ARBAC02 functions. The ARBAC Functional specification
+ * describes delegated administrative operations for the creation and maintenance of ARBAC element sets and relations.
+ * Delegated administrative review functions for performing administrative queries and system functions for creating and
+ * managing ARBAC attributes on user sessions and making delegated administrative access control decisions.
* <h3>Administrative Role Based Access Control (ARBAC)</h3>
- * <img src="./doc-files/ARbac.png">
- * <p/>
- * Fortress fully supports the Oh/Sandhu/Zhang ARBAC02 model for delegated administration. ARBAC provides large enterprises the capability to delegate administrative authority to users that reside outside of the security admin group.
- * Decentralizing administration helps because it provides security provisioning capability to work groups without sacrificing regulations for accountability or traceability.
- * <p/>
- * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)} or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
+ * <img src="./doc-files/ARbac.png" alt="">
+ * <p>
+ * Fortress fully supports the Oh/Sandhu/Zhang ARBAC02 model for delegated administration. ARBAC provides large enterprises
+ * the capability to delegate administrative authority to users that reside outside of the security admin group.
+ * Decentralizing administration helps because it provides security provisioning capability to work groups without
+ * sacrificing regulations for accountability or traceability.
+ * <p>
+ * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)}
+ * or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -52,7 +56,8 @@ public interface DelAccessMgr extends Manageable
* This function will determine if the user contains an AdminRole that is authorized assignment control over
* User-Role Assignment (URA). This adheres to the ARBAC02 functional specification for can-assign URA.
*
- * @param session This object must be instantiated by calling {@link AccessMgr#createSession(org.apache.directory.fortress.core.model.User, boolean)} before passing into the method. No variables need to be set by client after returned from createSession.
+ * @param session This object must be instantiated by calling
+ * {@link AccessMgr#createSession(org.apache.directory.fortress.core.model.User, boolean)} before passing into the method. No variables need to be set by client after returned from createSession.
* @param user Instantiated User entity requires only valid userId attribute set.
* @param role Instantiated Role entity requires only valid role name attribute set.
* @return boolean value true indicates access allowed.
@@ -67,7 +72,9 @@ public interface DelAccessMgr extends Manageable
* This function will determine if the user contains an AdminRole that is authorized revoke control over
* User-Role Assignment (URA). This adheres to the ARBAC02 functional specification for can-revoke URA.
*
- * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession. * @param user Instantiated User entity requires only valid userId attribute set.
+ * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing into
+ * the method. No variables need to be set by client after returned from createSession.
+ * @param user Instantiated User entity requires only valid userId attribute set.
* @param role Instantiated Role entity requires only valid role name attribute set.
* @return boolean value true indicates access allowed.
* @throws SecurityException
@@ -81,7 +88,9 @@ public interface DelAccessMgr extends Manageable
* This function will determine if the user contains an AdminRole that is authorized assignment control over
* Permission-Role Assignment (PRA). This adheres to the ARBAC02 functional specification for can-assign-p PRA.
*
- * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession. * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
+ * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing
+ * into the method. No variables need to be set by client after returned from createSession.
+ * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
* @param role Instantiated Role entity requires only valid role name attribute set.
* @return boolean value true indicates access allowed.
* @throws SecurityException
@@ -95,7 +104,9 @@ public interface DelAccessMgr extends Manageable
* This function will determine if the user contains an AdminRole that is authorized revoke control over
* Permission-Role Assignment (PRA). This adheres to the ARBAC02 functional specification for can-revoke-p PRA.
*
- * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession. * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
+ * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing
+ * into the method. No variables need to be set by client after returned from createSession.
+ * @param perm Instantiated Permission entity requires valid object name and operation name attributes set.
* @param role Instantiated Role entity requires only valid role name attribute set.
* @return boolean value true indicates access allowed.
* @throws SecurityException In the event of data validation error (i.e. invalid perm or role name) or system error.
@@ -113,9 +124,10 @@ public interface DelAccessMgr extends Manageable
* one of the session's active roles. This implementation will verify the roles or userId correspond
* to the subject's active roles are registered in the object's access control list.
*
- * @param perm object contains obj attribute which is a String and contains the name of the object user is trying to access;
- * perm object contains operation attribute which is also a String and contains the operation name for the object.
- * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing into the method. No variables need to be set by client after returned from createSession.
+ * @param perm object contains obj attribute which is a String and contains the name of the object user is trying to
+ * access; perm object contains operation attribute which is also a String and contains the operation name for the object.
+ * @param session This object must be instantiated by calling {@link AccessMgr#createSession} method before passing into
+ * the method. No variables need to be set by client after returned from createSession.
* @return True of user has access, false otherwise.
* @throws SecurityException
* is thrown if runtime error occurs with system.
@@ -129,11 +141,11 @@ public interface DelAccessMgr extends Manageable
* <p>
* The function is valid if and only if:
* <ul>
- * <li> the user is a member of the USERS data set
- * <li> the role is a member of the ADMIN ROLES data set
- * <li> the session is a valid Fortress session
- * <li> the user is authorized to that admin role
- * <li> the session is owned by that user.
+ * <li>the user is a member of the USERS data set</li>
+ * <li>the role is a member of the ADMIN ROLES data set</li>
+ * <li>the session is a valid Fortress session</li>
+ * <li>the user is authorized to that admin role</li>
+ * <li>the session is owned by that user.</li>
* </ul>
* <p>
*
@@ -165,7 +177,7 @@ public interface DelAccessMgr extends Manageable
* and only if the session is a valid Fortress session.
*
* @param session object contains the user's returned ARBAC session from the createSession method.
- * @return List<UserAdminRole> containing all adminRoles active in user's session. This will NOT contain inherited roles.
+ * @return List<UserAdminRole> containing all adminRoles active in user's session. This will NOT contain inherited roles.
* @throws SecurityException
* is thrown if session invalid or system. error.
*/
@@ -174,11 +186,11 @@ public interface DelAccessMgr extends Manageable
/**
- * This function returns the authorized admin roles associated with a session based on hierarchical relationships. The function is valid if
- * and only if the session is a valid Fortress session.
+ * This function returns the authorized admin roles associated with a session based on hierarchical relationships.
+ * The function is valid if and only if the session is a valid Fortress session.
*
* @param session object contains the user's returned ARBAC session from the createSession method.
- * @return Set<String> containing all adminRoles authorized in user's session. This will contain inherited roles.
+ * @return Set<String> containing all adminRoles authorized in user's session. This will contain inherited roles.
* @throws SecurityException is thrown if session invalid or system. error.
*/
Set<String> authorizedAdminRoles( Session session )
@@ -190,7 +202,7 @@ public interface DelAccessMgr extends Manageable
* to its authorized admin roles. The function is valid if and only if the session is a valid Fortress session.
*
* @param session object contains the user's returned ARBAC session from the createSession method.
- * @return List<Permission> containing admin permissions (op, obj) active for user's session.
+ * @return List<Permission> containing admin permissions (op, obj) active for user's session.
* @throws SecurityException in the event runtime error occurs with system.
*/
List<Permission> sessionPermissions( Session session )
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7dd2497/src/main/java/org/apache/directory/fortress/core/DelAccessMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/DelAccessMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/DelAccessMgrFactory.java
index d86fb6f..2b5b555 100755
--- a/src/main/java/org/apache/directory/fortress/core/DelAccessMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/DelAccessMgrFactory.java
@@ -29,10 +29,9 @@ import org.apache.directory.fortress.core.util.VUtil;
/**
* Creates an instance of the DelAccessMgr object.
- * <p/>
+ * <p>
* The default implementation class is specified as {@link DelAccessMgrImpl} but can be overridden by
* adding the {@link GlobalIds#DELEGATED_ACCESS_IMPLEMENTATION} config property.
- * <p/>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
[06/10] directory-fortress-core git commit: Fixed Javadoc issues
Posted by el...@apache.org.
Fixed Javadoc issues
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/f7c2bc0f
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/f7c2bc0f
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/f7c2bc0f
Branch: refs/heads/master
Commit: f7c2bc0f2ca80c31b64b02d5899fb83efd5769b3
Parents: 182e2e7
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Wed Jan 6 12:15:18 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Wed Jan 6 12:15:18 2016 +0100
----------------------------------------------------------------------
.../directory/fortress/core/GroupMgr.java | 8 +-
.../fortress/core/GroupMgrFactory.java | 8 +-
.../directory/fortress/core/Manageable.java | 9 +-
.../fortress/core/PasswordException.java | 3 +-
.../directory/fortress/core/PwPolicyMgr.java | 411 ++++++-----
.../fortress/core/PwPolicyMgrFactory.java | 3 +-
.../fortress/core/RemoveException.java | 6 +-
.../directory/fortress/core/RestException.java | 9 +-
.../fortress/core/SecurityException.java | 698 ++++++++++---------
9 files changed, 611 insertions(+), 544 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/GroupMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/GroupMgr.java b/src/main/java/org/apache/directory/fortress/core/GroupMgr.java
index 4ae3065..56a9fc2 100755
--- a/src/main/java/org/apache/directory/fortress/core/GroupMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/GroupMgr.java
@@ -28,9 +28,8 @@ import java.util.List;
/**
* This interface prescribes CRUD methods used to manage groups stored within the ldap directory.
- * <p/>
+ * <p>
* This class is thread safe.
- * <p/>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -48,8 +47,9 @@ public interface GroupMgr extends Manageable
/**
* Modify existing group node. The name is required. Does not update members or properties.
- * Use {@link GroupMgr#add( Group group, String key, String value )}, {@link GroupMgr#delete( Group group, String key, String value )},
- * {@link GroupMgr#assign( Group group, String member) }, or {@link GroupMgr#deassign( Group group, String member) } for multi-occurring attributes.
+ * Use {@link GroupMgr#add( Group group, String key, String value )}, {@link GroupMgr#delete( Group group, String key,
+ * String value )}, {@link GroupMgr#assign( Group group, String member) }, or
+ * {@link GroupMgr#deassign( Group group, String member) } for multi-occurring attributes.
*
* @param group contains {@link Group}.
* @return {@link Group} containing entity just modified.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/GroupMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/GroupMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/GroupMgrFactory.java
index b03fbac..770d506 100755
--- a/src/main/java/org/apache/directory/fortress/core/GroupMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/GroupMgrFactory.java
@@ -28,11 +28,9 @@ import org.apache.directory.fortress.core.util.VUtil;
/**
* Creates an instance of the ConfigMgr object.
- * <p/>
- * The default implementation class is specified as {@link org.apache.directory.fortress.core.impl.GroupMgrImpl} but can be overridden by
- * adding the {@link org.apache.directory.fortress.core.GlobalIds#GROUP_IMPLEMENTATION} config property.
- * <p/>
-
+ * <p>
+ * The default implementation class is specified as {@link org.apache.directory.fortress.core.impl.GroupMgrImpl} but can be
+ * overridden by adding the {@link org.apache.directory.fortress.core.GlobalIds#GROUP_IMPLEMENTATION} config property.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/Manageable.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/Manageable.java b/src/main/java/org/apache/directory/fortress/core/Manageable.java
index a4adfc7..7ec8922 100644
--- a/src/main/java/org/apache/directory/fortress/core/Manageable.java
+++ b/src/main/java/org/apache/directory/fortress/core/Manageable.java
@@ -25,19 +25,18 @@ import org.apache.directory.fortress.core.model.Session;
/**
* Interface allows outside clients to manage security and multi-tenant concerns within the Fortress runtime.
- * The {@link #setAdmin(org.apache.directory.fortress.core.model.Session)} method allows A/RBAC sessions to be loaded and allows authorization
- * to be performed on behalf of the user who is contained within the Session object itself.
+ * The {@link #setAdmin(org.apache.directory.fortress.core.model.Session)} method allows A/RBAC sessions to be loaded and
+ * allows authorization to be performed on behalf of the user who is contained within the Session object itself.
* The ARBAC permissions will be checked each time outside client makes calls into Fortress API.
* This interface also allows Fortress clients to operate in a multi-tenant fashion using {@link #setContextId(String)}.
- * <p/>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public interface Manageable
{
/**
- * Use this method to load an administrative user's ARBAC Session object into Manager object which will enable authorization to
- * be performed on behalf of admin user.
+ * Use this method to load an administrative user's ARBAC Session object into Manager object which will enable
+ * authorization to be performed on behalf of admin user.
* Setting Session into this object will enforce ARBAC controls and render this class' implementer thread unsafe.
*
* @param session contains a valid Fortress ARBAC Session object.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/PasswordException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/PasswordException.java b/src/main/java/org/apache/directory/fortress/core/PasswordException.java
index 7f0be6e..224cf4a 100755
--- a/src/main/java/org/apache/directory/fortress/core/PasswordException.java
+++ b/src/main/java/org/apache/directory/fortress/core/PasswordException.java
@@ -35,7 +35,8 @@ public class PasswordException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
*
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public PasswordException( int errorId, String msg )
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/PwPolicyMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/PwPolicyMgr.java b/src/main/java/org/apache/directory/fortress/core/PwPolicyMgr.java
index 25d100e..c0d3fac 100755
--- a/src/main/java/org/apache/directory/fortress/core/PwPolicyMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/PwPolicyMgr.java
@@ -27,30 +27,35 @@ import java.util.List;
/**
* This class is used to perform administrative and review functions on the PWPOLICIES and USERS data sets.
- * <p/>
+ * <h3></h3>
* <h4>Password Policies</h4>
- * <a href="http://www.openldap.org/">OpenLDAP</a> supports the IETF draft <a href="http://tools.ietf.org/html/draft-behera-ldap-password-policy-10/">Password Policies LDAP directories</a></li>. Policies may be applied at the user, group or global level.
- * <p/>
- * <img src="./doc-files/PasswordPolicy.png">
- * <p/>
+ * <a href="http://www.openldap.org/">OpenLDAP</a> supports the IETF draft
+ * <a href="http://tools.ietf.org/html/draft-behera-ldap-password-policy-10/">Password Policies LDAP directories</a>.
+ * Policies may be applied at the user, group or global level.
+ * <p>
+ * <img src="./doc-files/PasswordPolicy.png" alt="">
+ * <p>
* Password enforcement options include:
* <ol>
- * <li>A configurable limit on failed authentication attempts.</li>
- * <li>A counter to track the number of failed authentication attempts.</li>
- * <li>A time frame in which the limit of consecutive failed authentication attempts must happen before action is taken.</li>
- * <li>The action to be taken when the limit is reached. The action will either be nothing, or the account will be locked.</li>
- * <li>An amount of time the account is locked (if it is to be locked) This can be indefinite.</li>
- * <li>Password expiration.</li>
- * <li>Expiration warning</li>
- * <li>Grace authentications</li>
- * <li>Password history</li>
- * <li>Password minimum age</li>
- * <li>Password minimum length</li>
- * <li>Password Change after Reset</li>
- * <li>Safe Modification of Password</li>
+ * <li>A configurable limit on failed authentication attempts.</li>
+ * <li>A counter to track the number of failed authentication attempts.</li>
+ * <li>A time frame in which the limit of consecutive failed authentication attempts must happen before action is taken.</li>
+ * <li>
+ * The action to be taken when the limit is reached. The action will either be nothing, or the account will be locked.
+ * </li>
+ * <li>An amount of time the account is locked (if it is to be locked) This can be indefinite.</li>
+ * <li>Password expiration.</li>
+ * <li>Expiration warning</li>
+ * <li>Grace authentications</li>
+ * <li>Password history</li>
+ * <li>Password minimum age</li>
+ * <li>Password minimum length</li>
+ * <li>Password Change after Reset</li>
+ * <li>Safe Modification of Password</li>
* </ol>
- * <p/>
- * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)} or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
+ * <p>
+ * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)}
+ * or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -59,86 +64,109 @@ public interface PwPolicyMgr extends Manageable
/**
* This method will add a new policy entry to the POLICIES data set. This command is valid
* if and only if the policy entry is not already present in the POLICIES data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being added.</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class
+ * being added.
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minAge} - This attribute holds the number of seconds that must elapse between
- * modifications to the password. If this attribute is not present, 0
- * seconds is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxAge} - This attribute holds the number of seconds after which a modified
- * password will expire. If this attribute is not present, or if the value is 0 the password
- * does not expire. If not 0, the value must be greater than or equal
- * to the value of the pwdMinAge.
- * </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#inHistory} - This attribute specifies the maximum number of used passwords stored
- * in the pwdHistory attribute. If this attribute is not present, or if the value is 0, used
- * passwords are not stored in the pwdHistory attribute and thus may be reused.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minLength} - When quality checking is enabled, this attribute holds the minimum
- * number of characters that must be used in a password. If this
- * attribute is not present, no minimum password length will be
- * enforced. If the server is unable to check the length (due to a
- * hashed password or otherwise), the server will, depending on the
- * value of the pwdCheckQuality attribute, either accept the password
- * without checking it ('0' or '1') or refuse it ('2').</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#expireWarning} - This attribute specifies the maximum number of seconds before a
- * password is due to expire that expiration warning messages will be
- * returned to an authenticating user. If this attribute is not present, or if the value is 0 no warnings
- * will be returned. If not 0, the value must be smaller than the value
- * of the pwdMaxAge attribute.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#graceLoginLimit} - This attribute specifies the number of times an expired password can
- * be used to authenticate. If this attribute is not present or if the
- * value is 0, authentication will fail. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockout} - This attribute indicates, when its value is "TRUE", that the password
- * may not be used to authenticate after a specified number of
- * consecutive failed bind attempts. The maximum number of consecutive
- * failed bind attempts is specified in pwdMaxFailure. If this attribute is not present, or if the
- * value is "FALSE", the password may be used to authenticate when the number of failed bind
- * attempts has been reached.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockoutDuration} - This attribute holds the number of seconds that the password cannot
- * be used to authenticate due to too many failed bind attempts. If
- * this attribute is not present, or if the value is 0 the password
- * cannot be used to authenticate until reset by a password
- * administrator.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxFailure} - This attribute specifies the number of consecutive failed bind
- * attempts after which the password may not be used to authenticate.
- * If this attribute is not present, or if the value is 0, this policy
- * is not checked, and the value of pwdLockout will be ignored.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#failureCountInterval} - This attribute holds the number of seconds after which the password
- * failures are purged from the failure counter, even though no
- * successful authentication occurred. If this attribute is not present, or if its value is 0, the failure
- * counter is only reset by a successful authentication.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#mustChange} - This attribute specifies with a value of "TRUE" that users must
- * change their passwords when they first bind to the directory after a
- * password is set or reset by a password administrator. If this
- * attribute is not present, or if the value is "FALSE", users are not
- * required to change their password upon binding after the password
- * administrator sets or resets the password. This attribute is not set
- * due to any actions specified by this document, it is typically set by
- * a password administrator after resetting a user's password.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#allowUserChange} - This attribute indicates whether users can change their own
- * passwords, although the change operation is still subject to access
- * control. If this attribute is not present, a value of "TRUE" is
- * assumed. This attribute is intended to be used in the absence of an access control mechanism.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#safeModify} - This attribute specifies whether or not the existing password must be
- * sent along with the new password when being changed. If this
- * attribute is not present, a "FALSE" value is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#checkQuality} - This attribute indicates how the password quality will be verified
- * while being modified or added. If this attribute is not present, or
- * if the value is '0', quality checking will not be enforced. A value
- * of '1' indicates that the server will check the quality, and if the
- * server is unable to check it (due to a hashed password or other
- * reasons) it will be accepted. A value of '2' indicates that the
- * server will check the quality, and if the server is unable to verify
- * it, it will return an error refusing the password. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#attribute} - This holds the name of the attribute to which the password policy is
- * applied. For example, the password policy may be applied to the
- * userPassword attribute </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#minAge} - This attribute holds the number of seconds that
+ * must elapse between modifications to the password. If this attribute is not present, 0 seconds is assumed.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#maxAge} - This attribute holds the number of seconds
+ * after which a modified password will expire. If this attribute is not present, or if the value is 0 the password
+ * does not expire. If not 0, the value must be greater than or equal to the value of the pwdMinAge.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#inHistory} - This attribute specifies the maximum number
+ * of used passwords stored in the pwdHistory attribute. If this attribute is not present, or if the value is 0,
+ * used passwords are not stored in the pwdHistory attribute and thus may be reused.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#minLength} - When quality checking is enabled, this
+ * attribute holds the minimum number of characters that must be used in a password. If this attribute is not
+ * present, no minimum password length will be enforced. If the server is unable to check the length (due to a
+ * hashed password or otherwise), the server will, depending on the value of the pwdCheckQuality attribute, either
+ * accept the password without checking it ('0' or '1') or refuse it ('2').
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#expireWarning} - This attribute specifies the maximum
+ * number of seconds before a password is due to expire that expiration warning messages will be returned to an
+ * authenticating user. If this attribute is not present, or if the value is 0 no warnings will be returned. If
+ * not 0, the value must be smaller than the value of the pwdMaxAge attribute.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#graceLoginLimit} - This attribute specifies the number
+ * of times an expired password can be used to authenticate. If this attribute is not present or if the value is 0,
+ * authentication will fail.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#lockout} - This attribute indicates, when its value is
+ * "TRUE", that the password may not be used to authenticate after a specified number of consecutive failed bind
+ * attempts. The maximum number of consecutive failed bind attempts is specified in pwdMaxFailure. If this
+ * attribute is not present, or if the value is "FALSE", the password may be used to authenticate when the number of
+ * failed bind attempts has been reached.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#lockoutDuration} - This attribute holds the number of
+ * seconds that the password cannot be used to authenticate due to too many failed bind attempts. If this attribute
+ * is not present, or if the value is 0 the password cannot be used to authenticate until reset by a password
+ * administrator.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#maxFailure} - This attribute specifies the number of
+ * consecutive failed bind attempts after which the password may not be used to authenticate.
+ * If this attribute is not present, or if the value is 0, this policy is not checked, and the value of pwdLockout
+ * will be ignored.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#failureCountInterval} - This attribute holds the number
+ * of seconds after which the password failures are purged from the failure counter, even though no successful
+ * authentication occurred. If this attribute is not present, or if its value is 0, the failure counter is only
+ * reset by a successful authentication.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#mustChange} - This attribute specifies with a value of
+ * "TRUE" that users must change their passwords when they first bind to the directory after a password is set or
+ * reset by a password administrator. If this attribute is not present, or if the value is "FALSE", users are not
+ * required to change their password upon binding after the password administrator sets or resets the password.
+ * This attribute is not set due to any actions specified by this document, it is typically set by a password
+ * administrator after resetting a user's password.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#allowUserChange} - This attribute indicates whether users
+ * can change their own passwords, although the change operation is still subject to access control. If this
+ * attribute is not present, a value of "TRUE" is assumed. This attribute is intended to be used in the absence of
+ * an access control mechanism.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#safeModify} - This attribute specifies whether or not the
+ * existing password must be sent along with the new password when being changed. If this attribute is not present,
+ * a "FALSE" value is assumed.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#checkQuality} - This attribute indicates how the password
+ * quality will be verified while being modified or added. If this attribute is not present, or if the value is '0',
+ * quality checking will not be enforced. A value of '1' indicates that the server will check the quality, and if
+ * the server is unable to check it (due to a hashed password or other reasons) it will be accepted. A value of '2'
+ * indicates that the server will check the quality, and if the server is unable to verify it, it will return an
+ * error refusing the password.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#attribute} - This holds the name of the attribute to
+ * which the password policy is applied. For example, the password policy may be applied to the userPassword
+ * attribute
+ * </li>
* </ul>
*
- * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} and optionally other attributes.
+ * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} and optionally other
+ * attributes.
* @throws SecurityException In the event of data validation or system error.
*/
void add( PwPolicy policy )
@@ -148,86 +176,108 @@ public interface PwPolicyMgr extends Manageable
/**
* This method will update an exiting policy entry to the POLICIES data set. This command is valid
* if and only if the policy entry is already present in the POLICIES data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being updated.</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class
+ * being updated.
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minAge} - This attribute holds the number of seconds that must elapse between
- * modifications to the password. If this attribute is not present, 0
- * seconds is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxAge} - This attribute holds the number of seconds after which a modified
- * password will expire. If this attribute is not present, or if the value is 0 the password
- * does not expire. If not 0, the value must be greater than or equal
- * to the value of the pwdMinAge.
- * </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#inHistory} - This attribute specifies the maximum number of used passwords stored
- * in the pwdHistory attribute. If this attribute is not present, or if the value is 0, used
- * passwords are not stored in the pwdHistory attribute and thus may be reused.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#minLength} - When quality checking is enabled, this attribute holds the minimum
- * number of characters that must be used in a password. If this
- * attribute is not present, no minimum password length will be
- * enforced. If the server is unable to check the length (due to a
- * hashed password or otherwise), the server will, depending on the
- * value of the pwdCheckQuality attribute, either accept the password
- * without checking it ('0' or '1') or refuse it ('2').</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#expireWarning} - This attribute specifies the maximum number of seconds before a
- * password is due to expire that expiration warning messages will be
- * returned to an authenticating user. If this attribute is not present, or if the value is 0 no warnings
- * will be returned. If not 0, the value must be smaller than the value
- * of the pwdMaxAge attribute.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#graceLoginLimit} - This attribute specifies the number of times an expired password can
- * be used to authenticate. If this attribute is not present or if the
- * value is 0, authentication will fail. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockout} - This attribute indicates, when its value is "TRUE", that the password
- * may not be used to authenticate after a specified number of
- * consecutive failed bind attempts. The maximum number of consecutive
- * failed bind attempts is specified in pwdMaxFailure. If this attribute is not present, or if the
- * value is "FALSE", the password may be used to authenticate when the number of failed bind
- * attempts has been reached.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#lockoutDuration} - This attribute holds the number of seconds that the password cannot
- * be used to authenticate due to too many failed bind attempts. If
- * this attribute is not present, or if the value is 0 the password
- * cannot be used to authenticate until reset by a password
- * administrator.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#maxFailure} - This attribute specifies the number of consecutive failed bind
- * attempts after which the password may not be used to authenticate.
- * If this attribute is not present, or if the value is 0, this policy
- * is not checked, and the value of pwdLockout will be ignored.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#failureCountInterval} - This attribute holds the number of seconds after which the password
- * failures are purged from the failure counter, even though no
- * successful authentication occurred. If this attribute is not present, or if its value is 0, the failure
- * counter is only reset by a successful authentication.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#mustChange} - This attribute specifies with a value of "TRUE" that users must
- * change their passwords when they first bind to the directory after a
- * password is set or reset by a password administrator. If this
- * attribute is not present, or if the value is "FALSE", users are not
- * required to change their password upon binding after the password
- * administrator sets or resets the password. This attribute is not set
- * due to any actions specified by this document, it is typically set by
- * a password administrator after resetting a user's password.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#allowUserChange} - This attribute indicates whether users can change their own
- * passwords, although the change operation is still subject to access
- * control. If this attribute is not present, a value of "TRUE" is
- * assumed. This attribute is intended to be used in the absence of an access control mechanism.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#safeModify} - This attribute specifies whether or not the existing password must be
- * sent along with the new password when being changed. If this
- * attribute is not present, a "FALSE" value is assumed.</li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#checkQuality} - This attribute indicates how the password quality will be verified
- * while being modified or added. If this attribute is not present, or
- * if the value is '0', quality checking will not be enforced. A value
- * of '1' indicates that the server will check the quality, and if the
- * server is unable to check it (due to a hashed password or other
- * reasons) it will be accepted. A value of '2' indicates that the
- * server will check the quality, and if the server is unable to verify
- * it, it will return an error refusing the password. </li>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#attribute} - This holds the name of the attribute to which the password policy is
- * applied. For example, the password policy may be applied to the
- * userPassword attribute </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#minAge} - This attribute holds the number of seconds that
+ * must elapse between modifications to the password. If this attribute is not present, 0 seconds is assumed.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#maxAge} - This attribute holds the number of seconds
+ * after which a modified password will expire. If this attribute is not present, or if the value is 0 the password
+ * does not expire. If not 0, the value must be greater than or equal to the value of the pwdMinAge.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#inHistory} - This attribute specifies the maximum number
+ * of used passwords stored in the pwdHistory attribute. If this attribute is not present, or if the value is 0,
+ * used passwords are not stored in the pwdHistory attribute and thus may be reused.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#minLength} - When quality checking is enabled, this
+ * attribute holds the minimum number of characters that must be used in a password. If this attribute is not
+ * present, no minimum password length will be enforced. If the server is unable to check the length (due to a
+ * hashed password or otherwise), the server will, depending on the value of the pwdCheckQuality attribute, either
+ * accept the password without checking it ('0' or '1') or refuse it ('2').
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#expireWarning} - This attribute specifies the maximum
+ * number of seconds before a password is due to expire that expiration warning messages will be returned to an
+ * authenticating user. If this attribute is not present, or if the value is 0 no warnings will be returned.
+ * If not 0, the value must be smaller than the value of the pwdMaxAge attribute.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#graceLoginLimit} - This attribute specifies the number
+ * of times an expired password can be used to authenticate. If this attribute is not present or if the value is 0,
+ * authentication will fail.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#lockout} - This attribute indicates, when its value is
+ * "TRUE", that the password may not be used to authenticate after a specified number of consecutive failed bind
+ * attempts. The maximum number of consecutive failed bind attempts is specified in pwdMaxFailure. If this
+ * attribute is not present, or if the value is "FALSE", the password may be used to authenticate when the number of
+ * failed bind attempts has been reached.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#lockoutDuration} - This attribute holds the number of
+ * seconds that the password cannot be used to authenticate due to too many failed bind attempts. If this attribute
+ * is not present, or if the value is 0 the password cannot be used to authenticate until reset by a password
+ * administrator.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#maxFailure} - This attribute specifies the number of
+ * consecutive failed bind attempts after which the password may not be used to authenticate. If this attribute is
+ * not present, or if the value is 0, this policy is not checked, and the value of pwdLockout will be ignored.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#failureCountInterval} - This attribute holds the number
+ * of seconds after which the password failures are purged from the failure counter, even though no successful
+ * authentication occurred. If this attribute is not present, or if its value is 0, the failure counter is only
+ * reset by a successful authentication.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#mustChange} - This attribute specifies with a value of
+ * "TRUE" that users must change their passwords when they first bind to the directory after a password is set or
+ * reset by a password administrator. If this attribute is not present, or if the value is "FALSE", users are not
+ * required to change their password upon binding after the password administrator sets or resets the password.
+ * This attribute is not set due to any actions specified by this document, it is typically set by a password
+ * administrator after resetting a user's password.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#allowUserChange} - This attribute indicates whether
+ * users can change their own passwords, although the change operation is still subject to access control. If this
+ * attribute is not present, a value of "TRUE" is assumed. This attribute is intended to be used in the absence of
+ * an access control mechanism.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#safeModify} - This attribute specifies whether or not
+ * the existing password must be sent along with the new password when being changed. If this attribute is not
+ * present, a "FALSE" value is assumed.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#checkQuality} - This attribute indicates how the password
+ * quality will be verified while being modified or added. If this attribute is not present, or if the value is '0',
+ * quality checking will not be enforced. A value of '1' indicates that the server will check the quality, and if
+ * the server is unable to check it (due to a hashed password or other reasons) it will be accepted. A value of '2'
+ * indicates that the server will check the quality, and if the server is unable to verify it, it will return an
+ * error refusing the password.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#attribute} - This holds the name of the attribute to
+ * which the password policy is applied. For example, the password policy may be applied to the userPassword
+ * attribute
+ * </li>
* </ul>
*
- * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} and optionally all non-null attributes will be updated. null attributes will be ignored.
+ * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} and optionally all
+ * non-null attributes will be updated. null attributes will be ignored.
* @throws SecurityException In the event policy not found , data validation or system error.
*/
void update( PwPolicy policy )
@@ -238,12 +288,17 @@ public interface PwPolicyMgr extends Manageable
* This method will delete exiting policy entry from the POLICIES data set. This command is valid
* if and only if the policy entry is already present in the POLICIES data set. Existing users that
* are assigned this policy will be removed from association.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being removed.</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object
+ * class being removed.
+ * </li>
* </ul>
*
- * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} of the policy entity to remove.
+ * @param policy Object must contain {@link org.apache.directory.fortress.core.model.PwPolicy#name} of the policy entity
+ * to remove.
* @throws SecurityException In the event policy entity not found or system error.
*/
void delete( PwPolicy policy )
@@ -253,12 +308,17 @@ public interface PwPolicyMgr extends Manageable
/**
* This method will return the password policy entity to the caller. This command is valid
* if and only if the policy entry is present in the POLICIES data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class being read.</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PwPolicy#name} - Maps to name attribute of pwdPolicy object class
+ * being read.
+ * </li>
* </ul>
*
- * @param name String contains the {@link org.apache.directory.fortress.core.model.PwPolicy#name} of the policy entity to read.
+ * @param name String contains the {@link org.apache.directory.fortress.core.model.PwPolicy#name} of the policy entity to
+ * read.
* @return PswdPolicy entity returns fully populated with attributes.
* @throws SecurityException In the event policy entry not found, data validation or system error.
*/
@@ -271,7 +331,7 @@ public interface PwPolicyMgr extends Manageable
* This command will return an empty list of no matching entries are found.
*
* @param searchVal String contains the leading chars of a policy entity. This search is not case sensitive.
- * @return List<PswdPolicy> contains all matching password policy entities. If no records found this will be empty.
+ * @return List<PswdPolicy> contains all matching password policy entities. If no records found this will be empty.
* @throws SecurityException In the event of data validation or system error.
*/
List<PwPolicy> search( String searchVal )
@@ -283,8 +343,10 @@ public interface PwPolicyMgr extends Manageable
* if and only if the user is a member of the USERS data set and the policyName refers to a
* policy that is a member of the PWPOLICIES data set.
*
- * @param userId Contains {@link org.apache.directory.fortress.core.model.User#userId} of a User entity in USERS data set.
- * @param policyName String contains the {@link org.apache.directory.fortress.core.model.PwPolicy#name} of a pw policy entity contained within the PWPOLICIES data set.
+ * @param userId Contains {@link org.apache.directory.fortress.core.model.User#userId} of a User entity in USERS
+ * data set.
+ * @param policyName String contains the {@link org.apache.directory.fortress.core.model.PwPolicy#name} of a pw policy
+ * entity contained within the PWPOLICIES data set.
* @throws SecurityException thrown in the event either user or policy not valid or system error.
*/
void updateUserPolicy( String userId, String policyName )
@@ -297,7 +359,8 @@ public interface PwPolicyMgr extends Manageable
* Removal of pw policy assignment will revert the user's policy to use the global default for OpenLDAP
* instance that contains user.
*
- * @param userId Contains {@link org.apache.directory.fortress.core.model.User#userId} of a User entity in USERS data set.
+ * @param userId Contains {@link org.apache.directory.fortress.core.model.User#userId} of a User entity in USERS data
+ * set.
* @throws SecurityException Thrown in the event either user not valid or system error.
*/
void deletePasswordPolicy( String userId )
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/PwPolicyMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/PwPolicyMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/PwPolicyMgrFactory.java
index 9bdd43a..bacfe0b 100755
--- a/src/main/java/org/apache/directory/fortress/core/PwPolicyMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/PwPolicyMgrFactory.java
@@ -29,10 +29,9 @@ import org.apache.directory.fortress.core.util.VUtil;
/**
* Creates an instance of the PwPolicyMgr object.
- * <p/>
+ * <p>
* The default implementation class is specified as {@link PwPolicyMgrImpl} but can be overridden by
* adding the {@link GlobalIds#PSWD_POLICY_IMPLEMENTATION} config property.
- * <p/>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/RemoveException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/RemoveException.java b/src/main/java/org/apache/directory/fortress/core/RemoveException.java
index edc603c..928cb1e 100755
--- a/src/main/java/org/apache/directory/fortress/core/RemoveException.java
+++ b/src/main/java/org/apache/directory/fortress/core/RemoveException.java
@@ -35,7 +35,8 @@ public class RemoveException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
*
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public RemoveException( int errorId, String msg )
@@ -46,7 +47,8 @@ public class RemoveException extends SecurityException
/**
* Create exception with error id, message and related exception.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
* @param previousException contains reference to related exception which usually is system related, i.e. ldap.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/RestException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/RestException.java b/src/main/java/org/apache/directory/fortress/core/RestException.java
index 1c90c84..d14787e 100644
--- a/src/main/java/org/apache/directory/fortress/core/RestException.java
+++ b/src/main/java/org/apache/directory/fortress/core/RestException.java
@@ -21,7 +21,8 @@ package org.apache.directory.fortress.core;
/**
- * This exception extends {@link SecurityException} and is thrown when Fortress cannot call En Masse to perform a particular operation via RESTful interface.
+ * This exception extends {@link SecurityException} and is thrown when Fortress cannot call En Masse to perform a particular
+ * operation via RESTful interface.
* See the {@link GlobalErrIds} javadoc for list of error ids.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
@@ -34,7 +35,8 @@ public class RestException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public RestException( int errorId, String msg )
@@ -45,7 +47,8 @@ public class RestException extends SecurityException
/**
* Create exception with error id, message and related exception.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
* @param previousException contains reference to related exception which usually is system related, i.e. ldap.
*/
[05/10] directory-fortress-core git commit: Fixed Javadoc issues
Posted by el...@apache.org.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f7c2bc0f/src/main/java/org/apache/directory/fortress/core/SecurityException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/SecurityException.java b/src/main/java/org/apache/directory/fortress/core/SecurityException.java
index de4a38b..e498ffe 100755
--- a/src/main/java/org/apache/directory/fortress/core/SecurityException.java
+++ b/src/main/java/org/apache/directory/fortress/core/SecurityException.java
@@ -21,432 +21,433 @@ package org.apache.directory.fortress.core;
/**
- * This exception is declared to be thrown by all APIs within Fortress Manager interfaces: ({@link AdminMgr}, {@link AccessMgr},
- * {@link ReviewMgr},{@link PwPolicyMgr},{@link AuditMgr},{@link DelAdminMgr},
- * {@link DelAccessMgr},{@link DelReviewMgr},{@link ConfigMgr}).
+ * This exception is declared to be thrown by all APIs within Fortress Manager interfaces: ({@link AdminMgr},
+ * {@link AccessMgr}, {@link ReviewMgr},{@link PwPolicyMgr},{@link AuditMgr},{@link DelAdminMgr}, {@link DelAccessMgr},
+ * {@link DelReviewMgr},{@link ConfigMgr}).
* <h3>
- * <p/>The original exception thrown may be of this type or one of its extensions
+ * The original exception thrown may be of this type or one of its extensions
* </h3>
* <ul>
- * <li>{@link AuthorizationException} in the event user fails administrative permission check..
- * <li>{@link CfgException} in the event the runtime cfg system fails.
- * <li>{@link CreateException} in the event DAO cannot create entity.
- * <li>{@link FinderException} in the event DAO cannot find the entity.
- * <li>{@link PasswordException} in the event user fails password checks or password policy exception occurs.
- * <li>{@link RemoveException} in the event DAO cannot remove entity.
- * <li>{@link RestException} during HTTP event failure.
- * <li>{@link UpdateException} in the event DAO cannot update entity.
- * <li>{@link ValidationException} in the event entity validation fails.
+ * <li>{@link AuthorizationException} in the event user fails administrative permission check.</li>
+ * <li>{@link CfgException} in the event the runtime cfg system fails.</li>
+ * <li>{@link CreateException} in the event DAO cannot create entity.</li>
+ * <li>{@link FinderException} in the event DAO cannot find the entity.</li>
+ * <li>{@link PasswordException} in the event user fails password checks or password policy exception occurs.</li>
+ * <li>{@link RemoveException} in the event DAO cannot remove entity.</li>
+ * <li>{@link RestException} during HTTP event failure.</li>
+ * <li>{@link UpdateException} in the event DAO cannot update entity.</li>
+ * <li>{@link ValidationException} in the event entity validation fails.</li>
* </ul>
- * <p/>
- * For certain APIs, i.e., {@link AccessMgr#createSession(org.apache.directory.fortress.core.model.User, boolean)}, or {@link AccessMgr#authenticate(String, char[])}, the caller may need to differentiate by one of the above subclasses, e.g. {@link PasswordException}, to facilitate password expiring condition or allow user to retry authentication after entering it incorrectly.
- * If specific exception processing is not the aim, or if differentiating conditions by {@link #errorId} is acceptable, callers are allowed to catch (or throw) as type {@link SecurityException}.
- * <p/>
- * All exceptions generated by Fortress will be set with error code {@link SecurityException#getErrorId()} indicating fault condition which is set via its constructor - ({@link #SecurityException(int, String)}, {@link #SecurityException(int, String, Exception)}).
+ * <p>
+ * For certain APIs, i.e., {@link AccessMgr#createSession(org.apache.directory.fortress.core.model.User, boolean)}, or
+ * {@link AccessMgr#authenticate(String, char[])}, the caller may need to differentiate by one of the above subclasses, e.g.
+ * {@link PasswordException}, to facilitate password expiring condition or allow user to retry authentication after entering
+ * it incorrectly. If specific exception processing is not the aim, or if differentiating conditions by {@link #errorId} is
+ * acceptable, callers are allowed to catch (or throw) as type {@link SecurityException}.
+ * <p>
+ * All exceptions generated by Fortress will be set with error code {@link SecurityException#getErrorId()} indicating fault
+ * condition which is set via its constructor - ({@link #SecurityException(int, String)},
+ * {@link #SecurityException(int, String, Exception)}).
* The error codes are declared in {@link GlobalErrIds} and are also listed below.
* <h3>
- * <p/>100's - Configuration Errors
+ * 100's - Configuration Errors
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#CONTEXT_NULL} = 101;</code>
- * <li> <code>{@code CONTEXT_SERIALIZATION_FAILED} = 102;</code>*
- * <li> <code>{@link GlobalErrIds#FT_MGR_CLASS_NOT_FOUND} = 103;</code>
- * <li> <code>{@link GlobalErrIds#FT_MGR_INST_EXCEPTION} = 104;</code>
- * <li> <code>{@link GlobalErrIds#FT_MGR_ILLEGAL_ACCESS} = 105;</code>
- * <li> <code>{@link GlobalErrIds#FT_MGR_CLASS_NAME_NULL} = 106;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_NOT_FOUND} = 107;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_NAME_NULL} = 108;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_NAME_INVLD} = 109;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_PROPS_NULL} = 110;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_CREATE_FAILED} = 120;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_UPDATE_FAILED} = 121;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_DELETE_FAILED} = 122;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_DELETE_PROPS_FAILED} = 123;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_READ_FAILED} = 124;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_ALREADY_EXISTS} = 125;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_BOOTSTRAP_FAILED} = 126;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_INITIALIZE_FAILED} = 127;</code>
- * <li> <code>{@link GlobalErrIds#FT_RESOURCE_NOT_FOUND} = 128;</code>
- * <li> <code>{@link GlobalErrIds#FT_CACHE_NOT_CONFIGURED} = 129;</code>
- * <li> <code>{@link GlobalErrIds#FT_CACHE_GET_ERR} = 130;</code>
- * <li> <code>{@link GlobalErrIds#FT_CACHE_PUT_ERR} = 131;</code>
- * <li> <code>{@link GlobalErrIds#FT_CACHE_CLEAR_ERR} = 132;</code>
- * <li> <code>{@link GlobalErrIds#FT_CACHE_FLUSH_ERR} = 133;</code>
- * <li> <code>{@link GlobalErrIds#FT_NULL_CACHE} = 134;</code>
- * <li> <code>{@link GlobalErrIds#FT_APACHE_LDAP_POOL_INIT_FAILED} = 135;</code>
- * <li> <code>{@link GlobalErrIds#FT_CONFIG_JSSE_TRUSTSTORE_NULL} = 136;</code>
- *
+ * <li> <code>{@link GlobalErrIds#CONTEXT_NULL} = 101;</code></li>
+ * <li> {@code CONTEXT_SERIALIZATION_FAILED} = 102;</li>
+ * <li> <code>{@link GlobalErrIds#FT_MGR_CLASS_NOT_FOUND} = 103;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_MGR_INST_EXCEPTION} = 104;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_MGR_ILLEGAL_ACCESS} = 105;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_MGR_CLASS_NAME_NULL} = 106;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_NOT_FOUND} = 107;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_NAME_NULL} = 108;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_NAME_INVLD} = 109;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_PROPS_NULL} = 110;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_CREATE_FAILED} = 120;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_UPDATE_FAILED} = 121;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_DELETE_FAILED} = 122;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_DELETE_PROPS_FAILED} = 123;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_READ_FAILED} = 124;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_ALREADY_EXISTS} = 125;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_BOOTSTRAP_FAILED} = 126;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_INITIALIZE_FAILED} = 127;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_RESOURCE_NOT_FOUND} = 128;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CACHE_NOT_CONFIGURED} = 129;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CACHE_GET_ERR} = 130;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CACHE_PUT_ERR} = 131;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CACHE_CLEAR_ERR} = 132;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CACHE_FLUSH_ERR} = 133;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_NULL_CACHE} = 134;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_APACHE_LDAP_POOL_INIT_FAILED} = 135;</code></li>
+ * <li> <code>{@link GlobalErrIds#FT_CONFIG_JSSE_TRUSTSTORE_NULL} = 136;</code></li>
* </ul>
* <h3>
- * <p/>1000's - User Entity Rule and LDAP Errors
+ * 1000's - User Entity Rule and LDAP Errors
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#USER_SEARCH_FAILED} = 1000;</code>
- * <li> <code>{@link GlobalErrIds#USER_READ_FAILED} = 1001;</code>
- * <li> <code>{@link GlobalErrIds#USER_ADD_FAILED} = 1002;</code>
- * <li> <code>{@link GlobalErrIds#USER_UPDATE_FAILED} = 1003;</code>
- * <li> <code>{@link GlobalErrIds#USER_DELETE_FAILED} = 1004;</code>
- * <li> <code>{@link GlobalErrIds#USER_NOT_FOUND} = 1005;</code>
- * <li> <code>{@link GlobalErrIds#USER_ID_NULL} = 1006;</code>
- * <li> <code>{@link GlobalErrIds#USER_ID_DUPLICATE} = 1007;</code>
- * <li> <code>{@link GlobalErrIds#USER_NULL} = 1008;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_NULL} = 1009;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_INVLD_LEN} = 1010;</code>
- * <li> <code>{@link GlobalErrIds#USER_PLCY_VIOLATION} = 1011;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_PLCY_DEL_FAILED} = 1012;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_INVLD} = 1013;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_CHK_FAILED} = 1014;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_RESET} = 1015;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_LOCKED} = 1016;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_EXPIRED} = 1017;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_MOD_NOT_ALLOWED} = 1018;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_MUST_SUPPLY_OLD} = 1019;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_NSF_QUALITY} = 1020;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_TOO_SHORT} = 1021;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_TOO_YOUNG} = 1022;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_IN_HISTORY} = 1023;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_UNLOCK_FAILED} = 1024;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_LOCK_FAILED} = 1025;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_CHANGE_FAILED} = 1026;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_RESET_FAILED} = 1027;</code>
- * <li> <code>{@link GlobalErrIds#USER_LOCKED_BY_CONST} = 1028;</code>
- * <li> <code>{@link GlobalErrIds#USER_SESS_CREATE_FAILED} = 1029;</code>
- * <li> <code>{@link GlobalErrIds#USER_SESS_NULL} = 1030;</code>
- * <li> <code>{@link GlobalErrIds#USER_ADMIN_NOT_AUTHORIZED} = 1031;</code>
- * <li> <code>{@link GlobalErrIds#USER_CN_NULL} = 1032;</code>
- * <li> <code>{@link GlobalErrIds#USER_SN_NULL} = 1033;</code>
- * <li> <code>{@link GlobalErrIds#USER_PW_PLCY_INVALID} = 1034;</code>
- * <li> <code>{@link GlobalErrIds#USER_OU_INVALID} = 1035;</code>
- * <li> <code>{@link GlobalErrIds#SESS_CTXT_NULL} = 1036;</code>
- * <li> <code>{@link GlobalErrIds#USER_BIND_FAILED} = 1037;</code>
- *
- *
+ * <li> <code>{@link GlobalErrIds#USER_SEARCH_FAILED} = 1000;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_READ_FAILED} = 1001;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_ADD_FAILED} = 1002;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_UPDATE_FAILED} = 1003;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_DELETE_FAILED} = 1004;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_NOT_FOUND} = 1005;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_ID_NULL} = 1006;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_ID_DUPLICATE} = 1007;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_NULL} = 1008;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_NULL} = 1009;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_INVLD_LEN} = 1010;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PLCY_VIOLATION} = 1011;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_PLCY_DEL_FAILED} = 1012;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_INVLD} = 1013;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_CHK_FAILED} = 1014;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_RESET} = 1015;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_LOCKED} = 1016;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_EXPIRED} = 1017;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_MOD_NOT_ALLOWED} = 1018;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_MUST_SUPPLY_OLD} = 1019;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_NSF_QUALITY} = 1020;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_TOO_SHORT} = 1021;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_TOO_YOUNG} = 1022;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_IN_HISTORY} = 1023;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_UNLOCK_FAILED} = 1024;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_LOCK_FAILED} = 1025;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_CHANGE_FAILED} = 1026;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_RESET_FAILED} = 1027;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_LOCKED_BY_CONST} = 1028;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_SESS_CREATE_FAILED} = 1029;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_SESS_NULL} = 1030;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_ADMIN_NOT_AUTHORIZED} = 1031;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_CN_NULL} = 1032;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_SN_NULL} = 1033;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_PW_PLCY_INVALID} = 1034;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_OU_INVALID} = 1035;</code></li>
+ * <li> <code>{@link GlobalErrIds#SESS_CTXT_NULL} = 1036;</code></li>
+ * <li> <code>{@link GlobalErrIds#USER_BIND_FAILED} = 1037;</code></li>
* </ul>
* <h3>
- * <p/>2000's User-Role assignments
+ * 2000's User-Role assignments
* </h3>
* <h4>
- * <p/> User-Role Rule and LDAP errors
+ * User-Role Rule and LDAP errors
* </h4>
* <ul>
- * <li> <code>{@link GlobalErrIds#URLE_NULL} = 2003;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ASSIGN_FAILED} = 2004;</code>
- * <li> <code>{@link GlobalErrIds#URLE_DEASSIGN_FAILED} = 2005;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ACTIVATE_FAILED} = 2006;</code>
- * <li> <code>{@link GlobalErrIds#URLE_DEACTIVE_FAILED} = 2007;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ASSIGN_EXIST} = 2008;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ASSIGN_NOT_EXIST} = 2009;</code>
- * <li> <code>{@link GlobalErrIds#URLE_SEARCH_FAILED} = 2010;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ALREADY_ACTIVE} = 2011;</code>
- * <li> <code>{@link GlobalErrIds#URLE_NOT_ACTIVE} = 2022;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_ASSIGN} = 2023;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_DEASSIGN} = 2024;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_GRANT} = 2025;</code>
- * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_REVOKE} = 2026;</code>
+ * <li> <code>{@link GlobalErrIds#URLE_NULL} = 2003;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ASSIGN_FAILED} = 2004;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_DEASSIGN_FAILED} = 2005;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ACTIVATE_FAILED} = 2006;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_DEACTIVE_FAILED} = 2007;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ASSIGN_EXIST} = 2008;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ASSIGN_NOT_EXIST} = 2009;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_SEARCH_FAILED} = 2010;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ALREADY_ACTIVE} = 2011;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_NOT_ACTIVE} = 2022;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_ASSIGN} = 2023;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_DEASSIGN} = 2024;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_GRANT} = 2025;</code></li>
+ * <li> <code>{@link GlobalErrIds#URLE_ADMIN_CANNOT_REVOKE} = 2026;</code></li>
* </ul>
* <h4>
- * <p/> Temporal Constraint Activation Violations
+ * Temporal Constraint Activation Violations
* </h4>
* <ul>
- * <li> <code>{@link GlobalErrIds#ACTV_FAILED_DAY} = 2050;</code>
- * <li> <code>{@link GlobalErrIds#ACTV_FAILED_DATE} = 2051;</code>
- * <li> <code>{@link GlobalErrIds#ACTV_FAILED_TIME} = 2052;</code>
- * <li> <code>{@link GlobalErrIds#ACTV_FAILED_TIMEOUT} = 2053;</code>
- * <li> <code>{@link GlobalErrIds#ACTV_FAILED_LOCK} = 2054;</code>
- * <li> <code>{@link GlobalErrIds#ACTV_FAILED_DSD} = 2055;</code>
- * <li> <code>{@link GlobalErrIds#ACTV_FAILED_AUTHN} = 2056;</code>
+ * <li> <code>{@link GlobalErrIds#ACTV_FAILED_DAY} = 2050;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACTV_FAILED_DATE} = 2051;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACTV_FAILED_TIME} = 2052;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACTV_FAILED_TIMEOUT} = 2053;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACTV_FAILED_LOCK} = 2054;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACTV_FAILED_DSD} = 2055;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACTV_FAILED_AUTHN} = 2056;</code></li>
* </ul>
* <h3>
- * <p/>3000's - Permission Entity
+ * 3000's - Permission Entity
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#PERM_SEARCH_FAILED} = 3000;</code>
- * <li> <code>{@link GlobalErrIds#PERM_READ_OP_FAILED} = 3001;</code>
- * <li> <code>{@link GlobalErrIds#PERM_READ_OBJ_FAILED} = 3002;</code>
- * <li> <code>{@link GlobalErrIds#PERM_ADD_FAILED} = 3003;</code>
- * <li> <code>{@link GlobalErrIds#PERM_UPDATE_FAILED} = 3004;</code>
- * <li> <code>{@link GlobalErrIds#PERM_DELETE_FAILED} = 3005;</code>
- * <li> <code>{@link GlobalErrIds#PERM_OP_NOT_FOUND} = 3006;</code>
- * <li> <code>{@link GlobalErrIds#PERM_OBJ_NOT_FOUND} = 3007;</code>
- * <li> <code>{@link GlobalErrIds#PERM_NULL} = 3008;</code>
- * <li> <code>{@link GlobalErrIds#PERM_OPERATION_NULL} = 3009;</code>
- * <li> <code>{@link GlobalErrIds#PERM_OBJECT_NULL} = 3010;</code>
- * <li> <code>{@link GlobalErrIds#PERM_DUPLICATE} = 3011;</code>
- * <li> <code>{@link GlobalErrIds#PERM_GRANT_FAILED} = 3012;</code>
- * <li> <code>{@link GlobalErrIds#PERM_GRANT_USER_FAILED} = 3013;</code>
- * <li> <code>{@link GlobalErrIds#PERM_REVOKE_FAILED} = 3024;</code>
- * <li> <code>{@link GlobalErrIds#PERM_ROLE_EXIST} = 3015;</code>
- * <li> <code>{@link GlobalErrIds#PERM_ROLE_NOT_EXIST} = 3016;</code>
- * <li> <code>{@link GlobalErrIds#PERM_USER_EXIST} = 3017;</code>
- * <li> <code>{@link GlobalErrIds#PERM_USER_NOT_EXIST} = 3018;</code>
- * <li> <code>{@link GlobalErrIds#PERM_ROLE_SEARCH_FAILED} = 3019;</code>
- * <li> <code>{@link GlobalErrIds#PERM_USER_SEARCH_FAILED} = 3020;</code>
- * <li> <code>{@link GlobalErrIds#PERM_SESS_SEARCH_FAILED} = 3021;</code>
- * <li> <code>{@link GlobalErrIds#PERM_BULK_USER_REVOKE_FAILED} = 3022;</code>
- * <li> <code>{@link GlobalErrIds#PERM_BULK_ROLE_REVOKE_FAILED} = 3023;</code>
- * <li> <code>{@link GlobalErrIds#PERM_BULK_ADMINROLE_REVOKE_FAILED} = 3024;</code>
- * <li> <code>{@link GlobalErrIds#PERM_OU_INVALID} = 3025;</code>
- * <li> <code>{@link GlobalErrIds#PERM_OPERATION_NM_NULL} = 3026;</code>
- * <li> <code>{@link GlobalErrIds#PERM_OBJECT_NM_NULL} = 3027;</code>
- * <li> <code>{@link GlobalErrIds#PERM_COMPARE_OP_FAILED} = 3028;</code>
- * <li> <code>{@link GlobalErrIds#PERM_NOT_EXIST} = 3029;</code>
+ * <li> <code>{@link GlobalErrIds#PERM_SEARCH_FAILED} = 3000;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_READ_OP_FAILED} = 3001;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_READ_OBJ_FAILED} = 3002;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_ADD_FAILED} = 3003;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_UPDATE_FAILED} = 3004;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_DELETE_FAILED} = 3005;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_OP_NOT_FOUND} = 3006;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_OBJ_NOT_FOUND} = 3007;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_NULL} = 3008;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_OPERATION_NULL} = 3009;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_OBJECT_NULL} = 3010;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_DUPLICATE} = 3011;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_GRANT_FAILED} = 3012;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_GRANT_USER_FAILED} = 3013;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_REVOKE_FAILED} = 3024;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_ROLE_EXIST} = 3015;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_ROLE_NOT_EXIST} = 3016;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_USER_EXIST} = 3017;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_USER_NOT_EXIST} = 3018;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_ROLE_SEARCH_FAILED} = 3019;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_USER_SEARCH_FAILED} = 3020;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_SESS_SEARCH_FAILED} = 3021;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_BULK_USER_REVOKE_FAILED} = 3022;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_BULK_ROLE_REVOKE_FAILED} = 3023;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_BULK_ADMINROLE_REVOKE_FAILED} = 3024;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_OU_INVALID} = 3025;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_OPERATION_NM_NULL} = 3026;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_OBJECT_NM_NULL} = 3027;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_COMPARE_OP_FAILED} = 3028;</code></li>
+ * <li> <code>{@link GlobalErrIds#PERM_NOT_EXIST} = 3029;</code></li>
* </ul>
* <h3>
- * <p/>4000's - Password Policy Entity
+ * 4000's - Password Policy Entity
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#PSWD_READ_FAILED} = 4000;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_CREATE_FAILED} = 4001;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_UPDATE_FAILED} = 4002;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_DELETE_FAILED} = 4003;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_SEARCH_FAILED} = 4004;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_NOT_FOUND} = 4005;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_NAME_INVLD_LEN} = 4006;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_QLTY_INVLD_LEN} = 4007;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_QLTY_INVLD} = 4008;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_MAXAGE_INVLD} = 4009;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_MINAGE_INVLD} = 4010;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_MINLEN_INVLD} = 4011;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_INTERVAL_INVLD} = 4012;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_MAXFAIL_INVLD} = 4013;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_MUSTCHG_INVLD} = 4014;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_SAFECHG_INVLD} = 4015;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_ALLOWCHG_INVLD} = 4016;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_HISTORY_INVLD} = 4017;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_GRACE_INVLD} = 4018;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_LOCKOUTDUR_INVLD} = 4019;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_EXPWARN_INVLD} = 4020;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_LOCKOUT_INVLD} = 4021;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_NAME_NULL} = 4022;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_PLCY_NULL} = 4023;</code>
- * <li> <code>{@link GlobalErrIds#PSWD_CONST_VIOLATION} = 4024;</code>
+ * <li> <code>{@link GlobalErrIds#PSWD_READ_FAILED} = 4000;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_CREATE_FAILED} = 4001;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_UPDATE_FAILED} = 4002;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_DELETE_FAILED} = 4003;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_SEARCH_FAILED} = 4004;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_NOT_FOUND} = 4005;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_NAME_INVLD_LEN} = 4006;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_QLTY_INVLD_LEN} = 4007;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_QLTY_INVLD} = 4008;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_MAXAGE_INVLD} = 4009;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_MINAGE_INVLD} = 4010;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_MINLEN_INVLD} = 4011;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_INTERVAL_INVLD} = 4012;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_MAXFAIL_INVLD} = 4013;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_MUSTCHG_INVLD} = 4014;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_SAFECHG_INVLD} = 4015;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_ALLOWCHG_INVLD} = 4016;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_HISTORY_INVLD} = 4017;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_GRACE_INVLD} = 4018;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_LOCKOUTDUR_INVLD} = 4019;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_EXPWARN_INVLD} = 4020;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_LOCKOUT_INVLD} = 4021;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_NAME_NULL} = 4022;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_PLCY_NULL} = 4023;</code></li>
+ * <li> <code>{@link GlobalErrIds#PSWD_CONST_VIOLATION} = 4024;</code></li>
* </ul>
* <h3>
- * <p/>5000's - RBAC
+ * 5000's - RBAC
* </h3>
* <h4>
- * <p/> Role Rule and System errors
+ * Role Rule and System errors
* </h4>
* <ul>
- * <li> <code>{@link GlobalErrIds#ROLE_SEARCH_FAILED} = 5000;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_READ_FAILED} = 5001;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_ADD_FAILED} = 5002;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_UPDATE_FAILED} = 5003;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_DELETE_FAILED} = 5004;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_NM_NULL} = 5005;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_NOT_FOUND} = 5006;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_NULL} = 5007;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_USER_ASSIGN_FAILED} = 5008;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_USER_DEASSIGN_FAILED} = 5009;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_LST_NULL} = 5010;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_OCCUPANT_SEARCH_FAILED} = 5011;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_REMOVE_OCCUPANT_FAILED} = 5012;</code>
- * <li> <code>{@link GlobalErrIds#PARENT_ROLE_NULL} = 5013;</code>
- * <li> <code>{@link GlobalErrIds#CHILD_ROLE_NULL} = 5014;</code>
- * <li> <code>{@link GlobalErrIds#ROLE_REMOVE_PARENT_FAILED} = 5015;</code>
+ * <li> <code>{@link GlobalErrIds#ROLE_SEARCH_FAILED} = 5000;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_READ_FAILED} = 5001;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_ADD_FAILED} = 5002;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_UPDATE_FAILED} = 5003;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_DELETE_FAILED} = 5004;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_NM_NULL} = 5005;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_NOT_FOUND} = 5006;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_NULL} = 5007;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_USER_ASSIGN_FAILED} = 5008;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_USER_DEASSIGN_FAILED} = 5009;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_LST_NULL} = 5010;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_OCCUPANT_SEARCH_FAILED} = 5011;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_REMOVE_OCCUPANT_FAILED} = 5012;</code></li>
+ * <li> <code>{@link GlobalErrIds#PARENT_ROLE_NULL} = 5013;</code></li>
+ * <li> <code>{@link GlobalErrIds#CHILD_ROLE_NULL} = 5014;</code></li>
+ * <li> <code>{@link GlobalErrIds#ROLE_REMOVE_PARENT_FAILED} = 5015;</code></li>
* </ul>
* <h4>
- * <p/> Hierarchical Constraints
+ * Hierarchical Constraints
* </h4>
* <ul>
- * <li> <code>{@link GlobalErrIds#HIER_READ_FAILED} = 5051;</code>
- * <li> <code>{@link GlobalErrIds#HIER_ADD_FAILED} = 5052;</code>
- * <li> <code>{@link GlobalErrIds#HIER_UPDATE_FAILED} = 5053;</code>
- * <li> <code>{@link GlobalErrIds#HIER_DELETE_FAILED} = 5054;</code>
- * <li> <code>{@link GlobalErrIds#HIER_NOT_FOUND} = 5056;</code>
- * <li> <code>{@link GlobalErrIds#HIER_REL_INVLD} = 5057;</code>
- * <li> <code>{@link GlobalErrIds#HIER_DEL_FAILED_HAS_CHILD} = 5058;</code>
- * <li> <code>{@link GlobalErrIds#HIER_REL_EXIST} = 5059;</code>
- * <li> <code>{@link GlobalErrIds#HIER_REL_NOT_EXIST} = 5060;</code>
- * <li> <code>{@link GlobalErrIds#HIER_NULL} = 0561;</code>
- * <li> <code>{@link GlobalErrIds#HIER_TYPE_NULL} = 5062;</code>
- * <li> <code>{@link GlobalErrIds#HIER_CANNOT_PERFORM} = 5063;</code>
- * <li> <code>{@link GlobalErrIds#HIER_REL_CYCLIC} = 5064;</code>
+ * <li> <code>{@link GlobalErrIds#HIER_READ_FAILED} = 5051;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_ADD_FAILED} = 5052;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_UPDATE_FAILED} = 5053;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_DELETE_FAILED} = 5054;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_NOT_FOUND} = 5056;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_REL_INVLD} = 5057;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_DEL_FAILED_HAS_CHILD} = 5058;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_REL_EXIST} = 5059;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_REL_NOT_EXIST} = 5060;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_NULL} = 0561;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_TYPE_NULL} = 5062;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_CANNOT_PERFORM} = 5063;</code></li>
+ * <li> <code>{@link GlobalErrIds#HIER_REL_CYCLIC} = 5064;</code></li>
*
* </ul>
* <h4>
- * <p/> Separation of Duty Relations
+ * Separation of Duty Relations
* </h4>
* <ul>
- * <li> <code>{@link GlobalErrIds#SSD_SEARCH_FAILED} = 5080;</code>
- * <li> <code>{@link GlobalErrIds#SSD_READ_FAILED} = 5081;</code>
- * <li> <code>{@link GlobalErrIds#SSD_ADD_FAILED} = 5082;</code>
- * <li> <code>{@link GlobalErrIds#SSD_UPDATE_FAILED} = 5083;</code>
- * <li> <code>{@link GlobalErrIds#SSD_DELETE_FAILED} = 0584;</code>
- * <li> <code>{@link GlobalErrIds#SSD_NM_NULL} = 5085;</code>
- * <li> <code>{@link GlobalErrIds#SSD_NOT_FOUND} = 5086;</code>
- * <li> <code>{@link GlobalErrIds#SSD_NULL} = 5087;</code>
- * <li> <code>{@link GlobalErrIds#SSD_VALIDATION_FAILED} = 5088;</code>
- * <li> <code>{@link GlobalErrIds#DSD_SEARCH_FAILED} = 5089;</code>
- * <li> <code>{@link GlobalErrIds#DSD_READ_FAILED} = 5090;</code>
- * <li> <code>{@link GlobalErrIds#DSD_ADD_FAILED} = 5091;</code>
- * <li> <code>{@link GlobalErrIds#DSD_UPDATE_FAILED} = 5092;</code>
- * <li> <code>{@link GlobalErrIds#DSD_DELETE_FAILED} = 5093;</code>
- * <li> <code>{@link GlobalErrIds#DSD_NM_NULL} = 5094;</code>
- * <li> <code>{@link GlobalErrIds#DSD_NOT_FOUND} = 5095;</code>
- * <li> <code>{@link GlobalErrIds#DSD_NULL} = 5096;</code>
- * <li> <code>{@link GlobalErrIds#DSD_VALIDATION_FAILED} = 5097;</code>
+ * <li> <code>{@link GlobalErrIds#SSD_SEARCH_FAILED} = 5080;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_READ_FAILED} = 5081;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_ADD_FAILED} = 5082;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_UPDATE_FAILED} = 5083;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_DELETE_FAILED} = 0584;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_NM_NULL} = 5085;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_NOT_FOUND} = 5086;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_NULL} = 5087;</code></li>
+ * <li> <code>{@link GlobalErrIds#SSD_VALIDATION_FAILED} = 5088;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_SEARCH_FAILED} = 5089;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_READ_FAILED} = 5090;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_ADD_FAILED} = 5091;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_UPDATE_FAILED} = 5092;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_DELETE_FAILED} = 5093;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_NM_NULL} = 5094;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_NOT_FOUND} = 5095;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_NULL} = 5096;</code></li>
+ * <li> <code>{@link GlobalErrIds#DSD_VALIDATION_FAILED} = 5097;</code></li>
* </ul>
* <h3>
- * <p/>6000's - LDAP Suffix and Container Entities
+ * 6000's - LDAP Suffix and Container Entities
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#CNTR_CREATE_FAILED} = 6001;</code>
- * <li> <code>{@link GlobalErrIds#CNTR_DELETE_FAILED} = 6002;</code>
- * <li> <code>{@link GlobalErrIds#CNTR_NAME_NULL} = 6003;</code>
- * <li> <code>{@link GlobalErrIds#CNTR_NAME_INVLD} = 6004;</code>
- * <li> <code>{@link GlobalErrIds#CNTR_PARENT_NULL} = 6005;</code>
- * <li> <code>{@link GlobalErrIds#CNTR_PARENT_INVLD} = 6006;</code>
- * <li> <code>{@link GlobalErrIds#SUFX_CREATE_FAILED} = 6010;</code>
- * <li> <code>{@link GlobalErrIds#SUFX_DELETE_FAILED} = 6011;</code>
- * <li> <code>{@link GlobalErrIds#SUFX_NAME_NULL} = 6012;</code>
- * <li> <code>{@link GlobalErrIds#SUFX_NAME_INVLD} = 6013;</code>
- * <li> <code>{@link GlobalErrIds#SUFX_DCTOP_NULL} = 6014;</code>
- * <li> <code>{@link GlobalErrIds#SUFX_DCTOP_INVLD} = 6015;</code>
+ * <li> <code>{@link GlobalErrIds#CNTR_CREATE_FAILED} = 6001;</code></li>
+ * <li> <code>{@link GlobalErrIds#CNTR_DELETE_FAILED} = 6002;</code></li>
+ * <li> <code>{@link GlobalErrIds#CNTR_NAME_NULL} = 6003;</code></li>
+ * <li> <code>{@link GlobalErrIds#CNTR_NAME_INVLD} = 6004;</code></li>
+ * <li> <code>{@link GlobalErrIds#CNTR_PARENT_NULL} = 6005;</code></li>
+ * <li> <code>{@link GlobalErrIds#CNTR_PARENT_INVLD} = 6006;</code></li>
+ * <li> <code>{@link GlobalErrIds#SUFX_CREATE_FAILED} = 6010;</code></li>
+ * <li> <code>{@link GlobalErrIds#SUFX_DELETE_FAILED} = 6011;</code></li>
+ * <li> <code>{@link GlobalErrIds#SUFX_NAME_NULL} = 6012;</code></li>
+ * <li> <code>{@link GlobalErrIds#SUFX_NAME_INVLD} = 6013;</code></li>
+ * <li> <code>{@link GlobalErrIds#SUFX_DCTOP_NULL} = 6014;</code></li>
+ * <li> <code>{@link GlobalErrIds#SUFX_DCTOP_INVLD} = 6015;</code></li>
* </ul>
* <h3>
- * <p/>7000's - Audit Activities
+ * 7000's - Audit Activities
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#AUDT_BIND_SEARCH_FAILED} = 7000;</code>
- * <li> <code>{@link GlobalErrIds#AUDT_INPUT_NULL} = 7001;</code>
- * <li> <code>{@link GlobalErrIds#AUDT_AUTHZ_SEARCH_FAILED} = 7002;</code>
- * <li> <code>{@link GlobalErrIds#AUDT_MOD_SEARCH_FAILED} = 7003;</code>
- * <li> <code>{@link GlobalErrIds#AUDT_MOD_ADMIN_SEARCH_FAILED} = 7004;</code>
- * <li> <code>{@link GlobalErrIds#AUDT_AUTHN_INVALID_FAILED} = 7005;</code>
+ * <li> <code>{@link GlobalErrIds#AUDT_BIND_SEARCH_FAILED} = 7000;</code></li>
+ * <li> <code>{@link GlobalErrIds#AUDT_INPUT_NULL} = 7001;</code></li>
+ * <li> <code>{@link GlobalErrIds#AUDT_AUTHZ_SEARCH_FAILED} = 7002;</code></li>
+ * <li> <code>{@link GlobalErrIds#AUDT_MOD_SEARCH_FAILED} = 7003;</code></li>
+ * <li> <code>{@link GlobalErrIds#AUDT_MOD_ADMIN_SEARCH_FAILED} = 7004;</code></li>
+ * <li> <code>{@link GlobalErrIds#AUDT_AUTHN_INVALID_FAILED} = 7005;</code></li>
* </ul>
* <h3>
- * <p/>8000's Organizational Unit Rule and System errors
+ * 8000's Organizational Unit Rule and System errors
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#ORG_NULL} = 8001;</code>
- * <li> <code>{@link GlobalErrIds#ORG_TYPE_NULL} = 8002;</code>
- * <li> <code>{@link GlobalErrIds#ORG_READ_FAILED_USER} = 8011;</code>
- * <li> <code>{@link GlobalErrIds#ORG_ADD_FAILED_USER} = 8012;</code>
- * <li> <code>{@link GlobalErrIds#ORG_UPDATE_FAILED_USER} = 8013;</code>
- * <li> <code>{@link GlobalErrIds#ORG_DELETE_FAILED_USER} = 8014;</code>
- * <li> <code>{@link GlobalErrIds#ORG_SEARCH_FAILED_USER} = 8015;</code>
- * <li> <code>{@link GlobalErrIds#ORG_GET_FAILED_USER} = 0816;</code>
- * <li> <code>{@link GlobalErrIds#ORG_NOT_FOUND_USER} = 8017;</code>
- * <li> <code>{@link GlobalErrIds#ORG_NULL_USER} = 0818;</code>
- * <li> <code>{@link GlobalErrIds#ORG_TYPE_NULL_USER} = 8019;</code>
- * <li> <code>{@link GlobalErrIds#ORG_DEL_FAILED_USER} = 8020;</code>
- * <li> <code>{@link GlobalErrIds#ORG_REMOVE_PARENT_FAILED_USER} = 8021;</code>
- * <li> <code>{@link GlobalErrIds#ORG_READ_FAILED_PERM} = 8061;</code>
- * <li> <code>{@link GlobalErrIds#ORG_ADD_FAILED_PERM} = 8062;</code>
- * <li> <code>{@link GlobalErrIds#ORG_UPDATE_FAILED_PERM} = 8063;</code>
- * <li> <code>{@link GlobalErrIds#ORG_DELETE_FAILED_PERM} = 8064;</code>
- * <li> <code>{@link GlobalErrIds#ORG_SEARCH_FAILED_PERM} = 8065;</code>
- * <li> <code>{@link GlobalErrIds#ORG_GET_FAILED_PERM} = 8066;</code>
- * <li> <code>{@link GlobalErrIds#ORG_NOT_FOUND_PERM} = 8067;</code>
- * <li> <code>{@link GlobalErrIds#ORG_NULL_PERM} = 8068;</code>
- * <li> <code>{@link GlobalErrIds#ORG_TYPE_NULL_PERM} = 8069;</code>
- * <li> <code>{@link GlobalErrIds#ORG_DEL_FAILED_PERM} = 8070;</code>
- * <li> <code>{@link GlobalErrIds#ORG_LEN_INVLD} = 8071;</code>
- * <li> <code>{@link GlobalErrIds#ORG_PARENT_NULL} = 8072;</code>
- * <li> <code>{@link GlobalErrIds#ORG_CHILD_NULL} = 8073;</code>
- * <li> <code>{@link GlobalErrIds#ORG_REMOVE_PARENT_FAILED_PERM} = 8074;</code>
+ * <li> <code>{@link GlobalErrIds#ORG_NULL} = 8001;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_TYPE_NULL} = 8002;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_READ_FAILED_USER} = 8011;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_ADD_FAILED_USER} = 8012;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_UPDATE_FAILED_USER} = 8013;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_DELETE_FAILED_USER} = 8014;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_SEARCH_FAILED_USER} = 8015;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_GET_FAILED_USER} = 0816;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_NOT_FOUND_USER} = 8017;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_NULL_USER} = 0818;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_TYPE_NULL_USER} = 8019;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_DEL_FAILED_USER} = 8020;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_REMOVE_PARENT_FAILED_USER} = 8021;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_READ_FAILED_PERM} = 8061;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_ADD_FAILED_PERM} = 8062;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_UPDATE_FAILED_PERM} = 8063;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_DELETE_FAILED_PERM} = 8064;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_SEARCH_FAILED_PERM} = 8065;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_GET_FAILED_PERM} = 8066;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_NOT_FOUND_PERM} = 8067;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_NULL_PERM} = 8068;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_TYPE_NULL_PERM} = 8069;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_DEL_FAILED_PERM} = 8070;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_LEN_INVLD} = 8071;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_PARENT_NULL} = 8072;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_CHILD_NULL} = 8073;</code></li>
+ * <li> <code>{@link GlobalErrIds#ORG_REMOVE_PARENT_FAILED_PERM} = 8074;</code></li>
* </ul>
* <h3>
- * <p/>9000's Administrative RBAC
+ * 9000's Administrative RBAC
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#ARLE_SEARCH_FAILED} = 9000;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_READ_FAILED} = 9001;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_ADD_FAILED} = 9002;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_UPDATE_FAILED} = 9003;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_DELETE_FAILED} = 9004;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_NM_NULL} = 9005;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_NOT_FOUND} = 9006;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_NULL} = 9007;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_USER_ASSIGN_FAILED} = 9008;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_USER_DEASSIGN_FAILED} = 9009;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_LST_NULL} = 9010;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_BEGIN_RANGE_NULL} = 9011;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_END_RANGE_NULL} = 0911;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_INVLD_RANGE} = 9012;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_INVLD_RANGE_INCLUSIVE} = 9013;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_ACTIVATE_FAILED} = 9014;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_DEACTIVE_FAILED} = 9015;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_ALREADY_ACTIVE} = 9016;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_NOT_ACTIVE} = 9017;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_USER_SEARCH_FAILED} = 9018;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_PARENT_NULL} = 9019;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_CHILD_NULL} = 9020;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_ASSIGN_EXIST} = 9021;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_ASSIGN_NOT_EXIST} = 9022;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_DEASSIGN_NOT_EXIST} = 9023;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_ASSIGN_FAILED} = 9024;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_DEASSIGN_FAILED} = 9025;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_OCCUPANT_SEARCH_FAILED} = 9026;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_REMOVE_OCCUPANT_FAILED} = 9027;</code>
- * <li> <code>{@link GlobalErrIds#ARLE_REMOVE_PARENT_FAILED} = 9028;</code>
+ * <li> <code>{@link GlobalErrIds#ARLE_SEARCH_FAILED} = 9000;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_READ_FAILED} = 9001;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_ADD_FAILED} = 9002;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_UPDATE_FAILED} = 9003;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_DELETE_FAILED} = 9004;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_NM_NULL} = 9005;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_NOT_FOUND} = 9006;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_NULL} = 9007;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_USER_ASSIGN_FAILED} = 9008;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_USER_DEASSIGN_FAILED} = 9009;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_LST_NULL} = 9010;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_BEGIN_RANGE_NULL} = 9011;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_END_RANGE_NULL} = 0911;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_INVLD_RANGE} = 9012;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_INVLD_RANGE_INCLUSIVE} = 9013;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_ACTIVATE_FAILED} = 9014;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_DEACTIVE_FAILED} = 9015;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_ALREADY_ACTIVE} = 9016;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_NOT_ACTIVE} = 9017;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_USER_SEARCH_FAILED} = 9018;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_PARENT_NULL} = 9019;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_CHILD_NULL} = 9020;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_ASSIGN_EXIST} = 9021;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_ASSIGN_NOT_EXIST} = 9022;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_DEASSIGN_NOT_EXIST} = 9023;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_ASSIGN_FAILED} = 9024;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_DEASSIGN_FAILED} = 9025;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_OCCUPANT_SEARCH_FAILED} = 9026;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_REMOVE_OCCUPANT_FAILED} = 9027;</code></li>
+ * <li> <code>{@link GlobalErrIds#ARLE_REMOVE_PARENT_FAILED} = 9028;</code></li>
* </ul>
*
* <h3>
- * <p/>10000's - Temporal Constraint Validation Error Ids
+ * 10000's - Temporal Constraint Validation Error Ids
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#CONST_INVLD_TEXT} = 10001;</code>
- * <li> <code>{@link GlobalErrIds#CONST_INVLD_FIELD_LEN} = 10002;</code>
- * <li> <code>{@link GlobalErrIds#CONST_TIMEOUT_INVLD} = 10003;</code>
- * <li> <code>{@link GlobalErrIds#CONST_BEGINTIME_INVLD} = 10004;</code>
- * <li> <code>{@link GlobalErrIds#CONST_BEGINTIME_LEN_ERR} = 10005;</code>
- * <li> <code>{@link GlobalErrIds#CONST_ENDTIME_INVLD} = 10006;</code>
- * <li> <code>{@link GlobalErrIds#CONST_ENDTIME_LEN_ERR} = 10007;</code>
- * <li> <code>{@link GlobalErrIds#CONST_BEGINDATE_INVLD} = 10008;</code>
- * <li> <code>{@link GlobalErrIds#CONST_BEGINDATE_NULL} = 10009;</code>
- * <li> <code>{@link GlobalErrIds#CONST_ENDDATE_INVLD} = 10010;</code>
- * <li> <code>{@link GlobalErrIds#CONST_ENDDATE_NULL} = 10011;</code>
- * <li> <code>{@link GlobalErrIds#CONST_DAYMASK_INVLD} = 10012;</code>
- * <li> <code>{@link GlobalErrIds#CONST_DAYMASK_NULL} = 10013;</code>
- * <li> <code>{@link GlobalErrIds#CONST_DESC_LEN_INVLD} = 10014;</code>
- * <li> <code>{@link GlobalErrIds#CONST_NULL_TEXT} = 10015;</code>
+ * <li> <code>{@link GlobalErrIds#CONST_INVLD_TEXT} = 10001;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_INVLD_FIELD_LEN} = 10002;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_TIMEOUT_INVLD} = 10003;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_BEGINTIME_INVLD} = 10004;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_BEGINTIME_LEN_ERR} = 10005;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_ENDTIME_INVLD} = 10006;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_ENDTIME_LEN_ERR} = 10007;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_BEGINDATE_INVLD} = 10008;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_BEGINDATE_NULL} = 10009;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_ENDDATE_INVLD} = 10010;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_ENDDATE_NULL} = 10011;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_DAYMASK_INVLD} = 10012;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_DAYMASK_NULL} = 10013;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_DESC_LEN_INVLD} = 10014;</code></li>
+ * <li> <code>{@link GlobalErrIds#CONST_NULL_TEXT} = 10015;</code></li>
* </ul>
* <h3>
- * <p/>10100's - REST calls through remote En Masse Interface Error Ids
+ * 10100's - REST calls through remote En Masse Interface Error Ids
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#REST_WEB_ERR} = 10101;</code>
- * <li> <code>{@link GlobalErrIds#REST_IO_ERR} = 10102;</code>
- * <li> <code>{@link GlobalErrIds#REST_MARSHALL_ERR} = 10103;</code>
- * <li> <code>{@link GlobalErrIds#REST_UNMARSHALL_ERR} = 10104;</code>
- * <li> <code>{@link GlobalErrIds#REST_GET_FAILED} = 10105;</code>
- * <li> <code>{@link GlobalErrIds#REST_NOT_FOUND_ERR} = 10106;</code>
- * <li> <code>{@link GlobalErrIds#REST_UNKNOWN_ERR} = 10107;</code>
- * <li> <code>{@link GlobalErrIds#REST_FORBIDDEN_ERR} = 10108;</code>
- * <li> <code>{@link GlobalErrIds#REST_UNAUTHORIZED_ERR} = 10109;</code>
+ * <li> <code>{@link GlobalErrIds#REST_WEB_ERR} = 10101;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_IO_ERR} = 10102;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_MARSHALL_ERR} = 10103;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_UNMARSHALL_ERR} = 10104;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_GET_FAILED} = 10105;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_NOT_FOUND_ERR} = 10106;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_UNKNOWN_ERR} = 10107;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_FORBIDDEN_ERR} = 10108;</code></li>
+ * <li> <code>{@link GlobalErrIds#REST_UNAUTHORIZED_ERR} = 10109;</code></li>
* </ul>
* <h3>
- * <p/>10200's - RBAC Accelerator extended LDAP operation Error Ids
+ * 10200's - RBAC Accelerator extended LDAP operation Error Ids
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#ACEL_CREATE_SESSION_ERR} = 10201;</code>
- * <li> <code>{@link GlobalErrIds#ACEL_DELETE_SESSION_ERR} = 10202;</code>
- * <li> <code>{@link GlobalErrIds#ACEL_CHECK_ACCESS_ERR} = 10203;</code>
- * <li> <code>{@link GlobalErrIds#ACEL_ADD_ROLE_ERR} = 10204;</code>
- * <li> <code>{@link GlobalErrIds#ACEL_DROP_ROLE_ERR} = 10205;</code>
+ * <li> <code>{@link GlobalErrIds#ACEL_CREATE_SESSION_ERR} = 10201;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACEL_DELETE_SESSION_ERR} = 10202;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACEL_CHECK_ACCESS_ERR} = 10203;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACEL_ADD_ROLE_ERR} = 10204;</code></li>
+ * <li> <code>{@link GlobalErrIds#ACEL_DROP_ROLE_ERR} = 10205;</code></li>
* </ul>
* <h3>
- * <p/>10300's - LDAP Group operation Error Ids
+ * 10300's - LDAP Group operation Error Ids
* </h3>
* <ul>
- * <li> <code>{@link GlobalErrIds#GROUP_SEARCH_FAILED} = 10300;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_READ_FAILED} = 10301;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_ADD_FAILED} = 10302;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_UPDATE_FAILED} = 10303;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_DELETE_FAILED} = 10304;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_ADD_PROPERTY_FAILED} = 10305;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_DELETE_PROPERTY_FAILED} = 10306;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_NOT_FOUND} = 10307;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_NULL} = 10308;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_USER_ASSIGN_FAILED} = 10309;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_USER_DEASSIGN_FAILED} = 10310;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_NAME_NULL} = 10311;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_NAME_INVLD} = 10312;</code>
- * <li> <code>{@link GlobalErrIds#GROUP_PROTOCOL_INVLD} = 10313;</code>
+ * <li> <code>{@link GlobalErrIds#GROUP_SEARCH_FAILED} = 10300;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_READ_FAILED} = 10301;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_ADD_FAILED} = 10302;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_UPDATE_FAILED} = 10303;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_DELETE_FAILED} = 10304;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_ADD_PROPERTY_FAILED} = 10305;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_DELETE_PROPERTY_FAILED} = 10306;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_NOT_FOUND} = 10307;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_NULL} = 10308;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_USER_ASSIGN_FAILED} = 10309;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_USER_DEASSIGN_FAILED} = 10310;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_NAME_NULL} = 10311;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_NAME_INVLD} = 10312;</code></li>
+ * <li> <code>{@link GlobalErrIds#GROUP_PROTOCOL_INVLD} = 10313;</code></li>
* </ul>
- * <p/>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -458,7 +459,8 @@ public class SecurityException extends BaseException
/**
* Create exception with error id and message.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public SecurityException( int errorId, String msg )
[04/10] directory-fortress-core git commit: Fixed Javadoc issues
Posted by el...@apache.org.
Fixed Javadoc issues
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/182e2e7f
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/182e2e7f
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/182e2e7f
Branch: refs/heads/master
Commit: 182e2e7f7efbb844d37dfa49005bfa4d35d60bc3
Parents: d73afb5
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Wed Jan 6 11:38:14 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Wed Jan 6 11:38:14 2016 +0100
----------------------------------------------------------------------
.../fortress/core/DelAdminMgrFactory.java | 4 +-
.../directory/fortress/core/DelReviewMgr.java | 78 ++++++++++++--------
.../fortress/core/DelReviewMgrFactory.java | 3 +-
.../fortress/core/FinderException.java | 6 +-
.../directory/fortress/core/GlobalErrIds.java | 27 ++++---
5 files changed, 69 insertions(+), 49 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/182e2e7f/src/main/java/org/apache/directory/fortress/core/DelAdminMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/DelAdminMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/DelAdminMgrFactory.java
index 949417d..6a5f393 100755
--- a/src/main/java/org/apache/directory/fortress/core/DelAdminMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/DelAdminMgrFactory.java
@@ -29,10 +29,10 @@ import org.apache.directory.fortress.core.util.VUtil;
/**
* Creates an instance of the DelAdminMgr object.
- * <p/>
+ * <p>
* The default implementation class is specified as {@link DelAdminMgrImpl} but can be overridden by
* adding the {@link GlobalIds#DELEGATED_ADMIN_IMPLEMENTATION} config property.
- * <p/>
+ * <p>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/182e2e7f/src/main/java/org/apache/directory/fortress/core/DelReviewMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/DelReviewMgr.java b/src/main/java/org/apache/directory/fortress/core/DelReviewMgr.java
index 35a832c..bfdcb6b 100755
--- a/src/main/java/org/apache/directory/fortress/core/DelReviewMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/DelReviewMgr.java
@@ -29,18 +29,22 @@ import java.util.List;
/**
- * This class prescribes the ARBAC02 DelReviewMgr interface for performing policy interrogation of provisioned Fortress ARBAC entities
- * that reside in LDAP directory.
- * These APIs map directly to similar named APIs specified by ARBAC02 functions. The ARBAC Functional specification describes delegated administrative
- * operations for the creation and maintenance of ARBAC element sets and relations. Delegated administrative review functions for performing administrative queries
- * and system functions for creating and managing ARBAC attributes on user sessions and making delegated administrative access control decisions.
+ * This class prescribes the ARBAC02 DelReviewMgr interface for performing policy interrogation of provisioned Fortress
+ * ARBAC entities that reside in LDAP directory.
+ * These APIs map directly to similar named APIs specified by ARBAC02 functions. The ARBAC Functional specification
+ * describes delegated administrative operations for the creation and maintenance of ARBAC element sets and relations.
+ * Delegated administrative review functions for performing administrative queries and system functions for creating and
+ * managing ARBAC attributes on user sessions and making delegated administrative access control decisions.
* <h3>Administrative Role Based Access Control (ARBAC)</h3>
- * <img src="./doc-files/ARbac.png">
- * <p/>
- * Fortress fully supports the Oh/Sandhu/Zhang ARBAC02 model for delegated administration. ARBAC provides large enterprises the capability to delegate administrative authority to users that reside outside of the security admin group.
- * Decentralizing administration helps because it provides security provisioning capability to work groups without sacrificing regulations for accountability or traceability.
- * <p/>
- * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)} or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
+ * <img src="./doc-files/ARbac.png" alt="">
+ * <p>
+ * Fortress fully supports the Oh/Sandhu/Zhang ARBAC02 model for delegated administration. ARBAC provides large enterprises
+ * the capability to delegate administrative authority to users that reside outside of the security admin group.
+ * Decentralizing administration helps because it provides security provisioning capability to work groups without
+ * sacrificing regulations for accountability or traceability.
+ * <p>
+ * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)}
+ * or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -48,15 +52,15 @@ public interface DelReviewMgr extends Manageable
{
/**
* Method reads Admin Role entity from the admin role container in directory.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link AdminRole#name} - contains the name of the AdminRole being targeted for read</li>
+ * <li>{@link AdminRole#name} - contains the name of the AdminRole being targeted for read</li>
* </ul>
*
* @param role contains role name to be read.
* @return AdminRole entity that corresponds with role name.
- * @throws SecurityException
- * will be thrown if role not found or system error occurs.
+ * @throws SecurityException will be thrown if role not found or system error occurs.
*/
AdminRole readRole( AdminRole role )
throws SecurityException;
@@ -64,15 +68,15 @@ public interface DelReviewMgr extends Manageable
/**
* Method will return a list of type Admin Role.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link AdminRole#name} - contains all or some chars in the name of AdminRole(s) targeted for search</li>
+ * <li>{@link AdminRole#name} - contains all or some chars in the name of AdminRole(s) targeted for search</li>
* </ul>
*
* @param searchVal contains the all or some of the chars corresponding to admin role entities stored in directory.
* @return List of type AdminRole containing role entities that match the search criteria.
- * @throws SecurityException
- * in the event of system error.
+ * @throws SecurityException in the event of system error.
*/
List<AdminRole> findRoles( String searchVal )
throws SecurityException;
@@ -81,32 +85,32 @@ public interface DelReviewMgr extends Manageable
/**
* This function returns the set of admin roles assigned to a given user. The function is valid if and
* only if the user is a member of the USERS data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
* </ul>
*
* @param user contains userId matching user entity stored in the directory.
* @return List of type UserAdminRole containing the user admin role data.
- * @throws SecurityException
- * If user not found or system error occurs.
+ * @throws SecurityException If user not found or system error occurs.
*/
List<UserAdminRole> assignedRoles( User user )
throws SecurityException;
/**
- * This method returns the data set of all users who are assigned the given admin role. This searches the User data set for
- * AdminRole relationship. This method does NOT search for hierarchical Admin Roles relationships.
+ * This method returns the data set of all users who are assigned the given admin role. This searches the User data set
+ * for AdminRole relationship. This method does NOT search for hierarchical Admin Roles relationships.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link AdminRole#name} - contains the name of AdminRole targeted for search</li>
+ * <li>{@link AdminRole#name} - contains the name of AdminRole targeted for search</li>
* </ul>
*
* @param role contains the role name used to search the User data set.
* @return List of type User containing the users assigned data.
- * @throws SecurityException
- * If system error occurs.
+ * @throws SecurityException If system error occurs.
*/
List<User> assignedUsers( AdminRole role )
throws SecurityException;
@@ -115,10 +119,18 @@ public interface DelReviewMgr extends Manageable
/**
* Commands reads existing OrgUnit entity from OrgUnit dataset. The OrgUnit can be either User or Perm and is
* set by setting type attribute.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name associated with the OrgUnit object targeted for search.</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name associated with the OrgUnit
+ * object targeted for search.
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
* </ul>
*
* @param entity contains OrgUnit name and type.
@@ -132,17 +144,21 @@ public interface DelReviewMgr extends Manageable
/**
* Commands searches existing OrgUnit entities from OrgUnit dataset. The OrgUnit can be either User or Perm and is
* set by setting type parameter on API.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>searchVal - contains some or all of the chars associated with the OrgUnit objects targeted for search.</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
+ * <li>searchVal - contains some or all of the chars associated with the OrgUnit objects targeted for search.</li>
* </ul>
*
* @param type either PERM or USER
* @param searchVal contains the leading chars that map to {@link OrgUnit#name} on existing OrgUnit(s) targeted for search.
* @return List of type OrgUnit containing the OrgUnit data.
- * @throws SecurityException
- *
+ * @throws SecurityException in the event of data validation or system error.
*/
List<OrgUnit> search( OrgUnit.Type type, String searchVal )
throws SecurityException;
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/182e2e7f/src/main/java/org/apache/directory/fortress/core/DelReviewMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/DelReviewMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/DelReviewMgrFactory.java
index 8401a4d..70229f7 100755
--- a/src/main/java/org/apache/directory/fortress/core/DelReviewMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/DelReviewMgrFactory.java
@@ -29,10 +29,9 @@ import org.apache.directory.fortress.core.util.VUtil;
/**
* Creates an instance of the DelReviewMgr object.
- * <p/>
+ * <p>
* The default implementation class is specified as {@link DelReviewMgrImpl} but can be overridden by
* adding the {@link GlobalIds#DELEGATED_REVIEW_IMPLEMENTATION} config property.
- * <p/>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/182e2e7f/src/main/java/org/apache/directory/fortress/core/FinderException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/FinderException.java b/src/main/java/org/apache/directory/fortress/core/FinderException.java
index 4a62f06..4355b79 100755
--- a/src/main/java/org/apache/directory/fortress/core/FinderException.java
+++ b/src/main/java/org/apache/directory/fortress/core/FinderException.java
@@ -35,7 +35,8 @@ public class FinderException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
*
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public FinderException( int errorId, String msg )
@@ -46,7 +47,8 @@ public class FinderException extends SecurityException
/**
* Create exception with error id, message and related exception.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
* @param previousException contains reference to related exception which usually is system related, i.e. ldap.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/182e2e7f/src/main/java/org/apache/directory/fortress/core/GlobalErrIds.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/GlobalErrIds.java b/src/main/java/org/apache/directory/fortress/core/GlobalErrIds.java
index 4298162..363bb37 100755
--- a/src/main/java/org/apache/directory/fortress/core/GlobalErrIds.java
+++ b/src/main/java/org/apache/directory/fortress/core/GlobalErrIds.java
@@ -21,18 +21,19 @@ package org.apache.directory.fortress.core;
/**
* This module contains error identifiers that are used when exception need be thrown.
- * The Fortress Manager APIs declare {@code SecurityException} as thrown even though the child exception may vary according to type:
+ * The Fortress Manager APIs declare {@code SecurityException} as thrown even though the child exception may vary according
+ * to type:
* <ul>
- * <li>{@link CfgException} in the event the cfg of runtime fails.
- * <li>{@link CreateException} in the event DAO cannot create entity.
- * <li>{@link FinderException} in the event DAO cannot find the entity.
- * <li>{@link PasswordException} in the event user fails password checks.
- * <li>{@link RemoveException} in the event DAO cannot remove entity.
- * <li>{@link SecurityException} in the event security check fails.
- * <li>{@link UpdateException} in the event DAO cannot update entity.
- * <li>{@link ValidationException} in the event entity validation fails.
+ * <li>{@link CfgException} in the event the cfg of runtime fails.</li>
+ * <li>{@link CreateException} in the event DAO cannot create entity.</li>
+ * <li>{@link FinderException} in the event DAO cannot find the entity.</li>
+ * <li>{@link PasswordException} in the event user fails password checks.</li>
+ * <li>{@link RemoveException} in the event DAO cannot remove entity.</li>
+ * <li>{@link SecurityException} in the event security check fails.</li>
+ * <li>{@link UpdateException} in the event DAO cannot update entity.</li>
+ * <li>{@link ValidationException} in the event entity validation fails.</li>
* </ul>
- * <p/>
+ * <p>
* All Fortress public Manager Impl APIs will throw exception derived from {@link SecurityException} and containing
* an id that maps to one of these error codes.
*
@@ -240,7 +241,8 @@ public final class GlobalErrIds
public static final int USER_PW_NULL = 1009;
/**
- * The operation failed because the supplied User password is too long. Ensure the length does not exceed {@link GlobalIds#PASSWORD_LEN}.
+ * The operation failed because the supplied User password is too long. Ensure the length does not exceed
+ * {@link GlobalIds#PASSWORD_LEN}.
*/
public static final int USER_PW_INVLD_LEN = 1010;
@@ -679,7 +681,8 @@ public final class GlobalErrIds
public static final int PSWD_NOT_FOUND = 4005;
/**
- * The supplied Password policy name failed length check. Ensure that does not exceed {@link GlobalIds#PWPOLICY_NAME_LEN}.
+ * The supplied Password policy name failed length check. Ensure that does not exceed
+ * {@link GlobalIds#PWPOLICY_NAME_LEN}.
*/
public static final int PSWD_NAME_INVLD_LEN = 4006;
[03/10] directory-fortress-core git commit: Fixed the Javadoc
Posted by el...@apache.org.
Fixed the Javadoc
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/d73afb53
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/d73afb53
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/d73afb53
Branch: refs/heads/master
Commit: d73afb53566d35af321f40215c587a3f82ac94d2
Parents: f7dd249
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Wed Jan 6 08:30:21 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Wed Jan 6 08:30:21 2016 +0100
----------------------------------------------------------------------
.../directory/fortress/core/DelAdminMgr.java | 809 +++++++++++++------
1 file changed, 556 insertions(+), 253 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d73afb53/src/main/java/org/apache/directory/fortress/core/DelAdminMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/DelAdminMgr.java b/src/main/java/org/apache/directory/fortress/core/DelAdminMgr.java
index bc86a17..e1586c1 100755
--- a/src/main/java/org/apache/directory/fortress/core/DelAdminMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/DelAdminMgr.java
@@ -31,17 +31,20 @@ import org.apache.directory.fortress.core.model.User;
/**
* This class prescribes the ARBAC02 DelAdminMgr interface for performing policy administration of Fortress ARBAC entities
* that reside in LDAP directory.
- * These APIs map directly to similar named APIs specified by ARBAC02 functions. The ARBAC Functional specification describes delegated administrative
- * operations for the creation and maintenance of ARBAC element sets and relations. Delegated administrative review functions for performing administrative queries
- * and system functions for creating and managing ARBAC attributes on user sessions and making delegated administrative access control decisions.
- * <p/>
+ * These APIs map directly to similar named APIs specified by ARBAC02 functions. The ARBAC Functional specification
+ * describes delegated administrative operations for the creation and maintenance of ARBAC element sets and relations.
+ * Delegated administrative review functions for performing administrative queries and system functions for creating and
+ * managing ARBAC attributes on user sessions and making delegated administrative access control decisions.
* <h3>Administrative Role Based Access Control (ARBAC)</h3>
- * <img src="./doc-files/ARbac.png">
- * <p/>
- * Fortress fully supports the Oh/Sandhu/Zhang ARBAC02 model for delegated administration. ARBAC provides large enterprises the capability to delegate administrative authority to users that reside outside of the security admin group.
- * Decentralizing administration helps because it provides security provisioning capability to work groups without sacrificing regulations for accountability or traceability.
- * <p/>
- * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)} or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
+ * <img src="./doc-files/ARbac.png" alt="">
+ * <p>
+ * Fortress fully supports the Oh/Sandhu/Zhang ARBAC02 model for delegated administration. ARBAC provides large enterprises
+ * the capability to delegate administrative authority to users that reside outside of the security admin group.
+ * Decentralizing administration helps because it provides security provisioning capability to work groups without
+ * sacrificing regulations for accountability or traceability.
+ * <p>
+ * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)}
+ * or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -51,33 +54,55 @@ public interface DelAdminMgr extends Manageable
* This command creates a new admin role. The command is valid if and only if the new admin role is not
* already a member of the ADMIN ROLES data set. The ADMIN ROLES data set is updated.
* Initially, no user or permission is assigned to the new role.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for addition to LDAP</li>
+ * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for addition to LDAP</li>
* </ul>
- * <p/>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link AdminRole#description} - contains any safe text</li>
- * <li>{@link AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
+ * <li>{@link AdminRole#description} - contains any safe text</li>
+ * <li>{@link AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
+ * <li>{@link AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
+ * <li>
+ * {@link AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in
+ * hierarchy that administrator (whoever has this AdminRole activated) controls
+ * </li>
+ * <li>
+ * {@link AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in
+ * hierarchy that administrator may control
+ * </li>
+ * <li>
+ * {@link AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the
+ * possessor of this AdminRole
+ * </li>
+ * <li>
+ * {@link AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the
+ * administrator
+ * </li>
+ * <li>
+ * {@link AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.
+ * </li>
+ * <li>
+ * {@link AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC
+ * session
+ * </li>
+ * <li>
+ * {@link AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC
+ * session
+ * </li>
+ * <li>{@link AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>{@link AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
+ * <li>{@link AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated
+ * into user's ARBAC session</li>
* </ul>
*
* @param role Contains role name and description.
* @return AdminRole contains reference to entity added.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
AdminRole addRole( AdminRole role )
throws SecurityException;
@@ -87,15 +112,14 @@ public interface DelAdminMgr extends Manageable
* This command deletes an existing admin role from the ARBAC database. The command is valid
* if and only if the role to be deleted is a member of the ADMIN ROLES data set. This command will
* also deassign role from all users.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for removal</li>
+ * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for removal</li>
* </ul>
- * <p/>
*
* @param role Contains role name.
- * @throws SecurityException
- * Thrown in the event of data validation or system error.
+ * @throws SecurityException Thrown in the event of data validation or system error.
*/
void deleteRole( AdminRole role )
throws SecurityException;
@@ -103,33 +127,55 @@ public interface DelAdminMgr extends Manageable
/**
* Method will update an AdminRole entity in the directory. The role must exist in directory prior to this call.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for updating</li>
+ * <li>{@link AdminRole#name} - contains the name of the new AdminRole being targeted for updating</li>
* </ul>
- * <p/>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link AdminRole#description} - contains any safe text</li>
- * <li>{@link AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
- * <li>{@link AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
- * <li>{@link AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in hierarchy that administrator (whoever has this AdminRole activated) controls</li>
- * <li>{@link AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in hierarchy that administrator may control</li>
- * <li>{@link AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the posessor of this AdminRole</li>
- * <li>{@link AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the administratrator</li>
- * <li>{@link AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.</li>
- * <li>{@link AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session</li>
- * <li>{@link AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
+ * <li>{@link AdminRole#description} - contains any safe text</li>
+ * <li>{@link AdminRole#osPs} * - multi-occurring attribute used to set associations to existing PERMS OrgUnits</li>
+ * <li>{@link AdminRole#osUs} * - multi-occurring attribute used to set associations to existing USERS OrgUnits</li>
+ * <li>
+ * {@link AdminRole#beginRange} - contains the name of an existing RBAC Role that represents the lowest role in
+ * hierarchy that administrator (whoever has this AdminRole activated) controls
+ * </li>
+ * <li>
+ * {@link AdminRole#endRange} - contains the name of an existing RBAC Role that represents that highest role in
+ * hierarchy that administrator may control
+ * </li>
+ * <li>
+ * {@link AdminRole#beginInclusive} - if 'true' the RBAC Role specified in beginRange is also controlled by the
+ * possessor of this AdminRole
+ * </li>
+ * <li>
+ * {@link AdminRole#endInclusive} - if 'true' the RBAC Role specified in endRange is also controlled by the
+ * administrator
+ * </li>
+ * <li>
+ * {@link AdminRole#beginTime} - HHMM - determines begin hour adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link AdminRole#endTime} - HHMM - determines end hour adminRole may be activated into user's ARBAC session.
+ * </li>
+ * <li>
+ * {@link AdminRole#beginDate} - YYYYMMDD - determines date when adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>
+ * {@link AdminRole#endDate} - YYYYMMDD - indicates latest date adminRole may be activated into user's ARBAC session
+ * </li>
+ * <li>{@link AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>{@link AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
+ * <li>
+ * {@link AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into
+ * user's ARBAC session
+ * </li>
* </ul>
*
* @param role Contains role name and new description.
* @return AdminRole contains reference to entity operated on.
- * @throws SecurityException
- * Thrown in the event of data validation or system error.
+ * @throws SecurityException Thrown in the event of data validation or system error.
*/
AdminRole updateRole( AdminRole role )
throws SecurityException;
@@ -138,60 +184,86 @@ public interface DelAdminMgr extends Manageable
/**
* This command assigns a user to an admin role.
* Successful completion of this op, the following occurs:
- * <p>
* <ul>
- * <li> User entity (resides in people container) has role assignment added to aux object class attached to actual user record.
- * <li> AdminRole entity (resides in admin role container) has userId added as role occupant.
- * <li> (optional) Temporal constraints may be associated with <code>ftUserAttrs</code> aux object class based on:
- * <ul>
- * <li> timeout - number in seconds of session inactivity time allowed.
- * <li> beginDate - YYYYMMDD - determines date when role may be activated.
- * <li> endDate - YYMMDD - indicates latest date role may be activated.
- * <li> beginLockDate - YYYYMMDD - determines beginning of enforced inactive status
- * <li> endLockDate - YYMMDD - determines end of enforced inactive status.
- * <li> beginTime - HHMM - determines begin hour role may be activated in user's session.
- * <li> endTime - HHMM - determines end hour role may be activated in user's session.*
- * <li> dayMask - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day of week role may be activated.
- * </ul>
- * </ul>
+ * <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 admin 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:
+ * <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 UserAdminRole#name} - contains the name for already existing AdminRole to be assigned</li>
- * <li>{@link UserAdminRole#userId} - contains the userId for existing User</li>
+ * <li>{@link UserAdminRole#name} - contains the name for already existing AdminRole to be assigned</li>
+ * <li>{@link UserAdminRole#userId} - contains the userId for existing User</li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link UserAdminRole#beginTime} - HHMM - determines begin hour AdminRole may be activated into user's RBAC session</li>
- * <li>{@link UserAdminRole#endTime} - HHMM - determines end hour AdminRole may be activated into user's RBAC session.</li>
- * <li>{@link UserAdminRole#beginDate} - YYYYMMDD - determines date when AdminRole may be activated into user's RBAC session</li>
- * <li>{@link UserAdminRole#endDate} - YYYYMMDD - indicates latest date AdminRole may be activated into user's RBAC session</li>
- * <li>{@link UserAdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
- * <li>{@link UserAdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
- * <li>{@link UserAdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's ARBAC session</li>
+ * <li>
+ * {@link UserAdminRole#beginTime} - HHMM - determines begin hour AdminRole may be activated into user's RBAC session
+ * </li>
+ * <li>
+ * {@link UserAdminRole#endTime} - HHMM - determines end hour AdminRole may be activated into user's RBAC session.
+ * </li>
+ * <li>
+ * {@link UserAdminRole#beginDate} - YYYYMMDD - determines date when AdminRole may be activated into user's RBAC
+ * session
+ * </li>
+ * <li>
+ * {@link UserAdminRole#endDate} - YYYYMMDD - indicates latest date AdminRole may be activated into user's RBAC
+ * session
+ * </li>
+ * <li>{@link UserAdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status</li>
+ * <li>{@link UserAdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status</li>
+ * <li>
+ * {@link UserAdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated
+ * into user's ARBAC session
+ * </li>
* </ul>
*
- * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and {@link org.apache.directory.fortress.core.model.AdminRole#name} and optional {@code Constraints}..
- * @throws SecurityException
- * in the event data error in user or role objects or system error.
+ * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and
+ * {@link org.apache.directory.fortress.core.model.AdminRole#name} and optional {@code Constraints}..
+ * @throws SecurityException in the event data error in user or role objects or system error.
*/
void assignUser( UserAdminRole uAdminRole )
throws SecurityException;
/**
- * 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.
+ * 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:
+ * <pre>
* del Role to User assignment in User data set
* AND
* User to Role assignment in Admin Role data set.
+ * </pre>
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing AdminRole to be deassigned</li>
- * <li>{@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#name} - contains the name for already existing
+ * AdminRole to be deassigned
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole#userId} - contains the userId for existing User
+ * </li>
* </ul>
*
- * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and {@link org.apache.directory.fortress.core.model.AdminRole#name}.
+ * @param uAdminRole entity contains {@link org.apache.directory.fortress.core.model.User#userId} and
+ * {@link org.apache.directory.fortress.core.model.AdminRole#name}.
* @throws SecurityException - in the event data error in user or role objects or system error.
*/
void deassignUser( UserAdminRole uAdminRole )
@@ -201,20 +273,27 @@ public interface DelAdminMgr extends Manageable
/**
* Commands adds a new OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
* set by setting type attribute.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be added</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit
+ * to be added
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#description} - contains any safe text</li>
+ * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#description} - contains any safe text</li>
* </ul>
*
* @param entity contains OrgUnit name and type.
* @return OrgUnit contains reference to entity added.
- * @throws SecurityException
- * in the event of data validation or system error.
+ * @throws SecurityException in the event of data validation or system error.
*/
OrgUnit add( OrgUnit entity )
throws SecurityException;
@@ -223,20 +302,27 @@ public interface DelAdminMgr extends Manageable
/**
* Commands updates existing OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
* set by setting type attribute.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be updated</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit
+ * to be updated
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#description} - contains any safe text</li>
+ * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#description} - contains any safe text</li>
* </ul>
*
* @param entity contains OrgUnit name and type.
* @return OrgUnit contains reference to entity operated on.
- * @throws SecurityException
- * in the event of data validation or system error.
+ * @throws SecurityException in the event of data validation or system error.
*/
OrgUnit update( OrgUnit entity )
throws SecurityException;
@@ -245,16 +331,23 @@ public interface DelAdminMgr extends Manageable
/**
* Commands deletes existing OrgUnit entity to OrgUnit dataset. The OrgUnit can be either User or Perm and is
* set by setting type attribute.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit to be removed</li>
- * <li>{@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new USERS or PERMS OrgUnit
+ * to be removed
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OU:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
* </ul>
*
* @param entity contains OrgUnit name and type.
* @return OrgUnit contains reference to entity operated on.
- * @throws SecurityException
- * in the event of data validation or system error.
+ * @throws SecurityException in the event of data validation or system error.
*/
OrgUnit delete( OrgUnit entity )
throws SecurityException;
@@ -266,30 +359,42 @@ public interface DelAdminMgr extends Manageable
* <p>
* The command is valid if and only if:
* <ul>
- * <li> The child orgunit is not a member of the ORGUNITS data set.
- * <li> The parent orgunit is a member of the ORGUNITS data set.
+ * <li>The child orgunit is not a member of the ORGUNITS data set.</li>
+ * <li>The parent orgunit is a member of the ORGUNITS data set.</li>
* </ul>
- * <p>
* <p> This method:
* <ul>
- * <li> Adds new orgunit.
- * <li> Assigns orgunit relationship between new child and pre-existing parent.
+ * <li>Adds new orgunit.</li>
+ * <li>Assigns orgunit relationship between new child and pre-existing parent.</li>
* </ul>
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be child</li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit
+ * to be parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be
+ * child
+ * </li>
* </ul>
* <h4>optional parameters child</h4>
* <ul>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#description} - maps to description attribute on organizationalUnit object class for new child</li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.OrgUnit#description} - maps to description attribute
+ * on organizationalUnit object class for new child
+ * </li>
* </ul>
*
* @param parent This entity must be present in ORGUNIT data set. Success will add rel with child.
* @param child This entity must not be present in ORGUNIT data set. Success will add the new entity to ORGUNIT data set.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
void addDescendant( OrgUnit parent, OrgUnit child )
throws SecurityException;
@@ -301,81 +406,116 @@ public interface DelAdminMgr extends Manageable
* <p>
* The command is valid if and only if:
* <ul>
- * <li> The parent is not a member of the ORGUNITS data set.
- * <li> The child is a member of the ORGUNITS data set.
+ * <li>The parent is not a member of the ORGUNITS data set.</li>
+ * <li>The child is a member of the ORGUNITS data set.</li>
* </ul>
* <p>
- * <p> This method:
+ * This method:
* <ul>
- * <li> Adds new orgunit.
- * <li> Assigns orgunit relationship between new parent and pre-existing child.
+ * <li>Adds new orgunit.</li>
+ * <li>Assigns orgunit relationship between new parent and pre-existing child.</li>
* </ul>
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be child</li>
+ * <li>
+ * child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to
+ * be parent
+ * </li>
+ * <li>
+ * parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
+ * <li>
+ * parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of new OrgUnit to be
+ * child
+ * </li>
* </ul>
* <h4>optional parameters child</h4>
* <ul>
- * <li>parent - {@link OrgUnit#description} - maps to description attribute on organizationalUnit object class for new child</li>
+ * <li>
+ * parent - {@link OrgUnit#description} - maps to description attribute on organizationalUnit object class for new
+ * child
+ * </li>
* </ul>
*
* @param parent completion of op assigns new child relationship with child orgunit.
* @param child completion of op assigns new parent relationship with parent orgunit.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
void addAscendant( OrgUnit child, OrgUnit parent )
throws SecurityException;
/**
- * This command establishes a new immediate inheritance relationship with parent orgunit <<-- child orgunit
- * <p/>
+ * This command establishes a new immediate inheritance relationship with parent orgunit <<-- child orgunit
+ * <p>
* The command is valid if and only if:
* <ul>
- * <li> The parent and child are members of the ORGUNITS data set.
- * <li> The parent is not an immediate ascendant of child.
- * <li> The child does not properly inherit parent (in order to avoid cycle creation).
+ * <li> The parent and child are members of the ORGUNITS data set.</li>
+ * <li> The parent is not an immediate ascendant of child.</li>
+ * <li> The child does not properly inherit parent (in order to avoid cycle creation).</li>
* </ul>
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to be child</li>
+ * <li>
+ * parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to
+ * be parent
+ * </li>
+ * <li>
+ * parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
+ * <li>
+ * child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to
+ * be child
+ * </li>
* </ul>
*
* @param parent completion of op deassigns child relationship with child orgunit.
* @param child completion of op deassigns parent relationship with parent orgunit.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
void addInheritance( OrgUnit parent, OrgUnit child )
throws SecurityException;
/**
- * This command deletes an existing immediate inheritance relationship parent <<-- child.
- * <p/>
+ * This command deletes an existing immediate inheritance relationship parent <<-- child.
+ * <p>
* The command is valid if and only if:
* <ul>
- * <li> The orgunits parent and child are members of the ORGUNITS data set.
- * <li> The parent is an immediate ascendant of child.
- * <li> The new inheritance relation is computed as the reflexive-transitive closure of the immediate inheritance
- * relation resulted after deleting the relationship parent <<-- child.
+ * <li>The orgunits parent and child are members of the ORGUNITS data set.</li>
+ * <li>The parent is an immediate ascendant of child.</li>
+ * <li>
+ * The new inheritance relation is computed as the reflexive-transitive closure of the immediate inheritance
+ * relation resulted after deleting the relationship parent <<-- child.
+ * </li>
* </ul>
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to remove as parent</li>
- * <li>parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted: {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}</li>
- * <li>child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to remove as child</li>
+ * <li>
+ * parent - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to
+ * remove as parent
+ * </li>
+ * <li>
+ * parent - {@link org.apache.directory.fortress.core.model.OrgUnit#type} - contains the type of OrgUnit targeted:
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#USER} or
+ * {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
+ * </li>
+ * <li>
+ * child - {@link org.apache.directory.fortress.core.model.OrgUnit#name} - contains the name of existing OrgUnit to
+ * remove as child
+ * </li>
* </ul>
*
* @param parent completion of op removes child relationship with childRole.
* @param child completion of op removes parent relationship with parentRole.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
void deleteInheritance( OrgUnit parent, OrgUnit child )
throws SecurityException;
@@ -383,33 +523,66 @@ public interface DelAdminMgr extends Manageable
/**
* This command creates a new role childRole, and inserts it in the role hierarchy as an immediate descendant of
- * the existing role parentRole. The command is valid if and only if childRole is not a member of the ADMINROLES data set,
- * and parentRole is a member of the ADMINROLES data set.
- * <p/>
+ * the existing role parentRole. The command is valid if and only if childRole is not a member of the ADMINROLES data
+ * set, and parentRole is a member of the ADMINROLES data set.
+ * <p>
* This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new childRole and pre-existing parentRole.
+ * <ol>
+ * <li>Adds new role.</li>
+ * <li>Assigns role relationship between new childRole and pre-existing parentRole.</li>
+ * </ol>
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing Role to be parent</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of new Role to be child</li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing Role
+ * to be parent
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of new Role to be
+ * child
+ * </li>
* </ul>
* <h4>optional parameters childRole</h4>
* <ul>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#description} - maps to description attribute on organizationalRole object class for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's session for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new child</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's session for new child</li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#description} - maps to description attribute
+ * on organizationalRole object class for new child
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour
+ * role may be activated into user's session for new child
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour role
+ * may be activated into user's session for new child
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when
+ * role may be activated into user's session for new child
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date
+ * role may be activated into user's session for new chil
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines
+ * beginning of enforced inactive status for new child
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of
+ * enforced inactive status for new child
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday,
+ * etc - specifies which day role may be activated into user's session for new child
+ * </li>
* </ul>
*
* @param parentRole This entity must be present in ADMINROLES data set. Success will add role rel with childRole.
- * @param childRole This entity must not be present in ADMINROLES data set. Success will add the new role entity to ADMINROLES data set.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @param childRole This entity must not be present in ADMINROLES data set. Success will add the new role entity to
+ * ADMINROLES data set.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
void addDescendant( AdminRole parentRole, AdminRole childRole )
throws SecurityException;
@@ -420,23 +593,56 @@ public interface DelAdminMgr extends Manageable
* the existing role childRole. The command is valid if and only if parentRole is not a member of the ADMINROLES data set,
* and childRole is a member of the ADMINROLES data set.
* This method:
- * 1 - Adds new role.
- * 2 - Assigns role relationship between new parentRole and pre-existing childRole.
+ * <ol>
+ * <li>Adds new role.</li>
+ * <li>Assigns role relationship between new parentRole and pre-existing childRole.</li>
+ * </ol>
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing Role to be child</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of new Role to be added as parent</li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing Role
+ * to be child
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of new Role to be
+ * added as parent
+ * </li>
* </ul>
* <h4>optional parameters parentRole</h4>
* <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#description} - maps to description attribute on organizationalRole object class for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date when role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date role may be activated into user's session for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines beginning of enforced inactive status for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end of enforced inactive status for new parent</li>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday, etc - specifies which day role may be activated into user's session for new parent</li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#description} - maps to description
+ * attribute on organizationalRole object class for new parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginTime} - HHMM - determines begin hour
+ * role may be activated into user's session for new parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endTime} - HHMM - determines end hour role
+ * may be activated into user's session for new parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginDate} - YYYYMMDD - determines date
+ * when role may be activated into user's session for new parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endDate} - YYYYMMDD - indicates latest date
+ * role may be activated into user's session for new parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#beginLockDate} - YYYYMMDD - determines
+ * beginning of enforced inactive status for new parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#endLockDate} - YYYYMMDD - determines end
+ * of enforced inactive status for new parent
+ * </li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#dayMask} - 1234567, 1 = Sunday, 2 = Monday,
+ * etc - specifies which day role may be activated into user's session for new parent
+ * </li>
* </ul>
*
* @param parentRole completion of op assigns new child relationship with childRole.
@@ -448,63 +654,99 @@ public interface DelAdminMgr extends Manageable
/**
- * This command establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
- * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the ADMINROLES data
- * set, parentRole is not an immediate ascendant of childRole, and childRole does not properly inherit parentRole (in order to
- * avoid cycle creation).
+ * This command establishes a new immediate inheritance relationship parentRole <<-- childRole between existing
+ * roles parentRole, childRole. The command is valid if and only if parentRole and childRole are members of the
+ * 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>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to be parent</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to be child</li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole
+ * to be parent
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole
+ * to be child
+ * </li>
* </ul>
*
* @param parentRole completion of op deassigns child relationship with childRole.
* @param childRole completion of op deassigns parent relationship with parentRole.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
void addInheritance( AdminRole parentRole, AdminRole childRole )
throws SecurityException;
/**
- * This command deletes an existing immediate inheritance relationship parentRole <<-- childRole. The command is
+ * This command deletes an existing immediate inheritance relationship parentRole <<-- childRole. The command is
* valid if and only if the roles parentRole and childRole are members of the ADMINROLES data set, and parentRole is an
* immediate ascendant of childRole. The new inheritance relation is computed as the reflexive-transitive
- * closure of the immediate inheritance relation resulted after deleting the relationship parentRole <<-- childRole.
+ * closure of the immediate inheritance relation resulted after deleting the relationship parentRole <<-- childRole.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to remove as parent</li>
- * <li>childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing AdminRole to remove as child</li>
+ * <li>
+ * parentRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing
+ * AdminRole to remove as parent
+ * </li>
+ * <li>
+ * childRole - {@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the name of existing
+ * AdminRole to remove as child
+ * </li>
* </ul>
*
* @param parentRole completion of op removes child relationship with childRole.
* @param childRole completion of op removes parent relationship with parentRole.
- * @throws SecurityException
- * thrown in the event of data validation or system error.
+ * @throws SecurityException thrown in the event of data validation or system error.
*/
void deleteInheritance( AdminRole parentRole, AdminRole childRole )
throws SecurityException;
/**
- * This method will add an administrative permission operation to an existing permission object which resides under {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may have {@link org.apache.directory.fortress.core.model.AdminRole} or {@link org.apache.directory.fortress.core.model.User} associations. The target {@link org.apache.directory.fortress.core.model.Permission} must not exist prior to calling.
- * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
+ * This method will add an administrative permission operation to an existing permission object which resides under
+ * {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
+ * The perm operation entity may have {@link org.apache.directory.fortress.core.model.AdminRole} or
+ * {@link org.apache.directory.fortress.core.model.User} associations. The target
+ * {@link org.apache.directory.fortress.core.model.Permission} must not exist prior to calling.
+ * A Fortress Permission instance exists in a hierarchical, one-many relationship between its parent and itself as stored
+ * in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->
+ * {@link org.apache.directory.fortress.core.model.Permission}).
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission add</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission operation being added</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being
+ * targeted for the permission add
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of new permission operation
+ * being added
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link Permission#type} - any safe text</li>
+ * <li>
+ * {@link Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being
+ * granted to
+ * </li>
+ * <li>
+ * {@link Permission#users} * - multi occurring attribute contains Users that permission operation is being granted
+ * to
+ * </li>
+ * <li>
+ * {@link Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g.
+ * mykey1:myvalue1
+ * </li>
+ * <li>
+ * {@link Permission#type} - any safe text
+ * </li>
* </ul>
*
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link Permission#opName}, that identifies target along with optional other attributes..
+ * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and
+ * operation, {@link Permission#opName}, that identifies target along with optional other attributes..
* @return copy of Permission entity.
* @throws SecurityException - thrown in the event of perm object data or system error.
*/
@@ -513,64 +755,103 @@ public interface DelAdminMgr extends Manageable
/**
- * This method will update administrative permission operation pre-existing in target directory under {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
- * The perm operation entity may also contain {@link org.apache.directory.fortress.core.model.AdminRole} or {@link org.apache.directory.fortress.core.model.User} associations to add or remove using this function.
+ * This method will update administrative permission operation pre-existing in target directory under
+ * {@code ou=AdminPerms,ou=ARBAC,dc=yourHostName,dc=com} container in directory information tree.
+ * The perm operation entity may also contain {@link org.apache.directory.fortress.core.model.AdminRole} or
+ * {@link org.apache.directory.fortress.core.model.User} associations to add or remove using this function.
* The perm operation must exist before making this call. Only non-null attributes will be updated.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission update</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation being updated</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being
+ * targeted for the permission update
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission
+ * operation being updated
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains RBAC Roles that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains Users that permission operation is being granted to</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#roles} * - multi occurring attribute contains RBAC
+ * Roles that permission operation is being granted to
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#users} * - multi occurring attribute contains Users
+ * that permission operation is being granted to
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#props} * - multi-occurring property key and values are
+ * separated with a ':'. e.g. mykey1:myvalue1
+ * </li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#type} - any safe text</li>
* </ul>
*
- * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that identifies target and any optional data to update. Null or empty attributes will be ignored.
+ * @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, that
+ * identifies target and any optional data to update. Null or empty attributes will be ignored.
* @return copy of Permission entity.
- * @throws SecurityException
- * - thrown in the event of perm object data or system error.
+ * @throws SecurityException thrown in the event of perm object data or system error.
*/
Permission updatePermission( Permission perm )
throws SecurityException;
/**
- * This method will remove administrative permission operation entity from permission object. A Fortress permission is (object->operation).
+ * This method will remove administrative permission operation entity from permission object. A Fortress permission is
+ * (object->operation).
* The perm operation must exist before making this call.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being targeted for the permission delete</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission operation being removed</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#objName} - contains the name of existing object being
+ * targeted for the permission delete
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.Permission#opName} - contains the name of existing permission
+ * operation being removed
+ * </li>
* </ul>
*
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
- * @throws SecurityException
- * - thrown in the event of perm object data or system error.
+ * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and
+ * operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
+ * @throws SecurityException thrown in the event of perm object data or system error.
*/
void deletePermission( Permission perm )
throws SecurityException;
/**
- * This method will add administrative permission object to admin perms container in directory. The perm object must not exist before making this call.
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
+ * This method will add administrative permission object to admin perms container in directory. The perm object must not
+ * exist before making this call.
+ * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship
+ * between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*
+ * -> {@link org.apache.directory.fortress.core.model.Permission}).
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object being added</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS OrgUnit this object is associated with</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of new object being added
+ * </li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS OrgUnit this
+ * object is associated with
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
+ * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
+ * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and values are
+ * separated with a ':'. e.g. mykey1:myvalue1
+ * </li>
* </ul>
*
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} and {@link org.apache.directory.fortress.core.model.PermObj#ou}. The other attributes are optional.
+ * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} and
+ * {@link org.apache.directory.fortress.core.model.PermObj#ou}. The other attributes are optional.
* @return copy of PermObj entity.
* @throws SecurityException - thrown in the event of perm object data or system error.
*/
@@ -579,39 +860,57 @@ public interface DelAdminMgr extends Manageable
/**
- * This method will update administrative permission object in perms container in directory. The perm object must exist before making this call.
- * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*->{@link org.apache.directory.fortress.core.model.Permission}).
+ * This method will update administrative permission object in perms container in directory. The perm object must exist
+ * before making this call.
+ * A {@link org.apache.directory.fortress.core.model.PermObj} instance exists in a hierarchical, one-many relationship
+ * between itself and children as stored in ldap tree: ({@link org.apache.directory.fortress.core.model.PermObj}*
+ * -> {@link org.apache.directory.fortress.core.model.Permission}).
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of existing object being updated</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of existing object being
+ * updated
+ * </li>
* </ul>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@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} * - multi-occurring property key and values are separated with a ':'. e.g. mykey1:myvalue1</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PermObj#ou} - contains the name of an existing PERMS OrgUnit this
+ * object is associated with
+ * </li>
+ * <li>{@link org.apache.directory.fortress.core.model.PermObj#description} - any safe text</li>
+ * <li>{@link org.apache.directory.fortress.core.model.PermObj#type} - contains any safe text</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PermObj#props} * - multi-occurring property key and values are
+ * separated with a ':'. e.g. mykey1:myvalue1
+ * </li>
* </ul>
*
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName}. Only non-null attributes will be updated.
+ * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName}. Only non-null
+ * attributes will be updated.
* @return copy of newly updated PermObj entity.
- * @throws SecurityException
- * - thrown in the event of perm object data or system error.
+ * @throws SecurityException thrown in the event of perm object data or system error.
*/
PermObj updatePermObj( PermObj pObj )
throws SecurityException;
/**
- * This method will remove administrative permission object from perms container in directory. This method will also remove
- * in associated permission objects that are attached to this object.
+ * This method will remove administrative permission object from perms container in directory. This method will also
+ * remove in associated permission objects that are attached to this object.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of existing object targeted for removal</li>
+ * <li>
+ * {@link org.apache.directory.fortress.core.model.PermObj#objName} - contains the name of existing object targeted
+ * for removal
+ * </li>
* </ul>
*
- * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} of object targeted for removal.
- * @throws SecurityException - thrown in the event of perm object data or system error.
+ * @param pObj must contain the {@link org.apache.directory.fortress.core.model.PermObj#objName} of object targeted for
+ * removal.
+ * @throws SecurityException thrown in the event of perm object data or system error.
*/
void deletePermObj( PermObj pObj )
throws SecurityException;
@@ -623,17 +922,18 @@ public interface DelAdminMgr extends Manageable
* the object involved.
* The command is valid if and only if the pair (operation, object) represents a permission,
* and the adminRole is a member of the ADMIN_ROLES data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the adminRole name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the adminRole name</li>
* </ul>
*
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
+ * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and
+ * operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
* @param role must contains {@link org.apache.directory.fortress.core.model.AdminRole#name}.
- * @throws SecurityException
- * Thrown in the event of data validation or system error.
+ * @throws SecurityException Thrown in the event of data validation or system error.
*/
void grantPermission( Permission perm, AdminRole role )
throws SecurityException;
@@ -645,11 +945,12 @@ public interface DelAdminMgr extends Manageable
* list of the object involved.
* The command is valid if and only if the pair (operation, object) represents a permission,
* the role is a member of the ADMIN_ROLES data set, and the permission is assigned to that AdminRole.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the adminRole name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.AdminRole#name} - contains the adminRole name</li>
* </ul>
*
* @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
@@ -666,17 +967,18 @@ public interface DelAdminMgr extends Manageable
* the object involved.
* The command is valid if and only if the pair (operation, object) represents an administrative permission,
* and the user is a member of the USERS data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId</li>
* </ul>
*
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
+ * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and
+ * operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
* @param user must contain {@link org.apache.directory.fortress.core.model.User#userId} of target User entity.
- * @throws SecurityException
- * Thrown in the event of data validation or system error.
+ * @throws SecurityException Thrown in the event of data validation or system error.
*/
void grantPermission( Permission perm, User user )
throws SecurityException;
@@ -688,18 +990,19 @@ public interface DelAdminMgr extends Manageable
* list of the object involved.
* The command is valid if and only if the pair (operation, object) represents an administrative permission,
* the user is a member of the USERS data set, and the permission is assigned to that user.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
- * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
- * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#objName} - contains the object name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.Permission#opName} - contains the operation name</li>
+ * <li>{@link org.apache.directory.fortress.core.model.User#userId} - contains the userId</li>
* </ul>
*
- * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
+ * @param perm must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName}, and
+ * operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, that identifies target.
* @param user must contain {@link org.apache.directory.fortress.core.model.User#userId} of target User entity.
* @throws SecurityException Thrown in the event of data validation or system error.
*/
void revokePermission( Permission perm, User user )
throws SecurityException;
-
}
\ No newline at end of file
[09/10] directory-fortress-core git commit: Fixed various Javadoc
errors
Posted by el...@apache.org.
Fixed various Javadoc errors
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/ce77b1fb
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/ce77b1fb
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/ce77b1fb
Branch: refs/heads/master
Commit: ce77b1fbae8ceb809d457452cc88239e6e17f086
Parents: fb192af
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Wed Jan 6 16:49:44 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Wed Jan 6 16:49:44 2016 +0100
----------------------------------------------------------------------
.../fortress/core/ant/Addadminrole.java | 11 +-
.../core/ant/Addadminroleinheritance.java | 15 +-
.../directory/fortress/core/ant/Addconfig.java | 11 +-
.../fortress/core/ant/Addcontainer.java | 16 +-
.../directory/fortress/core/ant/Addcontext.java | 8 +-
.../directory/fortress/core/ant/Addgroup.java | 8 +-
.../fortress/core/ant/Addgroupmember.java | 5 +-
.../fortress/core/ant/Addgroupproperty.java | 8 +-
.../directory/fortress/core/ant/Addorgunit.java | 11 +-
.../fortress/core/ant/AddpermGrant.java | 12 +-
.../directory/fortress/core/ant/AddpermObj.java | 11 +-
.../directory/fortress/core/ant/AddpermOp.java | 11 +-
.../core/ant/Addpermorgunitinheritance.java | 15 +-
.../fortress/core/ant/Addpwpolicy.java | 8 +-
.../directory/fortress/core/ant/Addrole.java | 14 +-
.../fortress/core/ant/Addroleinheritance.java | 15 +-
.../directory/fortress/core/ant/Addsdset.java | 12 +-
.../directory/fortress/core/ant/Addsuffix.java | 11 +-
.../directory/fortress/core/ant/Adduser.java | 35 +-
.../fortress/core/ant/Adduseradminrole.java | 15 +-
.../core/ant/Adduserorgunitinheritance.java | 15 +-
.../fortress/core/ant/Adduserrole.java | 23 +-
.../fortress/core/ant/AdminRoleAnt.java | 3 +-
.../directory/fortress/core/ant/ConfigAnt.java | 2 +-
.../fortress/core/model/FortEntity.java | 8 +-
.../fortress/core/model/Graphable.java | 25 +-
.../directory/fortress/core/model/Role.java | 1323 +++++++++---------
27 files changed, 900 insertions(+), 751 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addadminrole.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addadminrole.java b/src/main/java/org/apache/directory/fortress/core/ant/Addadminrole.java
index 33d94f9..2de4b7f 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addadminrole.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addadminrole.java
@@ -23,9 +23,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.AdminRole}s used to drive {@link org.apache.directory.fortress.core.DelAdminMgr#addRole(org.apache.directory.fortress.core.model.AdminRole)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addadminrole', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.AdminRole}s used to
+ * drive {@link org.apache.directory.fortress.core.DelAdminMgr#addRole(org.apache.directory.fortress.core.model.AdminRole)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'Addadminrole', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -52,7 +55,7 @@ public class Addadminrole
}
/**
- * <p>This method name, 'addRole', is used for derived xml tag 'role' in the load script.<p>
+ * This method name, 'addRole', is used for derived xml tag 'role' in the load script.
* <pre>
* {@code
* <addadminrole>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addadminroleinheritance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addadminroleinheritance.java b/src/main/java/org/apache/directory/fortress/core/ant/Addadminroleinheritance.java
index 0a0cd31..f3952fb 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addadminroleinheritance.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addadminroleinheritance.java
@@ -25,9 +25,13 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#addInheritance(org.apache.directory.fortress.core.model.Role, org.apache.directory.fortress.core.model.Role)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addadminroleinheritance', is used for the xml tag in the load script.<p>
+ * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used to
+ * drive {@link org.apache.directory.fortress.core.AdminMgr#addInheritance(org.apache.directory.fortress.core.model.Role,
+ * org.apache.directory.fortress.core.model.Role)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'Addadminroleinheritance', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +58,7 @@ public class Addadminroleinheritance
}
/**
- * <p>This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.<p>
+ * This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.
* <pre>
* {@code
* <addadminroleinheritance>
@@ -73,7 +77,8 @@ public class Addadminroleinheritance
}
/**
- * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addAddadminrole(org.apache.directory.fortress.core.ant.Addadminrole)} to retrieve list of Roles as defined in input xml file.
+ * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addAddadminrole(org.apache.directory.fortress.core.ant.Addadminrole)}
+ * to retrieve list of Roles as defined in input xml file.
*
* @return collection containing {@link Relationship}s targeted for insertion.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addconfig.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addconfig.java b/src/main/java/org/apache/directory/fortress/core/ant/Addconfig.java
index 07f46e6..3bfb789 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addconfig.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addconfig.java
@@ -23,9 +23,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to load {@link ConfigAnt}s used to drive {@link org.apache.directory.fortress.core.ConfigMgr#add(String, java.util.Properties)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addconfig', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to load {@link ConfigAnt}s used to drive
+ * {@link org.apache.directory.fortress.core.ConfigMgr#add(String, java.util.Properties)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'Addconfig', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -52,7 +55,7 @@ public class Addconfig
}
/**
- * <p>This method name, 'addConfig', is used for derived xml tag 'config' in the load script.<p>
+ * This method name, 'addConfig', is used for derived xml tag 'config' in the load script.
* <pre>
* {@code
* <addconfig>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addcontainer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addcontainer.java b/src/main/java/org/apache/directory/fortress/core/ant/Addcontainer.java
index 9a71a56..30c40ee 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addcontainer.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addcontainer.java
@@ -25,9 +25,14 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to create new {@link org.apache.directory.fortress.core.model.OrganizationalUnit}s used to drive {@link org.apache.directory.fortress.core.impl.OrganizationalUnitP#add(org.apache.directory.fortress.core.model.OrganizationalUnit)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addcontainer', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to create new
+ * {@link org.apache.directory.fortress.core.model.OrganizationalUnit}s used to drive
+ * {@link org.apache.directory.fortress.core.impl.OrganizationalUnitP#add(
+ * org.apache.directory.fortress.core.model.OrganizationalUnit)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'Addcontainer', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -55,7 +60,7 @@ public class Addcontainer
}
/**
- * <p>This method name, 'addContainer', is used for derived xml tag 'container' in the load script.<p>
+ * This method name, 'addContainer', is used for derived xml tag 'container' in the load script.
* <pre>
* {@code
* <addcontainer>
@@ -84,7 +89,8 @@ public class Addcontainer
/**
* Used by {@link FortressAntTask#addContainers()} to retrieve list of OrganizationalUnits as defined in input xml file.
- * @return collection containing {@link org.apache.directory.fortress.core.model.OrganizationalUnit}s targeted for insertion.
+ * @return collection containing {@link org.apache.directory.fortress.core.model.OrganizationalUnit}s targeted for
+ * insertion.
*/
public List<OrganizationalUnit> getContainers()
{
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addcontext.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addcontext.java b/src/main/java/org/apache/directory/fortress/core/ant/Addcontext.java
index b2bcff1..ccd6ff9 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addcontext.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addcontext.java
@@ -27,8 +27,10 @@ import java.util.List;
/**
* The class is used by {@link FortressAntTask} to create new {@link Context} used to define multi-tenant property.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addcontext', is used for the xml tag in the load script.<p>
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'Addcontext', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -56,7 +58,7 @@ public class Addcontext
}
/**
- * <p>This method name, 'addContext', is used for derived xml tag 'context' in the load script.<p>
+ * This method name, 'addContext', is used for derived xml tag 'context' in the load script.
* <pre>
* {@code
* <addcontext>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addgroup.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addgroup.java b/src/main/java/org/apache/directory/fortress/core/ant/Addgroup.java
index 00eb4fa..98a2d4c 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addgroup.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addgroup.java
@@ -29,7 +29,8 @@ import java.util.List;
* {@link org.apache.directory.fortress.core.GroupMgr#add(org.apache.directory.fortress.core.model.Group)}.
* It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the
* xml tag used by load utility.
- * <p>This class name, 'Addgroup', is used for the xml tag in the load script.<p>
+ * <p>
+ * This class name, 'Addgroup', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -56,11 +57,12 @@ public class Addgroup
}
/**
- * <p>This method name, 'addGroup', is used for derived xml tag 'user' in the load script.<p>
+ * This method name, 'addGroup', is used for derived xml tag 'user' in the load script.
* <pre>
* {@code
* <addgroup>
- * <group name="test001" protocol="test" description="Test Group 001" members="guser1,guser2,guser3" properties="key1=value1, key2=val 2, key3='VAL 3'" />
+ * <group name="test001" protocol="test" description="Test Group 001" members="guser1,guser2,guser3"
+ * properties="key1=value1, key2=val 2, key3='VAL 3'" />
* </addgroup>
* }
* </pre>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addgroupmember.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addgroupmember.java b/src/main/java/org/apache/directory/fortress/core/ant/Addgroupmember.java
index 6712b19..4338d40 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addgroupmember.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addgroupmember.java
@@ -29,7 +29,8 @@ import java.util.List;
* {@link org.apache.directory.fortress.core.GroupMgr#add(org.apache.directory.fortress.core.model.Group)}.
* It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the
* xml tag used by load utility.
- * <p>This class name, 'Addgroup', is used for the xml tag in the load script.<p>
+ * <p>
+ * This class name, 'Addgroup', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -56,7 +57,7 @@ public class Addgroupmember
}
/**
- * <p>This method name, 'addGroup', is used for derived xml tag 'user' in the load script.<p>
+ * This method name, 'addGroup', is used for derived xml tag 'user' in the load script.
* <pre>
* {@code
* <addgroupmember>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addgroupproperty.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addgroupproperty.java b/src/main/java/org/apache/directory/fortress/core/ant/Addgroupproperty.java
index 0448f18..f43f03c 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addgroupproperty.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addgroupproperty.java
@@ -29,7 +29,8 @@ import java.util.List;
* {@link org.apache.directory.fortress.core.GroupMgr#add(org.apache.directory.fortress.core.model.Group)}.
* It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the
* xml tag used by load utility.
- * <p>This class name, 'Addgroup', is used for the xml tag in the load script.<p>
+ * <p>
+ * This class name, 'Addgroup', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -56,7 +57,7 @@ public class Addgroupproperty
}
/**
- * <p>This method name, 'addGroup', is used for derived xml tag 'user' in the load script.<p>
+ * This method name, 'addGroup', is used for derived xml tag 'user' in the load script.
* <pre>
* {@code
* <addgroupproperty>
@@ -73,7 +74,8 @@ public class Addgroupproperty
}
/**
- * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addGroupProperties()} to retrieve list of Groups as defined in input xml file.
+ * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addGroupProperties()} to retrieve list of
+ * Groups as defined in input xml file.
*
* @return collection containing {@link Group}s targeted for insertion.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addorgunit.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addorgunit.java b/src/main/java/org/apache/directory/fortress/core/ant/Addorgunit.java
index 72ffe75..19ec674 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addorgunit.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addorgunit.java
@@ -23,9 +23,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to create new {@link org.apache.directory.fortress.core.model.OrgUnit}s used to drive {@link org.apache.directory.fortress.core.DelAdminMgr#add(org.apache.directory.fortress.core.model.OrgUnit)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addorgunit', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to create new {@link org.apache.directory.fortress.core.model.OrgUnit}s used
+ * to drive {@link org.apache.directory.fortress.core.DelAdminMgr#add(org.apache.directory.fortress.core.model.OrgUnit)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'Addorgunit', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +57,7 @@ public class Addorgunit
/**
- * <p>This method name, 'addOrgUnit', is used for derived xml tag 'orgunit' in the load script.<p>
+ * This method name, 'addOrgUnit', is used for derived xml tag 'orgunit' in the load script.
* <pre>
* {@code
* <addorgunit>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/AddpermGrant.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/AddpermGrant.java b/src/main/java/org/apache/directory/fortress/core/ant/AddpermGrant.java
index a158986..9bfd89f 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/AddpermGrant.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/AddpermGrant.java
@@ -25,9 +25,13 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to create new {@link PermGrant}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#grantPermission(org.apache.directory.fortress.core.model.Permission, org.apache.directory.fortress.core.model.Role)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'AddpermGrant', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to create new {@link PermGrant}s used to drive
+ * {@link org.apache.directory.fortress.core.AdminMgr#grantPermission(org.apache.directory.fortress.core.model.Permission,
+ * org.apache.directory.fortress.core.model.Role)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'AddpermGrant', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -55,7 +59,7 @@ public class AddpermGrant
}
/**
- * <p>This method name, 'addPermGrant', is used for derived xml tag 'permgrant' in the load script.<p>
+ * This method name, 'addPermGrant', is used for derived xml tag 'permgrant' in the load script.
* <pre>
* {@code
* <addpermgrant>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/AddpermObj.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/AddpermObj.java b/src/main/java/org/apache/directory/fortress/core/ant/AddpermObj.java
index 3990d48..830779f 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/AddpermObj.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/AddpermObj.java
@@ -25,9 +25,12 @@ import java.util.List;
import org.apache.directory.fortress.core.model.PermObj;
/**
- * The class is used by {@link FortressAntTask} to load {@link PermObj}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#addPermObj(org.apache.directory.fortress.core.model.PermObj)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'AddpermObj', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to load {@link PermObj}s used to drive
+ * {@link org.apache.directory.fortress.core.AdminMgr#addPermObj(org.apache.directory.fortress.core.model.PermObj)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'AddpermObj', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -57,7 +60,7 @@ public class AddpermObj
/**
- * <p>This method name, 'addPermObj', is used for derived xml tag 'permobj' in the load script.<p>
+ * This method name, 'addPermObj', is used for derived xml tag 'permobj' in the load script.
* <pre>
* {@code
* <addpermobj>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/AddpermOp.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/AddpermOp.java b/src/main/java/org/apache/directory/fortress/core/ant/AddpermOp.java
index 4b14e04..275181b 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/AddpermOp.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/AddpermOp.java
@@ -23,9 +23,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.ant.PermAnt}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#addPermission(org.apache.directory.fortress.core.model.Permission)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'AddpermOp', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.ant.PermAnt}s used to drive
+ * {@link org.apache.directory.fortress.core.AdminMgr#addPermission(org.apache.directory.fortress.core.model.Permission)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'AddpermOp', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -52,7 +55,7 @@ public class AddpermOp
}
/**
- * <p>This method name, 'addPermOp', is used for derived xml tag 'permop' in the load script.<p>
+ * This method name, 'addPermOp', is used for derived xml tag 'permop' in the load script.
* <pre>
* {@code
* <addpermop>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addpermorgunitinheritance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addpermorgunitinheritance.java b/src/main/java/org/apache/directory/fortress/core/ant/Addpermorgunitinheritance.java
index 4581d46..f6e5001 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addpermorgunitinheritance.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addpermorgunitinheritance.java
@@ -25,9 +25,13 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#addInheritance(org.apache.directory.fortress.core.model.Role, org.apache.directory.fortress.core.model.Role)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addpermorgunitinheritance', is used for the xml tag in the load script.<p>
+ * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used to
+ * drive {@link org.apache.directory.fortress.core.AdminMgr#addInheritance(org.apache.directory.fortress.core.model.Role,
+ * org.apache.directory.fortress.core.model.Role)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'Addpermorgunitinheritance', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +58,7 @@ public class Addpermorgunitinheritance
}
/**
- * <p>This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.<p>
+ * This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.
* <pre>
* {@code
* <addpermorgunitinheritance>
@@ -73,7 +77,8 @@ public class Addpermorgunitinheritance
}
/**
- * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addAdminRoles()} to retrieve list of Roles as defined in input xml file.
+ * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addAdminRoles()} to retrieve list of Roles as
+ * defined in input xml file.
*
* @return collection containing {@link Relationship}s targeted for insertion.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addpwpolicy.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addpwpolicy.java b/src/main/java/org/apache/directory/fortress/core/ant/Addpwpolicy.java
index 009f987..781f304 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addpwpolicy.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addpwpolicy.java
@@ -25,9 +25,11 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.PwPolicy}s used to drive {@link org.apache.directory.fortress.core.PwPolicyMgr#add(org.apache.directory.fortress.core.model.PwPolicy)}.
+ * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.PwPolicy}s used to
+ * drive {@link org.apache.directory.fortress.core.PwPolicyMgr#add(org.apache.directory.fortress.core.model.PwPolicy)}.
* It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addpwpolicy', is used for the xml tag in the load script.<p>
+ * <p>
+ * This class name, 'Addpwpolicy', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +56,7 @@ public class Addpwpolicy
}
/**
- * <p>This method name, 'addPolicy', is used for derived xml tag 'policy' in the load script.<p>
+ * This method name, 'addPolicy', is used for derived xml tag 'policy' in the load script.
* <pre>
* {@code
* <addpwpolicy>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addrole.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addrole.java b/src/main/java/org/apache/directory/fortress/core/ant/Addrole.java
index beebf5f..fcc75e3 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addrole.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addrole.java
@@ -25,9 +25,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.Role}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#addRole(org.apache.directory.fortress.core.model.Role)}}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addrole', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.Role}s used to
+ * drive {@link org.apache.directory.fortress.core.AdminMgr#addRole(org.apache.directory.fortress.core.model.Role)}}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'Addrole', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,11 +57,12 @@ public class Addrole
}
/**
- * <p>This method name, 'addRole', is used for derived xml tag 'role' in the load script.<p>
+ * This method name, 'addRole', is used for derived xml tag 'role' in the load script.
* <pre>
* {@code
* <addrole>
- * <role name="role1" description="Tomcat Role for Calendar App" beginTime="0800" endTime="1700" beginDate="20110101" endDate="20111231" beginLockDate="20110601" endLockDate="20110615" dayMask="23456" timeout="60"/>
+ * <role name="role1" description="Tomcat Role for Calendar App" beginTime="0800" endTime="1700" beginDate="20110101"
+ * endDate="20111231" beginLockDate="20110601" endLockDate="20110615" dayMask="23456" timeout="60"/>
* <role name="role2" description="Tomcat Role 2 for Calendar App"/>
* </addrole>
* }
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addroleinheritance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addroleinheritance.java b/src/main/java/org/apache/directory/fortress/core/ant/Addroleinheritance.java
index 91eacd5..db8492a 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addroleinheritance.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addroleinheritance.java
@@ -25,9 +25,13 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#addInheritance(org.apache.directory.fortress.core.model.Role, org.apache.directory.fortress.core.model.Role)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addroleinheritance', is used for the xml tag in the load script.<p>
+ * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used
+ * to drive {@link org.apache.directory.fortress.core.AdminMgr#addInheritance(org.apache.directory.fortress.core.model.Role,
+ * org.apache.directory.fortress.core.model.Role)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'Addroleinheritance', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +58,7 @@ public class Addroleinheritance
}
/**
- * <p>This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.<p>
+ * This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.
* <pre>
* {@code
* <addroleinheritance>
@@ -73,7 +77,8 @@ public class Addroleinheritance
}
/**
- * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addRoleInheritances()} to retrieve list of Role relationships as defined in input xml file.
+ * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addRoleInheritances()} to retrieve list of Role
+ * relationships as defined in input xml file.
*
* @return collection containing {@link Relationship}s targeted for insertion.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addsdset.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addsdset.java b/src/main/java/org/apache/directory/fortress/core/ant/Addsdset.java
index b861706..deecad9 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addsdset.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addsdset.java
@@ -23,11 +23,15 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to create new {@link SDSetAnt}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#createSsdSet(org.apache.directory.fortress.core.model.SDSet)} or {@link org.apache.directory.fortress.core.AdminMgr#createDsdSet(org.apache.directory.fortress.core.model.SDSet)}.
+ * The class is used by {@link FortressAntTask} to create new {@link SDSetAnt}s used to drive
+ * {@link org.apache.directory.fortress.core.AdminMgr#createSsdSet(org.apache.directory.fortress.core.model.SDSet)} or
+ * {@link org.apache.directory.fortress.core.AdminMgr#createDsdSet(org.apache.directory.fortress.core.model.SDSet)}.
*
*
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addsdset', is used for the xml tag in the load script.<p>
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'Addsdset', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +58,7 @@ public class Addsdset
}
/**
- * <p>This method name, 'addSdset', is used for derived xml tag 'sdset' in the load script.<p>
+ * This method name, 'addSdset', is used for derived xml tag 'sdset' in the load script.
* <pre>
* {@code
* <addsdset>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Addsuffix.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Addsuffix.java b/src/main/java/org/apache/directory/fortress/core/ant/Addsuffix.java
index 3be1029..65e18cc 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Addsuffix.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Addsuffix.java
@@ -25,9 +25,12 @@ import java.util.List;
import org.apache.directory.fortress.core.model.Suffix;
/**
- * The class is used by {@link FortressAntTask} to create new {@link org.apache.directory.fortress.core.model.Suffix} used to drive {@link org.apache.directory.fortress.core.impl.SuffixP#add(org.apache.directory.fortress.core.model.Suffix)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Addsuffix', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to create new {@link org.apache.directory.fortress.core.model.Suffix} used
+ * to drive {@link org.apache.directory.fortress.core.impl.SuffixP#add(org.apache.directory.fortress.core.model.Suffix)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'Addsuffix', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -55,7 +58,7 @@ public class Addsuffix
}
/**
- * <p>This method name, 'addSuffix', is used for derived xml tag 'suffix' in the load script.<p>
+ * This method name, 'addSuffix', is used for derived xml tag 'suffix' in the load script.
* <pre>
* {@code
* <addsuffix>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Adduser.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Adduser.java b/src/main/java/org/apache/directory/fortress/core/ant/Adduser.java
index f33906a..5cead70 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Adduser.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Adduser.java
@@ -23,9 +23,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to load {@link UserAnt}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#addUser(org.apache.directory.fortress.core.model.User)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Adduser', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to load {@link UserAnt}s used to drive
+ * {@link org.apache.directory.fortress.core.AdminMgr#addUser(org.apache.directory.fortress.core.model.User)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the
+ * xml tag used by load utility.
+ * <p>
+ * This class name, 'Adduser', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -52,22 +55,34 @@ public class Adduser
}
/**
- * <p>This method name, 'addUser', is used for derived xml tag 'user' in the load script.<p>
+ * This method name, 'addUser', is used for derived xml tag 'user' in the load script.
* <pre>
* {@code
* <adduser>
* <!-- Bad User end time -->
- * <user userId="demoUser1" password="password" description="Demo Test User 1" ou="demousrs1" cn="JoeUser1" sn="User1" pwPolicy="Test1" beginTime="0000" endTime="0800" beginDate="20090101" endDate="20990101" beginLockDate="none" endLockDate="none" dayMask="1234567" timeout="60"/>
+ * <user userId="demoUser1" password="password" description="Demo Test User 1" ou="demousrs1" cn="JoeUser1" sn="User1"
+ * pwPolicy="Test1" beginTime="0000" endTime="0800" beginDate="20090101" endDate="20990101" beginLockDate="none"
+ * endLockDate="none" dayMask="1234567" timeout="60"/>
* <!-- Bad User day mask -->
- * <user userId="demoUser3" password="password" description="Demo Test User 3" ou="demousrs1" cn="JoeUser3" sn="User3" pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none" endLockDate="none" dayMask="17" timeout="60"/>
+ * <user userId="demoUser3" password="password" description="Demo Test User 3" ou="demousrs1" cn="JoeUser3" sn="User3"
+ * pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none"
+ * endLockDate="none" dayMask="17" timeout="60"/>
* <!-- This one is good -->
- * <user userId="demoUser4" password="password" description="Demo Test User 4" ou="demousrs1" cn="JoeUser4" sn="User4" pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none" endLockDate="none" dayMask="1234567" timeout="60"/>
+ * <user userId="demoUser4" password="password" description="Demo Test User 4" ou="demousrs1" cn="JoeUser4" sn="User4"
+ * pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none"
+ * endLockDate="none" dayMask="1234567" timeout="60"/>
* <!-- Bad User end time -->
- * <user userId="demoUser5" password="password" description="Demo Test User 5" ou="demousrs1" cn="JoeUser5" sn="User5" pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none" endLockDate="none" dayMask="1234567" timeout="60"/>
+ * <user userId="demoUser5" password="password" description="Demo Test User 5" ou="demousrs1" cn="JoeUser5" sn="User5"
+ * pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none"
+ * endLockDate="none" dayMask="1234567" timeout="60"/>
* <!-- Bad User begin date -->
- * <user userId="demoUser7" password="password" description="Demo Test User 7" ou="demousrs1" cn="JoeUser7" sn="User7" pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none" endLockDate="none" dayMask="1234567" timeout="60"/>
+ * <user userId="demoUser7" password="password" description="Demo Test User 7" ou="demousrs1" cn="JoeUser7" sn="User7"
+ * pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none"
+ * endLockDate="none" dayMask="1234567" timeout="60"/>
* <!-- Bad User end date -->
- * <user userId="demoUser9" password="password" description="Demo Test User 9" ou="demousrs1" cn="JoeUser9" sn="User9" pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none" endLockDate="none" dayMask="1234567" timeout="60"/>
+ * <user userId="demoUser9" password="password" description="Demo Test User 9" ou="demousrs1" cn="JoeUser9" sn="User9"
+ * pwPolicy="Test1" beginTime="0000" endTime="0000" beginDate="20090101" endDate="20990101" beginLockDate="none"
+ * endLockDate="none" dayMask="1234567" timeout="60"/>
* </adduser>
* }
* </pre>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Adduseradminrole.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Adduseradminrole.java b/src/main/java/org/apache/directory/fortress/core/ant/Adduseradminrole.java
index 95d5b91..1341a0c 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Adduseradminrole.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Adduseradminrole.java
@@ -25,9 +25,13 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link org.apache.directory.fortress.core.model.UserAdminRole}s used to drive {@link org.apache.directory.fortress.core.DelAdminMgr#assignUser(org.apache.directory.fortress.core.model.UserAdminRole)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Adduseradminrole', is used for the xml tag in the load script.<p>
+ * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load
+ * {@link org.apache.directory.fortress.core.model.UserAdminRole}s used to drive
+ * {@link org.apache.directory.fortress.core.DelAdminMgr#assignUser(org.apache.directory.fortress.core.model.UserAdminRole)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'Adduseradminrole', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +58,7 @@ public class Adduseradminrole
}
/**
- * <p>This method name, 'addUserRole', is used for derived xml tag 'userrole' in the load script.<p>
+ * This method name, 'addUserRole', is used for derived xml tag 'userrole' in the load script.
* <pre>
* {@code
* <adduseradminrole>
@@ -80,7 +84,8 @@ public class Adduseradminrole
}
/**
- * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addUserAdminRoles()} to retrieve list of UserAdminRoles as defined in input xml file.
+ * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addUserAdminRoles()} to retrieve list of
+ * UserAdminRoles as defined in input xml file.
*
* @return collection containing {@link org.apache.directory.fortress.core.model.UserAdminRole}s targeted for insertion.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Adduserorgunitinheritance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Adduserorgunitinheritance.java b/src/main/java/org/apache/directory/fortress/core/ant/Adduserorgunitinheritance.java
index 3891f29..cfdec8c 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Adduserorgunitinheritance.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Adduserorgunitinheritance.java
@@ -25,9 +25,13 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used to drive {@link org.apache.directory.fortress.core.DelAdminMgr#addAscendant(org.apache.directory.fortress.core.model.OrgUnit, org.apache.directory.fortress.core.model.OrgUnit)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Adduserorgunitinheritance', is used for the xml tag in the load script.<p>
+ * The class is used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} to load {@link Relationship}s used
+ * to drive {@link org.apache.directory.fortress.core.DelAdminMgr#addAscendant(
+ * org.apache.directory.fortress.core.model.OrgUnit, org.apache.directory.fortress.core.model.OrgUnit)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag
+ * used by load utility.
+ * <p>
+ * This class name, 'Adduserorgunitinheritance', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,7 +58,7 @@ public class Adduserorgunitinheritance
}
/**
- * <p>This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.<p>
+ * This method name, 'addRelationship', is used for derived xml tag 'relationship' in the load script.
* <pre>
* {@code
* <adduserorgunitinheritance>
@@ -73,7 +77,8 @@ public class Adduserorgunitinheritance
}
/**
- * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addAdduserorgunitinheritance(Adduserorgunitinheritance)} to retrieve list of User Org Unit relationships as defined in input xml file.
+ * Used by {@link org.apache.directory.fortress.core.ant.FortressAntTask#addAdduserorgunitinheritance(
+ * Adduserorgunitinheritance)} to retrieve list of User Org Unit relationships as defined in input xml file.
*
* @return collection containing {@link Relationship}s targeted for insertion.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/Adduserrole.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/Adduserrole.java b/src/main/java/org/apache/directory/fortress/core/ant/Adduserrole.java
index 16e0388..952f716 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/Adduserrole.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/Adduserrole.java
@@ -25,9 +25,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.UserRole}s used to drive {@link org.apache.directory.fortress.core.AdminMgr#assignUser(org.apache.directory.fortress.core.model.UserRole)}.
- * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml tag used by load utility.
- * <p>This class name, 'Adduserrole', is used for the xml tag in the load script.<p>
+ * The class is used by {@link FortressAntTask} to load {@link org.apache.directory.fortress.core.model.UserRole}s used to
+ * drive {@link org.apache.directory.fortress.core.AdminMgr#assignUser(org.apache.directory.fortress.core.model.UserRole)}.
+ * It is not intended to be callable by programs outside of the Ant load utility. The class name itself maps to the xml
+ * tag used by load utility.
+ * <p>
+ * This class name, 'Adduserrole', is used for the xml tag in the load script.
* <pre>
* {@code
* <target name="all">
@@ -54,17 +57,21 @@ public class Adduserrole
}
/**
- * <p>This method name, 'addUserRole', is used for derived xml tag 'userrole' in the load script.<p>
+ * This method name, 'addUserRole', is used for derived xml tag 'userrole' in the load script.
* <pre>
* {@code
* <adduserrole>
- * <userrole userId="demoUser1" name="role1" beginTime="0800" endTime="0700" beginDate="20110101" endDate="none" beginLockDate="none" endLockDate="none" dayMask="23456" timeout="30"/>
+ * <userrole userId="demoUser1" name="role1" beginTime="0800" endTime="0700" beginDate="20110101" endDate="none"
+ * beginLockDate="none" endLockDate="none" dayMask="23456" timeout="30"/>
* <!-- Bad - role end time -->
- * <userrole userId="demoUser5" name="role1" beginTime="0700" endTime="0800" beginDate="20100101" endDate="21000101" beginLockDate="none" endLockDate="none" dayMask="all" timeout="0"/>
+ * <userrole userId="demoUser5" name="role1" beginTime="0700" endTime="0800" beginDate="20100101" endDate="21000101"
+ * beginLockDate="none" endLockDate="none" dayMask="all" timeout="0"/>
* <!-- Bad - role begin date -->
- * <userrole userId="demoUser7" name="role1" beginTime="0000" endTime="0000" beginDate="20110110" endDate="21000101" beginLockDate="none" endLockDate="none" dayMask="all" timeout="0"/>
+ * <userrole userId="demoUser7" name="role1" beginTime="0000" endTime="0000" beginDate="20110110" endDate="21000101"
+ * beginLockDate="none" endLockDate="none" dayMask="all" timeout="0"/>
* <!-- Bad - role end date -->
- * <userrole userId="demoUser9" name="role1" beginTime="0000" endTime="0000" beginDate="20100101" endDate="20100608" beginLockDate="none" endLockDate="none" dayMask="all" timeout="0"/>
+ * <userrole userId="demoUser9" name="role1" beginTime="0000" endTime="0000" beginDate="20100101" endDate="20100608"
+ * beginLockDate="none" endLockDate="none" dayMask="all" timeout="0"/>
* </adduserrole>
* }
* </pre>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/AdminRoleAnt.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/AdminRoleAnt.java b/src/main/java/org/apache/directory/fortress/core/ant/AdminRoleAnt.java
index a95e021..85878f1 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/AdminRoleAnt.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/AdminRoleAnt.java
@@ -54,11 +54,12 @@ public class AdminRoleAnt extends AdminRole
* Set the list of Perm OUs as a comma delimited string. This method will convert from that format to
* the AdminRole native format which is collection of Strings.
*
- * @param osPs
+ * @param osPs The list of Perm OUs
*/
public void setOSPs( String osPs )
{
this.osPs = osPs;
+
if ( osPs != null )
{
// allow the setter to process comma delimited strings:
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/ant/ConfigAnt.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ant/ConfigAnt.java b/src/main/java/org/apache/directory/fortress/core/ant/ConfigAnt.java
index 4e8a288..3d64ea9 100755
--- a/src/main/java/org/apache/directory/fortress/core/ant/ConfigAnt.java
+++ b/src/main/java/org/apache/directory/fortress/core/ant/ConfigAnt.java
@@ -51,7 +51,7 @@ public class ConfigAnt
/**
* Set the properties as a String.
*
- * @param szProps
+ * @param szProps The properties to set
*/
public void setProps(String szProps)
{
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/model/FortEntity.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/FortEntity.java b/src/main/java/org/apache/directory/fortress/core/model/FortEntity.java
index 9b75f4d..1ff7a16 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/FortEntity.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/FortEntity.java
@@ -33,10 +33,10 @@ import javax.xml.bind.annotation.XmlType;
/**
* This abstract class is extended by other Fortress entities. It is used to store contextual data that can be used for
* administrative RBAC checking in addition to associating an audit context with every LDAP operation.
- * <p>
+ * <h3></h3>
* <h4>Audit Context Schema</h4>
* The FortEntity Class is used to tag all Fortress LDAP records with variables contained within this auxiliary object class:
- * <p/>
+ * <p>
* ftMods AUXILIARY Object Class is used to store Fortress audit variables on target entity.
* <pre>
* ------------------------------------------
@@ -53,7 +53,7 @@ import javax.xml.bind.annotation.XmlType;
* )
* ------------------------------------------
* </pre>
- * <p/>
+ * <p>
* This class is not thread safe.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
@@ -147,7 +147,7 @@ public abstract class FortEntity
* Load an ARBAC Session object into this entity. Once loaded, all Fortress Manager's will perform administrative
* permission checks against the User who is contained within the Session.
*
- * @param adminSession
+ * @param adminSession The ARBAC admin session
*/
public void setAdminSession( Session adminSession )
{
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/model/Graphable.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/Graphable.java b/src/main/java/org/apache/directory/fortress/core/model/Graphable.java
index 36d8748..6000e6b 100644
--- a/src/main/java/org/apache/directory/fortress/core/model/Graphable.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/Graphable.java
@@ -24,17 +24,21 @@ import java.util.Set;
/**
- * The Fortress Graphable interface prescribes attributes that are used to maintain implementor within a simple directed graph.
- * {@link org.apache.directory.fortress.core.model.Role}, {@link org.apache.directory.fortress.core.model.AdminRole}, {@link org.apache.directory.fortress.core.model.OrgUnit} entities.
- * <p/>
+ * The Fortress Graphable interface prescribes attributes that are used to maintain implementor within a simple directed
+ * graph. {@link org.apache.directory.fortress.core.model.Role}, {@link org.apache.directory.fortress.core.model.AdminRole},
+ * {@link org.apache.directory.fortress.core.model.OrgUnit} entities.
+ * <p>
+ * <h3></h3>
* <h4>Manageable Schema</h4>
- * The entity maps to Fortress LDAP attributetype ( 1.3.6.1.4.1.1.38088.1.28
- * NAME 'ftParents'
- * DESC 'Fortress Parent Nodes'
- * EQUALITY caseIgnoreMatch
- * SUBSTR caseIgnoreSubstringsMatch
- * SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
- * <p/>
+ * The entity maps to Fortress LDAP attributetype :
+ * <pre>
+ * ( 1.3.6.1.4.1.1.38088.1.28
+ * NAME 'ftParents'
+ * DESC 'Fortress Parent Nodes'
+ * EQUALITY caseIgnoreMatch
+ * SUBSTR caseIgnoreSubstringsMatch
+ * SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
+ * </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -83,6 +87,7 @@ public interface Graphable
/**
* Sets the required name attribute on the node.
*
+ * @param name The name to set
*/
void setName( String name );
}
\ No newline at end of file
[08/10] directory-fortress-core git commit: Fixed various Javadoc
errors
Posted by el...@apache.org.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/ce77b1fb/src/main/java/org/apache/directory/fortress/core/model/Role.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/Role.java b/src/main/java/org/apache/directory/fortress/core/model/Role.java
index 2aae591..8b78b27 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/Role.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/Role.java
@@ -36,55 +36,83 @@ import javax.xml.bind.annotation.XmlType;
/**
* All entities ({@link User}, {@link Role}, {@link org.apache.directory.fortress.core.model.Permission},
- * {@link org.apache.directory.fortress.core.model.PwPolicy} {@link SDSet} etc...) are used to carry data between three Fortress
- * layers.starting with the (1) Manager layer down thru middle (2) Process layer and it's processing rules into
+ * {@link org.apache.directory.fortress.core.model.PwPolicy} {@link SDSet} etc...) are used to carry data between three
+ * Fortress layers.starting with the (1) Manager layer down thru middle (2) Process layer and it's processing rules into
* (3) DAO layer where persistence with the OpenLDAP server occurs.
* <h4>Fortress Processing Layers</h4>
* <ol>
- * <li>Manager layer: {@link org.apache.directory.fortress.core.impl.AdminMgrImpl}, {@link org.apache.directory.fortress.core.impl.AccessMgrImpl}, {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl},...</li>
- * <li>Process layer: {@link org.apache.directory.fortress.core.impl.UserP}, {@link org.apache.directory.fortress.core.impl.RoleP}, {@link org.apache.directory.fortress.core.impl.PermP},...</li>
- * <li>DAO layer: {@link org.apache.directory.fortress.core.impl.UserDAO}, {@link org.apache.directory.fortress.core.impl.RoleDAO}, {@link org.apache.directory.fortress.core.impl.PermDAO},...</li>
+ * <li>
+ * Manager layer: {@link org.apache.directory.fortress.core.impl.AdminMgrImpl},
+ * {@link org.apache.directory.fortress.core.impl.AccessMgrImpl},
+ * {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl},...
+ * </li>
+ * <li>
+ * Process layer: {@link org.apache.directory.fortress.core.impl.UserP},
+ * {@link org.apache.directory.fortress.core.impl.RoleP}, {@link org.apache.directory.fortress.core.impl.PermP},...
+ * </li>
+ * <li>
+ * DAO layer: {@link org.apache.directory.fortress.core.impl.UserDAO},
+ * {@link org.apache.directory.fortress.core.impl.RoleDAO}, {@link org.apache.directory.fortress.core.impl.PermDAO},...
+ * </li>
* </ol>
* Fortress clients first instantiate and populate a data entity before invoking any of the Manager APIs. The caller must
* provide enough information to uniquely identity the entity target within ldap.<br>
- * For example, this entity requires {@link #setName} attribute set before passing into {@link org.apache.directory.fortress.core.impl.AdminMgrImpl} APIs.
- * Create methods sometimes require more attributes (than Read) due to constraints enforced between entities although only {@link Role#setName} is required for {@link Role}.
- * <p/>
+ * For example, this entity requires {@link #setName} attribute set before passing into
+ * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl} APIs. Create methods sometimes require more attributes
+ * (than Read) due to constraints enforced between entities although only {@link Role#setName} is required for {@link Role}.
+ * <p>
* <h4>Role entity attribute usages include</h4>
* <ul>
- * <li>{@link #setName} attribute must be set before calling {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#addRole(Role)}, {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#updateRole(Role)} or {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#deleteRole(Role)}
- * <li>{@link Constraint} may be set <b>before</b> calling method {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#addRole(Role)}.
- * <li>{@link Constraint} will be <b>returned</b> to caller on methods like {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl#readRole(Role)} or {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl#findRoles(String)} iff persisted to entity prior to call.
+ * <li>
+ * {@link #setName} attribute must be set before calling
+ * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#addRole(Role)},
+ * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#updateRole(Role)} or
+ * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#deleteRole(Role)}
+ * </li>
+ * <li>
+ * {@link Constraint} may be set <b>before</b> calling method
+ * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#addRole(Role)}.
+ * </li>
+ * <li>
+ * {@link Constraint} will be <b>returned</b> to caller on methods like
+ * {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl#readRole(Role)} or
+ * {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl#findRoles(String)} if persisted to entity prior to call.
+ * </li>
* </ul>
- * <p/>
- * This entity is used to store the RBAC Role assignments that comprise the many-to-many relationships between {@link User}s and {@link org.apache.directory.fortress.core.model.Permission}s.
- * <br>The unique key to locate a Role entity (which is subsequently assigned both to Users and Permissions) is 'Role.name'.<br>
- * <p/>
+ * <p>
+ * This entity is used to store the RBAC Role assignments that comprise the many-to-many relationships between {@link User}s
+ * and {@link org.apache.directory.fortress.core.model.Permission}s.
+ * <br>
+ * The unique key to locate a Role entity (which is subsequently assigned both to Users and Permissions) is 'Role.name'.
+ * <br>
+ * <p>
* There is a many-to-many relationship between User's, RBAC Roles and Permissions.
* <h3>{@link User}*<->*{@link Role}*<->*{@link org.apache.directory.fortress.core.model.Permission}</h3>
- * <p/>
- * <img src="../doc-files/RbacCore.png">
- * <p/>
+ * <p>
+ * <img src="../doc-files/RbacCore.png" alt="">
+ * <p>
* Example to create new RBAC Role:
* <pre>
* try
* {
- * // Instantiate the AdminMgr first
- * AdminMgr adminMgr = AdminMgrFactory.createInstance();
+ * // Instantiate the AdminMgr first
+ * AdminMgr adminMgr = AdminMgrFactory.createInstance();
*
- * Role myRole = new Role("MyRoleName");
- * myRole.setDescription("This is a test role");
- * adminMgr.addRole(myRole);
+ * Role myRole = new Role("MyRoleName");
+ * myRole.setDescription("This is a test role");
+ * adminMgr.addRole(myRole);
* }
* catch (SecurityException ex)
* {
- * // log or throw
- * }</pre>
- * The above code will persist to LDAP a Role object that can be used as a target for User-Role assignments and Role-Permission grants.
- * <p/>
+ * // log or throw
+ * }
+ * </pre>
+ * The above code will persist to LDAP a Role object that can be used as a target for User-Role assignments and
+ * Role-Permission grants.
+ * <p>
* <h4>Role Schema</h4>
* The Fortress Role entity is a composite of the following other Fortress structural and aux object classes:
- * <p/>
+ * <p>
* 1. organizationalRole Structural Object Class is used to store basic attributes like cn and description.
* <pre>
* ------------------------------------------
@@ -103,7 +131,7 @@ import javax.xml.bind.annotation.XmlType;
* )
* ------------------------------------------
* </pre>
- * <p/>
+ * <p>
* 2. ftRls Structural objectclass is used to store the Role information like name and temporal constraint attributes.
* <pre>
* ------------------------------------------
@@ -125,7 +153,7 @@ import javax.xml.bind.annotation.XmlType;
* )
* ------------------------------------------
* </pre>
- * <p/>
+ * <p>
* 3. ftProperties AUXILIARY Object Class is used to store client specific name/value pairs on target entity.<br>
* <code># This aux object class can be used to store custom attributes.</code><br>
* <code># The properties collections consist of name/value pairs and are not constrainted by Fortress.</code><br>
@@ -142,7 +170,7 @@ import javax.xml.bind.annotation.XmlType;
* )
* ------------------------------------------
* </pre>
- * <p/>
+ * <p>
* 4. ftMods AUXILIARY Object Class is used to store Fortress audit variables on target entity.
* <pre>
* ------------------------------------------
@@ -159,7 +187,7 @@ import javax.xml.bind.annotation.XmlType;
* )
* ------------------------------------------
* </pre>
- * <p/>
+ * <p>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -188,638 +216,661 @@ import javax.xml.bind.annotation.XmlType;
})
public class Role extends FortEntity implements Constraint, Graphable, java.io.Serializable
{
-private static final long serialVersionUID = 1L;
-private String id; // this maps to ftId
-private String name; // this is ftRoleName
-private String description; // this is description
-@XmlTransient
-private String dn; // this attribute is automatically saved to each ldap record.
-@XmlTransient
-private List<String> occupants;
-private Set<String> parents;
-private Set<String> children;
-private String beginTime; // this attribute is ftCstr
-private String endTime; // this attribute is ftCstr
-private String beginDate; // this attribute is ftCstr
-private String endDate; // this attribute is ftCstr
-private String beginLockDate;// this attribute is ftCstr
-private String endLockDate; // this attribute is ftCstr
-private String dayMask; // this attribute is ftCstr
-private int timeout; // this attribute is ftCstr
-
-
-/**
- * Default constructor is used by internal Fortress classes.
- */
-public Role()
-{
-}
-
-
-/**
- * Construct a Role entity with a given name.
- *
- * @param name maps to 'cn' attribute on 'organizationalrole' object class.
- */
-public Role( String name )
-{
- this.name = name;
-}
-
-
-/**
- * Construct an RBAC Role with a given temporal constraint.
- *
- * @param con maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-public Role( Constraint con )
-{
- ConstraintUtil.copy( con, this );
-}
-
-
-/**
- * Required on DAO classes convert Temporal attributes stored on entity to raw data object format needed for ldap. For internal use only.
- *
- * @return String that maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-public String getRawData()
-{
- return rawData;
-}
-
-
-/**
- * Required on DAO classes convert Temporal from raw ldap data to entity attributes. For internal use only.
- *
- * @param rawData maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-public void setRawData( String rawData )
-{
- this.rawData = rawData;
-}
-
-private String rawData;
-
-
-/**
- * Gets the name required attribute of the Role object
- *
- * @return attribute maps to 'cn' attribute on 'organizationalrole' object class.
- */
-public String getName()
-{
- return name;
-}
-
-
-/**
- * Sets the required name attribute on the Role object
- *
- */
-public void setName( String name )
-{
- this.name = name;
-}
-
-
-/**
- * Set the occupant attribute with the contents of the User dn.
- * @param occupant maps to 'roleOccupant' attribute on 'organizationalrole' object class.
- */
-public void setOccupant( String occupant )
-{
- if ( this.occupants == null )
+ private static final long serialVersionUID = 1L;
+ private String id; // this maps to ftId
+ private String name; // this is ftRoleName
+ private String description; // this is description
+ @XmlTransient
+ private String dn; // this attribute is automatically saved to each ldap record.
+ @XmlTransient
+ private List<String> occupants;
+ private Set<String> parents;
+ private Set<String> children;
+ private String beginTime; // this attribute is ftCstr
+ private String endTime; // this attribute is ftCstr
+ private String beginDate; // this attribute is ftCstr
+ private String endDate; // this attribute is ftCstr
+ private String beginLockDate;// this attribute is ftCstr
+ private String endLockDate; // this attribute is ftCstr
+ private String dayMask; // this attribute is ftCstr
+ private int timeout; // this attribute is ftCstr
+
+
+ /**
+ * Default constructor is used by internal Fortress classes.
+ */
+ public Role()
{
- this.occupants = new ArrayList<>();
}
- this.occupants.add( occupant );
-}
-
-
-/**
- * Return list of occupants for a particular Role entity.
- * @return List of type String containing User dn that maps to 'roleOccupant' attribute on 'organizationalrole' object class.
- */
-public List<String> getOccupants()
-{
- return occupants;
-}
-
-
-/**
- * Set a list of occupants for a particular Role entity.
- * @param occupants contains a List of type String which maps to 'roleOccupant' attribute on 'organizationalrole' object class.
- */
-public void setOccupants( List<String> occupants )
-{
- this.occupants = occupants;
-}
-
-
-/**
- * Returns optional description that is associated with Role. This attribute is validated but not constrained by Fortress.
- *
- * @return value that is mapped to 'description' in 'organizationalrole' object class.
- */
-public String getDescription()
-{
- return this.description;
-}
-
-
-/**
- * Sets the optional description that is associated with Role. This attribute is validated but not constrained by Fortress.
- *
- * @param description that is mapped to same name in 'organizationalrole' object class.
- */
-public void setDescription( String description )
-{
- this.description = description;
-}
-
-
-/**
- * Return the internal id that is associated with Role. This attribute is generated automatically
- * by Fortress when new Role is added to directory and is not known or changeable by external client.
- *
- * @return attribute maps to 'ftId' in 'ftRls' object class.
- */
-public String getId()
-{
- return id;
-}
-
-
-/**
- * Generate an internal Id that is associated with Role. This method is used by DAO class and
- * is not available to outside classes. The generated attribute maps to 'ftId' in 'ftRls' object class.
- */
-public void setId()
-{
- // generate a unique id that will be used as the rDn for this entry:
- UUID uuid = UUID.randomUUID();
- this.id = uuid.toString();
-}
-
-
-/**
- * Set the internal Id that is associated with Role. This method is used by DAO class and
- * is generated automatically by Fortress. Attribute stored in LDAP cannot be changed by external caller.
- * This method can be used by client for search purposes only.
- *
- * @param id maps to 'ftId' in 'ftRls' object class.
- */
-public void setId( String id )
-{
- this.id = id;
-}
-
-
-/**
- * temporal boolean flag is used by internal Fortress components.
- *
- * @return boolean indicating if temporal constraints are placed on Role.
- */
-@Override
-public boolean isTemporalSet()
-{
- return ( beginTime != null || endTime != null || beginDate != null || endDate != null || beginLockDate != null
- || endLockDate != null || dayMask != null );
-}
-
-
-/**
- * Contains the begin time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. 0800 (8:00 am) or 1700 (5:00 p.m.).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public String getBeginTime()
-{
- return this.beginTime;
-}
-
-
-/**
- * Set the begin time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. 0800 (8:00 am) or 1700 (5:00 p.m.).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param beginTime maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setBeginTime( String beginTime )
-{
- this.beginTime = beginTime;
-}
-
-
-/**
- * Contains the end time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. 0000 (12:00 am) or 2359 (11:59 p.m.).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public String getEndTime()
-{
- return this.endTime;
-}
-
-
-/**
- * Set the end time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. 0000 (12:00 am) or 2359 (11:59 p.m.).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param endTime maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setEndTime( String endTime )
-{
- this.endTime = endTime;
-}
-
-
-/**
- * Contains the begin date when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101 (January 1. 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public String getBeginDate()
-{
- return this.beginDate;
-}
-
-
-/**
- * Set the beginDate when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101 (January 1. 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param beginDate maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setBeginDate( String beginDate )
-{
- this.beginDate = beginDate;
-}
-
-
-/**
- * Contains the end date when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20101231 (December 31, 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public String getEndDate()
-{
- return this.endDate;
-}
-
-
-/**
- * Set the end date when Role is not allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101 (January 1. 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param endDate maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setEndDate( String endDate )
-{
- this.endDate = endDate;
-}
-
-
-/**
- * Contains the begin lock date when Role is temporarily not allowed to be activated in session. The format is - YYMMDD, i.e. 20100101 (January 1. 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public String getBeginLockDate()
-{
- return this.beginLockDate;
-}
-
-
-/**
- * Set the begin lock date when Role is temporarily not allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101 (January 1. 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param beginLockDate maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setBeginLockDate( String beginLockDate )
-{
- this.beginLockDate = beginLockDate;
-}
-
-
-/**
- * Contains the end lock date when Role is allowed to be activated in session once again. The format is - YYYYMMDD, i.e. 20100101 (January 1. 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public String getEndLockDate()
-{
- return this.endLockDate;
-}
-
-
-/**
- * Set the end lock date when Role is allowed to be activated in session once again. The format is - YYYYMMDD, i.e. 20100101 (January 1. 2010).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param endLockDate maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setEndLockDate( String endLockDate )
-{
- this.endLockDate = endLockDate;
-}
-
-
-/**
- * Get the daymask that indicates what days of week Role is allowed to be activated in session. The format is 1234567, i.e. 23456 (Monday, Tuesday, Wednesday, Thursday, Friday).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public String getDayMask()
-{
- return this.dayMask;
-}
-
-
-/**
- * Set the daymask that specifies what days of week Role is allowed to be activated in session. The format is 1234567, i.e. 23456 (Monday, Tuesday, Wednesday, Thursday, Friday).
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param dayMask maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setDayMask( String dayMask )
-{
- this.dayMask = dayMask;
-}
-
-
-/**
- * Return the integer timeout that contains total time (in seconds) that Role may remain inactive in User's session before it is deactivated.
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @return int maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public Integer getTimeout()
-{
- return this.timeout;
-}
-
-
-/**
- * Set the integer timeout that contains max time (in seconds) that Role may remain inactive in User's session before it is deactivated.
- * This attribute is optional but if set will be validated for reasonableness.
- *
- * @param timeout maps to 'ftCstr' attribute in 'ftRls' object class.
- */
-@Override
-public void setTimeout( Integer timeout )
-{
- this.timeout = timeout;
-}
-
-
-/**
- * Get the names of roles that are parents (direct ascendants) of this role.
- * @return Set of parent role names assigned to this role.
- */
-@Override
-public Set<String> getParents()
-{
- if ( this.parents == null )
+
+
+ /**
+ * Construct a Role entity with a given name.
+ *
+ * @param name maps to 'cn' attribute on 'organizationalrole' object class.
+ */
+ public Role( String name )
{
- this.parents = new HashSet<>();
+ this.name = name;
}
- return parents;
-}
-
-
-/**
- * Set the names of roles names that are parents (direct ascendants) of this role.
- * @param parents contains the Set of parent role names assigned to this role.
- */
-@Override
-public void setParents( Set<String> parents )
-{
- this.parents = parents;
-}
-
-
-/**
- * Set the occupant attribute with the contents of the User dn.
- * @param parent maps to 'ftParents' attribute on 'ftRls' object class.
- */
-@Override
-public void setParent( String parent )
-{
- if ( this.parents == null )
+
+
+ /**
+ * Construct an RBAC Role with a given temporal constraint.
+ *
+ * @param con maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ public Role( Constraint con )
{
- this.parents = new HashSet<>();
+ ConstraintUtil.copy( con, this );
}
- this.parents.add( parent );
-}
-
-
-/**
- * Set the occupant attribute with the contents of the User dn.
- * @param parent maps to 'ftParents' attribute on 'ftRls' object class.
- */
-@Override
-public void delParent( String parent )
-{
- if ( this.parents != null )
+
+
+ /**
+ * Required on DAO classes convert Temporal attributes stored on entity to raw data object format needed for ldap. For internal use only.
+ *
+ * @return String that maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ public String getRawData()
{
- this.parents.remove( parent );
+ return rawData;
}
-}
-
-
-/**
- * Return the Set of child role names (direct descendants) of this role.
- * @return Set of child role names assigned to this role.
- */
-public Set<String> getChildren()
-{
- return children;
-}
-
-
-/**
- * Set the Set of child role names (direct descendants) of this role
- * @param children contains the Set of child role names assigned to this role.
- */
-public void setChildren( Set<String> children )
-{
- this.children = children;
-}
-
-
-/**
- * Matches the name from two Role entities.
- *
- * @param thatObj contains a Role entity.
- * @return boolean indicating both objects contain matching Role names.
- */
-public boolean equals( Object thatObj )
-{
- if ( this == thatObj )
+
+
+ /**
+ * Required on DAO classes convert Temporal from raw ldap data to entity attributes. For internal use only.
+ *
+ * @param rawData maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ public void setRawData( String rawData )
{
- return true;
+ this.rawData = rawData;
}
-
- if ( name == null )
+
+ private String rawData;
+
+
+ /**
+ * Gets the name required attribute of the Role object
+ *
+ * @return attribute maps to 'cn' attribute on 'organizationalrole' object class.
+ */
+ public String getName()
{
- return false;
+ return name;
}
-
- if ( !( thatObj instanceof Role ) )
+
+
+ /**
+ * Sets the required name attribute on the Role object
+ *
+ */
+ public void setName( String name )
{
- return false;
+ this.name = name;
}
-
- Role thatRole = ( Role ) thatObj;
-
- if ( thatRole.getName() == null )
+
+
+ /**
+ * Set the occupant attribute with the contents of the User dn.
+ * @param occupant maps to 'roleOccupant' attribute on 'organizationalrole' object class.
+ */
+ public void setOccupant( String occupant )
{
- return false;
+ if ( this.occupants == null )
+ {
+ this.occupants = new ArrayList<>();
+ }
+ this.occupants.add( occupant );
}
-
- return thatRole.getName().equalsIgnoreCase( name );
-}
-
-
-@Override
-public int hashCode()
-{
- int result = id != null ? id.hashCode() : 0;
- result = 31 * result + ( name != null ? name.hashCode() : 0 );
- result = 31 * result + ( description != null ? description.hashCode() : 0 );
- result = 31 * result + ( dn != null ? dn.hashCode() : 0 );
- result = 31 * result + ( occupants != null ? occupants.hashCode() : 0 );
- result = 31 * result + ( parents != null ? parents.hashCode() : 0 );
- result = 31 * result + ( children != null ? children.hashCode() : 0 );
- result = 31 * result + ( beginTime != null ? beginTime.hashCode() : 0 );
- result = 31 * result + ( endTime != null ? endTime.hashCode() : 0 );
- result = 31 * result + ( beginDate != null ? beginDate.hashCode() : 0 );
- result = 31 * result + ( endDate != null ? endDate.hashCode() : 0 );
- result = 31 * result + ( beginLockDate != null ? beginLockDate.hashCode() : 0 );
- result = 31 * result + ( endLockDate != null ? endLockDate.hashCode() : 0 );
- result = 31 * result + ( dayMask != null ? dayMask.hashCode() : 0 );
- result = 31 * result + timeout;
- result = 31 * result + ( rawData != null ? rawData.hashCode() : 0 );
- return result;
-}
-
-
-/**
- * @see Object#toString()
- */
-protected String toString( String tabs )
-{
- StringBuilder sb = new StringBuilder();
-
- sb.append( tabs ).append( "Role[" );
-
- // The name
- sb.append( name ).append( ", " );
-
- if ( ( description != null ) && ( description.length() > 0 ) )
+
+
+ /**
+ * Return list of occupants for a particular Role entity.
+ * @return List of type String containing User dn that maps to 'roleOccupant' attribute on 'organizationalrole' object
+ * class.
+ */
+ public List<String> getOccupants()
{
- sb.append( description ).append( ", " );
+ return occupants;
}
-
- // the date
- sb.append( "date : <" ).append( beginDate ).append( ", " ).append( endDate ).append( ">, " );
-
- // The time
- sb.append( "time : <" ).append( beginTime ).append( ", " ).append( endTime ).append( ">, " );
-
- // The lock date
- sb.append( "lock date : <" ).append( beginLockDate ).append( ", " ).append( endLockDate ).append( ">, " );
-
- // The timeout
- sb.append( "timeout : " ).append( timeout ).append( ", " );
-
- // The day mask
- sb.append( "daymask : " ).append( dayMask );
-
- // The parents if any
- if ( ( parents != null ) && ( parents.size() > 0 ) )
+
+
+ /**
+ * Set a list of occupants for a particular Role entity.
+ * @param occupants contains a List of type String which maps to 'roleOccupant' attribute on 'organizationalrole'
+ * object class.
+ */
+ public void setOccupants( List<String> occupants )
{
- sb.append( ", parents : {" );
-
- boolean isFirst = true;
-
- for ( String parent : parents )
+ this.occupants = occupants;
+ }
+
+
+ /**
+ * Returns optional description that is associated with Role. This attribute is validated but not constrained by
+ * Fortress.
+ *
+ * @return value that is mapped to 'description' in 'organizationalrole' object class.
+ */
+ public String getDescription()
+ {
+ return this.description;
+ }
+
+
+ /**
+ * Sets the optional description that is associated with Role. This attribute is validated but not constrained by
+ * Fortress.
+ *
+ * @param description that is mapped to same name in 'organizationalrole' object class.
+ */
+ public void setDescription( String description )
+ {
+ this.description = description;
+ }
+
+
+ /**
+ * Return the internal id that is associated with Role. This attribute is generated automatically
+ * by Fortress when new Role is added to directory and is not known or changeable by external client.
+ *
+ * @return attribute maps to 'ftId' in 'ftRls' object class.
+ */
+ public String getId()
+ {
+ return id;
+ }
+
+
+ /**
+ * Generate an internal Id that is associated with Role. This method is used by DAO class and
+ * is not available to outside classes. The generated attribute maps to 'ftId' in 'ftRls' object class.
+ */
+ public void setId()
+ {
+ // generate a unique id that will be used as the rDn for this entry:
+ UUID uuid = UUID.randomUUID();
+ this.id = uuid.toString();
+ }
+
+
+ /**
+ * Set the internal Id that is associated with Role. This method is used by DAO class and
+ * is generated automatically by Fortress. Attribute stored in LDAP cannot be changed by external caller.
+ * This method can be used by client for search purposes only.
+ *
+ * @param id maps to 'ftId' in 'ftRls' object class.
+ */
+ public void setId( String id )
+ {
+ this.id = id;
+ }
+
+
+ /**
+ * temporal boolean flag is used by internal Fortress components.
+ *
+ * @return boolean indicating if temporal constraints are placed on Role.
+ */
+ @Override
+ public boolean isTemporalSet()
+ {
+ return ( beginTime != null || endTime != null || beginDate != null || endDate != null || beginLockDate != null
+ || endLockDate != null || dayMask != null );
+ }
+
+
+ /**
+ * Contains the begin time of day Role is allowed to be activated in session. The format is military time - HHMM,
+ * i.e. 0800 (8:00 am) or 1700 (5:00 p.m.).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public String getBeginTime()
+ {
+ return this.beginTime;
+ }
+
+
+ /**
+ * Set the begin time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e.
+ * 0800 (8:00 am) or 1700 (5:00 p.m.).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param beginTime maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setBeginTime( String beginTime )
+ {
+ this.beginTime = beginTime;
+ }
+
+
+ /**
+ * Contains the end time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e.
+ * 0000 (12:00 am) or 2359 (11:59 p.m.).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public String getEndTime()
+ {
+ return this.endTime;
+ }
+
+
+ /**
+ * Set the end time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. 0000
+ * (12:00 am) or 2359 (11:59 p.m.).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param endTime maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setEndTime( String endTime )
+ {
+ this.endTime = endTime;
+ }
+
+
+ /**
+ * Contains the begin date when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101
+ * (January 1. 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public String getBeginDate()
+ {
+ return this.beginDate;
+ }
+
+
+ /**
+ * Set the beginDate when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101
+ * (January 1. 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param beginDate maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setBeginDate( String beginDate )
+ {
+ this.beginDate = beginDate;
+ }
+
+
+ /**
+ * Contains the end date when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20101231
+ * (December 31, 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public String getEndDate()
+ {
+ return this.endDate;
+ }
+
+
+ /**
+ * Set the end date when Role is not allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101
+ * (January 1. 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param endDate maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setEndDate( String endDate )
+ {
+ this.endDate = endDate;
+ }
+
+
+ /**
+ * Contains the begin lock date when Role is temporarily not allowed to be activated in session. The format is - YYMMDD,
+ * i.e. 20100101 (January 1. 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public String getBeginLockDate()
+ {
+ return this.beginLockDate;
+ }
+
+
+ /**
+ * Set the begin lock date when Role is temporarily not allowed to be activated in session. The format is - YYYYMMDD,
+ * i.e. 20100101 (January 1. 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param beginLockDate maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setBeginLockDate( String beginLockDate )
+ {
+ this.beginLockDate = beginLockDate;
+ }
+
+
+ /**
+ * Contains the end lock date when Role is allowed to be activated in session once again. The format is - YYYYMMDD,
+ * i.e. 20100101 (January 1. 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public String getEndLockDate()
+ {
+ return this.endLockDate;
+ }
+
+
+ /**
+ * Set the end lock date when Role is allowed to be activated in session once again. The format is - YYYYMMDD, i.e.
+ * 20100101 (January 1. 2010).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param endLockDate maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setEndLockDate( String endLockDate )
+ {
+ this.endLockDate = endLockDate;
+ }
+
+
+ /**
+ * Get the daymask that indicates what days of week Role is allowed to be activated in session. The format is 1234567,
+ * i.e. 23456 (Monday, Tuesday, Wednesday, Thursday, Friday).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public String getDayMask()
+ {
+ return this.dayMask;
+ }
+
+
+ /**
+ * Set the daymask that specifies what days of week Role is allowed to be activated in session. The format is 1234567,
+ * i.e. 23456 (Monday, Tuesday, Wednesday, Thursday, Friday).
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param dayMask maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setDayMask( String dayMask )
+ {
+ this.dayMask = dayMask;
+ }
+
+
+ /**
+ * Return the integer timeout that contains total time (in seconds) that Role may remain inactive in User's session
+ * before it is deactivated.
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @return int maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public Integer getTimeout()
+ {
+ return this.timeout;
+ }
+
+
+ /**
+ * Set the integer timeout that contains max time (in seconds) that Role may remain inactive in User's session before it
+ * is deactivated.
+ * This attribute is optional but if set will be validated for reasonableness.
+ *
+ * @param timeout maps to 'ftCstr' attribute in 'ftRls' object class.
+ */
+ @Override
+ public void setTimeout( Integer timeout )
+ {
+ this.timeout = timeout;
+ }
+
+
+ /**
+ * Get the names of roles that are parents (direct ascendants) of this role.
+ * @return Set of parent role names assigned to this role.
+ */
+ @Override
+ public Set<String> getParents()
+ {
+ if ( this.parents == null )
{
- if ( isFirst )
- {
- isFirst = false;
- }
- else
- {
- sb.append( '|' );
- }
-
- sb.append( parent );
+ this.parents = new HashSet<>();
}
-
- sb.append( '}' );
+ return parents;
}
-
- // The children if any
- if ( ( children != null ) && ( children.size() > 0 ) )
+
+
+ /**
+ * Set the names of roles names that are parents (direct ascendants) of this role.
+ * @param parents contains the Set of parent role names assigned to this role.
+ */
+ @Override
+ public void setParents( Set<String> parents )
{
- sb.append( ", children : {" );
-
- boolean isFirst = true;
-
- for ( String child : children )
+ this.parents = parents;
+ }
+
+
+ /**
+ * Set the occupant attribute with the contents of the User dn.
+ * @param parent maps to 'ftParents' attribute on 'ftRls' object class.
+ */
+ @Override
+ public void setParent( String parent )
+ {
+ if ( this.parents == null )
+ {
+ this.parents = new HashSet<>();
+ }
+ this.parents.add( parent );
+ }
+
+
+ /**
+ * Set the occupant attribute with the contents of the User dn.
+ * @param parent maps to 'ftParents' attribute on 'ftRls' object class.
+ */
+ @Override
+ public void delParent( String parent )
+ {
+ if ( this.parents != null )
+ {
+ this.parents.remove( parent );
+ }
+ }
+
+
+ /**
+ * Return the Set of child role names (direct descendants) of this role.
+ * @return Set of child role names assigned to this role.
+ */
+ public Set<String> getChildren()
+ {
+ return children;
+ }
+
+
+ /**
+ * Set the Set of child role names (direct descendants) of this role
+ * @param children contains the Set of child role names assigned to this role.
+ */
+ public void setChildren( Set<String> children )
+ {
+ this.children = children;
+ }
+
+
+ /**
+ * Matches the name from two Role entities.
+ *
+ * @param thatObj contains a Role entity.
+ * @return boolean indicating both objects contain matching Role names.
+ */
+ public boolean equals( Object thatObj )
+ {
+ if ( this == thatObj )
+ {
+ return true;
+ }
+
+ if ( name == null )
+ {
+ return false;
+ }
+
+ if ( !( thatObj instanceof Role ) )
+ {
+ return false;
+ }
+
+ Role thatRole = ( Role ) thatObj;
+
+ if ( thatRole.getName() == null )
+ {
+ return false;
+ }
+
+ return thatRole.getName().equalsIgnoreCase( name );
+ }
+
+
+ @Override
+ public int hashCode()
+ {
+ int result = id != null ? id.hashCode() : 0;
+ result = 31 * result + ( name != null ? name.hashCode() : 0 );
+ result = 31 * result + ( description != null ? description.hashCode() : 0 );
+ result = 31 * result + ( dn != null ? dn.hashCode() : 0 );
+ result = 31 * result + ( occupants != null ? occupants.hashCode() : 0 );
+ result = 31 * result + ( parents != null ? parents.hashCode() : 0 );
+ result = 31 * result + ( children != null ? children.hashCode() : 0 );
+ result = 31 * result + ( beginTime != null ? beginTime.hashCode() : 0 );
+ result = 31 * result + ( endTime != null ? endTime.hashCode() : 0 );
+ result = 31 * result + ( beginDate != null ? beginDate.hashCode() : 0 );
+ result = 31 * result + ( endDate != null ? endDate.hashCode() : 0 );
+ result = 31 * result + ( beginLockDate != null ? beginLockDate.hashCode() : 0 );
+ result = 31 * result + ( endLockDate != null ? endLockDate.hashCode() : 0 );
+ result = 31 * result + ( dayMask != null ? dayMask.hashCode() : 0 );
+ result = 31 * result + timeout;
+ result = 31 * result + ( rawData != null ? rawData.hashCode() : 0 );
+ return result;
+ }
+
+
+ /**
+ * @see Object#toString()
+ *
+ * @param tabs the spaces to put at the beginning of each line for a correct indentation
+ * @return The representation of a Role as a String
+ */
+ protected String toString( String tabs )
+ {
+ StringBuilder sb = new StringBuilder();
+
+ sb.append( tabs ).append( "Role[" );
+
+ // The name
+ sb.append( name ).append( ", " );
+
+ if ( ( description != null ) && ( description.length() > 0 ) )
+ {
+ sb.append( description ).append( ", " );
+ }
+
+ // the date
+ sb.append( "date : <" ).append( beginDate ).append( ", " ).append( endDate ).append( ">, " );
+
+ // The time
+ sb.append( "time : <" ).append( beginTime ).append( ", " ).append( endTime ).append( ">, " );
+
+ // The lock date
+ sb.append( "lock date : <" ).append( beginLockDate ).append( ", " ).append( endLockDate ).append( ">, " );
+
+ // The timeout
+ sb.append( "timeout : " ).append( timeout ).append( ", " );
+
+ // The day mask
+ sb.append( "daymask : " ).append( dayMask );
+
+ // The parents if any
+ if ( ( parents != null ) && ( parents.size() > 0 ) )
{
- if ( isFirst )
+ sb.append( ", parents : {" );
+
+ boolean isFirst = true;
+
+ for ( String parent : parents )
{
- isFirst = false;
+ if ( isFirst )
+ {
+ isFirst = false;
+ }
+ else
+ {
+ sb.append( '|' );
+ }
+
+ sb.append( parent );
}
- else
+
+ sb.append( '}' );
+ }
+
+ // The children if any
+ if ( ( children != null ) && ( children.size() > 0 ) )
+ {
+ sb.append( ", children : {" );
+
+ boolean isFirst = true;
+
+ for ( String child : children )
{
- sb.append( '|' );
+ if ( isFirst )
+ {
+ isFirst = false;
+ }
+ else
+ {
+ sb.append( '|' );
+ }
+
+ sb.append( child );
}
-
- sb.append( child );
+
+ sb.append( '}' );
}
-
- sb.append( '}' );
+
+ sb.append( ']' );
+
+ return sb.toString();
+ }
+
+
+ /**
+ * @see Object#toString()
+ */
+ public String toString()
+ {
+ return toString( "" );
}
-
- sb.append( ']' );
-
- return sb.toString();
-}
-
-
-/**
- * @see Object#toString()
- */
-public String toString()
-{
- return toString( "" );
-}
}
[10/10] directory-fortress-core git commit: Merge branch 'master' of
http://git-wip-us.apache.org/repos/asf/directory-fortress-core
Posted by el...@apache.org.
Merge branch 'master' of http://git-wip-us.apache.org/repos/asf/directory-fortress-core
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/f5faeb0f
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/f5faeb0f
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/f5faeb0f
Branch: refs/heads/master
Commit: f5faeb0fc08fab8b504b3aaaf2910f096f0c9aef
Parents: ce77b1f 7a1a756
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Wed Jan 6 16:50:22 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Wed Jan 6 16:50:22 2016 +0100
----------------------------------------------------------------------
README-TEN-MINUTE-GUIDE.md | 94 ++++++
README-TEN-MINUTE-GUIDE.txt | 86 ------
README.md | 440 +++++++++++++++++++++++++++
README.txt | 638 ---------------------------------------
4 files changed, 534 insertions(+), 724 deletions(-)
----------------------------------------------------------------------
[07/10] directory-fortress-core git commit: Fixed Javadoc issues
Posted by el...@apache.org.
Fixed Javadoc issues
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/fb192af7
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/fb192af7
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/fb192af7
Branch: refs/heads/master
Commit: fb192af7a7cca9619a60036c1bce675e5d10a660
Parents: f7c2bc0
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Wed Jan 6 15:20:44 2016 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Wed Jan 6 15:20:44 2016 +0100
----------------------------------------------------------------------
.../directory/fortress/core/ReviewMgr.java | 246 +++++++++++--------
.../fortress/core/ReviewMgrFactory.java | 3 +-
.../fortress/core/StandardException.java | 8 +-
.../fortress/core/UpdateException.java | 6 +-
.../fortress/core/ValidationException.java | 3 +-
5 files changed, 150 insertions(+), 116 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/fb192af7/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java b/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java
index 5243d7b..0f73fc2 100755
--- a/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/ReviewMgr.java
@@ -40,30 +40,35 @@ import java.util.Set;
* and maintenance of RBAC element sets and relations; administrative review functions for
* performing administrative queries; and system functions for creating and managing
* RBAC attributes on user sessions and making access control decisions.
- * <p/>
* <hr>
+ * <h3></h3>
* <h4>RBAC0 - Core</h4>
- * Many-to-many relationship between Users, Roles and Permissions. Selective role activation into sessions. API to add, update, delete identity data and perform identity and access control decisions during runtime operations.
- * <p/>
- * <img src="./doc-files/RbacCore.png">
+ * Many-to-many relationship between Users, Roles and Permissions. Selective role activation into sessions. API to add,
+ * update, delete identity data and perform identity and access control decisions during runtime operations.
+ * <p>
+ * <img src="./doc-files/RbacCore.png" alt="">
* <hr>
* <h4>RBAC1 - General Hierarchical Roles</h4>
* Simplifies role engineering tasks using inheritance of one or more parent roles.
- * <p/>
- * <img src="./doc-files/RbacHier.png">
+ * <p>
+ * <img src="./doc-files/RbacHier.png" alt="">
* <hr>
* <h4>RBAC2 - Static Separation of Duty (SSD) Relations</h4>
- * Enforce mutual membership exclusions across role assignments. Facilitate dual control policies by restricting which roles may be assigned to users in combination. SSD provide added granularity for authorization limits which help enterprises meet strict compliance regulations.
- * <p/>
- * <img src="./doc-files/RbacSSD.png">
+ * Enforce mutual membership exclusions across role assignments. Facilitate dual control policies by restricting which roles
+ * may be assigned to users in combination. SSD provide added granularity for authorization limits which help enterprises
+ * meet strict compliance regulations.
+ * <p>
+ * <img src="./doc-files/RbacSSD.png" alt="">
* <hr>
* <h4>RBAC3 - Dynamic Separation of Duty (DSD) Relations</h4>
- * Control allowed role combinations to be activated within an RBAC session. DSD policies fine tune role policies that facilitate authorization dual control and two man policy restrictions during runtime security checks.
- * <p/>
- * <img src="./doc-files/RbacDSD.png">
+ * Control allowed role combinations to be activated within an RBAC session. DSD policies fine tune role policies that
+ * facilitate authorization dual control and two man policy restrictions during runtime security checks.
+ * <p>
+ * <img src="./doc-files/RbacDSD.png" alt="">
* <hr>
- * <p/>
- * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)} or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
+ * <p>
+ * This interface's implementer will NOT be thread safe if parent instance variables ({@link Manageable#setContextId(String)}
+ * or {@link Manageable#setAdmin(org.apache.directory.fortress.core.model.Session)}) are set.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -72,13 +77,15 @@ public interface ReviewMgr extends Manageable
/**
* This method returns a matching permission entity to caller.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
+ * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
+ * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
* </ul>
*
- * @param permission must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
+ * @param permission must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and
+ * optionally object id of targeted permission entity.
* @return Permission entity that is loaded with data.
* @throws SecurityException
* if permission not found or system error occurs.
@@ -89,9 +96,10 @@ public interface ReviewMgr extends Manageable
/**
* Method reads permission object from perm container in directory.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link PermObj#objName} - contains the name of existing object being targeted</li>
+ * <li>{@link PermObj#objName} - contains the name of existing object being targeted</li>
* </ul>
*
* @param permObj entity contains the {@link PermObj#objName} of target record.
@@ -104,17 +112,18 @@ public interface ReviewMgr extends Manageable
/**
* Method returns a list of type Permission that match the perm object search string.
+ * <h3></h3>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link Permission#objName} - contains one or more characters of existing object being targeted</li>
- * <li>{@link Permission#opName} - contains one or more characters of existing permission operation</li>
+ * <li>{@link Permission#objName} - contains one or more characters of existing object being targeted</li>
+ * <li>{@link Permission#opName} - contains one or more characters of existing permission operation</li>
* </ul>
*
- * @param permission contains object and operation name search strings. Each contains 1 or more leading chars that correspond to object or op name.
- * @return List of type Permission. Fortress permissions are object->operation mappings. The permissions may contain
+ * @param permission contains object and operation name search strings. Each contains 1 or more leading chars that
+ * correspond to object or op name.
+ * @return List of type Permission. Fortress permissions are object->operation mappings. The permissions may contain
* assigned user, role or group entities as well.
- * @throws SecurityException
- * thrown in the event of system error.
+ * @throws SecurityException thrown in the event of system error.
*/
List<Permission> findPermissions( Permission permission )
throws SecurityException;
@@ -134,7 +143,7 @@ public interface ReviewMgr extends Manageable
* Method returns a list of Permissions that match any part of the permission object or operation.
*
* @param permission contains object and operation name search strings.
- * @return List of type Permission. Fortress permissions are object->operation mappings. The permissions may contain
+ * @return List of type Permission. Fortress permissions are object->operation mappings. The permissions may contain
* assigned user, role or group entities as well.
* @throws SecurityException thrown in the event of system error.
*/
@@ -143,13 +152,15 @@ public interface ReviewMgr extends Manageable
/**
* Method returns a list of type PermObj that match the perm object search string.
+ * <h3></h3>
* <h4>optional parameters</h4>
* <ul>
- * <li>{@link PermObj#objName} - contains one or more characters of existing object being targeted</li>
+ * <li>{@link PermObj#objName} - contains one or more characters of existing object being targeted</li>
* </ul>
*
- * @param permObj contains object name search string. The search val contains 1 or more leading chars that correspond to object name.
- * @return List of type PermObj. Fortress permissions are object->operation mappings.
+ * @param permObj contains object name search string. The search val contains 1 or more leading chars that correspond
+ * to object name.
+ * @return List of type PermObj. Fortress permissions are object->operation mappings.
* @throws SecurityException thrown in the event of system error.
*/
List<PermObj> findPermObjs( PermObj permObj )
@@ -158,15 +169,18 @@ public interface ReviewMgr extends Manageable
/**
* Method returns a list of type Permission that match the perm object search string.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link OrgUnit#name} - contains one or more characters of org unit associated with existing object being targeted</li>
+ * <li>
+ * {@link OrgUnit#name} - contains one or more characters of org unit associated with existing object being targeted
+ * </li>
* </ul>
*
- * @param ou contains org unit name {@link org.apache.directory.fortress.core.model.OrgUnit#name}. The search val contains the full name of matching ou in OS-P data set.
- * @return List of type PermObj. Fortress permissions are object->operation mappings.
- * @throws SecurityException
- * thrown in the event of system error.
+ * @param ou contains org unit name {@link org.apache.directory.fortress.core.model.OrgUnit#name}. The search val
+ * contains the full name of matching ou in OS-P data set.
+ * @return List of type PermObj. Fortress permissions are object->operation mappings.
+ * @throws SecurityException thrown in the event of system error.
*/
List<PermObj> findPermObjs( OrgUnit ou )
throws SecurityException;
@@ -174,15 +188,15 @@ public interface ReviewMgr extends Manageable
/**
* Method reads Role entity from the role container in directory.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role to read.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role to read.</li>
* </ul>
*
* @param role contains role name, {@link Role#name}, to be read.
* @return Role entity that corresponds with role name.
- * @throws SecurityException
- * will be thrown if role not found or system error occurs.
+ * @throws SecurityException will be thrown if role not found or system error occurs.
*/
Role readRole( Role role )
throws SecurityException;
@@ -204,11 +218,11 @@ public interface ReviewMgr extends Manageable
* number of records that may be contained in the result set. This number can further limit global default but can
* not increase the max. This method is called by the Websphere Realm impl.
*
- * @param searchVal contains all or some leading chars that correspond to roles stored in the role container in the directory.
+ * @param searchVal contains all or some leading chars that correspond to roles stored in the role container in the
+ * directory.
* @param limit integer value specifies the max records that may be returned in the result set.
* @return List of type String containing matching Role names.
- * @throws SecurityException
- * in the event of system error.
+ * @throws SecurityException in the event of system error.
*/
List<String> findRoles( String searchVal, int limit )
throws SecurityException;
@@ -216,13 +230,14 @@ public interface ReviewMgr extends Manageable
/**
* Method returns matching User entity that is contained within the people container in the directory.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for read.</li>
+ * <li>{@link User#userId} - contains the userId associated with the User object targeted for read.</li>
* </ul>
*
- * @param user entity contains a value {@link User#userId} that matches record in the directory. userId is globally unique in
- * people container.
+ * @param user entity contains a value {@link User#userId} that matches record in the directory. userId is globally
+ * unique in people container.
* @return entity containing matching user data.
* @throws SecurityException if record not found or system error occurs.
*/
@@ -231,10 +246,12 @@ public interface ReviewMgr extends Manageable
/**
- * Return a list of type User of all users in the people container that match all or part of the {@link User#userId} field passed in User entity.
+ * Return a list of type User of all users in the people container that match all or part of the {@link User#userId}
+ * field passed in User entity.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains all or some leading chars that match userId(s) stored in the directory.</li>
+ * <li>{@link User#userId} - contains all or some leading chars that match userId(s) stored in the directory.</li>
* </ul>
*
* @param user contains all or some leading chars that match userIds stored in the directory.
@@ -247,15 +264,19 @@ public interface ReviewMgr extends Manageable
/**
* Return a list of type User of all users in the people container that match the name field passed in OrgUnit entity.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link OrgUnit#name} - contains one or more characters of org unit associated with existing object(s) being targeted</li>
+ * <li>
+ * {@link OrgUnit#name} - contains one or more characters of org unit associated with existing object(s) being
+ * targeted
+ * </li>
* </ul>
*
- * @param ou contains name of User OU, {@link OrgUnit#name} that match ou attribute associated with User entity in the directory.
+ * @param ou contains name of User OU, {@link OrgUnit#name} that match ou attribute associated with User entity in the
+ * directory.
* @return List of type User.
- * @throws SecurityException
- * In the event of system error.
+ * @throws SecurityException In the event of system error.
*/
List<User> findUsers( OrgUnit ou )
throws SecurityException;
@@ -263,11 +284,13 @@ public interface ReviewMgr extends Manageable
/**
* Return a list of type String of all users in the people container that match the userId field passed in User entity.
- * This method is used by the Websphere realm component. The max number of returned users may be set by the integer limit arg.
+ * This method is used by the Websphere realm component. The max number of returned users may be set by the integer
+ * limit arg.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for read.</li>
- * <li>limit - max number of objects to return.</li>
+ * <li>{@link User#userId} - contains the userId associated with the User object targeted for read.</li>
+ * <li>limit - max number of objects to return.</li>
* </ul>
*
* @param user contains all or some leading chars that correspond to users stored in the directory.
@@ -284,17 +307,17 @@ public interface ReviewMgr extends Manageable
* only if the role is a member of the ROLES data set.
* The max number of users returned is constrained by limit argument.
* This method is used by the Websphere realm component. This method does NOT use hierarchical impl.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
- * <li>limit - max number of objects to return.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>limit - max number of objects to return.</li>
* </ul>
*
* @param role Contains {@link Role#name} of Role entity assigned to user.
* @param limit integer value sets the max returned records.
* @return List of type String containing userIds assigned to a particular role.
- * @throws SecurityException
- * in the event of data validation or system error.
+ * @throws SecurityException in the event of data validation or system error.
*/
List<String> assignedUsers( Role role, int limit )
throws SecurityException;
@@ -303,15 +326,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the set of roles assigned to a given user. The function is valid if and
* only if the user is a member of the USERS data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
* </ul>
*
* @param user contains {@link User#userId} matching User entity targeted in the directory.
* @return List of type UserRole containing the Roles assigned to User.
- * @throws SecurityException
- * If user not found or system error occurs.
+ * @throws SecurityException If user not found or system error occurs.
*/
List<UserRole> assignedRoles( User user )
throws SecurityException;
@@ -320,15 +343,15 @@ public interface ReviewMgr extends Manageable
/**
* This method returns the data set of all users who are assigned the given role. This searches the User data set for
* Role relationship. This method does NOT search for hierarchical RBAC Roles relationships.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
* </ul>
*
* @param role contains the role name, {@link Role#name} used to search the User data set.
* @return List of type User containing the users assigned data.
- * @throws SecurityException
- * If system error occurs.
+ * @throws SecurityException If system error occurs.
*/
List<User> assignedUsers( Role role )
throws SecurityException;
@@ -340,8 +363,7 @@ public interface ReviewMgr extends Manageable
*
* @param userId matches userId stored in the directory.
* @return List of type String containing the role names of all roles assigned to user.
- * @throws SecurityException
- * If user not found or system error occurs.
+ * @throws SecurityException If user not found or system error occurs.
*/
List<String> assignedRoles( String userId )
throws SecurityException;
@@ -350,15 +372,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the set of users authorized to a given role, i.e., the users that are assigned to a role that
* inherits the given role. The function is valid if and only if the given role is a member of the ROLES data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
* </ul>
*
* @param role Contains role name, {@link Role#name} of Role entity assigned to User.
* @return List of type User containing all user's that having matching role assignment.
- * @throws SecurityException
- * In the event the role is not present in directory or system error occurs.
+ * @throws SecurityException In the event the role is not present in directory or system error occurs.
*/
List<User> authorizedUsers( Role role )
throws SecurityException;
@@ -367,9 +389,10 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the set of roles authorized for a given user. The function is valid if
* and only if the user is a member of the USERS data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
* </ul>
*
* @param user contains the {@link User#userId} matching User entity stored in the directory.
@@ -384,15 +407,15 @@ public interface ReviewMgr extends Manageable
* This function returns the set of all permissions (op, obj), granted to or inherited by a
* given role. The function is valid if and only if the role is a member of the ROLES data
* set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
* </ul>
*
* @param role contains role name, {@link Role#name} of Role entity Permission is granted to.
* @return List of type Permission that contains all perms granted to a role.
- * @throws SecurityException
- * In the event system error occurs.
+ * @throws SecurityException In the event system error occurs.
*/
List<Permission> rolePermissions( Role role )
throws SecurityException;
@@ -402,9 +425,10 @@ public interface ReviewMgr extends Manageable
* This function returns the set of all permissions (op, obj), granted to or inherited by a
* given role. The function is valid if and only if the role is a member of the ROLES data
* set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
* </ul>
*
* @param role contains role name, {@link Role#name} of Role entity Permission is granted to.
@@ -419,15 +443,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the set of permissions a given user gets through his/her authorized
* roles. The function is valid if and only if the user is a member of the USERS data set.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
+ * <li>{@link User#userId} - contains the userId associated with the User object targeted for search.</li>
* </ul>
*
* @param user contains the {@link User#userId} of User targeted for search.
* @return List of type Permission containing matching permission entities.
- * @throws SecurityException
- * in the event of validation or system error.
+ * @throws SecurityException in the event of validation or system error.
*/
List<Permission> userPermissions( User user )
throws SecurityException;
@@ -435,10 +459,11 @@ public interface ReviewMgr extends Manageable
/**
* Return a list of type String of all roles that have granted a particular permission.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
+ * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
+ * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
* </ul>
*
* @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
@@ -451,16 +476,16 @@ public interface ReviewMgr extends Manageable
/**
* Return all role names that have been authorized for a given permission. This will process role hierarchies to determine set of all Roles who have access to a given permission.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
+ * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
+ * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
* </ul>
*
* @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
* @return Set of type String containing all roles names that have been granted a particular permission.
- * @throws SecurityException
- * in the event of validation or system error.
+ * @throws SecurityException in the event of validation or system error.
*/
Set<String> authorizedPermissionRoles( Permission perm )
throws SecurityException;
@@ -468,16 +493,16 @@ public interface ReviewMgr extends Manageable
/**
* Return all userIds that have been granted (directly) a particular permission. This will not consider assigned or authorized Roles.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
+ * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
+ * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
* </ul>
*
* @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
* @return List of type String containing all userIds that have been granted a particular permission.
- * @throws SecurityException
- * in the event of validation or system error.
+ * @throws SecurityException in the event of validation or system error.
*/
List<String> permissionUsers( Permission perm )
throws SecurityException;
@@ -485,16 +510,16 @@ public interface ReviewMgr extends Manageable
/**
* 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>
- * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
- * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
+ * <li>{@link Permission#objName} - contains the name of existing object being targeted</li>
+ * <li>{@link Permission#opName} - contains the name of existing permission operation</li>
* </ul>
*
* @param perm must contain the object, {@link Permission#objName}, and operation, {@link Permission#opName}, and optionally object id of targeted permission entity.
* @return Set of type String containing all userIds that have been granted a particular permission.
- * @throws SecurityException
- * in the event of validation or system error.
+ * @throws SecurityException in the event of validation or system error.
*/
Set<String> authorizedPermissionUsers( Permission perm )
throws SecurityException;
@@ -503,15 +528,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the list of all SSD role sets that have a particular Role as member or Role's
* parent as a member. If the Role parameter is left blank, function will return all SSD role sets.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
* </ul>
*
* @param role Will contain the role name, {@link Role#name}, for targeted SSD set or null to return all
* @return List containing all matching SSD's.
- * @throws SecurityException
- * in the event of data or system error.
+ * @throws SecurityException in the event of data or system error.
*/
List<SDSet> ssdRoleSets( Role role )
throws SecurityException;
@@ -519,15 +544,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the SSD data set that matches a particular set name.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param set Will contain the name for existing SSD data set, {@link SDSet#name}.
* @return SDSet containing all attributes from matching SSD name.
- * @throws SecurityException
- * in the event of data or system error.
+ * @throws SecurityException in the event of data or system error.
*/
SDSet ssdRoleSet( SDSet set )
throws SecurityException;
@@ -535,9 +560,10 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the list of SSDs that match a given ssd name value.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param ssd contains the name for the SSD set targeted, {@link SDSet#name}.
@@ -551,9 +577,10 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the set of roles of a SSD role set. The function is valid if and only if the
* role set exists.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param ssd contains the name for the SSD set targeted, {@link SDSet#name}.
@@ -567,9 +594,10 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the cardinality associated with a SSD role set. The function is valid if and only if the
* role set exists.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param ssd contains the name of the SSD set targeted, {@link SDSet#name}.
@@ -583,15 +611,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the list of all dSD role sets that have a particular Role as member or Role's
* parent as a member. If the Role parameter is left blank, function will return all dSD role sets.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
+ * <li>{@link Role#name} - contains the name to use for the Role targeted for search.</li>
* </ul>
*
* @param role Will contain the role name, {@link Role#name}, for targeted dSD set or null to return all
* @return List containing all matching dSD's.
- * @throws SecurityException
- * in the event of data or system error.
+ * @throws SecurityException in the event of data or system error.
*/
List<SDSet> dsdRoleSets( Role role )
throws SecurityException;
@@ -599,15 +627,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the DSD data set that matches a particular set name.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param set Will contain the name for existing DSD data set, {@link SDSet#name}.
* @return SDSet containing all attributes from matching DSD name.
- * @throws SecurityException
- * in the event of data or system error.
+ * @throws SecurityException in the event of data or system error.
*/
SDSet dsdRoleSet( SDSet set )
throws SecurityException;
@@ -615,9 +643,10 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the list of DSDs that match a given dsd name value.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param dsd contains the name for the DSD set targeted, {@link SDSet#name}.
@@ -631,15 +660,15 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the set of roles of a DSD role set. The function is valid if and only if the
* role set exists.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param dsd contains the name for the DSD set targeted, {@link SDSet#name}.
* @return Set containing all Roles that are members of DSD data set.
- * @throws SecurityException
- * in the event of data or system error.
+ * @throws SecurityException in the event of data or system error.
*/
Set<String> dsdRoleSetRoles( SDSet dsd )
throws SecurityException;
@@ -648,9 +677,10 @@ public interface ReviewMgr extends Manageable
/**
* This function returns the cardinality associated with a DSD role set. The function is valid if and only if the
* role set exists.
+ * <h3></h3>
* <h4>required parameters</h4>
* <ul>
- * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
+ * <li>{@link SDSet#name} - contains the name of existing object being targeted</li>
* </ul>
*
* @param dsd contains the name of the DSD set targeted, {@link SDSet#name}.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/fb192af7/src/main/java/org/apache/directory/fortress/core/ReviewMgrFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ReviewMgrFactory.java b/src/main/java/org/apache/directory/fortress/core/ReviewMgrFactory.java
index 1a84a01..1d65835 100755
--- a/src/main/java/org/apache/directory/fortress/core/ReviewMgrFactory.java
+++ b/src/main/java/org/apache/directory/fortress/core/ReviewMgrFactory.java
@@ -29,10 +29,9 @@ import org.apache.directory.fortress.core.util.VUtil;
/**
* Creates an instance of the ReviewMgr object.
- * <p/>
+ * <p>
* The default implementation class is specified as {@link ReviewMgrImpl} but can be overridden by
* adding the {@link GlobalIds#REVIEW_IMPLEMENTATION} config property.
- * <p/>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/fb192af7/src/main/java/org/apache/directory/fortress/core/StandardException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/StandardException.java b/src/main/java/org/apache/directory/fortress/core/StandardException.java
index 4d2928a..84775ef 100755
--- a/src/main/java/org/apache/directory/fortress/core/StandardException.java
+++ b/src/main/java/org/apache/directory/fortress/core/StandardException.java
@@ -21,7 +21,8 @@ package org.apache.directory.fortress.core;
/**
- * Interface that is implemented by exception base class {@link StandardException} used to associate a Fortress error code to the exception instance.
+ * Interface that is implemented by exception base class {@link StandardException} used to associate a Fortress error code to
+ * the exception instance.
* See the {@link GlobalErrIds} javadoc for list of error ids used by Fortress.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
@@ -29,9 +30,10 @@ package org.apache.directory.fortress.core;
public interface StandardException
{
/**
- * Return the Fortress error code that is optional to exceptions thrown within this security system. See {@link GlobalErrIds} for list of all error codes.
+ * Return the Fortress error code that is optional to exceptions thrown within this security system. See
+ * {@link GlobalErrIds} for list of all error codes.
*
- * @return integer containing the source error code. Valid values for Fortress error codes fall between 0 and 100_000.
+ * @return integer containing the source error code. Valid values for Fortress error codes fall between 0 & 100_000.
*/
int getErrorId();
}
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/fb192af7/src/main/java/org/apache/directory/fortress/core/UpdateException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/UpdateException.java b/src/main/java/org/apache/directory/fortress/core/UpdateException.java
index 920a6cb..0994604 100755
--- a/src/main/java/org/apache/directory/fortress/core/UpdateException.java
+++ b/src/main/java/org/apache/directory/fortress/core/UpdateException.java
@@ -35,7 +35,8 @@ public class UpdateException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
*
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public UpdateException( int errorId, String msg )
@@ -46,7 +47,8 @@ public class UpdateException extends SecurityException
/**
* Create exception with error id, message and related exception.
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
* @param previousException contains reference to related exception which usually is system related, i.e. ldap.
*/
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/fb192af7/src/main/java/org/apache/directory/fortress/core/ValidationException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ValidationException.java b/src/main/java/org/apache/directory/fortress/core/ValidationException.java
index a706254..a05646f 100755
--- a/src/main/java/org/apache/directory/fortress/core/ValidationException.java
+++ b/src/main/java/org/apache/directory/fortress/core/ValidationException.java
@@ -35,7 +35,8 @@ public class ValidationException extends SecurityException
/**
* Create an exception with an error code that maps to {@link GlobalErrIds} and message text.
*
- * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between 0 & 100_000.
+ * @param errorId see {@link GlobalErrIds} for list of valid error codes that can be set. Valid values between
+ * 0 & 100_000.
* @param msg contains textual information including method of origin and description of the root cause.
*/
public ValidationException( int errorId, String msg )