Package org.apache.hadoop.yarn.server.webproxy

Class ProxyUriUtils

java.lang.Object

org.apache.hadoop.yarn.server.webproxy.ProxyUriUtils

public class ProxyUriUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROXY_APPROVAL_PARAM	Query Parameter indicating that the URI was approved.
static java.lang.String	PROXY_BASE	Base path where the proxy servlet will handle requests.
static java.lang.String	PROXY_PATH_SPEC	Path Specification for the proxy servlet.
static java.lang.String	PROXY_SERVLET_NAME	Name of the servlet to use when registering the proxy servlet.
static java.lang.String	REDIRECT	Path component added when the proxy redirects the connection.

Constructor Summary

Constructors

Constructor	Description
ProxyUriUtils()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getPath(org.apache.hadoop.yarn.api.records.ApplicationId id)	Get the proxied path for an application.
static java.lang.String	getPath(org.apache.hadoop.yarn.api.records.ApplicationId id, boolean redirected)	Get the proxied path for an application.
static java.lang.String	getPath(org.apache.hadoop.yarn.api.records.ApplicationId id, java.lang.String path)	Get the proxied path for an application.
static java.lang.String	getPath(org.apache.hadoop.yarn.api.records.ApplicationId id, java.lang.String path, boolean redirected)	Get the proxied path for an application.
static java.lang.String	getPathAndQuery(org.apache.hadoop.yarn.api.records.ApplicationId id, java.lang.String path, java.lang.String query, boolean approved)	Get the proxied path for an application
static java.net.URI	getProxyUri(java.net.URI originalUri, java.net.URI proxyUri, org.apache.hadoop.yarn.api.records.ApplicationId id)	Get a proxied URI for the original URI.
static java.lang.String	getSchemeFromUrl(java.lang.String url)	Returns the scheme if present in the url eg.
static java.net.URI	getUriFromAMUrl(java.lang.String scheme, java.lang.String noSchemeUrl)	Create a URI form a no scheme Url, such as is returned by the AM.
static java.net.URI	getUriFromTrackingPlugins(org.apache.hadoop.yarn.api.records.ApplicationId id, java.util.List<org.apache.hadoop.yarn.util.TrackingUriPlugin> trackingUriPlugins)	Returns the first valid tracking link, if any, from the given id from the given list of plug-ins, if any.

Methods inherited from class java.lang.Object

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

Field Detail

PROXY_SERVLET_NAME

public static final java.lang.String PROXY_SERVLET_NAME

Name of the servlet to use when registering the proxy servlet.

See Also:

Constant Field Values

PROXY_BASE

public static final java.lang.String PROXY_BASE

Base path where the proxy servlet will handle requests.

See Also:

Constant Field Values

REDIRECT

public static final java.lang.String REDIRECT

Path component added when the proxy redirects the connection.

See Also:

Constant Field Values

PROXY_PATH_SPEC

public static final java.lang.String PROXY_PATH_SPEC

Path Specification for the proxy servlet.

See Also:

Constant Field Values

PROXY_APPROVAL_PARAM

public static final java.lang.String PROXY_APPROVAL_PARAM

Query Parameter indicating that the URI was approved.

See Also:

Constant Field Values

Constructor Detail

ProxyUriUtils

public ProxyUriUtils()

Method Detail

getPath

public static java.lang.String getPath(org.apache.hadoop.yarn.api.records.ApplicationId id)

Get the proxied path for an application.

Parameters:

id - the application id to use

Returns:

the base path to that application through the proxy

getPath

public static java.lang.String getPath(org.apache.hadoop.yarn.api.records.ApplicationId id,
                                       boolean redirected)

Get the proxied path for an application.

Parameters:

id - the application id to use

redirected - whether the path should contain the redirect component

Returns:

the base path to that application through the proxy

getPath

public static java.lang.String getPath(org.apache.hadoop.yarn.api.records.ApplicationId id,
                                       java.lang.String path)

Get the proxied path for an application.

Parameters:

id - the application id to use

path - the rest of the path to the application

Returns:

the base path to that application through the proxy

getPath

public static java.lang.String getPath(org.apache.hadoop.yarn.api.records.ApplicationId id,
                                       java.lang.String path,
                                       boolean redirected)

Get the proxied path for an application.

Parameters:

id - the application id to use

path - the rest of the path to the application

redirected - whether the path should contain the redirect component

Returns:

the base path to that application through the proxy

getPathAndQuery

public static java.lang.String getPathAndQuery(org.apache.hadoop.yarn.api.records.ApplicationId id,
                                               java.lang.String path,
                                               java.lang.String query,
                                               boolean approved)

Get the proxied path for an application

Parameters:

id - the id of the application

path - the path of the application.

query - the query parameters

approved - true if the user has approved accessing this app.

Returns:

the proxied path for this app.

getProxyUri

public static java.net.URI getProxyUri(java.net.URI originalUri,
                                       java.net.URI proxyUri,
                                       org.apache.hadoop.yarn.api.records.ApplicationId id)

Get a proxied URI for the original URI.

Parameters:

originalUri - the original URI to go through the proxy, or null if a default path "/" can be used.

proxyUri - the URI of the proxy itself, scheme, host and port are used.

id - the id of the application

Returns:

the proxied URI

getUriFromAMUrl

public static java.net.URI getUriFromAMUrl(java.lang.String scheme,
                                           java.lang.String noSchemeUrl)
                                    throws java.net.URISyntaxException

Create a URI form a no scheme Url, such as is returned by the AM.

Parameters:

noSchemeUrl - the URL format returned by an AM

Returns:

a URI with an http scheme

Throws:

java.net.URISyntaxException - if the url is not formatted correctly.

getUriFromTrackingPlugins

public static java.net.URI getUriFromTrackingPlugins(org.apache.hadoop.yarn.api.records.ApplicationId id,
                                                     java.util.List<org.apache.hadoop.yarn.util.TrackingUriPlugin> trackingUriPlugins)
                                              throws java.net.URISyntaxException

Returns the first valid tracking link, if any, from the given id from the given list of plug-ins, if any.

Parameters:

id - the id of the application for which the tracking link is desired

trackingUriPlugins - list of plugins from which to get the tracking link

Returns:

the desired link if possible, otherwise null

Throws:

java.net.URISyntaxException

getSchemeFromUrl

public static java.lang.String getSchemeFromUrl(java.lang.String url)

Returns the scheme if present in the url eg. "https://issues.apache.org/jira/browse/YARN" -> "https"