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

Class AHSWebServices

java.lang.Object

org.apache.hadoop.yarn.server.webapp.WebServices

org.apache.hadoop.yarn.server.applicationhistoryservice.webapp.AHSWebServices

All Implemented Interfaces:

org.apache.hadoop.yarn.server.webapp.AppInfoProvider

public class AHSWebServices
extends org.apache.hadoop.yarn.server.webapp.WebServices

Field Summary

Fields inherited from class org.apache.hadoop.yarn.server.webapp.WebServices

appBaseProt

Constructor Summary

Constructors

Constructor	Description
AHSWebServices(org.apache.hadoop.yarn.api.ApplicationBaseProtocol appBaseProt, org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.yarn.api.records.timeline.TimelineAbout	about(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
org.apache.hadoop.yarn.server.webapp.dao.AppsInfo	get(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
org.apache.hadoop.yarn.server.webapp.dao.AppInfo	getApp(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId)
org.apache.hadoop.yarn.server.webapp.dao.AppAttemptInfo	getAppAttempt(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId, java.lang.String appAttemptId)
org.apache.hadoop.yarn.server.webapp.dao.AppAttemptsInfo	getAppAttempts(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId)
org.apache.hadoop.yarn.server.webapp.dao.AppsInfo	getApps(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String stateQuery, java.util.Set<java.lang.String> statesQuery, java.lang.String finalStatusQuery, java.lang.String userQuery, java.lang.String queueQuery, java.lang.String count, java.lang.String startedBegin, java.lang.String startedEnd, java.lang.String finishBegin, java.lang.String finishEnd, java.lang.String name, java.util.Set<java.lang.String> applicationTypes)
org.apache.hadoop.yarn.server.webapp.dao.ContainerInfo	getContainer(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId, java.lang.String appAttemptId, java.lang.String containerId)
javax.ws.rs.core.Response	getContainerLogFile(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String containerIdStr, java.lang.String filename, java.lang.String format, java.lang.String size, java.lang.String nmId, boolean redirectedFromNode, boolean manualRedirection)	Returns the contents of a container's log file in plain text.
javax.ws.rs.core.Response	getContainerLogsInfo(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String containerIdStr, java.lang.String nmId, boolean redirectedFromNode, boolean manualRedirection)	Returns log file's name as well as current file size for a container.
org.apache.hadoop.yarn.server.webapp.dao.ContainersInfo	getContainers(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId, java.lang.String appAttemptId)
javax.ws.rs.core.Response	getLogs(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String containerIdStr, java.lang.String filename, java.lang.String format, java.lang.String size, java.lang.String nmId, boolean redirectedFromNode, boolean manualRedirection)

Methods inherited from class org.apache.hadoop.yarn.server.webapp.WebServices

getApp, getApp, getApplicationAttemptReport, getApplicationAttemptsReport, getApplicationReport, getApplicationsReport, getContainer, getContainerReport, getContainersReport, getNodeHttpAddress, getUser, initForReadableEndpoints, parseApplicationAttemptId, parseApplicationId, parseContainerId, parseQueries, validateIds

Methods inherited from class java.lang.Object

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

Constructor Detail

AHSWebServices

@Inject
public AHSWebServices(org.apache.hadoop.yarn.api.ApplicationBaseProtocol appBaseProt,
                      org.apache.hadoop.conf.Configuration conf)

Method Detail

about

public org.apache.hadoop.yarn.api.records.timeline.TimelineAbout about(@Context
                                                                       javax.servlet.http.HttpServletRequest req,
                                                                       @Context
                                                                       javax.servlet.http.HttpServletResponse res)

get

public org.apache.hadoop.yarn.server.webapp.dao.AppsInfo get(@Context
                                                             javax.servlet.http.HttpServletRequest req,
                                                             @Context
                                                             javax.servlet.http.HttpServletResponse res)

getApps

public org.apache.hadoop.yarn.server.webapp.dao.AppsInfo getApps(@Context
                                                                 javax.servlet.http.HttpServletRequest req,
                                                                 @Context
                                                                 javax.servlet.http.HttpServletResponse res,
                                                                 java.lang.String stateQuery,
                                                                 java.util.Set<java.lang.String> statesQuery,
                                                                 java.lang.String finalStatusQuery,
                                                                 java.lang.String userQuery,
                                                                 java.lang.String queueQuery,
                                                                 java.lang.String count,
                                                                 java.lang.String startedBegin,
                                                                 java.lang.String startedEnd,
                                                                 java.lang.String finishBegin,
                                                                 java.lang.String finishEnd,
                                                                 java.lang.String name,
                                                                 java.util.Set<java.lang.String> applicationTypes)

Overrides:

getApps in class org.apache.hadoop.yarn.server.webapp.WebServices

getApp

public org.apache.hadoop.yarn.server.webapp.dao.AppInfo getApp(@Context
                                                               javax.servlet.http.HttpServletRequest req,
                                                               @Context
                                                               javax.servlet.http.HttpServletResponse res,
                                                               java.lang.String appId)

Overrides:

getApp in class org.apache.hadoop.yarn.server.webapp.WebServices

getAppAttempts

public org.apache.hadoop.yarn.server.webapp.dao.AppAttemptsInfo getAppAttempts(@Context
                                                                               javax.servlet.http.HttpServletRequest req,
                                                                               @Context
                                                                               javax.servlet.http.HttpServletResponse res,
                                                                               java.lang.String appId)

Overrides:

getAppAttempts in class org.apache.hadoop.yarn.server.webapp.WebServices

getAppAttempt

public org.apache.hadoop.yarn.server.webapp.dao.AppAttemptInfo getAppAttempt(@Context
                                                                             javax.servlet.http.HttpServletRequest req,
                                                                             @Context
                                                                             javax.servlet.http.HttpServletResponse res,
                                                                             java.lang.String appId,
                                                                             java.lang.String appAttemptId)

Overrides:

getAppAttempt in class org.apache.hadoop.yarn.server.webapp.WebServices

getContainers

public org.apache.hadoop.yarn.server.webapp.dao.ContainersInfo getContainers(@Context
                                                                             javax.servlet.http.HttpServletRequest req,
                                                                             @Context
                                                                             javax.servlet.http.HttpServletResponse res,
                                                                             java.lang.String appId,
                                                                             java.lang.String appAttemptId)

Overrides:

getContainers in class org.apache.hadoop.yarn.server.webapp.WebServices

getContainer

public org.apache.hadoop.yarn.server.webapp.dao.ContainerInfo getContainer(@Context
                                                                           javax.servlet.http.HttpServletRequest req,
                                                                           @Context
                                                                           javax.servlet.http.HttpServletResponse res,
                                                                           java.lang.String appId,
                                                                           java.lang.String appAttemptId,
                                                                           java.lang.String containerId)

Overrides:

getContainer in class org.apache.hadoop.yarn.server.webapp.WebServices

getContainerLogsInfo

public javax.ws.rs.core.Response getContainerLogsInfo(@Context
                                                      javax.servlet.http.HttpServletRequest req,
                                                      @Context
                                                      javax.servlet.http.HttpServletResponse res,
                                                      java.lang.String containerIdStr,
                                                      java.lang.String nmId,
                                                      boolean redirectedFromNode,
                                                      boolean manualRedirection)

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

Parameters:

req - HttpServletRequest

res - HttpServletResponse

containerIdStr - The container ID

nmId - The Node Manager NodeId

redirectedFromNode - Whether this is a redirected request from NM

Returns:

The log file's name and current file size

getContainerLogFile

@Public
@Unstable
public javax.ws.rs.core.Response getContainerLogFile(@Context
                                                     javax.servlet.http.HttpServletRequest req,
                                                     @Context
                                                     javax.servlet.http.HttpServletResponse res,
                                                     java.lang.String containerIdStr,
                                                     java.lang.String filename,
                                                     java.lang.String format,
                                                     java.lang.String size,
                                                     java.lang.String nmId,
                                                     boolean redirectedFromNode,
                                                     boolean manualRedirection)

Returns the contents of a container's log file in plain text.

Parameters:

req - HttpServletRequest

res - HttpServletResponse

containerIdStr - The container ID

filename - The name of the log file

format - The content type

size - the size of the log file

nmId - The Node Manager NodeId

redirectedFromNode - Whether this is the redirect request from NM

Returns:

The contents of the container's log file

getLogs

@Public
@Unstable
public javax.ws.rs.core.Response getLogs(@Context
                                         javax.servlet.http.HttpServletRequest req,
                                         @Context
                                         javax.servlet.http.HttpServletResponse res,
                                         java.lang.String containerIdStr,
                                         java.lang.String filename,
                                         java.lang.String format,
                                         java.lang.String size,
                                         java.lang.String nmId,
                                         boolean redirectedFromNode,
                                         boolean manualRedirection)