directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject [4/5] directory-fortress-core git commit: Fixed some Javadoc issues
Date Thu, 07 Jan 2016 13:40:04 GMT
Fixed some 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/90ef3ce9
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/90ef3ce9
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/90ef3ce9

Branch: refs/heads/master
Commit: 90ef3ce91de25fd75a875e100848b8dd29aa0d20
Parents: bf2de88
Author: Emmanuel L├ęcharny <elecharny@symas.com>
Authored: Thu Jan 7 14:39:32 2016 +0100
Committer: Emmanuel L├ęcharny <elecharny@symas.com>
Committed: Thu Jan 7 14:39:32 2016 +0100

----------------------------------------------------------------------
 .../core/ldap/ApacheDsDataProvider.java         |  57 +++--
 .../directory/fortress/core/model/PermObj.java  |   3 +-
 .../directory/fortress/core/model/Props.java    |  62 +++---
 .../directory/fortress/core/model/Session.java  | 212 ++++++++++---------
 .../fortress/core/rest/AuditMgrRestImpl.java    |  65 ++++--
 5 files changed, 215 insertions(+), 184 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/90ef3ce9/src/main/java/org/apache/directory/fortress/core/ldap/ApacheDsDataProvider.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/ldap/ApacheDsDataProvider.java
b/src/main/java/org/apache/directory/fortress/core/ldap/ApacheDsDataProvider.java
index e63b8f3..5eb8061 100644
--- a/src/main/java/org/apache/directory/fortress/core/ldap/ApacheDsDataProvider.java
+++ b/src/main/java/org/apache/directory/fortress/core/ldap/ApacheDsDataProvider.java
@@ -604,7 +604,6 @@ public abstract class ApacheDsDataProvider
      * @param dn         contains distinguished node of entry targeted for removal..
      * @param entity     contains audit context.
      * @throws LdapException   in the event system error occurs.
-     * @throws IOException
      * @throws CursorException
      */
     protected void deleteRecursive( LdapConnection connection, String dn, FortEntity entity
) throws LdapException,
@@ -629,7 +628,6 @@ public abstract class ApacheDsDataProvider
      * @param connection     handle to ldap connection.
      * @param recursiveCount keeps track of how many iterations have been performed.
      * @throws LdapException   in the event system error occurs.
-     * @throws IOException
      * @throws CursorException
      */
     private void deleteRecursive( String dn, LdapConnection connection, int recursiveCount
) throws LdapException,
@@ -683,7 +681,6 @@ public abstract class ApacheDsDataProvider
      *
      * @param mods   used to update ldap attributes.
      * @param entity contains audit context.
-     * @throws LdapException in the event of error with ldap client.
      */
     private void audit( List<Modification> mods, FortEntity entity )
     {
@@ -787,11 +784,10 @@ public abstract class ApacheDsDataProvider
      * @param attrsOnly  if true pull back attribute names only.
      * @return entry   containing target ldap node.
      * @throws LdapException   thrown in the event of error in ldap client or server code.
-     * @throws IOException
-     * @throws CursorException
+     * @throws CursorException If we weren't able to fetch an element from the search result
      */
     protected Entry searchNode( LdapConnection connection, String baseDn, SearchScope scope,
String filter,
-        String[] attrs, boolean attrsOnly ) throws LdapException, CursorException, IOException
+        String[] attrs, boolean attrsOnly ) throws LdapException, CursorException
     {
         SearchRequest searchRequest = new SearchRequestImpl();
 
@@ -829,11 +825,10 @@ public abstract class ApacheDsDataProvider
      *                   value will be stored in openldap auditsearch record AuthZID's attribute.
      * @return entry   containing target ldap node.
      * @throws LdapException   thrown in the event of error in ldap client or server code.
-     * @throws IOException
-     * @throws CursorException
+     * @throws CursorException If we weren't able to fetch an element from the search result
      */
     protected Entry searchNode( LdapConnection connection, String baseDn, SearchScope scope,
String filter,
-        String[] attrs, boolean attrsOnly, String userDn ) throws LdapException, CursorException,
IOException
+        String[] attrs, boolean attrsOnly, String userDn ) throws LdapException, CursorException
     {
         COUNTERS.incrementSearch();
 
@@ -901,7 +896,6 @@ public abstract class ApacheDsDataProvider
      * @param entry         contains the target ldap entry.
      * @param attributeName name of ldap attribute to retrieve.
      * @return List of type string containing attribute values.
-     * @throws LdapException in the event of ldap client error.
      */
     protected List<String> getAttributes( Entry entry, String attributeName )
     {
@@ -955,7 +949,6 @@ public abstract class ApacheDsDataProvider
      * @param entry         contains the target ldap entry.
      * @param attributeName name of ldap attribute to retrieve.
      * @return List of type string containing attribute values.
-     * @throws LdapException in the event of ldap client error.
      */
     protected Set<String> getAttributeSet( Entry entry, String attributeName )
     {
@@ -980,9 +973,7 @@ public abstract class ApacheDsDataProvider
      * @param entry         contains the target ldap entry.
      * @param attributeName name of ldap attribute to retrieve.
      * @return value contained in a string variable.
-     * @throws LdapInvalidAttributeValueException
-     *
-     * @throws LdapException in the event of ldap client error.
+     * @throws LdapInvalidAttributeValueException When we weren't able to get the attribute
from the entry
      */
     protected String getAttribute( Entry entry, String attributeName ) throws LdapInvalidAttributeValueException
     {
@@ -1011,7 +1002,6 @@ public abstract class ApacheDsDataProvider
      *
      * @param dn contains ldap distinguished name.
      * @return rDn as string.
-     * @throws LdapException in the event of ldap client error.
      */
     protected String getRdn( String dn )
     {
@@ -1047,7 +1037,7 @@ public abstract class ApacheDsDataProvider
      * @param ftDateTime reference to {@link org.apache.directory.fortress.core.model.Constraint}
containing formatted data.
      * @throws LdapInvalidAttributeValueException
      *
-     * @throws LdapException in the event of ldap client error.
+     * @throws LdapInvalidAttributeValueException when we weren't able to retrieve the attribute
from the entry
      */
     protected void unloadTemporal( Entry le, Constraint ftDateTime ) throws LdapInvalidAttributeValueException
     {
@@ -1066,6 +1056,7 @@ public abstract class ApacheDsDataProvider
      * @param list     list of type string containing attribute values to load into attribute
set.
      * @param entry    contains ldap attribute set targeted for adding.
      * @param attrName name of ldap attribute being added.
+     * @throws LdapException If we weren't able to add the attributes into the entry
      */
     protected void loadAttrs( List<String> list, Entry entry, String attrName ) throws
LdapException
     {
@@ -1163,7 +1154,7 @@ public abstract class ApacheDsDataProvider
      * @param values   set of type string containing attribute values to load into attribute
set.
      * @param entry    contains ldap entry to pull attrs from.
      * @param attrName name of ldap attribute being added.
-     * @throws LdapException
+     * @throws LdapException If we weren't able to add the values into the entry
      */
     protected void loadAttrs( Set<String> values, Entry entry, String attrName ) throws
LdapException
     {
@@ -1256,7 +1247,7 @@ public abstract class ApacheDsDataProvider
      * @param props    contains {@link java.util.Properties} targeted for adding to ldap.
      * @param entry    contains ldap entry to pull attrs from.
      * @param attrName contains the name of the ldap attribute to be added.
-     * @throws LdapException
+     * @throws LdapException If we weren't able to add the properies into the entry
      */
     protected void loadProperties( Properties props, Entry entry, String attrName ) throws
LdapException
     {
@@ -1289,20 +1280,22 @@ public abstract class ApacheDsDataProvider
      * @param entry    contains ldap entry to push attrs into.
      * @param attrName contains the name of the ldap attribute to be added.
      * @param separator contains the char value used to separate name and value in ldap raw
format.
-     * @throws LdapException
+     * @throws LdapException If we weren't able to add the properies into the entry
      */
     protected void loadProperties( Properties props, Entry entry, String attrName, char separator
)
         throws LdapException
     {
-        if ( props != null && props.size() > 0 )
+        if ( ( props != null ) && ( props.size() > 0 ) )
         {
             Attribute attr = null;
+            
             for ( Enumeration<?> e = props.propertyNames(); e.hasMoreElements(); )
             {
                 // This LDAP attr is stored as a name-value pair separated by a ':'.
                 String key = ( String ) e.nextElement();
                 String val = props.getProperty( key );
                 String prop = key + separator + val;
+                
                 if ( attr == null )
                 {
                     attr = new DefaultAttribute( attrName );
@@ -1312,6 +1305,7 @@ public abstract class ApacheDsDataProvider
                     attr.add( prop );
                 }
             }
+            
             if ( attr != null )
             {
                 entry.add( attr );
@@ -1321,10 +1315,12 @@ public abstract class ApacheDsDataProvider
 
 
     /**
-     * @param value
-     * @param validLen
+     * Encode some text so that it can be used in a LDAP filter.
+     * 
+     * @param value The value to encode
+     * @param validLen The maximum accepted length of the value. 
      * @return String containing encoded data.
-     * @throws LdapException
+     * @throws LdapException If the value is longer than the maximum value
      */
     protected String encodeSafeText( String value, int validLen ) throws LdapException
     {
@@ -1392,7 +1388,6 @@ public abstract class ApacheDsDataProvider
      * Calls the PoolMgr to close the Admin LDAP connection.
      *
      * @param connection handle to ldap connection object.
-     * @throws Exception
      */
     protected void closeAdminConnection( LdapConnection connection )
     {
@@ -1411,7 +1406,6 @@ public abstract class ApacheDsDataProvider
      * Calls the PoolMgr to close the Log LDAP connection.
      *
      * @param connection handle to ldap connection object.
-     * @throws Exception
      */
     protected void closeLogConnection( LdapConnection connection )
     {
@@ -1430,7 +1424,6 @@ public abstract class ApacheDsDataProvider
      * Calls the PoolMgr to close the User LDAP connection.
      *
      * @param connection handle to ldap connection object.
-     * @throws Exception
      */
     protected void closeUserConnection( LdapConnection connection )
     {
@@ -1449,7 +1442,7 @@ public abstract class ApacheDsDataProvider
      * Calls the PoolMgr to get an Admin connection to the LDAP server.
      *
      * @return ldap connection.
-     * @throws LdapException
+     * @throws LdapException If we had an issue getting an LDAP connection
      */
     protected LdapConnection getAdminConnection() throws LdapException
     {
@@ -1468,7 +1461,7 @@ public abstract class ApacheDsDataProvider
      * Calls the PoolMgr to get an Log connection to the LDAP server.
      *
      * @return ldap connection.
-     * @throws LdapException
+     * @throws LdapException If we had an issue getting an LDAP connection
      */
     protected LdapConnection getLogConnection() throws LdapException
     {
@@ -1487,7 +1480,7 @@ public abstract class ApacheDsDataProvider
      * Calls the PoolMgr to get an User connection to the LDAP server.
      *
      * @return ldap connection.
-     * @throws LdapException
+     * @throws LdapException If we had an issue getting an LDAP connection
      */
     protected LdapConnection getUserConnection() throws LdapException
     {
@@ -1573,10 +1566,8 @@ public abstract class ApacheDsDataProvider
 
     /**
      * Perform encoding on supplied input string for certain unsafe ascii characters.  These
chars may be unsafe
-     * because ldap reserves some
-     * characters as operands.  Safe encoding safeguards from malicious scripting input errors
that are possible iff
-     * data filtering
-     * did not get performed before being passed into dao layer.
+     * because ldap reserves some characters as operands.  Safe encoding safeguards from
malicious scripting input errors 
+     * that are possible if data filtering did not get performed before being passed into
dao layer.
      *
      * @param filter contains the data to filter.
      * @return possibly modified input string for matched characters.

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/90ef3ce9/src/main/java/org/apache/directory/fortress/core/model/PermObj.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/PermObj.java b/src/main/java/org/apache/directory/fortress/core/model/PermObj.java
index 6bf0410..a801007 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/PermObj.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/PermObj.java
@@ -62,7 +62,7 @@ import javax.xml.bind.annotation.XmlType;
  * <li>The {@link PermObj} entity is not used for authorization checks, rather contains
{@link org.apache.directory.fortress.core.model.Permission} which are themselves authorization
targets.<br>
  * <li>This entity must be associated with a valid Perm OU {@link org.apache.directory.fortress.core.model.OrgUnit.Type#PERM}
that is contained within the {@code ou=OS-P,ou=ARBAC,dc=example,dc=com} location in ldap.
  * <li>The object to operation pairings enable application resources to be mapped to
Fortress permissions in a way that is natural for object oriented programming.
- * <li>Permissions = Object {@link PermObj} 1<->* Operations {@link org.apache.directory.fortress.core.model.Permission}
+ * <li>Permissions = Object {@link PermObj} 1&lt;-&gt;* Operations {@link org.apache.directory.fortress.core.model.Permission}
  * <p>
  * <img src="../doc-files/RbacCore.png" alt="">
  * <li>The unique key to locate an Fortress PermObj entity is {@code PermObj#objName}.
@@ -88,6 +88,7 @@ import javax.xml.bind.annotation.XmlType;
  *      ftType
  *  )
  * )
+ * </pre>
  * 2. ftProperties AUXILIARY Object Class is used to store client specific name/value pairs
on target entity.
  * This aux object class can be used to store custom attributes<br>
  * The properties collections consist of name/value pairs and are not constrainted by Fortress.<br>

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/90ef3ce9/src/main/java/org/apache/directory/fortress/core/model/Props.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/Props.java b/src/main/java/org/apache/directory/fortress/core/model/Props.java
index 189ec02..80d8f55 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/Props.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/Props.java
@@ -39,27 +39,27 @@ import java.util.List;
  *         <p>The following schema fragment specifies the expected content contained
within this class.
  *         <p>
  *         <pre>
- *                 &lt;complexType>
- *                   &lt;complexContent>
- *                     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
- *                       &lt;sequence>
- *                         &lt;element name="entry" maxOccurs="unbounded" minOccurs="0">
- *                           &lt;complexType>
- *                             &lt;complexContent>
- *                               &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
- *                                 &lt;sequence>
- *                                   &lt;element name="key" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/>
- *                                   &lt;element name="value" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/>
- *                                 &lt;/sequence>
- *                               &lt;/restriction>
- *                             &lt;/complexContent>
- *                           &lt;/complexType>
- *                         &lt;/element>
- *                       &lt;/sequence>
- *                     &lt;/restriction>
- *                   &lt;/complexContent>
- *                 &lt;/complexType>
- *                 </pre>
+ *             &lt;complexType&gt;
+ *               &lt;complexContent&gt;
+ *                 &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt;
+ *                   &lt;sequence&gt;
+ *                     &lt;element name="entry" maxOccurs="unbounded" minOccurs="0"&gt;
+ *                       &lt;complexType&gt;
+ *                         &lt;complexContent&gt;
+ *                           &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt;
+ *                             &lt;sequence&gt;
+ *                               &lt;element name="key" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/&gt;
+ *                               &lt;element name="value" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/&gt;
+ *                             &lt;/sequence&gt;
+ *                           &lt;/restriction&gt;
+ *                         &lt;/complexContent&gt;
+ *                       &lt;/complexType&gt;
+ *                     &lt;/element&gt;
+ *                   &lt;/sequence&gt;
+ *                 &lt;/restriction&gt;
+ *               &lt;/complexContent&gt;
+ *             &lt;/complexType&gt;
+ *             </pre>
  */
 @XmlRootElement(name = "fortProps")
 @XmlAccessorType(XmlAccessType.FIELD)
@@ -111,16 +111,16 @@ public class Props extends FortEntity implements Serializable
      * <p>The following schema fragment specifies the expected content contained within
this class.
      *
      * <pre>
-     * &lt;complexType>
-     *   &lt;complexContent>
-     *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
-     *       &lt;sequence>
-     *         &lt;element name="key" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/>
-     *         &lt;element name="value" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/>
-     *       &lt;/sequence>
-     *     &lt;/restriction>
-     *   &lt;/complexContent>
-     * &lt;/complexType>
+     * &lt;complexType&gt;
+     *   &lt;complexContent&gt;
+     *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt;
+     *       &lt;sequence&gt;
+     *         &lt;element name="key" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/&gt;
+     *         &lt;element name="value" type="{http://www.w3.org/2001/XMLSchema}anyType"
minOccurs="0"/&gt;
+     *       &lt;/sequence&gt;
+     *     &lt;/restriction&gt;
+     *   &lt;/complexContent&gt;
+     * &lt;/complexType&gt;
      * </pre>
      *
      *

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/90ef3ce9/src/main/java/org/apache/directory/fortress/core/model/Session.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/Session.java b/src/main/java/org/apache/directory/fortress/core/model/Session.java
index 4035bf4..8479a3f 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/Session.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/Session.java
@@ -34,70 +34,82 @@ import java.util.UUID;
  * This contains attributes related to a user's RBAC session.
  * The following example shows the mapping to Session attributes on this entity:
  * <p>
- * <ul> <li><code>Session</code>
- * <li> <code>session.getUserId() => demoUser4</code>
- * <li> <code>session.getInternalUserId() => be2dd2e:12a82ba707e:-7fee</code>
- * <li> <code>session.getMessage() => Fortress checkPwPolicies userId <demouser4>
VALIDATION GOOD</code>
- * <li> <code>session.getErrorId() => 0</code>
- * <li> <code>session.getWarningId() => 11</code>
- * <li> <code>session.getExpirationSeconds() => 469831</code>
- * <li> <code>session.getGraceLogins() => 0</code>
- * <li> <code>session.getIsAuthenticated() => true</code>
- * <li> <code>session.getLastAccess() => 1283623680440</code>
- * <li> <code>session.getSessionId() => -7410986f:12addeea576:-7fff</code>
- * <li>  ------------------------------------------
- * <li> <code>User user = session.getUser();</code>
- * <ul> <li> <code>user.getUserId() => demoUser4</code>
- * <li> <code>user.getInternalId() => be2dd2e:12a82ba707e:-7fee</code>
- * <li> <code>user.getCn() => JoeUser4</code>
- * <li> <code>user.getDescription() => Demo Test User 4</code>
- * <li> <code>user.getOu() => test</code>
- * <li> <code>user.getSn() => User4</code>
- * <li> <code>user.getBeginDate() => 20090101</code>
- * <li> <code>user.getEndDate() => none</code>
- * <li> <code>user.getBeginLockDate() => none</code>
- * <li> <code>user.getEndLockDate() => none</code>
- * <li> <code>user.getDayMask() => 1234567</code>
- * <li> <code>user.getTimeout() => 60</code>
- * <li> <code>List<UserRole> roles = session.getRoles();</code>
- * <ul> <li><code>UserRole userRole = roles.get(i);</code>
- * <li> <code>userRole.getName() => role1</code>
- * <li> <code>userRole.getBeginTime() => 0000</code>
- * <li> <code>userRole.getEndTime() => 0000</code>
- * <li> <code>userRole.getBeginDate() => none</code>
- * <li> <code>userRole.getEndDate() => none</code>
- * <li> <code>userRole.getBeginLockDate() => null</code>
- * <li> <code>userRole.getEndLockDate() => null</code>
- * <li> <code>userRole.getDayMask() => null</code>
- * <li> <code>userRole.getTimeout() => 0</code>
- * <li> <code>List<UserAdminRole> adminRoles = session.getAdminRoles();</code>
- * </ul>
- * <ul> <li><code>UserAdminRole userAdminRole = adminRoles.get(i);</code>
- * <li> <code>userAdminRole.getName() => DemoAdminUsers</code>
- * <li> <code>userAdminRole.getBeginTime() => 0000</code>
- * <li> <code>userAdminRole.getEndTime() => 0000</code>
- * <li> <code>userAdminRole.getBeginDate() => none</code>
- * <li> <code>userAdminRole.getEndDate() => none</code>
- * <li> <code>userAdminRole.getBeginLockDate() => null</code>
- * <li> <code>userAdminRole.getEndLockDate() => null</code>
- * <li> <code>userAdminRole.getDayMask() => null</code>
- * <li> <code>userAdminRole.getTimeout() => 0</code>
- * <li> <code>userAdminRole.getOsPs() => [ftT3POrg10, ftT4POrg10]</code>
- * <li> <code>userAdminRole.getOsUs() => [ftT1UOrg10, ftT2UOrg10]</code>
- * <li> <code>userAdminRole.getBeginRange() => ftT14Role1</code>
- * <li> <code>userAdminRole.getEndRange() => ftT14Role10</code>
- * <li> <code>userAdminRole.getBeginInclusive() => true</code>
- * <li> <code>userAdminRole.getEndInclusive() => false</code>
- * </ul>
+ * <ul> 
+ *   <li><code>Session</code></li>
+ *   <li><code>session.getUserId() =&gt; demoUser4</code></li>
+ *   <li><code>session.getInternalUserId() =&gt; be2dd2e:12a82ba707e:-7fee</code></li>
+ *   <li><code>session.getMessage() =&gt; Fortress checkPwPolicies userId
&lt;demouser4&gt; VALIDATION GOOD</code></li>
+ *   <li><code>session.getErrorId() =&gt; 0</code></li>
+ *   <li><code>session.getWarningId() =&gt; 11</code></li>
+ *   <li><code>session.getExpirationSeconds() =&gt; 469831</code></li>
+ *   <li><code>session.getGraceLogins() =&gt; 0</code></li>
+ *   <li><code>session.getIsAuthenticated() =&gt; true</code></li>
+ *   <li><code>session.getLastAccess() =&gt; 1283623680440</code></li>
+ *   <li><code>session.getSessionId() =&gt; -7410986f:12addeea576:-7fff</code></li>
+ *   <li>------------------------------------------
+ *   <li><code>User user = session.getUser();</code>
+ *   <li>
+ *     <ul>
+ *       <li><code>user.getUserId() =&gt; demoUser4</code></li>
+ *       <li><code>user.getInternalId() =&gt; be2dd2e:12a82ba707e:-7fee</code></li>
+ *       <li><code>user.getCn() =&gt; JoeUser4</code></li>
+ *       <li><code>user.getDescription() =&gt; Demo Test User 4</code></li>
+ *       <li><code>user.getOu() =&gt; test</code></li>
+ *       <li><code>user.getSn() =&gt; User4</code></li>
+ *       <li><code>user.getBeginDate() =&gt; 20090101</code></li>
+ *       <li><code>user.getEndDate() =&gt; none</code></li>
+ *       <li><code>user.getBeginLockDate() =&gt; none</code></li>
+ *       <li><code>user.getEndLockDate() =&gt; none</code></li>
+ *       <li><code>user.getDayMask() =&gt; 1234567</code></li>
+ *       <li><code>user.getTimeout() =&gt; 60</code></li>
+ *       <li><code>List&lt;UserRole&gt; roles = session.getRoles();</code></li>
+ *     </ul>
+ *   </li>
+ *   <li>
+ *     <ul> 
+ *       <li><code>UserRole userRole = roles.get(i);</code></li>
+ *       <li><code>userRole.getName() =&gt; role1</code></li>
+ *       <li><code>userRole.getBeginTime() =&gt; 0000</code></li>
+ *       <li><code>userRole.getEndTime() =&gt; 0000</code></li>
+ *       <li><code>userRole.getBeginDate() =&gt; none</code></li>
+ *       <li><code>userRole.getEndDate() =&gt; none</code></li>
+ *       <li><code>userRole.getBeginLockDate() =&gt; null</code></li>
+ *       <li><code>userRole.getEndLockDate() =&gt; null</code></li>
+ *       <li><code>userRole.getDayMask() =&gt; null</code></li>
+ *       <li><code>userRole.getTimeout() =&gt; 0</code></li>
+ *       <li><code>List&lt;UserAdminRole&gt; adminRoles = session.getAdminRoles();</code></li>
+ *     </ul>
+ *   </li>
+ *   <li>
+ *     <ul>
+ *       <li><code>UserAdminRole userAdminRole = adminRoles.get(i);</code></li>
+ *       <li><code>userAdminRole.getName() =&gt; DemoAdminUsers</code></li>
+ *       <li><code>userAdminRole.getBeginTime() =&gt; 0000</code></li>
+ *       <li><code>userAdminRole.getEndTime() =&gt; 0000</code></li>
+ *       <li><code>userAdminRole.getBeginDate() =&gt; none</code></li>
+ *       <li><code>userAdminRole.getEndDate() =&gt; none</code></li>
+ *       <li><code>userAdminRole.getBeginLockDate() =&gt; null</code></li>
+ *       <li><code>userAdminRole.getEndLockDate() =&gt; null</code></li>
+ *       <li><code>userAdminRole.getDayMask() =&gt; null</code></li>
+ *       <li><code>userAdminRole.getTimeout() =&gt; 0</code></li>
+ *       <li><code>userAdminRole.getOsPs() =&gt; [ftT3POrg10, ftT4POrg10]</code></li>
+ *       <li><code>userAdminRole.getOsUs() =&gt; [ftT1UOrg10, ftT2UOrg10]</code></li>
+ *       <li><code>userAdminRole.getBeginRange() =&gt; ftT14Role1</code></li>
+ *       <li><code>userAdminRole.getEndRange() =&gt; ftT14Role10</code></li>
+ *       <li><code>userAdminRole.getBeginInclusive() =&gt; true</code></li>
+ *       <li><code>userAdminRole.getEndInclusive() =&gt; false</code></li>
+ *     </ul>
+ *   </li>
  * </ul>
  * <p>
+ * 
  * Sample Data data contained within this Entity.
  * <p>
  * Ses UID      [demoUser4]:<br>
  * Ses IID      [ccbb2929-bf01-413d-b768-529de4d428e5]<br>
  * Ses ERR      [0]<br>
  * Ses WARN     [10]<br>
- * Ses MSG      [checkPwPolicies for userId <demouser4> PASSWORD CHECK SUCCESS]<br>
+ * Ses MSG      [checkPwPolicies for userId &lt;demouser4&gt; PASSWORD CHECK SUCCESS]<br>
  * Ses EXP      [0]<br>
  * Ses GRAC     [0]<br>
  * Ses AUTH     [true]<br>
@@ -288,30 +300,30 @@ public class Session  extends FortEntity implements PwMessage, Serializable
      * U   PROP[0]=customerNumber VAL=3213432<br>
      * <p>
      * USER ROLE[0]:<br>
-     * role name <role1><br>
-     * begin time <0000><br>
-     * end time <0000><br>
-     * begin date <none><br>
-     * end date <none><br>
-     * begin lock <none><br>
-     * end lock <none><br>
-     * day mask <all><br>
-     * time out <0><br>
+     * role name &lt;role1&gt;<br>
+     * begin time &lt;0000&gt;<br>
+     * end time &lt;0000&gt;<br>
+     * begin date &lt;none&gt;<br>
+     * end date &lt;none&gt;<br>
+     * begin lock &lt;none&gt;<br>
+     * end lock &lt;none&gt;<br>
+     * day mask &lt;all&gt;<br>
+     * time out &lt;0&gt;<br>
      * <p>
      * USER ADMIN ROLE[0]:<br>
-     * admin role name <DemoAdminUsers><br>
-     * OsU <null><br>
-     * OsP <null><br>
-     * begin range <null><br>
-     * end range <null><br>
-     * begin time <0000><br>
-     * end time <0000><br>
-     * begin date <none><br>
-     * end date <none><br>
-     * begin lock <none><br>
-     * end lock <none><br>
-     * day mask <all><br>
-     * time out <0><br>
+     * admin role name &lt;DemoAdminUsers&gt;<br>
+     * OsU &lt;null&gt;<br>
+     * OsP &lt;null&gt;<br>
+     * begin range &lt;null&gt;<br>
+     * end range &lt;null&gt;<br>
+     * begin time &lt;0000&gt;<br>
+     * end time &lt;0000&gt;<br>
+     * begin date &lt;none&gt;<br>
+     * end date &lt;none&gt;<br>
+     * begin lock &lt;none&gt;<br>
+     * end lock &lt;none&gt;<br>
+     * day mask &lt;all&gt;<br>
+     * time out &lt;0&gt;<br>
      * <p>
      * @return User entity that contains userid, roles and other attributes valid for Session.
      */
@@ -505,30 +517,30 @@ public class Session  extends FortEntity implements PwMessage, Serializable
      * U   PROP[0]=customerNumber VAL=3213432<br>
      * <p>
      * USER ROLE[0]:<br>
-     * role name <role1><br>
-     * begin time <0000><br>
-     * end time <0000><br>
-     * begin date <none><br>
-     * end date <none><br>
-     * begin lock <none><br>
-     * end lock <none><br>
-     * day mask <all><br>
-     * time out <0><br>
+     * role name &lt;role1&gt;<br>
+     * begin time &lt;0000&gt;<br>
+     * end time &lt;0000&gt;<br>
+     * begin date &lt;none&gt;<br>
+     * end date &lt;none&gt;<br>
+     * begin lock &lt;none&gt;<br>
+     * end lock &lt;none&gt;<br>
+     * day mask &lt;all&gt;<br>
+     * time out &lt;0&gt;<br>
      * <p>
      * USER ADMIN ROLE[0]:<br>
-     * admin role name <DemoAdminUsers><br>
-     * OsU <null><br>
-     * OsP <null><br>
-     * begin range <null><br>
-     * end range <null><br>
-     * begin time <0000><br>
-     * end time <0000><br>
-     * begin date <none><br>
-     * end date <none><br>
-     * begin lock <none><br>
-     * end lock <none><br>
-     * day mask <all><br>
-     * time out <0><br>
+     * admin role name &lt;DemoAdminUsers&gt;<br>
+     * OsU &lt;null&gt;<br>
+     * OsP &lt;null&gt;<br>
+     * begin range &lt;null&gt;<br>
+     * end range &lt;null&gt;<br>
+     * begin time &lt;0000&gt;<br>
+     * end time &lt;0000&gt;<br>
+     * begin date &lt;none&gt;<br>
+     * end date &lt;none&gt;<br>
+     * begin lock &lt;none&gt;<br>
+     * end lock &lt;none&gt;<br>
+     * day mask &lt;all&gt;<br>
+     * time out &lt;0&gt;<br>
      * <p>
      * @param user Contains userId, roles and other security attributes used for access control.
      */

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/90ef3ce9/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java b/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
index 5637bb7..9d5c01b 100644
--- a/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/rest/AuditMgrRestImpl.java
@@ -35,18 +35,21 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * This class performs searches across <a href="http://www.openldap.org/">OpenLDAP</a>'s
slapd access log using HTTP access to En Masse REST server.
- * The access log events are
+ * This class performs searches across <a href="http://www.openldap.org/">OpenLDAP</a>'s
slapd access log using HTTP access 
+ * to En Masse REST server. The access log events are
  * persisted in <a href="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">BDB</a>.
- * Audit entries stored on behalf of Fortress operations correspond to runtime authentication
{@link org.apache.directory.fortress.core.model.Bind}, authorization {@link org.apache.directory.fortress.core.model.AuthZ}
and modification {@link Mod}
+ * Audit entries stored on behalf of Fortress operations correspond to runtime authentication

+ * {@link org.apache.directory.fortress.core.model.Bind}, authorization 
+ * {@link org.apache.directory.fortress.core.model.AuthZ} and modification {@link Mod}
  * events as they occur automatically on the server when audit is enabled.
+ * <h3></h3>
  * <h4>Audit Interrogator</h4>
  * Provides an OpenLDAP access log retrieval mechanism that enables security event monitoring.
  * <ol>
- * <li>Authentication events:
- * <li>Session enablement events
- * <li>Authorization events
- * <li>Entity mods and deletes
+ *   <li>Authentication events:</li>
+ *   <li>Session enablement events</li>
+ *   <li>Authorization events</li>
+ *   <li>Entity mods and deletes</li>
  * </li>
  * </ol>
  * <img src="../doc-files/Audit.png" alt="">
@@ -57,23 +60,47 @@ import java.util.List;
  * The following APIs generate events subsequently stored in this access log:
  * </h4>
  * <ul>
- * <li> {@link org.apache.directory.fortress.core.AccessMgr}
- * <li> {@link org.apache.directory.fortress.core.AdminMgr}
- * <li> {@link org.apache.directory.fortress.core.AdminMgr}
- * <li> {@link org.apache.directory.fortress.core.DelAdminMgr}
- * <li> {@link org.apache.directory.fortress.core.ConfigMgr}
- * <li> {@link org.apache.directory.fortress.core.PwPolicyMgr}
+ *   <li>{@link org.apache.directory.fortress.core.AccessMgr}</li>
+ *   <li>{@link org.apache.directory.fortress.core.AdminMgr}</li>
+ *   <li>{@link org.apache.directory.fortress.core.AdminMgr}</li>
+ *   <li>{@link org.apache.directory.fortress.core.DelAdminMgr}</li>
+ *   <li>{@link org.apache.directory.fortress.core.ConfigMgr}</li>
+ *   <li>{@link org.apache.directory.fortress.core.PwPolicyMgr}</li>
  * </ul>
  * <h4>
  * The following reports are supported using search input: {@link org.apache.directory.fortress.core.model.UserAudit}
  * </h4>
  * <ul>
- * <li>User Authentications:     <code>List<{@link org.apache.directory.fortress.core.model.Bind}>
 {@link org.apache.directory.fortress.core.AuditMgr#searchBinds(org.apache.directory.fortress.core.model.UserAudit)}</code>
- * <li>Invalid Users AuthN:      <code>List<{@link org.apache.directory.fortress.core.model.Bind}>
 {@link org.apache.directory.fortress.core.AuditMgr#searchInvalidUsers(org.apache.directory.fortress.core.model.UserAudit)}
</code>
- * <li>User Authorizations 1:    <code>List<{@link org.apache.directory.fortress.core.model.AuthZ}>
{@link org.apache.directory.fortress.core.AuditMgr#getUserAuthZs(org.apache.directory.fortress.core.model.UserAudit)}
</code>
- * <li>User Authorizations 2:    <code>List<{@link org.apache.directory.fortress.core.model.AuthZ}>
{@link org.apache.directory.fortress.core.AuditMgr#searchAuthZs(org.apache.directory.fortress.core.model.UserAudit)}
</code>
- * <li>User Session Activations: <code>List<{@link Mod}>   {@link org.apache.directory.fortress.core.AuditMgr#searchUserSessions(org.apache.directory.fortress.core.model.UserAudit)}
</code>
- * <li>Entity Modifications:     <code>List<{@link Mod}>   {@link org.apache.directory.fortress.core.AuditMgr#searchAdminMods(org.apache.directory.fortress.core.model.UserAudit)}
</code>
+ *   <li>
+ *     User Authentications:     <code>List&lt;{@link org.apache.directory.fortress.core.model.Bind}@gt;
 
+ *     {@link org.apache.directory.fortress.core.AuditMgr#searchBinds(org.apache.directory.fortress.core.model.UserAudit)}
+ *     </code>
+ *   </li>
+ *   <li>
+ *     Invalid Users AuthN:      <code>List&lt;{@link org.apache.directory.fortress.core.model.Bind}@gt;
 
+ *     {@link org.apache.directory.fortress.core.AuditMgr#searchInvalidUsers(
+ *     org.apache.directory.fortress.core.model.UserAudit)} </code>
+ *   </li>
+ *   <li>
+ *     User Authorizations 1:    <code>List&lt;{@link org.apache.directory.fortress.core.model.AuthZ}@gt;

+ *     {@link org.apache.directory.fortress.core.AuditMgr#getUserAuthZs(org.apache.directory.fortress.core.model.UserAudit)}

+ *     </code>
+ *   </li>
+ *   <li>
+ *     User Authorizations 2:    <code>List&lt;{@link org.apache.directory.fortress.core.model.AuthZ}@gt;

+ *     {@link org.apache.directory.fortress.core.AuditMgr#searchAuthZs(org.apache.directory.fortress.core.model.UserAudit)}

+ *     </code>
+ *   </li>
+ *   <li>
+ *     User Session Activations: <code>List&lt;{@link Mod}@gt;   
+ *     {@link org.apache.directory.fortress.core.AuditMgr#searchUserSessions(
+ *     org.apache.directory.fortress.core.model.UserAudit)} </code>
+ *   </li>
+ *   <li>
+ *     Entity Modifications:     <code>List&lt;{@link Mod}@gt;   
+ *     {@link org.apache.directory.fortress.core.AuditMgr#searchAdminMods(
+ *     org.apache.directory.fortress.core.model.UserAudit)} </code>
+ *   </li>
  * </ul>
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>


Mime
View raw message