directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject [04/10] directory-fortress-core git commit: Fixed Javadoc issues
Date Wed, 06 Jan 2016 15:51:13 GMT
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 <elecharny@symas.com>
Authored: Wed Jan 6 11:38:14 2016 +0100
Committer: Emmanuel L├ęcharny <elecharny@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 &amp; 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  &amp; 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;
 


Mime
View raw message