RMWebServices (Apache Hadoop YARN ResourceManager 2.8.0 API)

java.lang.Object
- org.apache.hadoop.yarn.server.resourcemanager.webapp.RMWebServices

public class RMWebServices
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static String DELEGATION_TOKEN_HEADER

Fields
Modifier and Type	Field and Description
`static String`	`DELEGATION_TOKEN_HEADER`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addToClusterNodeLabels(NodeLabelsInfo newNodeLabels, javax.servlet.http.HttpServletRequest hsr)`
`javax.ws.rs.core.Response`	`cancelDelegationToken(javax.servlet.http.HttpServletRequest hsr)`
`protected org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext`	`createAppSubmissionContext(ApplicationSubmissionContextInfo newApp)` Create the actual ApplicationSubmissionContext to be submitted to the RM from the information provided by the user.
`protected org.apache.hadoop.yarn.api.records.Resource`	`createAppSubmissionContextResource(ApplicationSubmissionContextInfo newApp)`
`protected org.apache.hadoop.yarn.api.records.ContainerLaunchContext`	`createContainerLaunchContext(ApplicationSubmissionContextInfo newApp)` Create the ContainerLaunchContext required for the ApplicationSubmissionContext.
`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.
`String`	`dumpSchedulerLogs(String time, javax.servlet.http.HttpServletRequest hsr)`
`ClusterInfo`	`get()`
`AppInfo`	`getApp(javax.servlet.http.HttpServletRequest hsr, String appId)`
`AppAttemptsInfo`	`getAppAttempts(javax.servlet.http.HttpServletRequest hsr, String appId)`
`AppPriority`	`getAppPriority(javax.servlet.http.HttpServletRequest hsr, String appId)`
`AppQueue`	`getAppQueue(javax.servlet.http.HttpServletRequest hsr, String appId)`
`AppsInfo`	`getApps(javax.servlet.http.HttpServletRequest hsr, String stateQuery, Set<String> statesQuery, String finalStatusQuery, String userQuery, String queueQuery, String count, String startedBegin, String startedEnd, String finishBegin, String finishEnd, Set<String> applicationTypes, Set<String> applicationTags)`
`AppState`	`getAppState(javax.servlet.http.HttpServletRequest hsr, String appId)`
`ApplicationStatisticsInfo`	`getAppStatistics(javax.servlet.http.HttpServletRequest hsr, Set<String> stateQueries, Set<String> typeQueries)`
`ClusterInfo`	`getClusterInfo()`
`ClusterMetricsInfo`	`getClusterMetricsInfo()`
`NodeLabelsInfo`	`getClusterNodeLabels(javax.servlet.http.HttpServletRequest hsr)`
`NodeLabelsInfo`	`getLabelsOnNode(javax.servlet.http.HttpServletRequest hsr, String nodeId)`
`LabelsToNodesInfo`	`getLabelsToNodes(Set<String> labels)`
`NodeInfo`	`getNode(String nodeId)`
`NodesInfo`	`getNodes(String states)` Returns all nodes in the cluster.
`NodeToLabelsInfo`	`getNodeToLabels(javax.servlet.http.HttpServletRequest hsr)`
`SchedulerTypeInfo`	`getSchedulerInfo()`
`protected 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, String diagnostic)`
`javax.ws.rs.core.Response`	`listReservation(String queue, 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, String targetQueue)`
`javax.ws.rs.core.Response`	`postDelegationToken(DelegationToken tokenData, javax.servlet.http.HttpServletRequest hsr)`
`javax.ws.rs.core.Response`	`postDelegationTokenExpiration(javax.servlet.http.HttpServletRequest hsr)`
`javax.ws.rs.core.Response`	`removeFromCluserNodeLabels(Set<String> oldNodeLabels, javax.servlet.http.HttpServletRequest hsr)`
`javax.ws.rs.core.Response`	`replaceLabelsOnNode(Set<String> newNodeLabelsName, javax.servlet.http.HttpServletRequest hsr, String nodeId)`
`javax.ws.rs.core.Response`	`replaceLabelsOnNodes(NodeToLabelsEntryList newNodeToLabels, javax.servlet.http.HttpServletRequest hsr)`
`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.
`javax.ws.rs.core.Response`	`updateApplicationPriority(AppPriority targetPriority, javax.servlet.http.HttpServletRequest hsr, String appId)`
`javax.ws.rs.core.Response`	`updateAppQueue(AppQueue targetQueue, javax.servlet.http.HttpServletRequest hsr, String appId)`
`javax.ws.rs.core.Response`	`updateAppState(AppState targetState, javax.servlet.http.HttpServletRequest hsr, String appId)`
`javax.ws.rs.core.Response`	`updateReservation(ReservationUpdateRequestInfo resContext, javax.servlet.http.HttpServletRequest hsr)` Function to update a Reservation to the RM.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DELEGATION_TOKEN_HEADER
```
public static final 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 Boolean hasAccess(RMApp app,
                javax.servlet.http.HttpServletRequest hsr)

get
```
public ClusterInfo get()
```

getClusterInfo
```
public ClusterInfo getClusterInfo()
```

getClusterMetricsInfo

public ClusterMetricsInfo getClusterMetricsInfo()

getSchedulerInfo

public SchedulerTypeInfo getSchedulerInfo()

dumpSchedulerLogs

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

Throws:: IOException

getNodes
```
public NodesInfo getNodes(String states)
```
Returns all nodes in the cluster. If the states param is given, returns all nodes that are in the comma-separated list of states.

getNode

public NodeInfo getNode(String nodeId)

getApps

public AppsInfo getApps(@Context
               javax.servlet.http.HttpServletRequest hsr,
               String stateQuery,
               Set<String> statesQuery,
               String finalStatusQuery,
               String userQuery,
               String queueQuery,
               String count,
               String startedBegin,
               String startedEnd,
               String finishBegin,
               String finishEnd,
               Set<String> applicationTypes,
               Set<String> applicationTags)

getAppStatistics

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

getApp

public AppInfo getApp(@Context
             javax.servlet.http.HttpServletRequest hsr,
             String appId)

getAppAttempts

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

getAppState

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException

updateAppState

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException; org.apache.hadoop.yarn.exceptions.YarnException; InterruptedException; IOException

getNodeToLabels

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

Throws:: IOException

getLabelsToNodes

public LabelsToNodesInfo getLabelsToNodes(Set<String> labels)
                                   throws IOException

Throws:: IOException

replaceLabelsOnNodes

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

Throws:: IOException

replaceLabelsOnNode

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

Throws:: Exception

getClusterNodeLabels

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

Throws:: IOException

addToClusterNodeLabels

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

Throws:: Exception

removeFromCluserNodeLabels

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

Throws:: Exception

getLabelsOnNode

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

Throws:: IOException

killApp

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

Throws:: IOException; InterruptedException

getAppPriority

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException

updateApplicationPriority

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException; org.apache.hadoop.yarn.exceptions.YarnException; InterruptedException; IOException

getAppQueue

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException

updateAppQueue

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException; org.apache.hadoop.yarn.exceptions.YarnException; InterruptedException; IOException

moveApp

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

Throws:: IOException; InterruptedException

createNewApplication

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

Generates a new ApplicationId which is then sent to the client

Parameters:: hsr - the servlet request
Returns:: Response containing the app id and the maximum resource capabilities
Throws:: org.apache.hadoop.security.authorize.AuthorizationException; IOException; InterruptedException

submitApplication

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

Function to submit an app to the RM

Parameters:: newApp - structure containing information to construct the ApplicationSubmissionContext; hsr - the servlet request
Returns:: Response containing the status code
Throws:: org.apache.hadoop.security.authorize.AuthorizationException; IOException; InterruptedException

createAppSubmissionContext
```
protected org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext createAppSubmissionContext(ApplicationSubmissionContextInfo newApp)
                                                                                              throws IOException
```
Create the actual ApplicationSubmissionContext to be submitted to the RM from the information provided by the user.

Parameters:
newApp - the information provided by the user

Returns:
returns the constructed ApplicationSubmissionContext

Throws:

IOException

createAppSubmissionContextResource

protected org.apache.hadoop.yarn.api.records.Resource createAppSubmissionContextResource(ApplicationSubmissionContextInfo newApp)
                                                                                  throws org.apache.hadoop.yarn.webapp.BadRequestException

Throws:: org.apache.hadoop.yarn.webapp.BadRequestException

createContainerLaunchContext

protected org.apache.hadoop.yarn.api.records.ContainerLaunchContext createContainerLaunchContext(ApplicationSubmissionContextInfo newApp)
                                                                                          throws org.apache.hadoop.yarn.webapp.BadRequestException,
                                                                                                 IOException

Create the ContainerLaunchContext required for the ApplicationSubmissionContext. This function takes the user information and generates the ByteBuffer structures required by the ContainerLaunchContext

Parameters:: newApp - the information provided by the user
Returns:: created context
Throws:: org.apache.hadoop.yarn.webapp.BadRequestException; IOException

postDelegationToken

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException; IOException; InterruptedException; Exception

postDelegationTokenExpiration

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException; IOException; InterruptedException; Exception

cancelDelegationToken

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

Throws:: org.apache.hadoop.security.authorize.AuthorizationException; IOException; InterruptedException; Exception

createNewReservation

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

Generates a new ReservationId which is then sent to the client.

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.; IOException - if creation fails.; InterruptedException - if interrupted.

submitReservation

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

Function to submit a Reservation to the RM.

Parameters:: resContext - provides information to construct the ReservationSubmissionRequest; hsr - the servlet request
Returns:: Response containing the status code
Throws:: org.apache.hadoop.security.authorize.AuthorizationException; IOException; InterruptedException

updateReservation

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

Function to update a Reservation to the RM.

Parameters:: resContext - provides information to construct the ReservationUpdateRequest; hsr - the servlet request
Returns:: Response containing the status code
Throws:: org.apache.hadoop.security.authorize.AuthorizationException; IOException; InterruptedException

deleteReservation
```
public javax.ws.rs.core.Response deleteReservation(ReservationDeleteRequestInfo resContext,
                                          @Context
                                          javax.servlet.http.HttpServletRequest hsr)
                                            throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                   IOException,
                                                   InterruptedException
```
Function to delete a Reservation to the RM.

Parameters:
resContext - provides information to construct the ReservationDeleteRequest
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.

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

InterruptedException - if doAs action throws an InterruptedException.

listReservation

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

Function to retrieve a list of all the reservations.

Throws:: Exception

Class RMWebServices

Field Summary

Constructor Summary