commit 7a897ca2f283f68742c759b1918cd6cb7dfe3152

Author: Boris Shkolnik <borya@yahoo-inc.com>
Date:   Wed May 5 09:15:13 2010 -0700

    HADOOP:6745 from https://issues.apache.org/jira/secure/attachment/12443726/HADOOP-6745-BP20-2.patch
    
    +++ b/YAHOO-CHANGES.txt
    +    HADOOP-6745. adding some java doc to Server.RpcMetrics, UGI (boryas)
    +


git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/branches/branch-0.20-security-patches@1077441 13f79535-47bb-0310-9956-ffa450edef68

src/core/org/apache/hadoop/ipc/Server.java

@@ -238,7 +238,10 @@ public abstract class Server {
     }
   }
   
-  /*Returns a handle to the rpcMetrics (required in tests)*/
+  /**
+   * Returns a handle to the rpcMetrics (required in tests)
+   * @return rpc metrics
+   */
   public RpcMetrics getRpcMetrics() {
     return rpcMetrics;
   }

src/core/org/apache/hadoop/ipc/metrics/RpcMetrics.java

@@ -74,26 +74,57 @@ public class RpcMetrics implements Updater {
    *  -they can also be read directly - e.g. JMX does this.
    */
 
+  /**
+   * metrics - number of bytes received
+   */
   public final MetricsTimeVaryingLong receivedBytes = 
          new MetricsTimeVaryingLong("ReceivedBytes", registry);
+  /**
+   * metrics - number of bytes sent
+   */
   public final MetricsTimeVaryingLong sentBytes = 
          new MetricsTimeVaryingLong("SentBytes", registry);
+  /**
+   * metrics - rpc queue time
+   */
   public final MetricsTimeVaryingRate rpcQueueTime =
           new MetricsTimeVaryingRate("RpcQueueTime", registry);
-  public MetricsTimeVaryingRate rpcProcessingTime =
+  /**
+   * metrics - rpc processing time
+   */
+  public final MetricsTimeVaryingRate rpcProcessingTime =
           new MetricsTimeVaryingRate("RpcProcessingTime", registry);
+  /**
+   * metrics - number of open connections
+   */
   public final MetricsIntValue numOpenConnections = 
           new MetricsIntValue("NumOpenConnections", registry);
+  /**
+   * metrics - length of the queue
+   */
   public final MetricsIntValue callQueueLen = 
           new MetricsIntValue("callQueueLen", registry);
+  /**
+   * metrics - number of failed authentications
+   */
   public final MetricsTimeVaryingInt authenticationFailures = 
           new MetricsTimeVaryingInt("rpcAuthenticationFailures", registry);
+  /**
+   * metrics - number of successful authentications
+   */
   public final MetricsTimeVaryingInt authenticationSuccesses = 
           new MetricsTimeVaryingInt("rpcAuthenticationSuccesses", registry);
+  /**
+   * metrics - number of failed authorizations
+   */
   public final MetricsTimeVaryingInt authorizationFailures = 
           new MetricsTimeVaryingInt("rpcAuthorizationFailures", registry);
+  /**
+   * metrics - number of successful authorizations
+   */
   public final MetricsTimeVaryingInt authorizationSuccesses = 
          new MetricsTimeVaryingInt("rpcAuthorizationSuccesses", registry);
+  
   /**
    * Push the metrics to the monitoring subsystem on doUpdate() call.
    */
@@ -111,6 +142,9 @@ public class RpcMetrics implements Updater {
     metricsRecord.update();
   }
 
+  /**
+   * shutdown the metrics
+   */
   public void shutdown() {
     if (rpcMBean != null) 
       rpcMBean.shutdown();

src/core/org/apache/hadoop/security/UserGroupInformation.java

@@ -761,6 +761,9 @@ public class UserGroupInformation {
     return result;
   }
 
+  /**
+   * existing types of authentications' methods
+   */
   public static enum AuthenticationMethod {
     SIMPLE,
     KERBEROS,
@@ -770,7 +773,8 @@ public class UserGroupInformation {
     PROXY;
   }
 
-  /* Create a proxy user using username of the effective user and the ugi of the
+  /**
+   * Create a proxy user using username of the effective user and the ugi of the
    * real user.
    *
    * @param effective
@@ -794,6 +798,10 @@ public class UserGroupInformation {
     return result;
   }
 
+  /**
+   * get RealUser (vs. EffectiveUser)
+   * @return realUser running over proxy user
+   */
   public UserGroupInformation getRealUser() {
     for (RealUser p: subject.getPrincipals(RealUser.class)) {
       return p.getRealUser();