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 2017/07/17 23:28:15 UTC

directory-fortress-commander git commit: a bit of javadoc

Repository: directory-fortress-commander
Updated Branches:
  refs/heads/master 869d773b8 -> b22a8159b


a bit of javadoc


Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/commit/b22a8159
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/tree/b22a8159
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/diff/b22a8159

Branch: refs/heads/master
Commit: b22a8159bf8a5e5c90e1e4f0e9e114f19bf77a13
Parents: 869d773
Author: Shawn McKinney <sm...@apache.org>
Authored: Mon Jul 17 18:28:09 2017 -0500
Committer: Shawn McKinney <sm...@apache.org>
Committed: Mon Jul 17 18:28:09 2017 -0500

----------------------------------------------------------------------
 .../directory/fortress/web/FortressWebBasePage.java       | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/blob/b22a8159/src/main/java/org/apache/directory/fortress/web/FortressWebBasePage.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/web/FortressWebBasePage.java b/src/main/java/org/apache/directory/fortress/web/FortressWebBasePage.java
index 59438a1..ecc7a14 100644
--- a/src/main/java/org/apache/directory/fortress/web/FortressWebBasePage.java
+++ b/src/main/java/org/apache/directory/fortress/web/FortressWebBasePage.java
@@ -42,7 +42,7 @@ import java.security.Principal;
 
 
 /**
- * Base class for Commander Web.  This class initializes Fortress RBAC context and so contains a synchronized block.
+ * This base class is extended by all pages in the fortress web.  It contains the security session and links for user.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$
@@ -61,6 +61,9 @@ public abstract class FortressWebBasePage extends WebPage
     private static final Logger LOG = Logger.getLogger( CLS_NM );
 
 
+    /**
+     * Default constructor puts page links onto the page, gets or initializes the user's fortress rbac session, and loads it into the wicket session.
+     */
     public FortressWebBasePage()
     {
         // Build the title bar string.
@@ -221,6 +224,11 @@ public abstract class FortressWebBasePage extends WebPage
     }
 
 
+    /**
+     * Return true if the fortress session is cached within the wicket session object.
+     *
+     * @return true if logged in, false otherwise.
+     */
     private boolean isLoggedIn()
     {
         boolean isLoggedIn = false;