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

Class WebServices

java.lang.Object

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

All Implemented Interfaces:

AppInfoProvider

public class WebServices
extends java.lang.Object
implements AppInfoProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.hadoop.yarn.api.ApplicationBaseProtocol	appBaseProt

Constructor Summary

Constructors

Constructor	Description
WebServices(org.apache.hadoop.yarn.api.ApplicationBaseProtocol appBaseProt)

Method Summary

Modifier and Type	Method	Description
AppInfo	getApp(javax.servlet.http.HttpServletRequest req, java.lang.String appId)
org.apache.hadoop.yarn.server.webapp.BasicAppInfo	getApp(javax.servlet.http.HttpServletRequest req, java.lang.String appId, java.lang.String clusterId)	Returns BasicAppInfo object that wraps the collected information about the application.
AppInfo	getApp(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId)
AppAttemptInfo	getAppAttempt(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId, java.lang.String appAttemptId)
AppAttemptsInfo	getAppAttempts(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId)
protected org.apache.hadoop.yarn.api.records.ApplicationAttemptReport	getApplicationAttemptReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest request)
protected java.util.List<org.apache.hadoop.yarn.api.records.ApplicationAttemptReport>	getApplicationAttemptsReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest request)
protected org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest request)
protected java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport>	getApplicationsReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest request)
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 nameQuery, java.util.Set<java.lang.String> applicationTypes)
ContainerInfo	getContainer(javax.servlet.http.HttpServletRequest req, java.lang.String appId, java.lang.String appAttemptId, java.lang.String containerId)
ContainerInfo	getContainer(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId, java.lang.String appAttemptId, java.lang.String containerId)
protected org.apache.hadoop.yarn.api.records.ContainerReport	getContainerReport(org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest request)
ContainersInfo	getContainers(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String appId, java.lang.String appAttemptId)
protected java.util.List<org.apache.hadoop.yarn.api.records.ContainerReport>	getContainersReport(org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest request)
java.lang.String	getNodeHttpAddress(javax.servlet.http.HttpServletRequest req, java.lang.String appId, java.lang.String appAttemptId, java.lang.String containerId, java.lang.String clusterId)	Returns the node HTTP address.
protected static org.apache.hadoop.security.UserGroupInformation	getUser(javax.servlet.http.HttpServletRequest req)
protected void	initForReadableEndpoints(javax.servlet.http.HttpServletResponse response)
protected static org.apache.hadoop.yarn.api.records.ApplicationAttemptId	parseApplicationAttemptId(java.lang.String appAttemptId)
protected static org.apache.hadoop.yarn.api.records.ApplicationId	parseApplicationId(java.lang.String appId)
protected static org.apache.hadoop.yarn.api.records.ContainerId	parseContainerId(java.lang.String containerId)
static java.util.Set<java.lang.String>	parseQueries(java.util.Set<java.lang.String> queries, boolean isState)
protected void	validateIds(org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, org.apache.hadoop.yarn.api.records.ContainerId containerId)

Methods inherited from class java.lang.Object

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

Field Detail

appBaseProt

protected org.apache.hadoop.yarn.api.ApplicationBaseProtocol appBaseProt

Constructor Detail

WebServices

public WebServices(org.apache.hadoop.yarn.api.ApplicationBaseProtocol appBaseProt)

Method Detail

getApps

public 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 nameQuery,
                        java.util.Set<java.lang.String> applicationTypes)

getApp

public AppInfo getApp(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse res,
                      java.lang.String appId)

getApp

public org.apache.hadoop.yarn.server.webapp.BasicAppInfo getApp(javax.servlet.http.HttpServletRequest req,
                                                                java.lang.String appId,
                                                                java.lang.String clusterId)

Description copied from interface: AppInfoProvider

Returns BasicAppInfo object that wraps the collected information about the application.

Specified by:

getApp in interface AppInfoProvider

Parameters:

req - HttpServletRequest associated with the request

appId - the id of the application

clusterId - the id of the cluster

Returns:

BasicAppInfo object

getApp

public AppInfo getApp(javax.servlet.http.HttpServletRequest req,
                      java.lang.String appId)

getAppAttempts

public AppAttemptsInfo getAppAttempts(javax.servlet.http.HttpServletRequest req,
                                      javax.servlet.http.HttpServletResponse res,
                                      java.lang.String appId)

getAppAttempt

public AppAttemptInfo getAppAttempt(javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse res,
                                    java.lang.String appId,
                                    java.lang.String appAttemptId)

getContainers

public ContainersInfo getContainers(javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse res,
                                    java.lang.String appId,
                                    java.lang.String appAttemptId)

getNodeHttpAddress

public java.lang.String getNodeHttpAddress(javax.servlet.http.HttpServletRequest req,
                                           java.lang.String appId,
                                           java.lang.String appAttemptId,
                                           java.lang.String containerId,
                                           java.lang.String clusterId)

Description copied from interface: AppInfoProvider

Returns the node HTTP address.

Specified by:

getNodeHttpAddress in interface AppInfoProvider

Parameters:

req - HttpServletRequest associated with the request

appId - the id of the application

appAttemptId - the id of the application attempt

containerId - the container id

clusterId - the id of the cluster

Returns:

the node HTTP address

getContainer

public ContainerInfo getContainer(javax.servlet.http.HttpServletRequest req,
                                  java.lang.String appId,
                                  java.lang.String appAttemptId,
                                  java.lang.String containerId)

getContainer

public ContainerInfo getContainer(javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse res,
                                  java.lang.String appId,
                                  java.lang.String appAttemptId,
                                  java.lang.String containerId)

initForReadableEndpoints

protected void initForReadableEndpoints(javax.servlet.http.HttpServletResponse response)

parseQueries

public static java.util.Set<java.lang.String> parseQueries(java.util.Set<java.lang.String> queries,
                                                           boolean isState)

parseApplicationId

protected static org.apache.hadoop.yarn.api.records.ApplicationId parseApplicationId(java.lang.String appId)

parseApplicationAttemptId

protected static org.apache.hadoop.yarn.api.records.ApplicationAttemptId parseApplicationAttemptId(java.lang.String appAttemptId)

parseContainerId

protected static org.apache.hadoop.yarn.api.records.ContainerId parseContainerId(java.lang.String containerId)

validateIds

protected void validateIds(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                           org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId,
                           org.apache.hadoop.yarn.api.records.ContainerId containerId)

getUser

protected static org.apache.hadoop.security.UserGroupInformation getUser(javax.servlet.http.HttpServletRequest req)

getApplicationReport

protected org.apache.hadoop.yarn.api.records.ApplicationReport getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest request)
                                                                             throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                    java.io.IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getApplicationsReport

protected java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport> getApplicationsReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest request)
                                                                                              throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                     java.io.IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getApplicationAttemptReport

protected org.apache.hadoop.yarn.api.records.ApplicationAttemptReport getApplicationAttemptReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest request)
                                                                                           throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                  java.io.IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getApplicationAttemptsReport

protected java.util.List<org.apache.hadoop.yarn.api.records.ApplicationAttemptReport> getApplicationAttemptsReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest request)
                                                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                   java.io.IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getContainerReport

protected org.apache.hadoop.yarn.api.records.ContainerReport getContainerReport(org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest request)
                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                java.io.IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getContainersReport

protected java.util.List<org.apache.hadoop.yarn.api.records.ContainerReport> getContainersReport(org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest request)
                                                                                          throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                 java.io.IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException