directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject [7/7] directory-fortress-core git commit: FC-132 - Fix javadoc issues
Date Sat, 02 Jan 2016 03:53:00 GMT
 FC-132 -  Fix 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/d33ae957
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/d33ae957
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/d33ae957

Branch: refs/heads/master
Commit: d33ae957fa162ba845cbc3b68ec85f14c70c1df3
Parents: 53e4208
Author: Shawn McKinney <smckinney@apache.org>
Authored: Fri Jan 1 21:52:49 2016 -0600
Committer: Shawn McKinney <smckinney@apache.org>
Committed: Fri Jan 1 21:52:49 2016 -0600

----------------------------------------------------------------------
 .../fortress/core/impl/AccelMgrImpl.java        | 111 +--
 .../fortress/core/impl/AccessMgrImpl.java       | 176 +---
 .../fortress/core/impl/AdminMgrImpl.java        | 824 +------------------
 .../fortress/core/impl/AuditMgrImpl.java        | 100 +--
 .../fortress/core/impl/ConfigMgrImpl.java       |  35 +-
 .../fortress/core/impl/DelAccessMgrImpl.java    |  94 +--
 .../fortress/core/impl/DelAdminMgrImpl.java     | 525 +-----------
 .../fortress/core/impl/DelReviewMgrImpl.java    |  73 +-
 .../fortress/core/impl/GroupMgrImpl.java        |  68 +-
 .../fortress/core/impl/PwPolicyMgrImpl.java     | 213 +----
 .../fortress/core/impl/ReviewMgrImpl.java       | 417 +---------
 .../fortress/core/rest/AccessMgrRestImpl.java   | 176 +---
 .../fortress/core/rest/AdminMgrRestImpl.java    | 745 +----------------
 .../fortress/core/rest/AuditMgrRestImpl.java    | 102 +--
 .../fortress/core/rest/ConfigMgrRestImpl.java   |  47 +-
 .../core/rest/DelAccessMgrRestImpl.java         | 103 +--
 .../fortress/core/rest/DelAdminMgrRestImpl.java | 545 ++----------
 .../core/rest/DelReviewMgrRestImpl.java         |  75 +-
 .../fortress/core/rest/PwPolicyMgrRestImpl.java | 213 +----
 .../fortress/core/rest/ReviewMgrRestImpl.java   | 443 ++--------
 20 files changed, 389 insertions(+), 4696 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
index 192f3c2..ab165ac 100644
--- a/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/AccelMgrImpl.java
@@ -85,58 +85,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
 
 
     /**
-     * Perform user authentication {@link org.apache.directory.fortress.core.model.User#password}
and role activations.<br />
-     * This method must be called once per user prior to calling other methods within this
class.
-     * The successful result is {@link org.apache.directory.fortress.core.model.Session}
that contains target user's RBAC {@link org.apache.directory.fortress.core.model.User#roles}
and Admin role {@link org.apache.directory.fortress.core.model.User#adminRoles}.<br />
-     * In addition to checking user password validity it will apply configured password policy
checks {@link org.apache.directory.fortress.core.model.User#pwPolicy}..<br />
-     * Method may also store parms passed in for audit trail {@link org.apache.directory.fortress.core.model.FortEntity}.
-     * <h4> This API will...</h4>
-     * <ul>
-     * <li> authenticate user password if trusted == false.
-     * <li> perform <a href="http://www.openldap.org/">OpenLDAP</a> <a
href="http://tools.ietf.org/html/draft-behera-ldap-password-policy-10">password policy
evaluation</a>.
-     * <li> fail for any user who is locked by OpenLDAP's policies {@link org.apache.directory.fortress.core.model.User#isLocked()},
regardless of trusted flag being set as parm on API.
-     * <li> evaluate temporal {@link org.apache.directory.fortress.core.model.Constraint}(s)
on {@link org.apache.directory.fortress.core.model.User}, {@link org.apache.directory.fortress.core.model.UserRole}
and {@link org.apache.directory.fortress.core.model.UserAdminRole} entities.
-     * <li> process selective role activations into User RBAC Session {@link org.apache.directory.fortress.core.model.User#roles}.
-     * <li> check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate(org.apache.directory.fortress.core.model.Session,
org.apache.directory.fortress.core.model.Constraint, org.apache.directory.fortress.core.util.time.Time)}
on {@link org.apache.directory.fortress.core.model.User#roles}.
-     * <li> process selective administrative role activations {@link org.apache.directory.fortress.core.model.User#adminRoles}.
-     * <li> return a {@link org.apache.directory.fortress.core.model.Session} that
contains a reference to an object stored on the RBAC server..
-     * <li> throw a checked exception that will be {@link org.apache.directory.fortress.core.SecurityException}
or its derivation.
-     * <li> throw a {@link SecurityException} for system failures.
-     * <li> throw a {@link org.apache.directory.fortress.core.PasswordException} for
authentication and password policy violations.
-     * <li> throw a {@link org.apache.directory.fortress.core.ValidationException}
for data validation errors.
-     * <li> throw a {@link org.apache.directory.fortress.core.FinderException} if User
id not found.
-     * </ul>
-     * <h4>
-     * The function is valid if and only if:
-     * </h4>
-     * <ul>
-     * <li> the user is a member of the USERS data set
-     * <li> the password is supplied (unless trusted).
-     * <li> the (optional) active role set is a subset of the roles authorized for
that user.
-     * </ul>
-     * <h4>
-     * The following attributes may be set when calling this method
-     * </h4>
-     * <ul>
-     * <li> {@link org.apache.directory.fortress.core.model.User#userId} - required
-     * <li> {@link org.apache.directory.fortress.core.model.User#password}
-     * <li> {@link org.apache.directory.fortress.core.model.User#roles} contains a
list of RBAC role names authorized for user and targeted for activation within this session.
 Default is all authorized RBAC roles will be activated into this Session.
-     * <li> {@link org.apache.directory.fortress.core.model.User#adminRoles} contains
a list of Admin role names authorized for user and targeted for activation.  Default is all
authorized ARBAC roles will be activated into this Session.
-     * <li> {@link org.apache.directory.fortress.core.model.User#props} collection
of name value pairs collected on behalf of User during signon.  For example hostname:myservername
or ip:192.168.1.99
-     * </ul>
-     * <h4>
-     * Notes:
-     * </h4>
-     * <ul>
-     * <li> roles that violate Dynamic Separation of Duty Relationships will not be
activated into session.
-     * <li> role activations will proceed in same order as supplied to User entity
setter, see {@link org.apache.directory.fortress.core.model.User#setRole(String)}.
-     * </ul>
-     * </p>
-     *
-     * @param user Contains {@link org.apache.directory.fortress.core.model.User#userId},
{@link org.apache.directory.fortress.core.model.User#password} (optional if {@code isTrusted}
is 'true'), optional {@link org.apache.directory.fortress.core.model.User#roles}, optional
{@link org.apache.directory.fortress.core.model.User#adminRoles}
-     * @param isTrusted if true password is not required.
-     * @return Session object will contain authentication result code {@link org.apache.directory.fortress.core.model.Session#errorId},
-     * @throws SecurityException in the event of data validation failure, security policy
violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public Session createSession( User user, boolean isTrusted )
@@ -149,10 +98,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
 
 
     /**
-     * This function requests the RBAC server to delete the session from cache.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @throws SecurityException in the event runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public void deleteSession( Session session )
@@ -165,12 +111,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
 
 
     /**
-     * This function returns the active roles associated with a session. The function is
valid if
-     * and only if the session is a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @return List<UserRole> containing all roles active in user's session.  This
will NOT contain inherited roles.
-     * @throws SecurityException is thrown if session invalid or system. error.
+     * {@inheritDoc}
      */
     public List<UserRole> sessionRoles(Session session)
         throws SecurityException
@@ -182,18 +123,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
 
 
     /**
-     * Perform user impl authorization.  This function returns a Boolean value meaning whether
the subject of a given session is
-     * allowed or not to perform a given operation on a given object. The function is valid
if and
-     * only if the session is a valid Fortress session, the object is a member of the OBJS
data set,
-     * and the operation is a member of the OPS data set. The session's subject has the permission
-     * to perform the operation on that object if and only if that permission is assigned
to (at least)
-     * one of the session's active roles. This implementation will verify the roles or userId
correspond
-     * to the subject's active roles are registered in the object's access control list.
-     *
-     * @param perm  must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName},
and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, of permission
User is trying to access.
-     * @param session This object must be instantiated by calling {@link AccessMgrImpl#createSession}
method before passing into the method.  No variables need to be set by client after returned
from createSession.
-     * @return True if user has access, false otherwise.
-     * @throws SecurityException in the event of data validation failure, security policy
violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public boolean checkAccess( Session session, Permission perm )
@@ -211,12 +141,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
 
 
     /**
-     * This function returns the permissions of the session, i.e., the permissions assigned
-     * to its authorized roles. The function is valid if and only if the session is a valid
Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @return List<Permission> containing permissions (op, obj) active for user's
session.
-     * @throws SecurityException in the event runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> sessionPermissions( Session session )
@@ -227,22 +152,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
 
 
     /**
-     * This function adds a role as an active role of a session whose owner is a given user.
-     * <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 ROLES data set
-     * <li> the role inclusion does not violate Dynamic Separation of Duty Relationships
-     * <li> the session is a valid Fortress session
-     * <li> the user is authorized to that role
-     * <li> the session is owned by that user.
-     * </ul>
-     * </p>
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @param role object contains the role name, {@link UserRole#name}, to be activated
into session.
-     * @throws SecurityException is thrown if user is not allowed to activate or runtime
error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public void addActiveRole( Session session, UserRole role )
@@ -260,14 +170,7 @@ public class AccelMgrImpl extends Manageable implements AccelMgr
 
 
     /**
-     * This function deletes a role from the active role set of a session owned by a given
user.
-     * The function is valid if and only if the user is a member of the USERS data set, the
-     * session object contains a valid Fortress session, the session is owned by the user,
-     * and the role is an active role of that session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @param role object contains the role name, {@link UserRole#name}, to be deactivated.
-     * @throws SecurityException is thrown if user is not allowed to deactivate or runtime
error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public void dropActiveRole( Session session, UserRole role )

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/d33ae957/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java b/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
index 1062715..6ed29e9 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
+++ b/src/main/java/org/apache/directory/fortress/core/impl/AccessMgrImpl.java
@@ -79,13 +79,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
     private static final PermP permP = new PermP();
 
     /**
-     * Perform user authentication only.  It does not activate RBAC roles in session but
will evaluate
-     * password policies.
-     *
-     * @param userId   Contains the userid of the user signing on.
-     * @param password Contains the user's password.
-     * @return Session object will be returned if authentication successful.  This will not
contain user's roles.
-     * @throws SecurityException in the event of data validation failure, security policy
violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public Session authenticate( String userId, char[] password )
@@ -108,58 +102,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * Perform user authentication {@link User#password} and role activations.<br />
-     * This method must be called once per user prior to calling other methods within this
class.
-     * The successful result is {@link Session} that contains target user's RBAC {@link User#roles}
and Admin role {@link User#adminRoles}.<br />
-     * In addition to checking user password validity it will apply configured password policy
checks {@link User#pwPolicy}..<br />
-     * Method may also store parms passed in for audit trail {@link org.apache.directory.fortress.core.model.FortEntity}.
-     * <h4> This API will...</h4>
-     * <ul>
-     * <li> authenticate user password if trusted == false.
-     * <li> perform <a href="http://www.openldap.org/">OpenLDAP</a> <a
href="http://tools.ietf.org/html/draft-behera-ldap-password-policy-10">password policy
evaluation</a>.
-     * <li> fail for any user who is locked by OpenLDAP's policies {@link User#isLocked()},
regardless of trusted flag being set as parm on API.
-     * <li> evaluate temporal {@link org.apache.directory.fortress.core.model.Constraint}(s)
on {@link User}, {@link org.apache.directory.fortress.core.model.UserRole} and {@link org.apache.directory.fortress.core.model.UserAdminRole}
entities.
-     * <li> process selective role activations into User RBAC Session {@link User#roles}.
-     * <li> check Dynamic Separation of Duties {@link org.apache.directory.fortress.core.impl.DSDChecker#validate(Session,
org.apache.directory.fortress.core.model.Constraint, org.apache.directory.fortress.core.util.time.Time)}
on {@link User#roles}.
-     * <li> process selective administrative role activations {@link User#adminRoles}.
-     * <li> return a {@link Session} containing {@link Session#getUser()}, {@link Session#getRoles()}
and (if admin user) {@link Session#getAdminRoles()} if everything checks out good.
-     * <li> throw a checked exception that will be {@link org.apache.directory.fortress.core.SecurityException}
or its derivation.
-     * <li> throw a {@link SecurityException} for system failures.
-     * <li> throw a {@link org.apache.directory.fortress.core.PasswordException} for
authentication and password policy violations.
-     * <li> throw a {@link org.apache.directory.fortress.core.ValidationException}
for data validation errors.
-     * <li> throw a {@link org.apache.directory.fortress.core.FinderException} if User
id not found.
-     * </ul>
-     * <h4>
-     * The function is valid if and only if:
-     * </h4>
-     * <ul>
-     * <li> the user is a member of the USERS data set
-     * <li> the password is supplied (unless trusted).
-     * <li> the (optional) active role set is a subset of the roles authorized for
that user.
-     * </ul>
-     * <h4>
-     * The following attributes may be set when calling this method
-     * </h4>
-     * <ul>
-     * <li> {@link User#userId} - required
-     * <li> {@link User#password}
-     * <li> {@link User#roles} contains a list of RBAC role names authorized for user
and targeted for activation within this session.  Default is all authorized RBAC roles will
be activated into this Session.
-     * <li> {@link User#adminRoles} contains a list of Admin role names authorized
for user and targeted for activation.  Default is all authorized ARBAC roles will be activated
into this Session.
-     * <li> {@link User#props} collection of name value pairs collected on behalf of
User during signon.  For example hostname:myservername or ip:192.168.1.99
-     * </ul>
-     * <h4>
-     * Notes:
-     * </h4>
-     * <ul>
-     * <li> roles that violate Dynamic Separation of Duty Relationships will not be
activated into session.
-     * <li> role activations will proceed in same order as supplied to User entity
setter, see {@link User#setRole(String)}.
-     * </ul>
-     * </p>
-     *
-     * @param user Contains {@link User#userId}, {@link User#password} (optional if {@code
isTrusted} is 'true'), optional {@link User#roles}, optional {@link User#adminRoles}
-     * @param isTrusted if true password is not required.
-     * @return Session object will contain authentication result code {@link Session#errorId},
RBAC role activations {@link Session#getRoles()}, Admin Role activations {@link Session#getAdminRoles()},OpenLDAP
pw policy codes {@link Session#warnings}, {@link Session#expirationSeconds}, {@link Session#graceLogins}
and more.
-     * @throws SecurityException in the event of data validation failure, security policy
violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public Session createSession( User user, boolean isTrusted )
@@ -173,18 +116,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * Perform user impl authorization.  This function returns a Boolean value meaning whether
the subject of a given session is
-     * allowed or not to perform a given operation on a given object. The function is valid
if and
-     * only if the session is a valid Fortress session, the object is a member of the OBJS
data set,
-     * and the operation is a member of the OPS data set. The session's subject has the permission
-     * to perform the operation on that object if and only if that permission is assigned
to (at least)
-     * one of the session's active roles. This implementation will verify the roles or userId
correspond
-     * to the subject's active roles are registered in the object's access control list.
-     *
-     * @param perm  must contain the object, {@link org.apache.directory.fortress.core.model.Permission#objName},
and operation, {@link org.apache.directory.fortress.core.model.Permission#opName}, of permission
User is trying to access.
-     * @param session This object must be instantiated by calling {@link AccessMgrImpl#createSession}
method before passing into the method.  No variables need to be set by client after returned
from createSession.
-     * @return True if user has access, false otherwise.
-     * @throws SecurityException in the event of data validation failure, security policy
violation or DAO error.
+     * {@inheritDoc}
      */
     @Override
     public boolean checkAccess( Session session, Permission perm )
@@ -204,12 +136,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * This function returns the permissions of the session, i.e., the permissions assigned
-     * to its authorized roles. The function is valid if and only if the session is a valid
Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @return List<Permission> containing permissions (op, obj) active for user's
session.
-     * @throws SecurityException in the event runtime error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public List<Permission> sessionPermissions( Session session )
@@ -224,13 +151,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * This function returns the active roles associated with a session. The function is
valid if
-     * and only if the session is a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @return List<UserRole> containing all roles active in user's session.  This
will NOT contain inherited roles.
-     * @throws SecurityException
-     *          is thrown if session invalid or system. error.
+     * {@inheritDoc}
      */
     @Override
     public List<UserRole> sessionRoles( Session session )
@@ -245,12 +166,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * This function returns the authorized roles associated with a session based on hierarchical
relationships. The function is valid if
-     * and only if the session is a valid Fortress session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @return Set<String> containing all roles active in user's session.  This will
contain inherited roles.
-     * @throws SecurityException is thrown if session invalid or system. error.
+     * {@inheritDoc}
      */
     @Override
     public Set<String> authorizedRoles( Session session )
@@ -266,22 +182,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * This function adds a role as an active role of a session whose owner is a given user.
-     * <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 ROLES data set
-     * <li> the role inclusion does not violate Dynamic Separation of Duty Relationships
-     * <li> the session is a valid Fortress session
-     * <li> the user is authorized to that role
-     * <li> the session is owned by that user.
-     * </ul>
-     * </p>
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @param role object contains the role name, {@link UserRole#name}, to be activated
into session.
-     * @throws SecurityException is thrown if user is not allowed to activate or runtime
error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public void addActiveRole( Session session, UserRole role )
@@ -326,14 +227,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * This function deletes a role from the active role set of a session owned by a given
user.
-     * The function is valid if and only if the user is a member of the USERS data set, the
-     * session object contains a valid Fortress session, the session is owned by the user,
-     * and the role is an active role of that session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @param role object contains the role name, {@link UserRole#name}, to be deactivated.
-     * @throws SecurityException is thrown if user is not allowed to deactivate or runtime
error occurs with system.
+     * {@inheritDoc}
      */
     @Override
     public void dropActiveRole( Session session, UserRole role )
@@ -361,12 +255,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * This function returns the userId value that is contained within the session object.
-     * The function is valid if and only if the session object contains a valid Fortress
session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @return The userId value
-     * @throws SecurityException is thrown if user session not active or runtime error occurs
with system.
+     * {@inheritDoc}
      */
     @Override
     public String getUserId( Session session )
@@ -378,52 +267,7 @@ public class AccessMgrImpl extends Manageable implements AccessMgr
 
 
     /**
-     * This function returns the user object that is contained within the session object.
-     * The function is valid if and only if the session object contains a valid Fortress
session.
-     *
-     * @param session object contains the user's returned RBAC session from the createSession
method.
-     * @return The user value
-     *         Sample User data contained in Session object:
-     *         <ul> <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>
-     *         </ul>
-     *         </ul>
-     *         </ul>
-     * @throws SecurityException is thrown if user session not active or runtime error occurs
with system.
+     * {@inheritDoc}
      */
     @Override
     public User getUser( Session session )


Mime
View raw message