Package org.apache.hadoop.yarn.webapp.util

Class WebAppUtils

java.lang.Object

org.apache.hadoop.yarn.webapp.util.WebAppUtils

@Private
@Evolving
public class WebAppUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebAppUtils.ThrowingBiFunction<T,U,R>	A BiFunction which throws on Exception.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	HTTP_PREFIX
static java.lang.String	HTTPS_PREFIX
static java.lang.String	WEB_APP_KEY_PASSWORD_KEY
static java.lang.String	WEB_APP_KEYSTORE_PASSWORD_KEY
static java.lang.String	WEB_APP_TRUSTSTORE_PASSWORD_KEY

Constructor Summary

Constructors

Constructor	Description
WebAppUtils()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	appendQueryParams(javax.servlet.http.HttpServletRequest request, java.lang.String targetUri)	Add the query params from a HttpServletRequest to the target uri passed.
static <T,R> R	execOnActiveRM(org.apache.hadoop.conf.Configuration conf, WebAppUtils.ThrowingBiFunction<java.lang.String,T,R> func, T arg)	Runs a certain function against the active RM.
static java.lang.String	getAggregatedLogURL(java.lang.String serverHttpAddress, java.lang.String allocatedNode, java.lang.String containerId, java.lang.String entity, java.lang.String user)
static java.lang.String	getAHSWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getDefaultLogContentType()
static java.lang.String	getGPGWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getHtmlEscapedURIWithQueryString(javax.servlet.http.HttpServletRequest request)	Get a HTML escaped uri with the query parameters of the request.
static java.lang.String	getHttpSchemePrefix(org.apache.hadoop.conf.Configuration conf)	Choose which scheme (HTTP or HTTPS) to use when generating a URL based on the configuration.
static java.lang.String	getNMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getProxyHostAndPort(org.apache.hadoop.conf.Configuration conf)
static java.util.List<java.lang.String>	getProxyHostsAndPortsForAmFilter(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getResolvedAddress(java.net.InetSocketAddress address)
static java.lang.String	getResolvedRemoteRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getResolvedRemoteRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.http.HttpConfig.Policy httpPolicy)
static java.lang.String	getResolvedRemoteRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.http.HttpConfig.Policy httpPolicy, java.lang.String rmId)
static java.lang.String	getResolvedRemoteRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getResolvedRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getResolvedRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.http.HttpConfig.Policy httpPolicy)
static java.lang.String	getResolvedRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf, boolean isHAEnabled, int haIdIndex)
static java.lang.String	getRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf, int haIdIndex)
static java.lang.String	getRouterWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getRouterWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getRunningLogURL(java.lang.String nodeHttpAddress, java.lang.String containerId, java.lang.String user)
static java.lang.String	getSupportedLogContentType(java.lang.String format)
static java.lang.String	getTimelineCollectorWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	getTimelineReaderWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)
static java.util.List<org.apache.http.NameValuePair>	getURLEncodedQueryParam(javax.servlet.http.HttpServletRequest request)	Get a query string.
static java.lang.String	getURLWithScheme(java.lang.String schemePrefix, java.lang.String url)	if url has scheme then it will be returned as it is else it will return url with scheme.
static java.lang.String	getWebAppBindURL(org.apache.hadoop.conf.Configuration conf, java.lang.String hostProperty, java.lang.String webAppURLWithoutScheme)	Get the URL to use for binding where bind hostname can be specified to override the hostname in the webAppURLWithoutScheme.
static java.util.List<java.lang.String>	listSupportedLogContentType()
static org.apache.hadoop.http.HttpServer2.Builder	loadSslConfiguration(org.apache.hadoop.http.HttpServer2.Builder builder)	Load the SSL keystore / truststore into the HttpServer builder.
static org.apache.hadoop.http.HttpServer2.Builder	loadSslConfiguration(org.apache.hadoop.http.HttpServer2.Builder builder, org.apache.hadoop.conf.Configuration conf)	Load the SSL keystore / truststore into the HttpServer builder.
static org.apache.hadoop.yarn.api.records.ApplicationId	parseApplicationId(org.apache.hadoop.yarn.factories.RecordFactory recordFactory, java.lang.String appId)
static java.lang.String	removeQueryParams(javax.servlet.http.HttpServletRequest httpRequest, java.lang.String parameterName)	Get a query string which removes the passed parameter.
static void	setNMWebAppHostNameAndPort(org.apache.hadoop.conf.Configuration conf, java.lang.String hostName, int port)
static void	setRMWebAppHostnameAndPort(org.apache.hadoop.conf.Configuration conf, java.lang.String hostname, int port)
static void	setRMWebAppPort(org.apache.hadoop.conf.Configuration conf, int port)

Methods inherited from class java.lang.Object

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

Field Detail

WEB_APP_TRUSTSTORE_PASSWORD_KEY

public static final java.lang.String WEB_APP_TRUSTSTORE_PASSWORD_KEY

See Also:

Constant Field Values

WEB_APP_KEYSTORE_PASSWORD_KEY

public static final java.lang.String WEB_APP_KEYSTORE_PASSWORD_KEY

See Also:

Constant Field Values

WEB_APP_KEY_PASSWORD_KEY

public static final java.lang.String WEB_APP_KEY_PASSWORD_KEY

See Also:

Constant Field Values

HTTPS_PREFIX

public static final java.lang.String HTTPS_PREFIX

See Also:

Constant Field Values

HTTP_PREFIX

public static final java.lang.String HTTP_PREFIX

See Also:

Constant Field Values

Constructor Detail

WebAppUtils

public WebAppUtils()

Method Detail

setRMWebAppPort

public static void setRMWebAppPort(org.apache.hadoop.conf.Configuration conf,
                                   int port)

setRMWebAppHostnameAndPort

public static void setRMWebAppHostnameAndPort(org.apache.hadoop.conf.Configuration conf,
                                              java.lang.String hostname,
                                              int port)

setNMWebAppHostNameAndPort

public static void setNMWebAppHostNameAndPort(org.apache.hadoop.conf.Configuration conf,
                                              java.lang.String hostName,
                                              int port)

execOnActiveRM

public static <T,R> R execOnActiveRM(org.apache.hadoop.conf.Configuration conf,
                                           WebAppUtils.ThrowingBiFunction<java.lang.String,T,R> func,
                                           T arg)
                                    throws java.lang.Exception

Runs a certain function against the active RM. The function's first argument is expected to be a string which contains the address of the RM being tried.

Type Parameters:

T - Generic T.

R - Generic R.

Parameters:

conf - configuration.

func - throwing bi function.

arg - T arg.

Returns:

instance of Generic R.

Throws:

java.lang.Exception - exception occurs.

getRMWebAppURLWithoutScheme

public static java.lang.String getRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf,
                                                           boolean isHAEnabled,
                                                           int haIdIndex)

getRMWebAppURLWithScheme

public static java.lang.String getRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf,
                                                        int haIdIndex)

getRMWebAppURLWithScheme

public static java.lang.String getRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)

getRMWebAppURLWithoutScheme

public static java.lang.String getRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getRouterWebAppURLWithScheme

public static java.lang.String getRouterWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)

getRouterWebAppURLWithoutScheme

public static java.lang.String getRouterWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getGPGWebAppURLWithoutScheme

public static java.lang.String getGPGWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getProxyHostsAndPortsForAmFilter

public static java.util.List<java.lang.String> getProxyHostsAndPortsForAmFilter(org.apache.hadoop.conf.Configuration conf)

getProxyHostAndPort

public static java.lang.String getProxyHostAndPort(org.apache.hadoop.conf.Configuration conf)

getResolvedRemoteRMWebAppURLWithScheme

public static java.lang.String getResolvedRemoteRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)

getResolvedRMWebAppURLWithScheme

public static java.lang.String getResolvedRMWebAppURLWithScheme(org.apache.hadoop.conf.Configuration conf)

getResolvedRemoteRMWebAppURLWithoutScheme

public static java.lang.String getResolvedRemoteRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getResolvedRMWebAppURLWithoutScheme

public static java.lang.String getResolvedRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getResolvedRMWebAppURLWithoutScheme

public static java.lang.String getResolvedRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf,
                                                                   org.apache.hadoop.http.HttpConfig.Policy httpPolicy)

getResolvedRemoteRMWebAppURLWithoutScheme

public static java.lang.String getResolvedRemoteRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf,
                                                                         org.apache.hadoop.http.HttpConfig.Policy httpPolicy)

getResolvedRemoteRMWebAppURLWithoutScheme

public static java.lang.String getResolvedRemoteRMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf,
                                                                         org.apache.hadoop.http.HttpConfig.Policy httpPolicy,
                                                                         java.lang.String rmId)

getResolvedAddress

public static java.lang.String getResolvedAddress(java.net.InetSocketAddress address)

getWebAppBindURL

public static java.lang.String getWebAppBindURL(org.apache.hadoop.conf.Configuration conf,
                                                java.lang.String hostProperty,
                                                java.lang.String webAppURLWithoutScheme)

Get the URL to use for binding where bind hostname can be specified to override the hostname in the webAppURLWithoutScheme. Port specified in the webAppURLWithoutScheme will be used.

Parameters:

conf - the configuration

hostProperty - bind host property name

webAppURLWithoutScheme - web app URL without scheme String

Returns:

String representing bind URL

getNMWebAppURLWithoutScheme

public static java.lang.String getNMWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getAHSWebAppURLWithoutScheme

public static java.lang.String getAHSWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getTimelineReaderWebAppURLWithoutScheme

public static java.lang.String getTimelineReaderWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getTimelineCollectorWebAppURLWithoutScheme

public static java.lang.String getTimelineCollectorWebAppURLWithoutScheme(org.apache.hadoop.conf.Configuration conf)

getURLWithScheme

public static java.lang.String getURLWithScheme(java.lang.String schemePrefix,
                                                java.lang.String url)

if url has scheme then it will be returned as it is else it will return url with scheme.

Parameters:

schemePrefix - eg. http:// or https://

url - url.

Returns:

url with scheme

getRunningLogURL

public static java.lang.String getRunningLogURL(java.lang.String nodeHttpAddress,
                                                java.lang.String containerId,
                                                java.lang.String user)

getAggregatedLogURL

public static java.lang.String getAggregatedLogURL(java.lang.String serverHttpAddress,
                                                   java.lang.String allocatedNode,
                                                   java.lang.String containerId,
                                                   java.lang.String entity,
                                                   java.lang.String user)

getHttpSchemePrefix

public static java.lang.String getHttpSchemePrefix(org.apache.hadoop.conf.Configuration conf)

Choose which scheme (HTTP or HTTPS) to use when generating a URL based on the configuration.

Parameters:

conf - configuration.

Returns:

the scheme (HTTP / HTTPS)

loadSslConfiguration

public static org.apache.hadoop.http.HttpServer2.Builder loadSslConfiguration(org.apache.hadoop.http.HttpServer2.Builder builder)

Load the SSL keystore / truststore into the HttpServer builder.

Parameters:

builder - the HttpServer2.Builder to populate with ssl config

Returns:

HttpServer2.Builder instance (passed in as the first parameter) after loading SSL stores

loadSslConfiguration

public static org.apache.hadoop.http.HttpServer2.Builder loadSslConfiguration(org.apache.hadoop.http.HttpServer2.Builder builder,
                                                                              org.apache.hadoop.conf.Configuration conf)

Load the SSL keystore / truststore into the HttpServer builder.

Parameters:

builder - the HttpServer2.Builder to populate with ssl config

conf - the Configuration instance to load custom SSL config from

Returns:

HttpServer2.Builder instance (passed in as the first parameter) after loading SSL stores

parseApplicationId

public static org.apache.hadoop.yarn.api.records.ApplicationId parseApplicationId(org.apache.hadoop.yarn.factories.RecordFactory recordFactory,
                                                                                  java.lang.String appId)

getSupportedLogContentType

public static java.lang.String getSupportedLogContentType(java.lang.String format)

getDefaultLogContentType

public static java.lang.String getDefaultLogContentType()

listSupportedLogContentType

public static java.util.List<java.lang.String> listSupportedLogContentType()

getURLEncodedQueryParam

public static java.util.List<org.apache.http.NameValuePair> getURLEncodedQueryParam(javax.servlet.http.HttpServletRequest request)

Get a query string.

Parameters:

request - HttpServletRequest with the request details

Returns:

the query parameter string

removeQueryParams

public static java.lang.String removeQueryParams(javax.servlet.http.HttpServletRequest httpRequest,
                                                 java.lang.String parameterName)

Get a query string which removes the passed parameter.

Parameters:

httpRequest - HttpServletRequest with the request details

parameterName - the query parameters must be removed

Returns:

the query parameter string

getHtmlEscapedURIWithQueryString

public static java.lang.String getHtmlEscapedURIWithQueryString(javax.servlet.http.HttpServletRequest request)

Get a HTML escaped uri with the query parameters of the request.

Parameters:

request - HttpServletRequest with the request details

Returns:

HTML escaped uri with the query paramters

appendQueryParams

public static java.lang.String appendQueryParams(javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String targetUri)

Add the query params from a HttpServletRequest to the target uri passed.

Parameters:

request - HttpServletRequest with the request details

targetUri - the uri to which the query params must be added

Returns:

URL encoded string containing the targetUri + "?" + query string