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

Class RMWebServices

java.lang.Object

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

org.apache.hadoop.yarn.server.resourcemanager.webapp.RMWebServices

All Implemented Interfaces:

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

public class RMWebServices
extends org.apache.hadoop.yarn.server.webapp.WebServices
implements RMWebServiceProtocol

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_ACTIVITIES_COUNT
static java.lang.String	DEFAULT_END_TIME
static java.lang.String	DEFAULT_INCLUDE_RESOURCE
static java.lang.String	DEFAULT_QUEUE
static java.lang.String	DEFAULT_RESERVATION_ID
static java.lang.String	DEFAULT_START_TIME
static java.lang.String	DEFAULT_SUMMARIZE
static java.lang.String	DELEGATION_TOKEN_HEADER
static int	MAX_ACTIVITIES_COUNT

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

appBaseProt

Constructor Summary

Constructors

Constructor	Description
RMWebServices(ResourceManager rm, org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addToClusterNodeLabels(NodeLabelsInfo newNodeLabels, javax.servlet.http.HttpServletRequest hsr)	This method adds specific node labels for specific nodes, and it is reachable by using RMWSConsts.ADD_NODE_LABELS.
javax.ws.rs.core.Response	cancelDelegationToken(javax.servlet.http.HttpServletRequest hsr)	This method cancel the delegation token from the client, and it is reachable by using RMWSConsts.DELEGATION_TOKEN.
RMQueueAclInfo	checkUserAccessToQueue(java.lang.String queue, java.lang.String username, java.lang.String queueAclType, javax.servlet.http.HttpServletRequest hsr)	This method verifies if a user has access to a specified queue.
javax.ws.rs.core.Response	createNewApplication(javax.servlet.http.HttpServletRequest hsr)	Generates a new ApplicationId which is then sent to the client.
javax.ws.rs.core.Response	createNewReservation(javax.servlet.http.HttpServletRequest hsr)	Generates a new ReservationId which is then sent to the client.
javax.ws.rs.core.Response	deleteReservation(ReservationDeleteRequestInfo resContext, javax.servlet.http.HttpServletRequest hsr)	Function to delete a Reservation to the RM.
java.lang.String	dumpSchedulerLogs(java.lang.String time, javax.servlet.http.HttpServletRequest hsr)	This method dumps the scheduler logs for the time got in input, and it is reachable by using RMWSConsts.SCHEDULER_LOGS.
static java.lang.String	escapeInvalidXMLCharacters(java.lang.String str)	This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard.
javax.ws.rs.core.Response	formatSchedulerConfiguration(javax.servlet.http.HttpServletRequest hsr)
ClusterInfo	get()	This method retrieves the cluster information, and it is reachable by using RMWSConsts.INFO.
ActivitiesInfo	getActivities(javax.servlet.http.HttpServletRequest hsr, java.lang.String nodeId, java.lang.String groupBy)	This method retrieve all the activities in a specific node, and it is reachable by using RMWSConsts.SCHEDULER_ACTIVITIES.
AppInfo	getApp(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId, java.util.Set<java.lang.String> unselectedFields)	This method retrieves the report for a specific app, and it is reachable by using RMWSConsts.APPS_APPID.
AppActivitiesInfo	getAppActivities(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId, java.lang.String time, java.util.Set<java.lang.String> requestPriorities, java.util.Set<java.lang.String> allocationRequestIds, java.lang.String groupBy, java.lang.String limit, java.util.Set<java.lang.String> actions, boolean summarize)	This method retrieves all the activities for a specific app for a specific period of time, and it is reachable by using RMWSConsts.SCHEDULER_APP_ACTIVITIES.
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)
AppAttemptsInfo	getAppAttempts(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method retrieves all the attempts information for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_APPATTEMPTS.
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)
AppPriority	getAppPriority(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method retrieves the priority for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_PRIORITY.
AppQueue	getAppQueue(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method retrieves the queue for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_QUEUE.
AppsInfo	getApps(javax.servlet.http.HttpServletRequest hsr, 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 limit, java.lang.String startedBegin, java.lang.String startedEnd, java.lang.String finishBegin, java.lang.String finishEnd, java.util.Set<java.lang.String> applicationTypes, java.util.Set<java.lang.String> applicationTags, java.lang.String name, java.util.Set<java.lang.String> unselectedFields)	This method retrieves all the app reports in the cluster, and it is reachable by using RMWSConsts.APPS.
org.apache.hadoop.yarn.util.LRUCache<org.apache.hadoop.yarn.util.AppsCacheKey,AppsInfo>	getAppsLRUCache()
AppState	getAppState(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method retrieves the state for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_STATE.
ApplicationStatisticsInfo	getAppStatistics(javax.servlet.http.HttpServletRequest hsr, java.util.Set<java.lang.String> stateQueries, java.util.Set<java.lang.String> typeQueries)	This method retrieves all the statistics for a specific app, and it is reachable by using RMWSConsts.APP_STATISTICS.
AppTimeoutInfo	getAppTimeout(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId, java.lang.String type)	This method retrieves the timeout information for a specific app with a specific type, and it is reachable by using RMWSConsts.APPS_TIMEOUTS_TYPE.
AppTimeoutsInfo	getAppTimeouts(javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method retrieves the timeout information for a specific app, and it is reachable by using RMWSConsts.APPS_TIMEOUTS.
BulkActivitiesInfo	getBulkActivities(javax.servlet.http.HttpServletRequest hsr, java.lang.String groupBy, int activitiesCount)	This method retrieve the last n activities inside scheduler, and it is reachable by using RMWSConsts.SCHEDULER_BULK_ACTIVITIES.
ClusterInfo	getClusterInfo()	This method retrieves the cluster information, and it is reachable by using RMWSConsts.INFO.
ClusterMetricsInfo	getClusterMetricsInfo()	This method retrieves the cluster metrics information, and it is reachable by using RMWSConsts.METRICS.
NodeLabelsInfo	getClusterNodeLabels(javax.servlet.http.HttpServletRequest hsr)	This method retrieves all the node labels in the cluster, and it is reachable by using RMWSConsts.GET_NODE_LABELS.
ClusterUserInfo	getClusterUserInfo(javax.servlet.http.HttpServletRequest hsr)	This method retrieves the cluster user information, and it is reachable by using RMWSConsts.CLUSTER_USER_INFO.
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)
protected org.apache.hadoop.yarn.api.records.ContainerReport	getContainerReport(org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest request)
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)
protected java.util.List<org.apache.hadoop.yarn.api.records.ContainerReport>	getContainersReport(org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest request)
NodeLabelsInfo	getLabelsOnNode(javax.servlet.http.HttpServletRequest hsr, java.lang.String nodeId)	This method retrieves all the node labels for specific node, and it is reachable by using RMWSConsts.NODES_NODEID_GETLABELS.
LabelsToNodesInfo	getLabelsToNodes(java.util.Set<java.lang.String> labels)	This method retrieves all the node within multiple node labels in the cluster, and it is reachable by using RMWSConsts.LABEL_MAPPINGS.
NodeInfo	getNode(java.lang.String nodeId)	This method retrieves a specific node information, and it is reachable by using RMWSConsts.NODES_NODEID.
NodesInfo	getNodes(java.lang.String states)	This method retrieves all the nodes information in the cluster, and it is reachable by using RMWSConsts.NODES.
NodeToLabelsInfo	getNodeToLabels(javax.servlet.http.HttpServletRequest hsr)	This method retrieves all the node labels with the respective nodes in the cluster, and it is reachable by using RMWSConsts.GET_NODE_TO_LABELS.
NodeLabelsInfo	getRMNodeLabels(javax.servlet.http.HttpServletRequest hsr)
javax.ws.rs.core.Response	getSchedulerConfiguration(javax.servlet.http.HttpServletRequest hsr)	This method retrieves all the Scheduler configuration, and it is reachable by using RMWSConsts.SCHEDULER_CONF.
javax.ws.rs.core.Response	getSchedulerConfigurationVersion(javax.servlet.http.HttpServletRequest hsr)
SchedulerTypeInfo	getSchedulerInfo()	This method retrieves the current scheduler status, and it is reachable by using RMWSConsts.SCHEDULER.
SchedulerOverviewInfo	getSchedulerOverview()
protected java.lang.Boolean	hasAccess(RMApp app, javax.servlet.http.HttpServletRequest hsr)
protected javax.ws.rs.core.Response	killApp(RMApp app, org.apache.hadoop.security.UserGroupInformation callerUGI, javax.servlet.http.HttpServletRequest hsr, java.lang.String diagnostic)
javax.ws.rs.core.Response	listReservation(java.lang.String queue, java.lang.String reservationId, long startTime, long endTime, boolean includeResourceAllocations, javax.servlet.http.HttpServletRequest hsr)	Function to retrieve a list of all the reservations.
protected javax.ws.rs.core.Response	moveApp(RMApp app, org.apache.hadoop.security.UserGroupInformation callerUGI, java.lang.String targetQueue)
javax.ws.rs.core.Response	postDelegationToken(DelegationToken tokenData, javax.servlet.http.HttpServletRequest hsr)	This method posts a delegation token from the client, and it is reachable by using RMWSConsts.DELEGATION_TOKEN.
javax.ws.rs.core.Response	postDelegationTokenExpiration(javax.servlet.http.HttpServletRequest hsr)	This method updates the expiration for a delegation token from the client, and it is reachable by using RMWSConsts.DELEGATION_TOKEN_EXPIRATION.
javax.ws.rs.core.Response	removeFromClusterNodeLabels(java.util.Set<java.lang.String> oldNodeLabels, javax.servlet.http.HttpServletRequest hsr)	This method removes all the node labels for specific nodes, and it is reachable by using RMWSConsts.REMOVE_NODE_LABELS.
javax.ws.rs.core.Response	replaceLabelsOnNode(java.util.Set<java.lang.String> newNodeLabelsName, javax.servlet.http.HttpServletRequest hsr, java.lang.String nodeId)	This method replaces all the node labels for specific node, and it is reachable by using RMWSConsts.NODES_NODEID_REPLACE_LABELS.
javax.ws.rs.core.Response	replaceLabelsOnNodes(NodeToLabelsEntryList newNodeToLabels, javax.servlet.http.HttpServletRequest hsr)	This method replaces all the node labels for specific nodes, and it is reachable by using RMWSConsts.REPLACE_NODE_TO_LABELS.
javax.ws.rs.core.Response	signalToContainer(java.lang.String containerId, java.lang.String command, javax.servlet.http.HttpServletRequest hsr)	This method sends a signal to container.
javax.ws.rs.core.Response	submitApplication(ApplicationSubmissionContextInfo newApp, javax.servlet.http.HttpServletRequest hsr)	Function to submit an app to the RM.
javax.ws.rs.core.Response	submitReservation(ReservationSubmissionRequestInfo resContext, javax.servlet.http.HttpServletRequest hsr)	Function to submit a Reservation to the RM.This method is reachable by using RMWSConsts.RESERVATION_SUBMIT.
javax.ws.rs.core.Response	updateApplicationPriority(AppPriority targetPriority, javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method updates the priority for a specific application, and it is reachable by using RMWSConsts.APPS_APPID_PRIORITY.
javax.ws.rs.core.Response	updateApplicationTimeout(AppTimeoutInfo appTimeout, javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method updates the timeout information for a specific app, and it is reachable by using RMWSConsts.APPS_TIMEOUT.
javax.ws.rs.core.Response	updateAppQueue(AppQueue targetQueue, javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method updates the queue for a specific application, and it is reachable by using RMWSConsts.APPS_APPID_QUEUE.
javax.ws.rs.core.Response	updateAppState(AppState targetState, javax.servlet.http.HttpServletRequest hsr, java.lang.String appId)	This method updates the state of the app in input, and it is reachable by using RMWSConsts.APPS_APPID_STATE.
ResourceInfo	updateNodeResource(javax.servlet.http.HttpServletRequest hsr, java.lang.String nodeId, ResourceOptionInfo resourceOption)	This method changes the resources of a specific node, and it is reachable by using RMWSConsts.NODE_RESOURCE.
javax.ws.rs.core.Response	updateReservation(ReservationUpdateRequestInfo resContext, javax.servlet.http.HttpServletRequest hsr)	Function to update a Reservation to the RM.
javax.ws.rs.core.Response	updateSchedulerConfiguration(org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo mutationInfo, javax.servlet.http.HttpServletRequest hsr)	This method updates the Scheduler configuration, and it is reachable by using RMWSConsts.SCHEDULER_CONF.
javax.ws.rs.core.Response	validateAndGetSchedulerConfiguration(org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo mutationInfo, javax.servlet.http.HttpServletRequest hsr)

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

getApp, getApp, getApp, getAppAttempts, getApps, getContainer, 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

Field Detail

DEFAULT_QUEUE

public static final java.lang.String DEFAULT_QUEUE

See Also:

Constant Field Values

DEFAULT_RESERVATION_ID

public static final java.lang.String DEFAULT_RESERVATION_ID

See Also:

Constant Field Values

DEFAULT_START_TIME

public static final java.lang.String DEFAULT_START_TIME

See Also:

Constant Field Values

DEFAULT_END_TIME

public static final java.lang.String DEFAULT_END_TIME

See Also:

Constant Field Values

DEFAULT_INCLUDE_RESOURCE

public static final java.lang.String DEFAULT_INCLUDE_RESOURCE

See Also:

Constant Field Values

DEFAULT_SUMMARIZE

public static final java.lang.String DEFAULT_SUMMARIZE

See Also:

Constant Field Values

DEFAULT_ACTIVITIES_COUNT

public static final java.lang.String DEFAULT_ACTIVITIES_COUNT

See Also:

Constant Field Values

MAX_ACTIVITIES_COUNT

public static final int MAX_ACTIVITIES_COUNT

See Also:

Constant Field Values

DELEGATION_TOKEN_HEADER

public static final java.lang.String DELEGATION_TOKEN_HEADER

See Also:

Constant Field Values

Constructor Detail

RMWebServices

@Inject
public RMWebServices(ResourceManager rm,
                     org.apache.hadoop.conf.Configuration conf)

Method Detail

hasAccess

protected java.lang.Boolean hasAccess(RMApp app,
                                      javax.servlet.http.HttpServletRequest hsr)

get

public ClusterInfo get()

Description copied from interface: RMWebServiceProtocol

This method retrieves the cluster information, and it is reachable by using RMWSConsts.INFO.

Specified by:

get in interface RMWebServiceProtocol

Returns:

the cluster information

getClusterInfo

public ClusterInfo getClusterInfo()

Description copied from interface: RMWebServiceProtocol

This method retrieves the cluster information, and it is reachable by using RMWSConsts.INFO.

Specified by:

getClusterInfo in interface RMWebServiceProtocol

Returns:

the cluster information

getClusterUserInfo

public ClusterUserInfo getClusterUserInfo(@Context
                                          javax.servlet.http.HttpServletRequest hsr)

Description copied from interface: RMWebServiceProtocol

This method retrieves the cluster user information, and it is reachable by using RMWSConsts.CLUSTER_USER_INFO.

Specified by:

getClusterUserInfo in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

the cluster user information

getClusterMetricsInfo

public ClusterMetricsInfo getClusterMetricsInfo()

Description copied from interface: RMWebServiceProtocol

This method retrieves the cluster metrics information, and it is reachable by using RMWSConsts.METRICS.

Specified by:

getClusterMetricsInfo in interface RMWebServiceProtocol

Returns:

the cluster metrics information

See Also:

ApplicationClientProtocol.getClusterMetrics(org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest)

getSchedulerInfo

public SchedulerTypeInfo getSchedulerInfo()

Description copied from interface: RMWebServiceProtocol

This method retrieves the current scheduler status, and it is reachable by using RMWSConsts.SCHEDULER.

Specified by:

getSchedulerInfo in interface RMWebServiceProtocol

Returns:

the current scheduler status

dumpSchedulerLogs

public java.lang.String dumpSchedulerLogs(java.lang.String time,
                                          @Context
                                          javax.servlet.http.HttpServletRequest hsr)
                                   throws java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method dumps the scheduler logs for the time got in input, and it is reachable by using RMWSConsts.SCHEDULER_LOGS.

Specified by:

dumpSchedulerLogs in interface RMWebServiceProtocol

Parameters:

time - the period of time. It is a FormParam.

hsr - the servlet request

Returns:

the result of the operation

Throws:

java.io.IOException - when it cannot create dump log file

getNodes

public NodesInfo getNodes(java.lang.String states)

Description copied from interface: RMWebServiceProtocol

This method retrieves all the nodes information in the cluster, and it is reachable by using RMWSConsts.NODES.

Specified by:

getNodes in interface RMWebServiceProtocol

Parameters:

states - the states we want to filter. It is a QueryParam.

Returns:

all nodes in the cluster. If the states param is given, returns all nodes that are in the comma-separated list of states

See Also:

ApplicationClientProtocol.getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)

getNode

public NodeInfo getNode(java.lang.String nodeId)

Description copied from interface: RMWebServiceProtocol

This method retrieves a specific node information, and it is reachable by using RMWSConsts.NODES_NODEID.

Specified by:

getNode in interface RMWebServiceProtocol

Parameters:

nodeId - the node we want to retrieve the information. It is a PathParam.

Returns:

the information about the node in input

updateNodeResource

public ResourceInfo updateNodeResource(@Context
                                       javax.servlet.http.HttpServletRequest hsr,
                                       java.lang.String nodeId,
                                       ResourceOptionInfo resourceOption)
                                throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method changes the resources of a specific node, and it is reachable by using RMWSConsts.NODE_RESOURCE.

Specified by:

updateNodeResource in interface RMWebServiceProtocol

Parameters:

hsr - The servlet request.

nodeId - The node we want to retrieve the information for. It is a PathParam.

resourceOption - The resource change.

Returns:

the resources of a specific node.

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - If the user is not authorized.

escapeInvalidXMLCharacters

public static java.lang.String escapeInvalidXMLCharacters(java.lang.String str)

This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard. For reference, please see the standard.

Parameters:

str - The String whose invalid xml characters we want to escape.

Returns:

The str String after escaping invalid xml characters.

getApps

public AppsInfo getApps(@Context
                        javax.servlet.http.HttpServletRequest hsr,
                        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 limit,
                        java.lang.String startedBegin,
                        java.lang.String startedEnd,
                        java.lang.String finishBegin,
                        java.lang.String finishEnd,
                        java.util.Set<java.lang.String> applicationTypes,
                        java.util.Set<java.lang.String> applicationTags,
                        java.lang.String name,
                        java.util.Set<java.lang.String> unselectedFields)

Description copied from interface: RMWebServiceProtocol

This method retrieves all the app reports in the cluster, and it is reachable by using RMWSConsts.APPS.

Specified by:

getApps in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

stateQuery - right now the stateQuery is deprecated. It is a QueryParam.

statesQuery - filter the result by states. It is a QueryParam.

finalStatusQuery - filter the result by final states. It is a QueryParam.

userQuery - filter the result by user. It is a QueryParam.

queueQuery - filter the result by queue. It is a QueryParam.

limit - set a limit of the result. It is a QueryParam.

startedBegin - filter the result by started begin time. It is a QueryParam.

startedEnd - filter the result by started end time. It is a QueryParam.

finishBegin - filter the result by finish begin time. It is a QueryParam.

finishEnd - filter the result by finish end time. It is a QueryParam.

applicationTypes - filter the result by types. It is a QueryParam.

applicationTags - filter the result by tags. It is a QueryParam.

name - filter the name of the application. It is a QueryParam.

unselectedFields - De-selected params to avoid from report. It is a QueryParam.

Returns:

all apps in the cluster

See Also:

ApplicationBaseProtocol.getApplications(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest)

getActivities

public ActivitiesInfo getActivities(@Context
                                    javax.servlet.http.HttpServletRequest hsr,
                                    java.lang.String nodeId,
                                    java.lang.String groupBy)

Description copied from interface: RMWebServiceProtocol

This method retrieve all the activities in a specific node, and it is reachable by using RMWSConsts.SCHEDULER_ACTIVITIES.

Specified by:

getActivities in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

nodeId - the node we want to retrieve the activities. It is a QueryParam.

groupBy - the groupBy type by which the activities should be aggregated. It is a QueryParam.

Returns:

all the activities in the specific node

getBulkActivities

public BulkActivitiesInfo getBulkActivities(@Context
                                            javax.servlet.http.HttpServletRequest hsr,
                                            java.lang.String groupBy,
                                            int activitiesCount)
                                     throws java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

This method retrieve the last n activities inside scheduler, and it is reachable by using RMWSConsts.SCHEDULER_BULK_ACTIVITIES.

Specified by:

getBulkActivities in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

groupBy - the groupBy type by which the activities should be aggregated. It is a QueryParam.

activitiesCount - number of activities

Returns:

last n activities

Throws:

java.lang.InterruptedException - if interrupted.

getAppActivities

public AppActivitiesInfo getAppActivities(@Context
                                          javax.servlet.http.HttpServletRequest hsr,
                                          java.lang.String appId,
                                          java.lang.String time,
                                          java.util.Set<java.lang.String> requestPriorities,
                                          java.util.Set<java.lang.String> allocationRequestIds,
                                          java.lang.String groupBy,
                                          java.lang.String limit,
                                          java.util.Set<java.lang.String> actions,
                                          boolean summarize)

Description copied from interface: RMWebServiceProtocol

This method retrieves all the activities for a specific app for a specific period of time, and it is reachable by using RMWSConsts.SCHEDULER_APP_ACTIVITIES.

Specified by:

getAppActivities in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the applicationId we want to retrieve the activities. It is a QueryParam.

time - for how long we want to retrieve the activities. It is a QueryParam.

requestPriorities - the request priorities we want to retrieve the activities. It is a QueryParam.

allocationRequestIds - the allocation request ids we want to retrieve the activities. It is a QueryParam.

groupBy - the groupBy type by which the activities should be aggregated. It is a QueryParam.

limit - set a limit of the result. It is a QueryParam.

actions - the required actions of app activities. It is a QueryParam.

summarize - whether app activities in multiple scheduling processes need to be summarized. It is a QueryParam.

Returns:

all the activities about a specific app for a specific time

getAppStatistics

public ApplicationStatisticsInfo getAppStatistics(@Context
                                                  javax.servlet.http.HttpServletRequest hsr,
                                                  java.util.Set<java.lang.String> stateQueries,
                                                  java.util.Set<java.lang.String> typeQueries)

Description copied from interface: RMWebServiceProtocol

This method retrieves all the statistics for a specific app, and it is reachable by using RMWSConsts.APP_STATISTICS.

Specified by:

getAppStatistics in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

stateQueries - filter the result by states. It is a QueryParam.

typeQueries - filter the result by type names. It is a QueryParam.

Returns:

the application's statistics for specific states and types

getApp

public AppInfo getApp(@Context
                      javax.servlet.http.HttpServletRequest hsr,
                      java.lang.String appId,
                      java.util.Set<java.lang.String> unselectedFields)

Description copied from interface: RMWebServiceProtocol

This method retrieves the report for a specific app, and it is reachable by using RMWSConsts.APPS_APPID.

Specified by:

getApp in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the Id of the application we want the report. It is a PathParam.

unselectedFields - De-selected param list to avoid from report. It is a QueryParam.

Returns:

the app report for a specific application

See Also:

ApplicationBaseProtocol.getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)

getAppAttempts

public AppAttemptsInfo getAppAttempts(@Context
                                      javax.servlet.http.HttpServletRequest hsr,
                                      java.lang.String appId)

Description copied from interface: RMWebServiceProtocol

This method retrieves all the attempts information for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_APPATTEMPTS.

Specified by:

getAppAttempts in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the application we want to get the attempts. It is a PathParam.

Returns:

all the attempts info for a specific application

See Also:

ApplicationBaseProtocol.getApplicationAttempts(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest)

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

getAppState

public AppState getAppState(@Context
                            javax.servlet.http.HttpServletRequest hsr,
                            java.lang.String appId)
                     throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method retrieves the state for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_STATE.

Specified by:

getAppState in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the Id of the application we want the state. It is a PathParam.

Returns:

the state for a specific application

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized

updateAppState

public javax.ws.rs.core.Response updateAppState(AppState targetState,
                                                @Context
                                                javax.servlet.http.HttpServletRequest hsr,
                                                java.lang.String appId)
                                         throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                org.apache.hadoop.yarn.exceptions.YarnException,
                                                java.lang.InterruptedException,
                                                java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method updates the state of the app in input, and it is reachable by using RMWSConsts.APPS_APPID_STATE.

Specified by:

updateAppState in interface RMWebServiceProtocol

Parameters:

targetState - the target state for the app. It is a content param.

hsr - the servlet request

appId - the Id of the application we want to update the state. It is a PathParam.

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method

org.apache.hadoop.yarn.exceptions.YarnException - if app does not exist

java.lang.InterruptedException - if interrupted

java.io.IOException - if doAs action throws an IOException

getNodeToLabels

public NodeToLabelsInfo getNodeToLabels(@Context
                                        javax.servlet.http.HttpServletRequest hsr)
                                 throws java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method retrieves all the node labels with the respective nodes in the cluster, and it is reachable by using RMWSConsts.GET_NODE_TO_LABELS.

Specified by:

getNodeToLabels in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

all the nodes within a node label

Throws:

java.io.IOException - if an IOException happened

See Also:

ApplicationClientProtocol.getNodeToLabels(org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest)

getLabelsToNodes

public LabelsToNodesInfo getLabelsToNodes(java.util.Set<java.lang.String> labels)
                                   throws java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method retrieves all the node within multiple node labels in the cluster, and it is reachable by using RMWSConsts.LABEL_MAPPINGS.

Specified by:

getLabelsToNodes in interface RMWebServiceProtocol

Parameters:

labels - filter the result by node labels. It is a QueryParam.

Returns:

all the nodes within multiple node labels

Throws:

java.io.IOException - if an IOException happened

See Also:

ApplicationClientProtocol.getLabelsToNodes(org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest)

replaceLabelsOnNodes

public javax.ws.rs.core.Response replaceLabelsOnNodes(NodeToLabelsEntryList newNodeToLabels,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest hsr)
                                               throws java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method replaces all the node labels for specific nodes, and it is reachable by using RMWSConsts.REPLACE_NODE_TO_LABELS.

Specified by:

replaceLabelsOnNodes in interface RMWebServiceProtocol

Parameters:

newNodeToLabels - the list of new labels. It is a content param.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

java.io.IOException

See Also:

ResourceManagerAdministrationProtocol.replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest)

replaceLabelsOnNode

public javax.ws.rs.core.Response replaceLabelsOnNode(java.util.Set<java.lang.String> newNodeLabelsName,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest hsr,
                                                     java.lang.String nodeId)
                                              throws java.lang.Exception

Description copied from interface: RMWebServiceProtocol

This method replaces all the node labels for specific node, and it is reachable by using RMWSConsts.NODES_NODEID_REPLACE_LABELS.

Specified by:

replaceLabelsOnNode in interface RMWebServiceProtocol

Parameters:

newNodeLabelsName - the list of new labels. It is a QueryParam.

hsr - the servlet request

nodeId - the node we want to replace the node labels. It is a PathParam.

Returns:

Response containing the status code

Throws:

java.lang.Exception - if an exception happened

See Also:

ResourceManagerAdministrationProtocol.replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest)

getClusterNodeLabels

public NodeLabelsInfo getClusterNodeLabels(@Context
                                           javax.servlet.http.HttpServletRequest hsr)
                                    throws java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method retrieves all the node labels in the cluster, and it is reachable by using RMWSConsts.GET_NODE_LABELS.

Specified by:

getClusterNodeLabels in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

all the node labels in the cluster

Throws:

java.io.IOException - if an IOException happened

See Also:

ApplicationClientProtocol.getClusterNodeLabels(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest)

getRMNodeLabels

public NodeLabelsInfo getRMNodeLabels(@Context
                                      javax.servlet.http.HttpServletRequest hsr)
                               throws java.io.IOException

Specified by:

getRMNodeLabels in interface RMWebServiceProtocol

Throws:

java.io.IOException

addToClusterNodeLabels

public javax.ws.rs.core.Response addToClusterNodeLabels(NodeLabelsInfo newNodeLabels,
                                                        @Context
                                                        javax.servlet.http.HttpServletRequest hsr)
                                                 throws java.lang.Exception

Description copied from interface: RMWebServiceProtocol

This method adds specific node labels for specific nodes, and it is reachable by using RMWSConsts.ADD_NODE_LABELS.

Specified by:

addToClusterNodeLabels in interface RMWebServiceProtocol

Parameters:

newNodeLabels - the node labels to add. It is a content param.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

java.lang.Exception - in case of bad request

See Also:

ResourceManagerAdministrationProtocol.addToClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsRequest)

removeFromClusterNodeLabels

public javax.ws.rs.core.Response removeFromClusterNodeLabels(java.util.Set<java.lang.String> oldNodeLabels,
                                                             @Context
                                                             javax.servlet.http.HttpServletRequest hsr)
                                                      throws java.lang.Exception

Description copied from interface: RMWebServiceProtocol

This method removes all the node labels for specific nodes, and it is reachable by using RMWSConsts.REMOVE_NODE_LABELS.

Specified by:

removeFromClusterNodeLabels in interface RMWebServiceProtocol

Parameters:

oldNodeLabels - the node labels to remove. It is a QueryParam.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

java.lang.Exception - in case of bad request

See Also:

ResourceManagerAdministrationProtocol.removeFromClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsRequest)

getLabelsOnNode

public NodeLabelsInfo getLabelsOnNode(@Context
                                      javax.servlet.http.HttpServletRequest hsr,
                                      java.lang.String nodeId)
                               throws java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method retrieves all the node labels for specific node, and it is reachable by using RMWSConsts.NODES_NODEID_GETLABELS.

Specified by:

getLabelsOnNode in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

nodeId - the node we want to get all the node labels. It is a PathParam.

Returns:

all the labels for a specific node.

Throws:

java.io.IOException - if an IOException happened

killApp

protected javax.ws.rs.core.Response killApp(RMApp app,
                                            org.apache.hadoop.security.UserGroupInformation callerUGI,
                                            javax.servlet.http.HttpServletRequest hsr,
                                            java.lang.String diagnostic)
                                     throws java.io.IOException,
                                            java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

getAppPriority

public AppPriority getAppPriority(@Context
                                  javax.servlet.http.HttpServletRequest hsr,
                                  java.lang.String appId)
                           throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method retrieves the priority for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_PRIORITY.

Specified by:

getAppPriority in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the app we want to get the priority. It is a PathParam.

Returns:

the priority for a specific application

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - in case of the user is not authorized

updateApplicationPriority

public javax.ws.rs.core.Response updateApplicationPriority(AppPriority targetPriority,
                                                           @Context
                                                           javax.servlet.http.HttpServletRequest hsr,
                                                           java.lang.String appId)
                                                    throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                           org.apache.hadoop.yarn.exceptions.YarnException,
                                                           java.lang.InterruptedException,
                                                           java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method updates the priority for a specific application, and it is reachable by using RMWSConsts.APPS_APPID_PRIORITY.

Specified by:

updateApplicationPriority in interface RMWebServiceProtocol

Parameters:

targetPriority - the priority we want to set for the app. It is a content param.

hsr - the servlet request

appId - the application we want to update its priority. It is a PathParam.

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authenticated

org.apache.hadoop.yarn.exceptions.YarnException - if the target is null

java.lang.InterruptedException - if interrupted.

java.io.IOException - if the update fails.

getAppQueue

public AppQueue getAppQueue(@Context
                            javax.servlet.http.HttpServletRequest hsr,
                            java.lang.String appId)
                     throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method retrieves the queue for a specific app, and it is reachable by using RMWSConsts.APPS_APPID_QUEUE.

Specified by:

getAppQueue in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the application we want to retrieve its queue. It is a PathParam.

Returns:

the Queue for a specific application.

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authenticated

updateAppQueue

public javax.ws.rs.core.Response updateAppQueue(AppQueue targetQueue,
                                                @Context
                                                javax.servlet.http.HttpServletRequest hsr,
                                                java.lang.String appId)
                                         throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                org.apache.hadoop.yarn.exceptions.YarnException,
                                                java.lang.InterruptedException,
                                                java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method updates the queue for a specific application, and it is reachable by using RMWSConsts.APPS_APPID_QUEUE.

Specified by:

updateAppQueue in interface RMWebServiceProtocol

Parameters:

targetQueue - the queue we want to set. It is a content param.

hsr - the servlet request

appId - the application we want to change its queue. It is a PathParam.

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authenticated

org.apache.hadoop.yarn.exceptions.YarnException - if the app is not found

java.lang.InterruptedException - if interrupted.

java.io.IOException - if the update fails.

moveApp

protected javax.ws.rs.core.Response moveApp(RMApp app,
                                            org.apache.hadoop.security.UserGroupInformation callerUGI,
                                            java.lang.String targetQueue)
                                     throws java.io.IOException,
                                            java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

createNewApplication

public javax.ws.rs.core.Response createNewApplication(@Context
                                                      javax.servlet.http.HttpServletRequest hsr)
                                               throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                      java.io.IOException,
                                                      java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

Generates a new ApplicationId which is then sent to the client. This method is reachable by using RMWSConsts.APPS_NEW_APPLICATION.

Specified by:

createNewApplication in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

Response containing the app id and the maximum resource capabilities

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method

java.io.IOException - if the creation fails

java.lang.InterruptedException - if interrupted

See Also:

ApplicationClientProtocol.getNewApplication(org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest)

submitApplication

public javax.ws.rs.core.Response submitApplication(ApplicationSubmissionContextInfo newApp,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest hsr)
                                            throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                   java.io.IOException,
                                                   java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

Function to submit an app to the RM. This method is reachable by using RMWSConsts.APPS.

Specified by:

submitApplication in interface RMWebServiceProtocol

Parameters:

newApp - structure containing information to construct the ApplicationSubmissionContext. It is a content param.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method

java.io.IOException - if the submission failed

java.lang.InterruptedException - if interrupted

See Also:

ApplicationClientProtocol.submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)

postDelegationToken

public javax.ws.rs.core.Response postDelegationToken(DelegationToken tokenData,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest hsr)
                                              throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                     java.io.IOException,
                                                     java.lang.InterruptedException,
                                                     java.lang.Exception

Description copied from interface: RMWebServiceProtocol

This method posts a delegation token from the client, and it is reachable by using RMWSConsts.DELEGATION_TOKEN.

Specified by:

postDelegationToken in interface RMWebServiceProtocol

Parameters:

tokenData - the token to delegate. It is a content param.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if Kerberos auth failed

java.io.IOException - if the delegation failed

java.lang.InterruptedException - if interrupted

java.lang.Exception - in case of bad request

See Also:

ApplicationBaseProtocol.getDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest)

postDelegationTokenExpiration

public javax.ws.rs.core.Response postDelegationTokenExpiration(@Context
                                                               javax.servlet.http.HttpServletRequest hsr)
                                                        throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                               java.io.IOException,
                                                               java.lang.InterruptedException,
                                                               java.lang.Exception

Description copied from interface: RMWebServiceProtocol

This method updates the expiration for a delegation token from the client, and it is reachable by using RMWSConsts.DELEGATION_TOKEN_EXPIRATION.

Specified by:

postDelegationTokenExpiration in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if Kerberos auth failed

java.io.IOException - if the delegation failed

java.lang.Exception - in case of bad request

java.lang.InterruptedException

See Also:

ApplicationBaseProtocol.renewDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.RenewDelegationTokenRequest)

cancelDelegationToken

public javax.ws.rs.core.Response cancelDelegationToken(@Context
                                                       javax.servlet.http.HttpServletRequest hsr)
                                                throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                       java.io.IOException,
                                                       java.lang.InterruptedException,
                                                       java.lang.Exception

Description copied from interface: RMWebServiceProtocol

This method cancel the delegation token from the client, and it is reachable by using RMWSConsts.DELEGATION_TOKEN.

Specified by:

cancelDelegationToken in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if Kerberos auth failed

java.io.IOException - if the delegation failed

java.lang.InterruptedException - if interrupted

java.lang.Exception - in case of bad request

See Also:

ApplicationBaseProtocol.cancelDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.CancelDelegationTokenRequest)

createNewReservation

public javax.ws.rs.core.Response createNewReservation(@Context
                                                      javax.servlet.http.HttpServletRequest hsr)
                                               throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                      java.io.IOException,
                                                      java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

Generates a new ReservationId which is then sent to the client. This method is reachable by using RMWSConsts.RESERVATION_NEW.

Specified by:

createNewReservation in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

Response containing the app id and the maximum resource capabilities

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method.

java.io.IOException - if creation failed

java.lang.InterruptedException - if interrupted

See Also:

ApplicationClientProtocol.getNewReservation(org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest)

submitReservation

public javax.ws.rs.core.Response submitReservation(ReservationSubmissionRequestInfo resContext,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest hsr)
                                            throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                   java.io.IOException,
                                                   java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

Function to submit a Reservation to the RM.This method is reachable by using RMWSConsts.RESERVATION_SUBMIT.

Specified by:

submitReservation in interface RMWebServiceProtocol

Parameters:

resContext - provides information to construct the ReservationSubmissionRequest. It is a content param.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method

java.io.IOException - if creation failed

java.lang.InterruptedException - if interrupted

See Also:

ApplicationClientProtocol.submitReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest)

updateReservation

public javax.ws.rs.core.Response updateReservation(ReservationUpdateRequestInfo resContext,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest hsr)
                                            throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                   java.io.IOException,
                                                   java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

Function to update a Reservation to the RM. This method is reachable by using RMWSConsts.RESERVATION_UPDATE.

Specified by:

updateReservation in interface RMWebServiceProtocol

Parameters:

resContext - provides information to construct the ReservationUpdateRequest. It is a content param.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method

java.io.IOException - if the operation failed

java.lang.InterruptedException - if interrupted

See Also:

ApplicationClientProtocol.updateReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest)

deleteReservation

public javax.ws.rs.core.Response deleteReservation(ReservationDeleteRequestInfo resContext,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest hsr)
                                            throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                   java.io.IOException,
                                                   java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

Function to delete a Reservation to the RM. This method is reachable by using RMWSConsts.RESERVATION_DELETE.

Specified by:

deleteReservation in interface RMWebServiceProtocol

Parameters:

resContext - provides information to construct the ReservationDeleteRequest. It is a content param.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - when the user group information cannot be retrieved.

java.io.IOException - when a ReservationDeleteRequest cannot be created from the ReservationDeleteRequestInfo. This exception is also thrown on ClientRMService.deleteReservation invocation failure.

java.lang.InterruptedException - if doAs action throws an InterruptedException.

See Also:

ApplicationClientProtocol.deleteReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest)

listReservation

public javax.ws.rs.core.Response listReservation(java.lang.String queue,
                                                 java.lang.String reservationId,
                                                 long startTime,
                                                 long endTime,
                                                 boolean includeResourceAllocations,
                                                 @Context
                                                 javax.servlet.http.HttpServletRequest hsr)
                                          throws java.lang.Exception

Description copied from interface: RMWebServiceProtocol

Function to retrieve a list of all the reservations. This method is reachable by using RMWSConsts.RESERVATION_LIST.

Specified by:

listReservation in interface RMWebServiceProtocol

Parameters:

queue - filter the result by queue. It is a QueryParam.

reservationId - filter the result by reservationId. It is a QueryParam.

startTime - filter the result by start time. It is a QueryParam.

endTime - filter the result by end time. It is a QueryParam.

includeResourceAllocations - true if the resource allocation should be in the result, false otherwise. It is a QueryParam.

hsr - the servlet request

Returns:

Response containing the status code

Throws:

java.lang.Exception - in case of bad request

See Also:

ApplicationClientProtocol.listReservations(org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest)

getAppTimeout

public AppTimeoutInfo getAppTimeout(@Context
                                    javax.servlet.http.HttpServletRequest hsr,
                                    java.lang.String appId,
                                    java.lang.String type)
                             throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method retrieves the timeout information for a specific app with a specific type, and it is reachable by using RMWSConsts.APPS_TIMEOUTS_TYPE.

Specified by:

getAppTimeout in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the application we want to get the timeout. It is a PathParam.

type - the type of the timeouts. It is a PathParam.

Returns:

the timeout for a specific application with a specific type.

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized

getAppTimeouts

public AppTimeoutsInfo getAppTimeouts(@Context
                                      javax.servlet.http.HttpServletRequest hsr,
                                      java.lang.String appId)
                               throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method retrieves the timeout information for a specific app, and it is reachable by using RMWSConsts.APPS_TIMEOUTS.

Specified by:

getAppTimeouts in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

appId - the application we want to get the timeouts. It is a PathParam.

Returns:

the timeouts for a specific application

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized

updateApplicationTimeout

public javax.ws.rs.core.Response updateApplicationTimeout(AppTimeoutInfo appTimeout,
                                                          @Context
                                                          javax.servlet.http.HttpServletRequest hsr,
                                                          java.lang.String appId)
                                                   throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                          org.apache.hadoop.yarn.exceptions.YarnException,
                                                          java.lang.InterruptedException,
                                                          java.io.IOException

Description copied from interface: RMWebServiceProtocol

This method updates the timeout information for a specific app, and it is reachable by using RMWSConsts.APPS_TIMEOUT.

Specified by:

updateApplicationTimeout in interface RMWebServiceProtocol

Parameters:

appTimeout - the appTimeoutInfo. It is a content param.

hsr - the servlet request

appId - the application we want to update. It is a PathParam.

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method

org.apache.hadoop.yarn.exceptions.YarnException - in case of bad request

java.lang.InterruptedException - if interrupted

java.io.IOException - if the operation failed

See Also:

ApplicationClientProtocol.updateApplicationTimeouts(org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest)

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

Overrides:

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

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

Overrides:

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

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

Overrides:

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

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

Overrides:

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

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

Overrides:

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

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

Overrides:

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

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

formatSchedulerConfiguration

public javax.ws.rs.core.Response formatSchedulerConfiguration(@Context
                                                              javax.servlet.http.HttpServletRequest hsr)
                                                       throws org.apache.hadoop.security.authorize.AuthorizationException

Throws:

org.apache.hadoop.security.authorize.AuthorizationException

validateAndGetSchedulerConfiguration

public javax.ws.rs.core.Response validateAndGetSchedulerConfiguration(org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo mutationInfo,
                                                                      @Context
                                                                      javax.servlet.http.HttpServletRequest hsr)
                                                               throws org.apache.hadoop.security.authorize.AuthorizationException

Throws:

org.apache.hadoop.security.authorize.AuthorizationException

updateSchedulerConfiguration

public javax.ws.rs.core.Response updateSchedulerConfiguration(org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo mutationInfo,
                                                              @Context
                                                              javax.servlet.http.HttpServletRequest hsr)
                                                       throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                              java.lang.InterruptedException

Description copied from interface: RMWebServiceProtocol

This method updates the Scheduler configuration, and it is reachable by using RMWSConsts.SCHEDULER_CONF.

Specified by:

updateSchedulerConfiguration in interface RMWebServiceProtocol

Parameters:

mutationInfo - th information for making scheduler configuration changes (supports adding, removing, or updating a queue, as well as global scheduler conf changes)

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method

java.lang.InterruptedException - if interrupted

getSchedulerConfiguration

public javax.ws.rs.core.Response getSchedulerConfiguration(@Context
                                                           javax.servlet.http.HttpServletRequest hsr)
                                                    throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method retrieves all the Scheduler configuration, and it is reachable by using RMWSConsts.SCHEDULER_CONF.

Specified by:

getSchedulerConfiguration in interface RMWebServiceProtocol

Parameters:

hsr - the servlet request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method.

getSchedulerConfigurationVersion

public javax.ws.rs.core.Response getSchedulerConfigurationVersion(@Context
                                                                  javax.servlet.http.HttpServletRequest hsr)
                                                           throws org.apache.hadoop.security.authorize.AuthorizationException

Throws:

org.apache.hadoop.security.authorize.AuthorizationException

checkUserAccessToQueue

public RMQueueAclInfo checkUserAccessToQueue(java.lang.String queue,
                                             java.lang.String username,
                                             java.lang.String queueAclType,
                                             @Context
                                             javax.servlet.http.HttpServletRequest hsr)
                                      throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method verifies if a user has access to a specified queue.

Specified by:

checkUserAccessToQueue in interface RMWebServiceProtocol

Parameters:

queue - queue

username - user

queueAclType - acl type of queue, it could be SUBMIT_APPLICATIONS/ADMINISTER_QUEUE

hsr - request

Returns:

Response containing the status code.

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method.

signalToContainer

public javax.ws.rs.core.Response signalToContainer(java.lang.String containerId,
                                                   java.lang.String command,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest hsr)
                                            throws org.apache.hadoop.security.authorize.AuthorizationException

Description copied from interface: RMWebServiceProtocol

This method sends a signal to container.

Specified by:

signalToContainer in interface RMWebServiceProtocol

Parameters:

containerId - containerId

command - signal command, it could be OUTPUT_THREAD_DUMP/ GRACEFUL_SHUTDOWN/FORCEFUL_SHUTDOWN

hsr - request

Returns:

Response containing the status code

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - if the user is not authorized to invoke this method.

getSchedulerOverview

public SchedulerOverviewInfo getSchedulerOverview()

getAppsLRUCache

@VisibleForTesting
public org.apache.hadoop.yarn.util.LRUCache<org.apache.hadoop.yarn.util.AppsCacheKey,AppsInfo> getAppsLRUCache()