Package org.apache.spark.ui
Class JettyUtils
Object
org.apache.spark.ui.JettyUtils
Utilities for launching a web server using Jetty's HTTP Server class
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic class -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidaddFilter(org.eclipse.jetty.servlet.ServletContextHandler handler, String filter, scala.collection.immutable.Map<String, String> params) static org.eclipse.jetty.servlet.ServletContextHandlercreateProxyHandler(scala.Function1<String, scala.Option<String>> idToUiAddress) Create a handler for proxying request to Workers and Application Driversstatic StringcreateProxyLocationHeader(String headerValue, jakarta.servlet.http.HttpServletRequest clientRequest, URI targetUri) static URIcreateProxyURI(String prefix, String target, String path, String query) static org.eclipse.jetty.servlet.ServletContextHandlercreateRedirectHandler(String srcPath, String destPath, scala.Function1<jakarta.servlet.http.HttpServletRequest, scala.runtime.BoxedUnit> beforeRedirect, String basePath, scala.collection.immutable.Set<String> httpMethods, scala.Option<String> csrfToken) Create a handler that always redirects the user to the given path.static org.eclipse.jetty.servlet.ServletContextHandlercreateServletHandler(String path, jakarta.servlet.http.HttpServlet servlet, String basePath) Create a context handler that responds to a request with the given path prefixstatic <T> org.eclipse.jetty.servlet.ServletContextHandlercreateServletHandler(String path, JettyUtils.ServletParams<T> servletParams, SparkConf conf, String basePath) Create a context handler that responds to a request with the given path prefixstatic org.eclipse.jetty.servlet.ServletContextHandlercreateStaticHandler(String resourceBase, String path) Create a handler for serving files from a static directorystatic JettyUtils.ServletParams<scala.collection.immutable.Seq<scala.xml.Node>>htmlResponderToServlet(scala.Function1<jakarta.servlet.http.HttpServletRequest, scala.collection.immutable.Seq<scala.xml.Node>> responder) static JettyUtils.ServletParams<org.json4s.JValue>jsonResponderToServlet(scala.Function1<jakarta.servlet.http.HttpServletRequest, org.json4s.JValue> responder) static org.apache.spark.internal.Logging.LogStringContextLogStringContext(scala.StringContext sc) static org.slf4j.Loggerstatic voidorg$apache$spark$internal$Logging$$log__$eq(org.slf4j.Logger x$1) static Stringstatic Stringstatic org.apache.spark.ui.ServerInfostartJettyServer(String hostName, int port, org.apache.spark.SSLOptions sslOptions, SparkConf conf, String serverName, int poolSize) Attempt to start a Jetty server bound to the supplied hostName:port using the given context handlers.static JettyUtils.ServletParams<String>textResponderToServlet(scala.Function1<jakarta.servlet.http.HttpServletRequest, String> responder) static String[]toVirtualHosts(scala.collection.immutable.Seq<String> connectors)
-
Constructor Details
-
JettyUtils
public JettyUtils()
-
-
Method Details
-
SPARK_CONNECTOR_NAME
-
REDIRECT_CONNECTOR_NAME
-
jsonResponderToServlet
public static JettyUtils.ServletParams<org.json4s.JValue> jsonResponderToServlet(scala.Function1<jakarta.servlet.http.HttpServletRequest, org.json4s.JValue> responder) -
htmlResponderToServlet
public static JettyUtils.ServletParams<scala.collection.immutable.Seq<scala.xml.Node>> htmlResponderToServlet(scala.Function1<jakarta.servlet.http.HttpServletRequest, scala.collection.immutable.Seq<scala.xml.Node>> responder) -
textResponderToServlet
public static JettyUtils.ServletParams<String> textResponderToServlet(scala.Function1<jakarta.servlet.http.HttpServletRequest, String> responder) -
createServletHandler
public static <T> org.eclipse.jetty.servlet.ServletContextHandler createServletHandler(String path, JettyUtils.ServletParams<T> servletParams, SparkConf conf, String basePath) Create a context handler that responds to a request with the given path prefix -
createServletHandler
public static org.eclipse.jetty.servlet.ServletContextHandler createServletHandler(String path, jakarta.servlet.http.HttpServlet servlet, String basePath) Create a context handler that responds to a request with the given path prefix -
createRedirectHandler
public static org.eclipse.jetty.servlet.ServletContextHandler createRedirectHandler(String srcPath, String destPath, scala.Function1<jakarta.servlet.http.HttpServletRequest, scala.runtime.BoxedUnit> beforeRedirect, String basePath, scala.collection.immutable.Set<String> httpMethods, scala.Option<String> csrfToken) Create a handler that always redirects the user to the given path.- Parameters:
csrfToken- when defined, mark the handler as state-changing and guard it: requests must carry the token as the "csrfToken" parameter or they are rejected with 403 (see isValidCsrfToken), prefetch requests are rejected with 403 (see isPrefetchRequest), and HEAD is refused with 405 instead of being delegated to doGet. A cross-site page can neither read the token out of the UI's pages (same-origin policy) nor guess it, so it cannot forge a request. Set this for handlers that change state (e.g. the job/stage kill endpoints).srcPath- (undocumented)destPath- (undocumented)beforeRedirect- (undocumented)basePath- (undocumented)httpMethods- (undocumented)- Returns:
- (undocumented)
-
createStaticHandler
public static org.eclipse.jetty.servlet.ServletContextHandler createStaticHandler(String resourceBase, String path) Create a handler for serving files from a static directory -
createProxyHandler
public static org.eclipse.jetty.servlet.ServletContextHandler createProxyHandler(scala.Function1<String, scala.Option<String>> idToUiAddress) Create a handler for proxying request to Workers and Application Drivers -
startJettyServer
public static org.apache.spark.ui.ServerInfo startJettyServer(String hostName, int port, org.apache.spark.SSLOptions sslOptions, SparkConf conf, String serverName, int poolSize) Attempt to start a Jetty server bound to the supplied hostName:port using the given context handlers.If the desired port number is contended, continues incrementing ports until a free port is found. Return the jetty Server object, the chosen port, and a mutable collection of handlers.
- Parameters:
hostName- (undocumented)port- (undocumented)sslOptions- (undocumented)conf- (undocumented)serverName- (undocumented)poolSize- (undocumented)- Returns:
- (undocumented)
-
createProxyURI
-
createProxyLocationHeader
-
addFilter
-
toVirtualHosts
-
org$apache$spark$internal$Logging$$log_
public static org.slf4j.Logger org$apache$spark$internal$Logging$$log_() -
org$apache$spark$internal$Logging$$log__$eq
public static void org$apache$spark$internal$Logging$$log__$eq(org.slf4j.Logger x$1) -
LogStringContext
public static org.apache.spark.internal.Logging.LogStringContext LogStringContext(scala.StringContext sc)
-