You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2015/02/19 17:58:27 UTC
directory-fortress-core git commit: FC-73 - java 8,
turn javadoc lint off
Repository: directory-fortress-core
Updated Branches:
refs/heads/master c58ad94e3 -> f0d1fec5f
FC-73 - java 8, turn javadoc lint off
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/f0d1fec5
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/f0d1fec5
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/f0d1fec5
Branch: refs/heads/master
Commit: f0d1fec5fde26b77b465617ffe0fd639615f1b3c
Parents: c58ad94
Author: Shawn McKinney <sm...@apache.org>
Authored: Thu Feb 19 10:58:12 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Thu Feb 19 10:58:12 2015 -0600
----------------------------------------------------------------------
README-TEN-MINUTE-GUIDE.txt | 2 +-
pom.xml | 1 +
.../apache/directory/fortress/core/AccelMgr.java | 17 +++++++++++------
.../apache/directory/fortress/core/AccessMgr.java | 3 +--
.../fortress/core/doc-files/ten-minute-guide.html | 2 +-
5 files changed, 15 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f0d1fec5/README-TEN-MINUTE-GUIDE.txt
----------------------------------------------------------------------
diff --git a/README-TEN-MINUTE-GUIDE.txt b/README-TEN-MINUTE-GUIDE.txt
index 27148c6..825e191 100644
--- a/README-TEN-MINUTE-GUIDE.txt
+++ b/README-TEN-MINUTE-GUIDE.txt
@@ -36,7 +36,7 @@ ________________________________________________________________________________
3. Git installed to target machine.
-4. Java SDK Version 7 sdk installed to target machine.
+4. Java SDK Version 7 (or beyond) sdk installed to target machine.
5. Apache Maven 3 installed to target machine.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f0d1fec5/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 0820d14..badd06f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -607,6 +607,7 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>${javadoc.version}</version>
<configuration>
+ <additionalparam>-Xdoclint:none</additionalparam>
<stylesheet>java</stylesheet>
<bottom><small>Copyright &copy; 2003-2015, The Apache Software Foundation. All Rights Reserved. Generated ${maven.build.timestamp}</small></bottom>
<overview>src/main/java/org/apache/directory/fortress/core/overview.html</overview>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f0d1fec5/src/main/java/org/apache/directory/fortress/core/AccelMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/AccelMgr.java b/src/main/java/org/apache/directory/fortress/core/AccelMgr.java
index e6fc343..3d401a2 100644
--- a/src/main/java/org/apache/directory/fortress/core/AccelMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/AccelMgr.java
@@ -65,12 +65,17 @@ public interface AccelMgr extends Manageable
{
/**
- * Perform user authentication {@link User#password} and role activations.<br />
+ * 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 org.apache.directory.fortress.core.rbac.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 org.apache.directory.fortress.core.rbac.User#pwPolicy}..<br />
+ * The successful result is {@link org.apache.directory.fortress.core.rbac.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 org.apache.directory.fortress.core.rbac.User#pwPolicy}.
+ * <br>
* Method may also store parms passed in for audit trail {@link org.apache.directory.fortress.core.rbac.FortEntity}.
- * <h4> This API will...</h4>
+ * <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>.
@@ -112,7 +117,7 @@ public interface AccelMgr extends Manageable
* <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>
+ * <p>
*
* @param user Contains {@link User#userId}, {@link org.apache.directory.fortress.core.rbac.User#password} (optional if {@code isTrusted} is 'true'), optional {@link User#roles}, optional {@link org.apache.directory.fortress.core.rbac.User#adminRoles}
* @param isTrusted if true password is not required.
@@ -139,7 +144,7 @@ public interface AccelMgr extends Manageable
* 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.
+ * @return list containing all roles active in user's session. This will NOT contain inherited roles.
* @throws SecurityException is thrown if session invalid or system. error.
*/
public List<UserRole> sessionRoles(Session session)
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f0d1fec5/src/main/java/org/apache/directory/fortress/core/AccessMgr.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/AccessMgr.java b/src/main/java/org/apache/directory/fortress/core/AccessMgr.java
index b39105d..85b9575 100755
--- a/src/main/java/org/apache/directory/fortress/core/AccessMgr.java
+++ b/src/main/java/org/apache/directory/fortress/core/AccessMgr.java
@@ -66,8 +66,7 @@ public interface AccessMgr extends Manageable
{
/**
- * Perform user authentication only. It does not activate RBAC roles in session but will evaluate
- * password policies.
+ * 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.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f0d1fec5/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
index c27b2db..9f510fb 100644
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
@@ -51,7 +51,7 @@
These items are required and must be installed to target machine before any of these tutorial steps. Instructions cover Debian and Fedora system syntax.
Fortress is written in Java, runs on various platforms, but the others are not be covered here.
<ol type="1">
- <li>Java 7 sdk installed.</li>
+ <li>Java 7 (or greater) sdk installed.</li>
<li><a href="http://git-scm.com/download/linux">Git Download for Linux and Unix</a></li>
<li><a href="http://maven.apache.org/">Apache Maven 3</a></li>
<li><a href="https://www.mozilla.org/en-GB/firefox/new/">Firefox Web Browser</a></li>