Package org.apache.hadoop.yarn.webapp

Class View

java.lang.Object

org.apache.hadoop.yarn.webapp.View

All Implemented Interfaces:

Params

Direct Known Subclasses:

TextView

@LimitedPrivate({"YARN","MapReduce"})
public abstract class View
extends java.lang.Object
implements Params

Base class for all views

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	View.ViewContext

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG

Fields inherited from interface org.apache.hadoop.yarn.webapp.Params

ERROR_DETAILS, TITLE, TITLE_LINK, USER

Constructor Summary

Constructors

Constructor	Description
View()
View(View.ViewContext ctx)

Method Summary

Modifier and Type	Method	Description
java.lang.String	$(java.lang.String key)	Lookup a value from the current context
java.lang.String	$(java.lang.String key, java.lang.String defaultValue)	Lookup a value from the current context.
View.ViewContext	context()
java.util.Map<java.lang.String,javax.servlet.http.Cookie>	cookies()	Get the cookies
java.lang.Throwable	error()
<T> T	getInstance(java.lang.Class<T> cls)
boolean	inDevMode()
ResponseInfo	info(java.lang.String about)
com.google.inject.Injector	injector()
java.util.Map<java.lang.String,java.lang.String>	moreParams()
javax.servlet.ServletOutputStream	outputStream()
java.lang.String	prefix()
abstract void	render()	The API to render the view
void	render(java.lang.Class<? extends SubView> cls)	Render a sub-view
javax.servlet.http.HttpServletRequest	request()
javax.servlet.http.HttpServletResponse	response()
java.lang.String	root()
java.lang.String	root_url(java.lang.String... parts)	Create an url from url components
void	set(java.lang.String key, java.lang.String value)	Set a context value.
void	setTitle(java.lang.String title)
void	setTitle(java.lang.String title, java.lang.String url)
int	status()
java.lang.String	url(java.lang.String... parts)	Create an url from url components
java.io.PrintWriter	writer()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

View

public View()

View

public View(View.ViewContext ctx)

Method Detail

render

public abstract void render()

The API to render the view

context

public View.ViewContext context()

error

public java.lang.Throwable error()

status

public int status()

inDevMode

public boolean inDevMode()

injector

public com.google.inject.Injector injector()

getInstance

public <T> T getInstance(java.lang.Class<T> cls)

request

public javax.servlet.http.HttpServletRequest request()

response

public javax.servlet.http.HttpServletResponse response()

moreParams

public java.util.Map<java.lang.String,java.lang.String> moreParams()

cookies

public java.util.Map<java.lang.String,javax.servlet.http.Cookie> cookies()

Get the cookies

Returns:

the cookies map

outputStream

public javax.servlet.ServletOutputStream outputStream()

writer

public java.io.PrintWriter writer()

$

public java.lang.String $(java.lang.String key,
                          java.lang.String defaultValue)

Lookup a value from the current context.

Parameters:

key - to lookup

defaultValue - if key is missing

Returns:

the value of the key or the default value

$

public java.lang.String $(java.lang.String key)

Lookup a value from the current context

Parameters:

key - to lookup

Returns:

the value of the key or empty string

set

public void set(java.lang.String key,
                java.lang.String value)

Set a context value. (e.g. UI properties for sub views.) Try to avoid any application (vs view/ui) logic.

Parameters:

key - to set

value - to set

root

public java.lang.String root()

prefix

public java.lang.String prefix()

setTitle

public void setTitle(java.lang.String title)

setTitle

public void setTitle(java.lang.String title,
                     java.lang.String url)

root_url

public java.lang.String root_url(java.lang.String... parts)

Create an url from url components

Parameters:

parts - components to join

Returns:

an url string

url

public java.lang.String url(java.lang.String... parts)

Create an url from url components

Parameters:

parts - components to join

Returns:

an url string

info

public ResponseInfo info(java.lang.String about)

render

public void render(java.lang.Class<? extends SubView> cls)

Render a sub-view

Parameters:

cls - the class of the sub-view