From dd696f3a3d04f5e3b453173c0d4e86690f6bcb1b Mon Sep 17 00:00:00 2001
From: Patrick Wendell <pwendell@gmail.com>
Date: Thu, 20 Jun 2013 23:20:56 -0700
Subject: [PATCH] Some renaming and comments

---
 .../scala/spark/deploy/master/MasterWebUI.scala    | 14 +++++++-------
 .../scala/spark/deploy/worker/WorkerWebUI.scala    |  6 +++---
 .../spark/ui/{JettyUI.scala => JettyUtils.scala}   |  4 +++-
 core/src/main/scala/spark/ui/SparkUI.scala         |  6 +++---
 .../main/scala/spark/ui/jobs/JobProgressUI.scala   |  2 +-
 .../scala/spark/ui/storage/BlockManagerUI.scala    |  6 ++++--
 .../main/scala/spark/ui/storage/IndexPage.scala    |  6 ++++--
 7 files changed, 25 insertions(+), 19 deletions(-)
 rename core/src/main/scala/spark/ui/{JettyUI.scala => JettyUtils.scala} (97%)

diff --git a/core/src/main/scala/spark/deploy/master/MasterWebUI.scala b/core/src/main/scala/spark/deploy/master/MasterWebUI.scala
index 1ec5f77bd7..3238661127 100644
--- a/core/src/main/scala/spark/deploy/master/MasterWebUI.scala
+++ b/core/src/main/scala/spark/deploy/master/MasterWebUI.scala
@@ -10,11 +10,11 @@ import net.liftweb.json.JsonAST.JValue
 import org.eclipse.jetty.server.Handler
 import scala.xml.Node
 import spark.{Logging, Utils}
-import spark.ui.JettyUI
-import JettyUI._
+import spark.ui.JettyUtils
+import JettyUtils._
 import spark.deploy._
 import spark.deploy.MasterState
-import spark.ui.JettyUI
+import spark.ui.JettyUtils
 
 /**
  * Web UI server for the standalone master.
@@ -29,11 +29,11 @@ class MasterWebUI(master: ActorRef) extends Logging {
 
   def start() {
     try {
-      val (server, boundPort) = JettyUI.startJettyServer("0.0.0.0", port, handlers)
+      val (server, boundPort) = JettyUtils.startJettyServer("0.0.0.0", port, handlers)
       logInfo("Started Master web UI at http://%s:%d".format(host, boundPort))
     } catch {
       case e: Exception =>
-        logError("Failed to create Master JettyUI", e)
+        logError("Failed to create Master JettyUtils", e)
         System.exit(1)
     }
   }
@@ -99,7 +99,7 @@ class MasterWebUI(master: ActorRef) extends Logging {
           {executorTable(app.executors.values.toList)}
         </div>
       </div>;
-      JettyUI.sparkPage(content, "Application Info: " + app.desc.name)
+      JettyUtils.sparkPage(content, "Application Info: " + app.desc.name)
   }
 
   def executorTable(executors: Seq[ExecutorInfo]): Seq[Node] = {
@@ -189,7 +189,7 @@ class MasterWebUI(master: ActorRef) extends Logging {
           {appTable(state.completedApps.sortBy(_.endTime).reverse)}
         </div>
       </div>;
-    JettyUI.sparkPage(content, "Spark Master: " + state.uri)
+    JettyUtils.sparkPage(content, "Spark Master: " + state.uri)
   }
 
   def workerTable(workers: Seq[spark.deploy.master.WorkerInfo]) = {
diff --git a/core/src/main/scala/spark/deploy/worker/WorkerWebUI.scala b/core/src/main/scala/spark/deploy/worker/WorkerWebUI.scala
index 0febb9364c..805e7b52db 100644
--- a/core/src/main/scala/spark/deploy/worker/WorkerWebUI.scala
+++ b/core/src/main/scala/spark/deploy/worker/WorkerWebUI.scala
@@ -12,8 +12,8 @@ import org.eclipse.jetty.server.Handler
 import scala.io.Source
 import spark.{Utils, Logging}
 import spark.deploy.{JsonProtocol, WorkerState, RequestWorkerState}
-import spark.ui.{JettyUI => UtilsWebUI}
-import spark.ui.JettyUI._
+import spark.ui.{JettyUtils => UtilsWebUI}
+import spark.ui.JettyUtils._
 import xml.Node
 
 /**
@@ -40,7 +40,7 @@ class WorkerWebUI(worker: ActorRef, workDir: File) extends Logging {
       logInfo("Started Worker web UI at http://%s:%d".format(host, boundPort))
     } catch {
       case e: Exception =>
-        logError("Failed to create Worker JettyUI", e)
+        logError("Failed to create Worker JettyUtils", e)
         System.exit(1)
     }
   }
diff --git a/core/src/main/scala/spark/ui/JettyUI.scala b/core/src/main/scala/spark/ui/JettyUtils.scala
similarity index 97%
rename from core/src/main/scala/spark/ui/JettyUI.scala
rename to core/src/main/scala/spark/ui/JettyUtils.scala
index c3f01073d5..8bb343163a 100644
--- a/core/src/main/scala/spark/ui/JettyUI.scala
+++ b/core/src/main/scala/spark/ui/JettyUtils.scala
@@ -15,7 +15,9 @@ import spark.Logging
 
 import xml.Node
 
-private[spark] object JettyUI extends Logging {
+
+/** Utilities for launching a web server using Jetty's HTTP Server class */
+private[spark] object JettyUtils extends Logging {
   // Base type for a function that returns something based on an HTTP request. Allows for
   // implicit conversion from many types of functions to jetty Handlers.
   type Responder[T] = HttpServletRequest => T
diff --git a/core/src/main/scala/spark/ui/SparkUI.scala b/core/src/main/scala/spark/ui/SparkUI.scala
index dd7d33e0fa..7428e7a343 100644
--- a/core/src/main/scala/spark/ui/SparkUI.scala
+++ b/core/src/main/scala/spark/ui/SparkUI.scala
@@ -8,7 +8,7 @@ import spark.{Logging, SparkContext, Utils}
 import spark.ui.storage.BlockManagerUI
 import spark.ui.jobs.JobProgressUI
 import spark.ui.UIUtils._
-import spark.ui.JettyUI._
+import spark.ui.JettyUtils._
 
 /** Top level user interface for Spark */
 private[spark] class SparkUI(sc: SparkContext) extends Logging {
@@ -27,12 +27,12 @@ private[spark] class SparkUI(sc: SparkContext) extends Logging {
   def start() {
     /** Start an HTTP server to run the Web interface */
     try {
-      val (server, usedPort) = JettyUI.startJettyServer("0.0.0.0", port, allHandlers)
+      val (server, usedPort) = JettyUtils.startJettyServer("0.0.0.0", port, allHandlers)
       logInfo("Started Spark Web UI at http://%s:%d".format(host, usedPort))
       boundPort = Some(usedPort)
     } catch {
     case e: Exception =>
-      logError("Failed to create Spark JettyUI", e)
+      logError("Failed to create Spark JettyUtils", e)
       System.exit(1)
     }
   }
diff --git a/core/src/main/scala/spark/ui/jobs/JobProgressUI.scala b/core/src/main/scala/spark/ui/jobs/JobProgressUI.scala
index 31aa0f9f0d..97fda84e06 100644
--- a/core/src/main/scala/spark/ui/jobs/JobProgressUI.scala
+++ b/core/src/main/scala/spark/ui/jobs/JobProgressUI.scala
@@ -9,7 +9,7 @@ import org.eclipse.jetty.server.Handler
 import scala.Seq
 import scala.collection.mutable.{HashSet, ListBuffer, HashMap, ArrayBuffer}
 
-import spark.ui.JettyUI._
+import spark.ui.JettyUtils._
 import spark.SparkContext
 import spark.scheduler._
 import spark.scheduler.cluster.TaskInfo
diff --git a/core/src/main/scala/spark/ui/storage/BlockManagerUI.scala b/core/src/main/scala/spark/ui/storage/BlockManagerUI.scala
index d83c826033..4f1928fac9 100644
--- a/core/src/main/scala/spark/ui/storage/BlockManagerUI.scala
+++ b/core/src/main/scala/spark/ui/storage/BlockManagerUI.scala
@@ -1,11 +1,13 @@
 package spark.ui.storage
 
 import akka.util.Duration
+
 import javax.servlet.http.HttpServletRequest
+
 import org.eclipse.jetty.server.Handler
+
 import spark.{Logging, SparkContext}
-import spark.ui.JettyUI._
-import spark.ui.{UIComponent}
+import spark.ui.JettyUtils._
 
 /** Web UI showing storage status of all RDD's in the given SparkContext. */
 private[spark]
diff --git a/core/src/main/scala/spark/ui/storage/IndexPage.scala b/core/src/main/scala/spark/ui/storage/IndexPage.scala
index 5ead772bc0..1f9953fb6b 100644
--- a/core/src/main/scala/spark/ui/storage/IndexPage.scala
+++ b/core/src/main/scala/spark/ui/storage/IndexPage.scala
@@ -1,10 +1,12 @@
 package spark.ui.storage
 
-import xml.Node
+import javax.servlet.http.HttpServletRequest
+
 import spark.storage.{RDDInfo, StorageUtils}
 import spark.Utils
 import spark.ui.UIUtils._
-import javax.servlet.http.HttpServletRequest
+
+import xml.Node
 
 /** Page showing list of RDD's currently stored in the cluster */
 class IndexPage(parent: BlockManagerUI) {
-- 
GitLab