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/12 15:18:48 UTC

directory-fortress-realm git commit: proxy javadoc notes

Repository: directory-fortress-realm
Updated Branches:
  refs/heads/master ba0fa63cf -> 534ef355f


proxy javadoc notes


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

Branch: refs/heads/master
Commit: 534ef355f6c49a10ca57f3a4526455ff5664195c
Parents: ba0fa63
Author: Shawn McKinney <sm...@apache.org>
Authored: Tue Jul 11 22:53:33 2017 -0500
Committer: Shawn McKinney <sm...@apache.org>
Committed: Tue Jul 11 22:53:33 2017 -0500

----------------------------------------------------------------------
 .../fortress/realm/tomcat/Tc7AccessMgrProxy.java       | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-realm/blob/534ef355/proxy/src/main/java/org/apache/directory/fortress/realm/tomcat/Tc7AccessMgrProxy.java
----------------------------------------------------------------------
diff --git a/proxy/src/main/java/org/apache/directory/fortress/realm/tomcat/Tc7AccessMgrProxy.java b/proxy/src/main/java/org/apache/directory/fortress/realm/tomcat/Tc7AccessMgrProxy.java
index 4c575e6..97a133d 100644
--- a/proxy/src/main/java/org/apache/directory/fortress/realm/tomcat/Tc7AccessMgrProxy.java
+++ b/proxy/src/main/java/org/apache/directory/fortress/realm/tomcat/Tc7AccessMgrProxy.java
@@ -32,15 +32,22 @@ import java.util.logging.Logger;
 import org.apache.directory.fortress.realm.util.ChildFirstUrlClassLoader;
 
 /**
- * This class extends the Tomcat 7 and beyond RealmBase class and provides Java EE security services within the Tomcat container.
- * This class is a "proxy" for the {@link org.apache.directory.fortress.realm.tomcat.TcAccessMgrImpl} class which isolates dependencies from the Tomcat
- * runtime environment by loading the implementation on a URLClassLoader.
+ *
+ * This class...
+ * <ul>
+ *   <li>extends the Tomcat 7 and beyond RealmBase class and provides Java EE security services within the Tomcat container.</li>
+ *   <li>loads into a jar that is placed directly on Tomcat's system classpath, it must have no dependencies on other 3rd party jars.</li>
+ *   <li>is a "proxy" for the {@link org.apache.directory.fortress.realm.tomcat.TcAccessMgrImpl} class which isolates dependencies from the Tomcat runtime environment by loading the implementation on a URLClassLoader.</li>
+ *   <li>accesses the runtime impl via instantiation into URL classloader.</li>
+ *   <li>runtime implementation classes reside inside .war for corresponding application.</li>
+ * </ul>
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</ga>
  */
 public class Tc7AccessMgrProxy extends RealmBase
 {
     private static final String CLS_NM = Tc7AccessMgrProxy.class.getName();
+    // Do not change from Java's native logger in order to keep Tomcat's system classpath free of additional dependencies.
     private static final Logger LOG = Logger.getLogger( CLS_NM );
     private static final String REALM_IMPL = "org.apache.directory.fortress.realm.tomcat.TcAccessMgrImpl";
     private static final String REALM_CLASSPATH = "REALM_CLASSPATH";