Package org.apache.hadoop.yarn.server.nodemanager.webapp

Class NMWebServices

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.webapp.NMWebServices

public class NMWebServices
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
NMWebServices(Context nm, ResourceView view, org.apache.hadoop.yarn.webapp.WebApp webapp)
NMWebServices(Context nm, ResourceView view, org.apache.hadoop.yarn.webapp.WebApp webapp, javax.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method	Description
NodeInfo	get()
AuxiliaryServicesInfo	getAuxiliaryServices(javax.servlet.http.HttpServletRequest hsr)
javax.ws.rs.core.Response	getContainerLogFile(java.lang.String containerIdStr, java.lang.String filename, java.lang.String format, java.lang.String size)	Returns the contents of a container's log file in plain text.
javax.ws.rs.core.Response	getContainerLogsInfo(javax.servlet.http.HttpServletRequest hsr, javax.servlet.http.HttpServletResponse res, java.lang.String containerIdStr)	Returns log file's name as well as current file size for a container.
javax.ws.rs.core.Response	getLogs(java.lang.String containerIdStr, java.lang.String filename, java.lang.String format, java.lang.String size)	Returns the contents of a container's log file in plain text.
java.lang.Object	getNMResourceInfo(java.lang.String resourceName)
AppInfo	getNodeApp(java.lang.String appId)
AppsInfo	getNodeApps(javax.servlet.http.HttpServletRequest hsr, java.lang.String stateQuery, java.lang.String userQuery)
ContainerInfo	getNodeContainer(javax.servlet.http.HttpServletRequest hsr, java.lang.String id)
ContainersInfo	getNodeContainers(javax.servlet.http.HttpServletRequest hsr)
NodeInfo	getNodeInfo()
protected java.lang.Boolean	hasAccess(java.lang.String user, org.apache.hadoop.yarn.api.records.ApplicationId appId, javax.servlet.http.HttpServletRequest hsr)
protected java.lang.Boolean	hasAdminAccess(javax.servlet.http.HttpServletRequest hsr)
javax.ws.rs.core.Response	putAuxiliaryServices(javax.servlet.http.HttpServletRequest req, AuxServiceRecords services)
javax.ws.rs.core.Response	syncYarnSysFS(javax.servlet.http.HttpServletRequest req, java.lang.String user, java.lang.String appId, java.lang.String spec)

Methods inherited from class java.lang.Object

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

Constructor Detail

NMWebServices

@Inject
public NMWebServices(Context nm,
                     ResourceView view,
                     org.apache.hadoop.yarn.webapp.WebApp webapp)

NMWebServices

public NMWebServices(Context nm,
                     ResourceView view,
                     org.apache.hadoop.yarn.webapp.WebApp webapp,
                     javax.servlet.http.HttpServletResponse response)

Method Detail

get

public NodeInfo get()

getNodeInfo

public NodeInfo getNodeInfo()

getNodeApps

public AppsInfo getNodeApps(@Context
                            javax.servlet.http.HttpServletRequest hsr,
                            java.lang.String stateQuery,
                            java.lang.String userQuery)

getNodeApp

public AppInfo getNodeApp(java.lang.String appId)

getNodeContainers

public ContainersInfo getNodeContainers(@Context
                                        javax.servlet.http.HttpServletRequest hsr)

getNodeContainer

public ContainerInfo getNodeContainer(@Context
                                      javax.servlet.http.HttpServletRequest hsr,
                                      java.lang.String id)

getContainerLogsInfo

public javax.ws.rs.core.Response getContainerLogsInfo(@Context
                                                      javax.servlet.http.HttpServletRequest hsr,
                                                      @Context
                                                      javax.servlet.http.HttpServletResponse res,
                                                      java.lang.String containerIdStr)

Returns log file's name as well as current file size for a container.

Parameters:

hsr - HttpServletRequest

res - HttpServletResponse

containerIdStr - The container ID

Returns:

The log file's name and current file size

getContainerLogFile

@Public
@Unstable
public javax.ws.rs.core.Response getContainerLogFile(java.lang.String containerIdStr,
                                                     java.lang.String filename,
                                                     java.lang.String format,
                                                     java.lang.String size)

Returns the contents of a container's log file in plain text. Only works for containers that are still in the NodeManager's memory, so logs are no longer available after the corresponding application is no longer running.

Parameters:

containerIdStr - The container ID

filename - The name of the log file

format - The content type

size - the size of the log file

Returns:

The contents of the container's log file

getLogs

@Public
@Unstable
public javax.ws.rs.core.Response getLogs(java.lang.String containerIdStr,
                                         java.lang.String filename,
                                         java.lang.String format,
                                         java.lang.String size)

Returns the contents of a container's log file in plain text. Only works for containers that are still in the NodeManager's memory, so logs are no longer available after the corresponding application is no longer running.

Parameters:

containerIdStr - The container ID

filename - The name of the log file

format - The content type

size - the size of the log file

Returns:

The contents of the container's log file

getNMResourceInfo

public java.lang.Object getNMResourceInfo(java.lang.String resourceName)
                                   throws org.apache.hadoop.yarn.exceptions.YarnException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

getAuxiliaryServices

public AuxiliaryServicesInfo getAuxiliaryServices(@Context
                                                  javax.servlet.http.HttpServletRequest hsr)

putAuxiliaryServices

public javax.ws.rs.core.Response putAuxiliaryServices(@Context
                                                      javax.servlet.http.HttpServletRequest req,
                                                      AuxServiceRecords services)

syncYarnSysFS

public javax.ws.rs.core.Response syncYarnSysFS(@Context
                                               javax.servlet.http.HttpServletRequest req,
                                               java.lang.String user,
                                               java.lang.String appId,
                                               java.lang.String spec)

hasAccess

protected java.lang.Boolean hasAccess(java.lang.String user,
                                      org.apache.hadoop.yarn.api.records.ApplicationId appId,
                                      javax.servlet.http.HttpServletRequest hsr)

hasAdminAccess

protected java.lang.Boolean hasAdminAccess(javax.servlet.http.HttpServletRequest hsr)