Package org.apache.hadoop.http

Class HttpServer2

java.lang.Object

org.apache.hadoop.http.HttpServer2

All Implemented Interfaces:

FilterContainer

@Private
@Evolving
public final class HttpServer2
extends java.lang.Object
implements FilterContainer

Create a Jetty embedded server to answer http requests. The primary goal is to serve up status information for the server. There are three contexts: "/logs/" -> points to the log directory "/static/" -> points to common static files (src/webapps/static) "/" -> the jsp server code from (src/webapps/<name>) This class is a fork of the old HttpServer. HttpServer exists for compatibility reasons. See HBASE-10336 for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpServer2.Builder	Class to construct instances of HTTP server with specific options.
static class	HttpServer2.QuotingInputFilter	A Servlet input filter that quotes all HTML active characters in the parameter names and values.
static class	HttpServer2.StackServlet	A very simple servlet to serve up a text representation of the current stack traces.
static class	HttpServer2.XFrameOption	The X-FRAME-OPTIONS header in HTTP response to mitigate clickjacking attack.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADMINS_ACL
static java.lang.String	BIND_ADDRESS
static java.lang.String	CONF_CONTEXT_ATTRIBUTE
static java.lang.String	FILTER_INITIALIZER_PROPERTY
protected java.util.List<java.lang.String>	filterNames
protected boolean	findPort
static int	HTTP_ACCEPTOR_COUNT_DEFAULT
static java.lang.String	HTTP_ACCEPTOR_COUNT_KEY
static java.lang.String	HTTP_HEADER_PREFIX
static int	HTTP_IDLE_TIMEOUT_MS_DEFAULT
static java.lang.String	HTTP_IDLE_TIMEOUT_MS_KEY
static int	HTTP_MAX_REQUEST_HEADER_SIZE_DEFAULT
static java.lang.String	HTTP_MAX_REQUEST_HEADER_SIZE_KEY
static int	HTTP_MAX_RESPONSE_HEADER_SIZE_DEFAULT
static java.lang.String	HTTP_MAX_RESPONSE_HEADER_SIZE_KEY
static java.lang.String	HTTP_MAX_THREADS_KEY
static java.lang.String	HTTP_SCHEME
static int	HTTP_SELECTOR_COUNT_DEFAULT
static java.lang.String	HTTP_SELECTOR_COUNT_KEY
static boolean	HTTP_SNI_HOST_CHECK_ENABLED_DEFAULT
static java.lang.String	HTTP_SNI_HOST_CHECK_ENABLED_KEY
static int	HTTP_SOCKET_BACKLOG_SIZE_DEFAULT
static java.lang.String	HTTP_SOCKET_BACKLOG_SIZE_KEY
static java.lang.String	HTTP_TEMP_DIR_KEY
static java.lang.String	HTTPS_SCHEME
static org.slf4j.Logger	LOG
static java.lang.String	NO_CACHE_FILTER
protected Configuration.IntegerRanges	portRanges
protected static java.lang.String	PROMETHEUS_SINK
static java.lang.String	SPNEGO_FILTER
protected org.eclipse.jetty.webapp.WebAppContext	webAppContext
protected org.eclipse.jetty.server.Server	webServer

Method Summary

Modifier and Type	Method	Description
void	addContext(org.eclipse.jetty.servlet.ServletContextHandler ctxt, boolean isFiltered)
protected void	addDefaultApps(org.eclipse.jetty.server.handler.ContextHandlerCollection parent, java.lang.String appDir, Configuration conf)	Add default apps.
protected void	addDefaultServlets(Configuration configuration)	Add default servlets.
void	addFilter(java.lang.String name, java.lang.String classname, java.util.Map<java.lang.String,java.lang.String> parameters)	Add a filter to the container.
protected void	addFilterPathMapping(java.lang.String pathSpec, org.eclipse.jetty.servlet.ServletContextHandler webAppCtx)	Add the path spec to the filter path mapping.
void	addGlobalFilter(java.lang.String name, java.lang.String classname, java.util.Map<java.lang.String,java.lang.String> parameters)	Add a global filter to the container.
void	addHandlerAtEnd(org.eclipse.jetty.server.Handler handler)	Add the given handler to the end of the list of handlers.
void	addHandlerAtFront(org.eclipse.jetty.server.Handler handler)	Add the given handler to the front of the list of handlers.
void	addInternalServlet(java.lang.String name, java.lang.String pathSpec, java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz)	Add an internal servlet in the server.
void	addInternalServlet(java.lang.String name, java.lang.String pathSpec, java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz, boolean requireAuth)	Add an internal servlet in the server, specifying whether or not to protect with Kerberos authentication.
void	addInternalServlet(java.lang.String name, java.lang.String pathSpec, java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz, java.util.Map<java.lang.String,java.lang.String> params)	Add an internal servlet in the server, with initialization parameters.
void	addJerseyResourcePackage(java.lang.String packageName, java.lang.String pathSpec)	Add a Jersey resource package.
void	addJerseyResourcePackage(java.lang.String packageName, java.lang.String pathSpec, java.util.Map<java.lang.String,java.lang.String> params)	Add a Jersey resource package.
void	addServlet(java.lang.String name, java.lang.String pathSpec, java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz)	Add a servlet in the server.
static void	defineFilter(org.eclipse.jetty.servlet.ServletContextHandler ctx, java.lang.String name, java.lang.String classname, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String[] urls)	Define a filter for a context and set up default url mappings.
java.lang.Object	getAttribute(java.lang.String name)	Get the value in the webapp context.
java.net.InetSocketAddress	getConnectorAddress(int index)	Get the address that corresponds to a particular connector.
static java.util.Properties	getFilterProperties(Configuration conf, java.util.List<java.lang.String> prefixes)
int	getPort()	Deprecated.
org.eclipse.jetty.webapp.WebAppContext	getWebAppContext()
protected java.lang.String	getWebAppsPath(java.lang.String appName)	Get the pathname to the webapps files.
static boolean	hasAdministratorAccess(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Does the user sending the HttpServletRequest has the administrator ACLs? If it isn't the case, response will be modified to send an error to the user.
boolean	isAlive()	Test for the availability of the web server
static boolean	isInstrumentationAccessAllowed(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Checks the user has privileges to access to instrumentation servlets.
void	join()
void	setAttribute(java.lang.String name, java.lang.Object value)	Set a value in the webapp context.
void	setThreads(int min, int max)	Set the min, max number of worker threads (simultaneous connections).
void	start()	Start the server.
void	stop()	stop the server.
java.lang.String	toString()
static boolean	userHasAdministratorAccess(javax.servlet.ServletContext servletContext, java.lang.String remoteUser)	Get the admin ACLs from the given ServletContext and check if the given user is in the ACL.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

HTTP_SCHEME

public static final java.lang.String HTTP_SCHEME

See Also:

Constant Field Values

HTTPS_SCHEME

public static final java.lang.String HTTPS_SCHEME

See Also:

Constant Field Values

HTTP_MAX_REQUEST_HEADER_SIZE_KEY

public static final java.lang.String HTTP_MAX_REQUEST_HEADER_SIZE_KEY

See Also:

Constant Field Values

HTTP_MAX_REQUEST_HEADER_SIZE_DEFAULT

public static final int HTTP_MAX_REQUEST_HEADER_SIZE_DEFAULT

See Also:

Constant Field Values

HTTP_MAX_RESPONSE_HEADER_SIZE_KEY

public static final java.lang.String HTTP_MAX_RESPONSE_HEADER_SIZE_KEY

See Also:

Constant Field Values

HTTP_MAX_RESPONSE_HEADER_SIZE_DEFAULT

public static final int HTTP_MAX_RESPONSE_HEADER_SIZE_DEFAULT

See Also:

Constant Field Values

HTTP_SOCKET_BACKLOG_SIZE_KEY

public static final java.lang.String HTTP_SOCKET_BACKLOG_SIZE_KEY

See Also:

Constant Field Values

HTTP_SOCKET_BACKLOG_SIZE_DEFAULT

public static final int HTTP_SOCKET_BACKLOG_SIZE_DEFAULT

See Also:

Constant Field Values

HTTP_MAX_THREADS_KEY

public static final java.lang.String HTTP_MAX_THREADS_KEY

See Also:

Constant Field Values

HTTP_ACCEPTOR_COUNT_KEY

public static final java.lang.String HTTP_ACCEPTOR_COUNT_KEY

See Also:

Constant Field Values

HTTP_ACCEPTOR_COUNT_DEFAULT

public static final int HTTP_ACCEPTOR_COUNT_DEFAULT

See Also:

Constant Field Values

HTTP_SELECTOR_COUNT_KEY

public static final java.lang.String HTTP_SELECTOR_COUNT_KEY

See Also:

Constant Field Values

HTTP_SELECTOR_COUNT_DEFAULT

public static final int HTTP_SELECTOR_COUNT_DEFAULT

See Also:

Constant Field Values

HTTP_IDLE_TIMEOUT_MS_KEY

public static final java.lang.String HTTP_IDLE_TIMEOUT_MS_KEY

See Also:

Constant Field Values

HTTP_IDLE_TIMEOUT_MS_DEFAULT

public static final int HTTP_IDLE_TIMEOUT_MS_DEFAULT

See Also:

Constant Field Values

HTTP_TEMP_DIR_KEY

public static final java.lang.String HTTP_TEMP_DIR_KEY

See Also:

Constant Field Values

FILTER_INITIALIZER_PROPERTY

public static final java.lang.String FILTER_INITIALIZER_PROPERTY

See Also:

Constant Field Values

HTTP_SNI_HOST_CHECK_ENABLED_KEY

public static final java.lang.String HTTP_SNI_HOST_CHECK_ENABLED_KEY

See Also:

Constant Field Values

HTTP_SNI_HOST_CHECK_ENABLED_DEFAULT

public static final boolean HTTP_SNI_HOST_CHECK_ENABLED_DEFAULT

See Also:

Constant Field Values

CONF_CONTEXT_ATTRIBUTE

public static final java.lang.String CONF_CONTEXT_ATTRIBUTE

See Also:

Constant Field Values

ADMINS_ACL

public static final java.lang.String ADMINS_ACL

See Also:

Constant Field Values

SPNEGO_FILTER

public static final java.lang.String SPNEGO_FILTER

See Also:

Constant Field Values

NO_CACHE_FILTER

public static final java.lang.String NO_CACHE_FILTER

See Also:

Constant Field Values

BIND_ADDRESS

public static final java.lang.String BIND_ADDRESS

See Also:

Constant Field Values

webServer

protected final org.eclipse.jetty.server.Server webServer

webAppContext

protected final org.eclipse.jetty.webapp.WebAppContext webAppContext

findPort

protected final boolean findPort

portRanges

protected final Configuration.IntegerRanges portRanges

filterNames

protected final java.util.List<java.lang.String> filterNames

HTTP_HEADER_PREFIX

public static final java.lang.String HTTP_HEADER_PREFIX

See Also:

Constant Field Values

PROMETHEUS_SINK

protected static final java.lang.String PROMETHEUS_SINK

See Also:

Constant Field Values

Method Detail

getFilterProperties

public static java.util.Properties getFilterProperties(Configuration conf,
                                                       java.util.List<java.lang.String> prefixes)

addDefaultApps

protected void addDefaultApps(org.eclipse.jetty.server.handler.ContextHandlerCollection parent,
                              java.lang.String appDir,
                              Configuration conf)
                       throws java.io.IOException

Add default apps.

Parameters:

parent - contexthandlercollection.

appDir - The application directory

conf - configuration.

Throws:

java.io.IOException - raised on errors performing I/O.

addDefaultServlets

protected void addDefaultServlets(Configuration configuration)

Add default servlets.

Parameters:

configuration - the hadoop configuration

addContext

public void addContext(org.eclipse.jetty.servlet.ServletContextHandler ctxt,
                       boolean isFiltered)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Set a value in the webapp context. These values are available to the jsp pages as "application.getAttribute(name)".

Parameters:

name - The name of the attribute

value - The value of the attribute

addJerseyResourcePackage

public void addJerseyResourcePackage(java.lang.String packageName,
                                     java.lang.String pathSpec)

Add a Jersey resource package.

Parameters:

packageName - The Java package name containing the Jersey resource.

pathSpec - The path spec for the servlet

addJerseyResourcePackage

public void addJerseyResourcePackage(java.lang.String packageName,
                                     java.lang.String pathSpec,
                                     java.util.Map<java.lang.String,java.lang.String> params)

Add a Jersey resource package.

Parameters:

packageName - The Java package name containing the Jersey resource.

pathSpec - The path spec for the servlet

params - properties and features for ResourceConfig

addServlet

public void addServlet(java.lang.String name,
                       java.lang.String pathSpec,
                       java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz)

Add a servlet in the server.

Parameters:

name - The name of the servlet (can be passed as null)

pathSpec - The path spec for the servlet

clazz - The servlet class

addInternalServlet

public void addInternalServlet(java.lang.String name,
                               java.lang.String pathSpec,
                               java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz)

Add an internal servlet in the server. Note: This method is to be used for adding servlets that facilitate internal communication and not for user facing functionality. For servlets added using this method, filters are not enabled.

Parameters:

name - The name of the servlet (can be passed as null)

pathSpec - The path spec for the servlet

clazz - The servlet class

addInternalServlet

public void addInternalServlet(java.lang.String name,
                               java.lang.String pathSpec,
                               java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz,
                               boolean requireAuth)

Add an internal servlet in the server, specifying whether or not to protect with Kerberos authentication. Note: This method is to be used for adding servlets that facilitate internal communication and not for user facing functionality. For servlets added using this method, filters (except internal Kerberos filters) are not enabled.

Parameters:

name - The name of the servlet (can be passed as null)

pathSpec - The path spec for the servlet

clazz - The servlet class

requireAuth - Require Kerberos authenticate to access servlet

addInternalServlet

public void addInternalServlet(java.lang.String name,
                               java.lang.String pathSpec,
                               java.lang.Class<? extends javax.servlet.http.HttpServlet> clazz,
                               java.util.Map<java.lang.String,java.lang.String> params)

Add an internal servlet in the server, with initialization parameters. Note: This method is to be used for adding servlets that facilitate internal communication and not for user facing functionality. For servlets added using this method, filters (except internal Kerberos filters) are not enabled.

Parameters:

name - The name of the servlet (can be passed as null)

pathSpec - The path spec for the servlet

clazz - The servlet class

params - init parameters

addHandlerAtFront

public void addHandlerAtFront(org.eclipse.jetty.server.Handler handler)

Add the given handler to the front of the list of handlers.

Parameters:

handler - The handler to add

addHandlerAtEnd

public void addHandlerAtEnd(org.eclipse.jetty.server.Handler handler)

Add the given handler to the end of the list of handlers.

Parameters:

handler - The handler to add

addFilter

public void addFilter(java.lang.String name,
                      java.lang.String classname,
                      java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: FilterContainer

Add a filter to the container.

Specified by:

addFilter in interface FilterContainer

Parameters:

name - Filter name

classname - Filter class name

parameters - a map from parameter names to initial values

addGlobalFilter

public void addGlobalFilter(java.lang.String name,
                            java.lang.String classname,
                            java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: FilterContainer

Add a global filter to the container.

Specified by:

addGlobalFilter in interface FilterContainer

Parameters:

name - filter name

classname - filter class name

parameters - a map from parameter names to initial values

defineFilter

public static void defineFilter(org.eclipse.jetty.servlet.ServletContextHandler ctx,
                                java.lang.String name,
                                java.lang.String classname,
                                java.util.Map<java.lang.String,java.lang.String> parameters,
                                java.lang.String[] urls)

Define a filter for a context and set up default url mappings.

Parameters:

ctx - ctx.

name - name.

classname - classname.

parameters - parameters.

urls - urls.

addFilterPathMapping

protected void addFilterPathMapping(java.lang.String pathSpec,
                                    org.eclipse.jetty.servlet.ServletContextHandler webAppCtx)

Add the path spec to the filter path mapping.

Parameters:

pathSpec - The path spec

webAppCtx - The WebApplicationContext to add to

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Get the value in the webapp context.

Parameters:

name - The name of the attribute

Returns:

The value of the attribute

getWebAppContext

public org.eclipse.jetty.webapp.WebAppContext getWebAppContext()

getWebAppsPath

protected java.lang.String getWebAppsPath(java.lang.String appName)
                                   throws java.io.FileNotFoundException

Get the pathname to the webapps files.

Parameters:

appName - eg "secondary" or "datanode"

Returns:

the pathname as a URL

Throws:

java.io.FileNotFoundException - if 'webapps' directory cannot be found on CLASSPATH or in the development location.

getPort

@Deprecated
public int getPort()

Deprecated.

Get the port that the server is on

Returns:

the port

getConnectorAddress

public java.net.InetSocketAddress getConnectorAddress(int index)

Get the address that corresponds to a particular connector.

Parameters:

index - index.

Returns:

the corresponding address for the connector, or null if there's no such connector or the connector is not bounded or was closed.

setThreads

public void setThreads(int min,
                       int max)

Set the min, max number of worker threads (simultaneous connections).

Parameters:

min - min.

max - max.

start

public void start()
           throws java.io.IOException

Start the server. Does not wait for the server to start.

Throws:

java.io.IOException - raised on errors performing I/O.

stop

public void stop()
          throws java.lang.Exception

stop the server.

Throws:

java.lang.Exception - exception.

join

public void join()
          throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

isAlive

public boolean isAlive()

Test for the availability of the web server

Returns:

true if the web server is started, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isInstrumentationAccessAllowed

public static boolean isInstrumentationAccessAllowed(javax.servlet.ServletContext servletContext,
                                                     javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)
                                              throws java.io.IOException

Checks the user has privileges to access to instrumentation servlets.

If hadoop.security.instrumentation.requires.admin is set to FALSE (default value) it always returns TRUE.

If hadoop.security.instrumentation.requires.admin is set to TRUE it will check that if the current user is in the admin ACLS. If the user is in the admin ACLs it returns TRUE, otherwise it returns FALSE.

Parameters:

servletContext - the servlet context.

request - the servlet request.

response - the servlet response.

Returns:

TRUE/FALSE based on the logic decribed above.

Throws:

java.io.IOException - raised on errors performing I/O.

hasAdministratorAccess

public static boolean hasAdministratorAccess(javax.servlet.ServletContext servletContext,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws java.io.IOException

Does the user sending the HttpServletRequest has the administrator ACLs? If it isn't the case, response will be modified to send an error to the user.

Parameters:

servletContext - servletContext.

request - request.

response - used to send the error response if user does not have admin access.

Returns:

true if admin-authorized, false otherwise

Throws:

java.io.IOException - raised on errors performing I/O.

userHasAdministratorAccess

public static boolean userHasAdministratorAccess(javax.servlet.ServletContext servletContext,
                                                 java.lang.String remoteUser)

Get the admin ACLs from the given ServletContext and check if the given user is in the ACL.

Parameters:

servletContext - the context containing the admin ACL.

remoteUser - the remote user to check for.

Returns:

true if the user is present in the ACL, false if no ACL is set or the user is not present