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

Class RouterWebServiceUtil

java.lang.Object

org.apache.hadoop.yarn.server.router.webapp.RouterWebServiceUtil

public final class RouterWebServiceUtil
extends java.lang.Object

The Router webservice util class.

Method Summary

Modifier and Type	Method	Description
static javax.ws.rs.core.Response	clientResponseToResponse(com.sun.jersey.api.client.ClientResponse r)
protected static com.sun.jersey.api.client.Client	createJerseyClient(org.apache.hadoop.conf.Configuration conf)	Create a Jersey client instance.
static void	createKerberosUserGroupInformation(javax.servlet.http.HttpServletRequest hsr)
static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodesInfo	deleteDuplicateNodesInfo(java.util.ArrayList<org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeInfo> nodes)	Deletes all the duplicate NodeInfo by discarding the old instances.
static org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier>	extractToken(java.lang.String encodedToken)	Parse Token data.
static org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier>	extractToken(javax.servlet.http.HttpServletRequest request)
static java.lang.String	generateWebTitle(java.lang.String title, java.lang.String msg)
protected static <T> T	genericForward(java.lang.String webApp, javax.servlet.http.HttpServletRequest hsr, java.lang.Class<T> returnType, HTTPMethods method, java.lang.String targetPath, java.lang.Object formParam, java.util.Map<java.lang.String,java.lang.String[]> additionalParam, org.apache.hadoop.conf.Configuration conf, com.sun.jersey.api.client.Client client)	Creates and performs a REST call to a specific WebService.
static org.apache.hadoop.security.UserGroupInformation	getKerberosUserGroupInformation(org.apache.hadoop.conf.Configuration conf, javax.servlet.http.HttpServletRequest request)	Get Kerberos UserGroupInformation.
protected static <T> java.lang.String	getMediaTypeFromHttpServletRequest(javax.servlet.http.HttpServletRequest request, java.lang.Class<T> returnType)	Extract from HttpServletRequest the MediaType in output.
static void	initForWritableEndpoints(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.UserGroupInformation callerUGI)	initForWritableEndpoints does the init and acls verification for all writable REST end points.
static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ApplicationStatisticsInfo	mergeApplicationStatisticsInfo(java.util.Collection<org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ApplicationStatisticsInfo> appStatistics)
static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppsInfo	mergeAppsInfo(java.util.ArrayList<org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppInfo> appsInfo, boolean returnPartialResult)	Merges a list of AppInfo grouping by ApplicationId.
static void	mergeMetrics(org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ClusterMetricsInfo metrics, org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ClusterMetricsInfo metricsResponse)	Adds all the values from the second ClusterMetricsInfo to the first one.
static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeLabelsInfo	mergeNodeLabelsInfo(java.util.Map<org.apache.hadoop.yarn.server.federation.store.records.SubClusterInfo,org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeLabelsInfo> paramMap)
static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeToLabelsInfo	mergeNodeToLabels(java.util.Map<org.apache.hadoop.yarn.server.federation.store.records.SubClusterInfo,org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeToLabelsInfo> nodeToLabelsInfoMap)
static void	retrieveException(com.sun.jersey.api.client.ClientResponse response)

Methods inherited from class java.lang.Object

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

Method Detail

genericForward

protected static <T> T genericForward(java.lang.String webApp,
                                      javax.servlet.http.HttpServletRequest hsr,
                                      java.lang.Class<T> returnType,
                                      HTTPMethods method,
                                      java.lang.String targetPath,
                                      java.lang.Object formParam,
                                      java.util.Map<java.lang.String,java.lang.String[]> additionalParam,
                                      org.apache.hadoop.conf.Configuration conf,
                                      com.sun.jersey.api.client.Client client)

Creates and performs a REST call to a specific WebService.

Type Parameters:

T - Type of return object.

Parameters:

webApp - the address of the remote webapp

hsr - the servlet request

returnType - the return type of the REST call

method - the HTTP method of the REST call

targetPath - additional path to add to the webapp address

formParam - the form parameters as input for a specific REST call

additionalParam - the query parameters as input for a specific REST call in case the call has no servlet request

conf - configuration.

client - same client used to reduce number of clients created

Returns:

the retrieved entity from the REST call

clientResponseToResponse

public static javax.ws.rs.core.Response clientResponseToResponse(com.sun.jersey.api.client.ClientResponse r)

retrieveException

public static void retrieveException(com.sun.jersey.api.client.ClientResponse response)

mergeAppsInfo

public static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppsInfo mergeAppsInfo(java.util.ArrayList<org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppInfo> appsInfo,
                                                                                              boolean returnPartialResult)

Merges a list of AppInfo grouping by ApplicationId. Our current policy is to merge the application reports from the reachable SubClusters. Via configuration parameter, we decide whether to return applications for which the primary AM is missing or to omit them.

Parameters:

appsInfo - a list of AppInfo to merge

returnPartialResult - if the merge AppsInfo should contain partial result or not

Returns:

the merged AppsInfo

createJerseyClient

protected static com.sun.jersey.api.client.Client createJerseyClient(org.apache.hadoop.conf.Configuration conf)

Create a Jersey client instance.

Parameters:

conf - Configuration

Returns:

a jersey client

deleteDuplicateNodesInfo

public static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodesInfo deleteDuplicateNodesInfo(java.util.ArrayList<org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeInfo> nodes)

Deletes all the duplicate NodeInfo by discarding the old instances.

Parameters:

nodes - a list of NodeInfo to check for duplicates

Returns:

a NodesInfo that contains a list of NodeInfos without duplicates

mergeMetrics

public static void mergeMetrics(org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ClusterMetricsInfo metrics,
                                org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ClusterMetricsInfo metricsResponse)

Adds all the values from the second ClusterMetricsInfo to the first one.

Parameters:

metrics - the ClusterMetricsInfo we want to update

metricsResponse - the ClusterMetricsInfo we want to add to the first param

getMediaTypeFromHttpServletRequest

protected static <T> java.lang.String getMediaTypeFromHttpServletRequest(javax.servlet.http.HttpServletRequest request,
                                                                         java.lang.Class<T> returnType)

Extract from HttpServletRequest the MediaType in output.

Type Parameters:

T - Generic Type T.

Parameters:

request - the servlet request.

returnType - the return type of the REST call.

Returns:

MediaType.

mergeNodeToLabels

public static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeToLabelsInfo mergeNodeToLabels(java.util.Map<org.apache.hadoop.yarn.server.federation.store.records.SubClusterInfo,org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeToLabelsInfo> nodeToLabelsInfoMap)

mergeApplicationStatisticsInfo

public static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ApplicationStatisticsInfo mergeApplicationStatisticsInfo(java.util.Collection<org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ApplicationStatisticsInfo> appStatistics)

mergeNodeLabelsInfo

public static org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeLabelsInfo mergeNodeLabelsInfo(java.util.Map<org.apache.hadoop.yarn.server.federation.store.records.SubClusterInfo,org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeLabelsInfo> paramMap)

initForWritableEndpoints

public static void initForWritableEndpoints(org.apache.hadoop.conf.Configuration conf,
                                            org.apache.hadoop.security.UserGroupInformation callerUGI)
                                     throws org.apache.hadoop.security.authorize.AuthorizationException

initForWritableEndpoints does the init and acls verification for all writable REST end points.

Parameters:

conf - Configuration.

callerUGI - remote caller who initiated the request.

Throws:

org.apache.hadoop.security.authorize.AuthorizationException - in case of no access to perfom this op.

createKerberosUserGroupInformation

public static void createKerberosUserGroupInformation(javax.servlet.http.HttpServletRequest hsr)
                                               throws org.apache.hadoop.yarn.exceptions.YarnException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

extractToken

public static org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier> extractToken(java.lang.String encodedToken)

Parse Token data.

Parameters:

encodedToken - tokenData

Returns:

RMDelegationTokenIdentifier.

extractToken

public static org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.RMDelegationTokenIdentifier> extractToken(javax.servlet.http.HttpServletRequest request)

getKerberosUserGroupInformation

public static org.apache.hadoop.security.UserGroupInformation getKerberosUserGroupInformation(org.apache.hadoop.conf.Configuration conf,
                                                                                              javax.servlet.http.HttpServletRequest request)
                                                                                       throws org.apache.hadoop.security.authorize.AuthorizationException,
                                                                                              org.apache.hadoop.yarn.exceptions.YarnException

Get Kerberos UserGroupInformation. Parse ugi from hsr and set kerberos authentication attributes.

Parameters:

conf - Configuration.

request - the servlet request.

Returns:

UserGroupInformation.

Throws:

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

org.apache.hadoop.yarn.exceptions.YarnException - If Authentication Type verification fails.

generateWebTitle

public static java.lang.String generateWebTitle(java.lang.String title,
                                                java.lang.String msg)