svn commit: r1647785 - /portals/jetspeed-2/applications/j2-admin/trunk/src/main/java/org/apache/jetspeed/portlets/sso/SSOReverseProxyServlet.java

Author: woonsan
Date: Wed Dec 24 13:49:21 2014
New Revision: 1647785

URL: http://svn.apache.org/r1647785
Log:
APA-67: adding javadoc

Modified:
    portals/jetspeed-2/applications/j2-admin/trunk/src/main/java/org/apache/jetspeed/portlets/sso/SSOReverseProxyServlet.java

Modified: portals/jetspeed-2/applications/j2-admin/trunk/src/main/java/org/apache/jetspeed/portlets/sso/SSOReverseProxyServlet.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/applications/j2-admin/trunk/src/main/java/org/apache/jetspeed/portlets/sso/SSOReverseProxyServlet.java?rev=1647785&r1=1647784&r2=1647785&view=diff
==============================================================================
--- portals/jetspeed-2/applications/j2-admin/trunk/src/main/java/org/apache/jetspeed/portlets/sso/SSOReverseProxyServlet.java (original)
+++ portals/jetspeed-2/applications/j2-admin/trunk/src/main/java/org/apache/jetspeed/portlets/sso/SSOReverseProxyServlet.java Wed Dec 24 13:49:21 2014
@@ -19,20 +19,39 @@ package org.apache.jetspeed.portlets.sso
 import javax.servlet.ServletConfig;
 import javax.servlet.ServletException;
 
+import org.apache.portals.applications.webcontent2.proxy.HttpClientContextBuilder;
 import org.apache.portals.applications.webcontent2.proxy.command.InitHttpRequestCommand;
 import org.apache.portals.applications.webcontent2.proxy.impl.ProxyProcessingChain;
 import org.apache.portals.applications.webcontent2.proxy.servlet.SimpleReverseProxyServlet;
 
+/**
+ * Extending {@link SimpleReverseProxyServlet} in order to replace the default initializing command
+ * by a custom initializing command, {@link SSOInitHttpRequestCommand}, which can read
+ * Jetspeed SSO Site credentials.
+ * Also, this class customizes the default {@link HttpClientContextBuilder} by a custom one,
+ * {@link JetspeedHttpClientContextBuilder}, in order to build custom authentication states
+ * based on the Jetspeed SSO Site credentials.
+ */
 public class SSOReverseProxyServlet extends SimpleReverseProxyServlet
 {
 
     private static final long serialVersionUID = 1L;
 
+    /**
+     * Zero-argument default constructor.
+     */
     public SSOReverseProxyServlet()
     {
         super();
     }
 
+    /**
+     * {@inheritDoc}
+     * <p>
+     * Also, it sets a custom {@link HttpClientContextBuilder}, {@link JetspeedHttpClientContextBuilder},
+     * in order to build custom authentication states based on the Jetspeed SSO Site credentials.
+     * </p>
+     */
     @Override
     public void init(ServletConfig servletConfig) throws ServletException
     {
@@ -40,6 +59,13 @@ public class SSOReverseProxyServlet exte
         super.init(servletConfig);
     }
 
+    /**
+     * {@inheritDoc}
+     * <p>
+     * Also, it replaces the default initializing command by a custom initializing command,
+     * {@link SSOInitHttpRequestCommand}, which can read Jetspeed SSO Site credentials.
+     * </p>
+     */
     @Override
     protected ProxyProcessingChain createProxyServiceCommand() {
         ProxyProcessingChain proxyChain = super.createProxyServiceCommand();