Package org.apache.hadoop.yarn.webapp

Class Controller

java.lang.Object

org.apache.hadoop.yarn.webapp.Controller

All Implemented Interfaces:

Params

Direct Known Subclasses:

HelloWorld.Hello, MyApp.MyController

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Controller.RequestContext

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
Controller()
Controller(Controller.RequestContext ctx)

Method Summary

Modifier and Type	Method	Description
java.lang.String	$(java.lang.String key)
Controller.RequestContext	context()
java.util.Map<java.lang.String,javax.servlet.http.Cookie>	cookies()	Get the cookies
void	echo()
java.lang.Throwable	error()
java.lang.String	get(java.lang.String key, java.lang.String defaultValue)
<T> T	getInstance(java.lang.Class<T> cls)
boolean	inDevMode()
abstract void	index()	The default action.
ResponseInfo	info(java.lang.String about)
com.google.inject.Injector	injector()
protected void	render(java.lang.Class<? extends View> cls)
protected void	renderJSON(java.lang.Class<? extends ToJSON> cls)
protected void	renderJSON(java.lang.Object object)	Convenience method for REST APIs (without explicit views)
protected void	renderText(java.lang.String s)	Convenience method for hello world :)
javax.servlet.http.HttpServletRequest	request()
javax.servlet.http.HttpServletResponse	response()
void	set(java.lang.String key, java.lang.String value)
void	setStatus(int status)
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
protected 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

Controller

public Controller()

Controller

public Controller(Controller.RequestContext ctx)

Method Detail

context

public Controller.RequestContext context()

error

public java.lang.Throwable error()

status

public int status()

setStatus

public void setStatus(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()

set

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

get

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

$

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

setTitle

public void setTitle(java.lang.String title)

setTitle

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

info

public ResponseInfo info(java.lang.String about)

cookies

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

Get the cookies

Returns:

the cookies map

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

index

public abstract void index()

The default action.

echo

public void echo()

render

protected void render(java.lang.Class<? extends View> cls)

renderJSON

protected void renderJSON(java.lang.Object object)

Convenience method for REST APIs (without explicit views)

Parameters:

object - - the object as the response (in JSON)

renderJSON

protected void renderJSON(java.lang.Class<? extends ToJSON> cls)

renderText

protected void renderText(java.lang.String s)

Convenience method for hello world :)

Parameters:

s - - the content to render as plain text

writer

protected java.io.PrintWriter writer()