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/06/09 05:16:08 UTC
[62/75] [abbrv] directory-fortress-core git commit: javadoc cleanup
javadoc cleanup
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/f88771a0
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/f88771a0
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/f88771a0
Branch: refs/heads/master
Commit: f88771a096bb7e96372989c29e91635dd64f49c1
Parents: 0e2f389
Author: Shawn McKinney <sm...@apache.org>
Authored: Wed Jun 3 19:53:43 2015 -0500
Committer: Shawn McKinney <sm...@apache.org>
Committed: Wed Jun 3 19:53:43 2015 -0500
----------------------------------------------------------------------
.../directory/fortress/core/impl/package.html | 23 ++++++----
.../fortress/core/model/Permission.java | 2 +-
.../directory/fortress/core/model/package.html | 45 ++++++++++++++++++++
3 files changed, 61 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f88771a0/src/main/java/org/apache/directory/fortress/core/impl/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/impl/package.html b/src/main/java/org/apache/directory/fortress/core/impl/package.html
index f8b2212..800129a 100755
--- a/src/main/java/org/apache/directory/fortress/core/impl/package.html
+++ b/src/main/java/org/apache/directory/fortress/core/impl/package.html
@@ -22,19 +22,26 @@
<title>Package Documentation for org.apache.directory.fortress.core.impl</title>
</head>
<body>
+ <p>
+ This package contains the fortress implementation classes for data persistence with the LDAP server.
+ This package contain the classes that are the three layers of processing of fortress:
+ (1) Manager layer - e.g. AdminMgrImpl, AccessMgrImpl, ReviewMgrImpl
+ (2) Process layer - e.g. UserP, RoleP, PermP
+ (3) DAO layer - e.g. UserDAO, RoleDAO, PermDAO
+ </p>
<p>
<ol>
- <li>This package provides data entities and apis that adhere to standards like <a href="http://csrc.nist.gov/groups/SNS/rbac/documents/draft-rbac-implementation-std-v01.pdf">RBAC</a></li>
- <li>This package provides data entities and APIs that adhere to <a href="http://profsandhu.com/journals/tissec/p113-oh.pdf">ARBAC02</a> model to provide delegated administration capabilities.</li>
- <li>This package provides data entities and APIs to interrogate <a href="http://openldap.org/">OpenLDAP</a>'s slapd access log to obtain fortress audit trail and historical events.</li>
- <li>This package provides CRUD APIs for storing config data on the ldap server.</li>
- <li>This package contains APIs to perform create and teardown the ldap group node.</li>
+ <li>This package provides apis that adhere to standards like <a href="http://csrc.nist.gov/groups/SNS/rbac/documents/draft-rbac-implementation-std-v01.pdf">RBAC</a></li>
+ <li>This package provides apis that adhere to <a href="http://profsandhu.com/journals/tissec/p113-oh.pdf">ARBAC02</a> model to provide delegated administration capabilities.</li>
+ <li>This package provides apis to interrogate <a href="http://openldap.org/">OpenLDAP</a>'s slapd access log to obtain fortress audit trail and historical events.</li>
+ <li>This package provides CRUD apis for storing config data on the ldap server.</li>
+ <li>This package contains apis to perform create and teardown the ldap group node.</li>
<li>This package uses <a href="http://www.jgrapht.org/">JGraphT</a> to provide hierarchical functionality that is reused within several other packages in the fortress system.</li>
</ol>
</p>
<p>
The <b>org.apache.directory.fortress.core.impl</b> package data entities may be manipulated by outside
- programs but the apis contained within this package are for fortress use only.
+ programs but the apis contained within this package are for internal use only.
The entities include {@link org.apache.directory.fortress.core.model.User User},{@link org.apache.directory.fortress.core.model.Role Role}, {@link org.apache.directory.fortress.core.model.PermObj PermObj}, {@link org.apache.directory.fortress.core.model.Permission Permission}, and more.
See the corresponding javadoc contained with this package for more info.
</p>
@@ -48,8 +55,8 @@
<li><a href="DelegatedReviewMgrImpl.html">DelegatedReviewMgrImpl</a> - This implements using LDAP the <a href="http://profsandhu.com/journals/tissec/p113-oh.pdf">ARBAC02</a> DelegatedReviewMgr interface for performing policy interrogation of provisioned Fortress ARBAC02 entities that reside in LDAP directory.</li>
<li><a href="PwPolicyMgrImpl.html">PwPolicyMgrImpl</a> - Performs CRUD on OpenLDAP password policies stored in directory.</li>
<li><a href="AuditMgrImpl.html">AuditMgrImpl</a> - Interrogates Fortress audit data stored in OpenLDAP.</li>
- <li><a href="ConfigMgrImpl.html">ConfigMgrImpl</a> - CRUD for Fortress config objects.</li>
- <li><a href="GroupMgrImpl.html">GroupMgrImpl</a> - CRUD for LDAP group objects..</li>
+ <li><a href="ConfigMgrImpl.html">ConfigMgrImpl</a> - CRUD for Fortress config parameters.</li>
+ <li><a href="GroupMgrImpl.html">GroupMgrImpl</a> - CRUD for LDAP group objects.</li>
</ol>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f88771a0/src/main/java/org/apache/directory/fortress/core/model/Permission.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/Permission.java b/src/main/java/org/apache/directory/fortress/core/model/Permission.java
index 90f37e7..cb56a6c 100755
--- a/src/main/java/org/apache/directory/fortress/core/model/Permission.java
+++ b/src/main/java/org/apache/directory/fortress/core/model/Permission.java
@@ -55,7 +55,7 @@ import javax.xml.bind.annotation.XmlType;
* All entities ({@link User}, {@link Role}, {@link Permission},
* {@link PwPolicy} {@link SDSet} etc...) are used to carry data between three Fortress
* layers.starting with the (1) Manager layer down thru middle (2) Process layer and it's processing rules into
- * (3) DAO layer where persistence with the OpenLDAP server occurs.
+ * (3) DAO layer where persistence with the LDAP server occurs.
* <h4>Fortress Processing Layers</h4>
* <ol>
* <li>Manager layer: {@link org.apache.directory.fortress.core.impl.AdminMgrImpl}, {@link org.apache.directory.fortress.core.impl.AccessMgrImpl}, {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl},...</li>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/f88771a0/src/main/java/org/apache/directory/fortress/core/model/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/model/package.html b/src/main/java/org/apache/directory/fortress/core/model/package.html
new file mode 100755
index 0000000..f430ae7
--- /dev/null
+++ b/src/main/java/org/apache/directory/fortress/core/model/package.html
@@ -0,0 +1,45 @@
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+-->
+<html>
+ <head>
+ <title>Package Documentation for org.apache.directory.fortress.model</title>
+ </head>
+ <body>
+ <p>
+ The data entities in this package comprise the fortress data model. These classes are intended to be accessible publicly using the getter and setters methods on them.
+ All entities ({@link User}, {@link Role}, {@link Permission},
+ {@link PwPolicy} {@link SDSet} etc...) are used to carry data between three Fortress layers:
+ (1) Manager layer - e.g. AdminMgrImpl, AccessMgrImpl, ReviewMgrImpl
+ (2) Process layer - e.g. UserP, RoleP, PermP
+ (3) DAO layer - e.g. UserDAO, RoleDAO, PermDAO
+ </p>
+ <p>
+ This entities in this package...
+ <ol>
+ <li>adhere to standards like <a href="http://csrc.nist.gov/groups/SNS/rbac/documents/draft-rbac-implementation-std-v01.pdf">RBAC</a></li>
+ <li>adhere to <a href="http://profsandhu.com/journals/tissec/p113-oh.pdf">ARBAC02</a> model to provide delegated administration capabilities.</li>
+ <li>adhere to <a href="http://openldap.org/">OpenLDAP</a>'s slapd access log to obtain fortress audit trail and historical events.</li>
+ <li>represent fortress configuration parameter data to be stored on the ldap server.</li>
+ <li>can be used for LDAP groups.</li>
+ <li>use <a href="http://www.jgrapht.org/">JGraphT</a> to provide hierarchical functionality that is reused within several other packages in the fortress system.</li>
+ </ol>
+ </p>
+ </body>
+</html>