Skip to content

ApiRequestContext

== [[ApiRequestContext]] ApiRequestContext

ApiRequestContext is the <> of...FIXME

[[contract]] [source, scala]


package org.apache.spark.status.api.v1

trait ApiRequestContext { // only required methods that have no implementation // the others follow @Context var servletContext: ServletContext = _

@Context var httpRequest: HttpServletRequest = _ }


NOTE: ApiRequestContext is a private[v1] contract.

.ApiRequestContext Contract [cols="1,2",options="header",width="100%"] |=== | Method | Description

| httpRequest | [[httpRequest]] Java Servlets' HttpServletRequest

Used when...FIXME

| servletContext | [[servletContext]] Java Servlets' ServletContext

Used when...FIXME |===

[[implementations]] .ApiRequestContexts [cols="1,2",options="header",width="100%"] |=== | ApiRequestContext | Description

| spark-api-ApiRootResource.md[ApiRootResource] | [[ApiRootResource]]

| ApiStreamingApp | [[ApiStreamingApp]]

| spark-api-ApplicationListResource.md[ApplicationListResource] | [[ApplicationListResource]]

| spark-api-BaseAppResource.md[BaseAppResource] | [[BaseAppResource]]

| SecurityFilter | [[SecurityFilter]] |===

=== [[uiRoot]] Getting Current UIRoot -- uiRoot Method

[source, scala]

uiRoot: UIRoot

uiRoot simply requests UIRootFromServletContext to spark-api-UIRootFromServletContext.md#getUiRoot[get the current UIRoot] (for the given <>).

NOTE: uiRoot is used when...FIXME


Last update: 2020-10-06