You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by jg...@apache.org on 2010/07/28 02:56:50 UTC
svn commit: r979919 - in /hadoop/common/trunk: CHANGES.txt
src/java/org/apache/hadoop/ipc/Server.java
src/java/org/apache/hadoop/ipc/metrics/RpcMetrics.java
src/java/org/apache/hadoop/security/UserGroupInformation.java
Author: jghoman
Date: Wed Jul 28 00:56:50 2010
New Revision: 979919
URL: http://svn.apache.org/viewvc?rev=979919&view=rev
Log:
HADOOP-6475. Adding some javadoc to Server.RpcMetrics, UGI. Contributed by Jitendra Pandey and borya.
Modified:
hadoop/common/trunk/CHANGES.txt
hadoop/common/trunk/src/java/org/apache/hadoop/ipc/Server.java
hadoop/common/trunk/src/java/org/apache/hadoop/ipc/metrics/RpcMetrics.java
hadoop/common/trunk/src/java/org/apache/hadoop/security/UserGroupInformation.java
Modified: hadoop/common/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/CHANGES.txt?rev=979919&r1=979918&r2=979919&view=diff
==============================================================================
--- hadoop/common/trunk/CHANGES.txt (original)
+++ hadoop/common/trunk/CHANGES.txt Wed Jul 28 00:56:50 2010
@@ -85,6 +85,9 @@ Trunk (unreleased changes)
HADOOP-6877. Common part of HDFS-1178 (NameNode servlets should communicate
with NameNode directrly). (Kan Zhang via jghoman)
+
+ HADOOP-6475. Adding some javadoc to Server.RpcMetrics, UGI.
+ (Jitendra Pandey and borya via jghoman)
OPTIMIZATIONS
Modified: hadoop/common/trunk/src/java/org/apache/hadoop/ipc/Server.java
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/src/java/org/apache/hadoop/ipc/Server.java?rev=979919&r1=979918&r2=979919&view=diff
==============================================================================
--- hadoop/common/trunk/src/java/org/apache/hadoop/ipc/Server.java (original)
+++ hadoop/common/trunk/src/java/org/apache/hadoop/ipc/Server.java Wed Jul 28 00:56:50 2010
@@ -231,7 +231,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;
}
Modified: hadoop/common/trunk/src/java/org/apache/hadoop/ipc/metrics/RpcMetrics.java
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/src/java/org/apache/hadoop/ipc/metrics/RpcMetrics.java?rev=979919&r1=979918&r2=979919&view=diff
==============================================================================
--- hadoop/common/trunk/src/java/org/apache/hadoop/ipc/metrics/RpcMetrics.java (original)
+++ hadoop/common/trunk/src/java/org/apache/hadoop/ipc/metrics/RpcMetrics.java Wed Jul 28 00:56:50 2010
@@ -76,26 +76,57 @@ public class RpcMetrics implements Updat
* -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.
*/
@@ -113,6 +144,9 @@ public class RpcMetrics implements Updat
metricsRecord.update();
}
+ /**
+ * shutdown the metrics
+ */
public void shutdown() {
if (rpcMBean != null)
rpcMBean.shutdown();
Modified: hadoop/common/trunk/src/java/org/apache/hadoop/security/UserGroupInformation.java
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/src/java/org/apache/hadoop/security/UserGroupInformation.java?rev=979919&r1=979918&r2=979919&view=diff
==============================================================================
--- hadoop/common/trunk/src/java/org/apache/hadoop/security/UserGroupInformation.java (original)
+++ hadoop/common/trunk/src/java/org/apache/hadoop/security/UserGroupInformation.java Wed Jul 28 00:56:50 2010
@@ -556,6 +556,9 @@ public class UserGroupInformation {
return new UserGroupInformation(subject);
}
+ /**
+ * existing types of authentications' methods
+ */
@InterfaceStability.Evolving
public static enum AuthenticationMethod {
SIMPLE,
@@ -566,7 +569,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
@@ -587,6 +591,10 @@ public class UserGroupInformation {
return new UserGroupInformation(subject);
}
+ /**
+ * get RealUser (vs. EffectiveUser)
+ * @return realUser running over proxy user
+ */
public UserGroupInformation getRealUser() {
for (RealUser p: subject.getPrincipals(RealUser.class)) {
return p.getRealUser();