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/03/25 16:25:54 UTC
directory-fortress-core git commit: FC-84 - Add console and cli doc
Repository: directory-fortress-core
Updated Branches:
refs/heads/master 2d6e1e9f2 -> c3a2ae412
FC-84 - Add console and cli doc
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/c3a2ae41
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/c3a2ae41
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/c3a2ae41
Branch: refs/heads/master
Commit: c3a2ae412a4f1430ff5a8565ef2feabc2ac5ec79
Parents: 2d6e1e9
Author: Shawn McKinney <sm...@apache.org>
Authored: Wed Mar 25 10:25:41 2015 -0500
Committer: Shawn McKinney <sm...@apache.org>
Committed: Wed Mar 25 10:25:41 2015 -0500
----------------------------------------------------------------------
.../core/doc-files/apache-fortress-core.html | 31 +++++++++++++++++--
.../screenshot-fortress-console-rbac-access.png | Bin 0 -> 62716 bytes
.../screenshot-fortress-console-rbac-admin.png | Bin 0 -> 111410 bytes
.../screenshot-fortress-console-rbac-review.png | Bin 0 -> 56791 bytes
.../screenshot-fortress-console-review.png | Bin 0 -> 58782 bytes
.../fortress/core/ProcessMenuCommand.java | 14 ++++-----
6 files changed, 36 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/c3a2ae41/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
index 0ec3798..c92a170 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
@@ -170,6 +170,8 @@ mvn -Dtest=FortressJUnitTest test
Tests should run with no errors.
</li>
+ <br>
+
<li>
Run the Fortress Command Line Interface:
<pre>
@@ -177,13 +179,13 @@ mvn -Dtest=FortressJUnitTest test
mvn -Pcli test
</p>
</pre>
-For instructions on how to use CLI, point your browser here:
+ This program provides a command line interface for driving the fortress APIs. It is useful for ad-hoc and automated updates to the data. It's instruction manual can be found inside fortress javadoc, point your browser here:
<br>file:///[directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/cli/package-summary.html.
<br><br>Where [directory-fortress-core] is base folder of the fortress core source package.
</li>
<br>
-
+
<li>
Run the Fortress Console:
<pre>
@@ -191,6 +193,31 @@ For instructions on how to use CLI, point your browser here:
mvn -Pconsole test
</p>
</pre>
+ This program provides an interfactive console for driving the fortress functions. It is useful for testing and ad-hoc updates to the data.
+ <br><br>
+ <ol type="a">
+ <li>Start at the Main Menu:
+ <br><img src="./screenshot-fortress-console-main.png" height="50%" width="40%"/>
+ <br>Enter option to perform a particular manager function.
+ </li>
+ <br>
+ <li>Option '1' for RBAC Admin Manager Functions:
+ <br><img src="./screenshot-fortress-console-rbac-admin.png" height="50%" width="25%"/>
+ <br>Add, Update and Delete RBAC entities.
+ </li>
+ <br>
+ <li>Option '2' for RBAC Review Manager Functions:
+ <br><img src="./screenshot-fortress-console-rbac-review.png" height="50%" width="35%"/>
+ <br>Read and Search RBAC entities.
+ </li>
+ <br>
+ <li>Option '3' for RBAC Access Manager Functions:
+ <br><img src="./screenshot-fortress-console-rbac-access.png" height="50%" width="35%"/>
+ <br>Test RBAC runtime functions like createSession and checkAccess.
+ </li>
+ <br>
+ <li>etc</li>
+ </ol>
</li>
</ol>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/c3a2ae41/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-access.png
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-access.png b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-access.png
new file mode 100644
index 0000000..67c03b5
Binary files /dev/null and b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-access.png differ
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/c3a2ae41/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-admin.png
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-admin.png b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-admin.png
new file mode 100644
index 0000000..bc29875
Binary files /dev/null and b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-admin.png differ
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/c3a2ae41/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-review.png
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-review.png b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-review.png
new file mode 100644
index 0000000..21ebbc4
Binary files /dev/null and b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-rbac-review.png differ
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/c3a2ae41/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-review.png
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-review.png b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-review.png
new file mode 100644
index 0000000..71d5bbf
Binary files /dev/null and b/src/main/java/org/apache/directory/fortress/core/doc-files/screenshot-fortress-console-review.png differ
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/c3a2ae41/src/test/java/org/apache/directory/fortress/core/ProcessMenuCommand.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/directory/fortress/core/ProcessMenuCommand.java b/src/test/java/org/apache/directory/fortress/core/ProcessMenuCommand.java
index ab87d35..8bd4b08 100755
--- a/src/test/java/org/apache/directory/fortress/core/ProcessMenuCommand.java
+++ b/src/test/java/org/apache/directory/fortress/core/ProcessMenuCommand.java
@@ -53,18 +53,18 @@ class ProcessMenuCommand
{
ReaderUtil.clearScreen();
System.out.println( "CHOOSE FUNCTION:" );
- System.out.println( "1. ADMIN MANAGER" );
- System.out.println( "2. REVIEW MANAGER" );
- System.out.println( "3. ACCESS MANAGER" );
- System.out.println( "4. DELEGATED ADMIN MANAGER" );
- System.out.println( "5. DELEGATED REVIEW MANAGER" );
- System.out.println( "6. DELEGATED ACCESS MANAGER" );
+ System.out.println( "1. RBAC ADMIN MANAGER" );
+ System.out.println( "2. RBAC REVIEW MANAGER" );
+ System.out.println( "3. RBAC ACCESS MANAGER" );
+ System.out.println( "4. ARBAC ADMIN MANAGER" );
+ System.out.println( "5. ARBAC REVIEW MANAGER" );
+ System.out.println( "6. ARBAC ACCESS MANAGER" );
System.out.println( "7. PASSWORD POLICY MANAGER" );
System.out.println( "8. AUDIT MANAGER" );
System.out.println( "9. CONFIG MANAGER" );
System.out.println( "A. ENCRYPTION MANAGER" );
System.out.println( "B. GROUP MANAGER" );
- System.out.println( "C. ACCEL MANAGER" );
+ System.out.println( "C. RBAC ACCELERATOR MANAGER" );
System.out.println( "Enter q or Q to quit" );
}