org.apache.hadoop.http

Class HttpServer

java.lang.Object

org.apache.hadoop.http.HttpServer

All Implemented Interfaces:

FilterContainer

@InterfaceAudience.LimitedPrivate(value={"HDFS","MapReduce","HBase"})
@InterfaceStability.Evolving
public class HttpServer
extends 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/)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpServer.QuotingInputFilter A Servlet input filter that quotes all HTML active characters in the parameter names and values.
static class	HttpServer.StackServlet A very simple servlet to serve up a text representation of the current stack traces.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMINS_ACL
static String	BIND_ADDRESS
static String	CONF_CONTEXT_ATTRIBUTE
protected org.eclipse.jetty.server.handler.ContextHandlerCollection	contexts
protected Map<org.eclipse.jetty.servlet.ServletContextHandler,Boolean>	defaultContexts
protected List<String>	filterNames
protected boolean	findPort
protected org.eclipse.jetty.server.ServerConnector	listener
static org.apache.commons.logging.Log	LOG
static String	NO_CACHE_FILTER
static String	SPNEGO_FILTER
protected org.eclipse.jetty.webapp.WebAppContext	webAppContext
protected org.eclipse.jetty.server.Server	webServer

Constructor Summary

Constructors

Constructor and Description
HttpServer(String name, String bindAddress, int port, boolean findPort) Same as this(name, bindAddress, port, findPort, null);
HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf) Create a status server on the given port.
HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf, AccessControlList adminsAcl)
HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf, AccessControlList adminsAcl, org.eclipse.jetty.server.ServerConnector connector) Create a status server on the given port.
HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf, AccessControlList adminsAcl, org.eclipse.jetty.server.ServerConnector connector, String[] pathSpecs, org.eclipse.jetty.server.Server server) Create a status server on the given port.
HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf, org.eclipse.jetty.server.ServerConnector connector)
HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf, String[] pathSpecs) Create a status server on the given port.

Method Summary

Methods

Modifier and Type	Method and Description
void	addContext(org.eclipse.jetty.servlet.ServletContextHandler ctxt, boolean isFiltered)
protected void	addContext(String pathSpec, String dir, boolean isFiltered) Add a context
protected void	addDefaultApps(org.eclipse.jetty.server.handler.ContextHandlerCollection parent, String appDir, Configuration conf) Add default apps.
protected void	addDefaultServlets() Add default servlets.
void	addFilter(String name, String classname, Map<String,String> parameters) Add a filter to the container.
protected void	addFilterPathMapping(String pathSpec, org.eclipse.jetty.servlet.ServletContextHandler webAppCtx) Add the path spec to the filter path mapping.
void	addGlobalFilter(String name, String classname, Map<String,String> parameters) Add a global filter to the container.
void	addInternalServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz) Add an internal servlet in the server.
void	addInternalServlet(String name, String pathSpec, 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	addJerseyResourcePackage(String packageName, String pathSpec) Add a Jersey resource package.
void	addServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz) Add a servlet in the server.
void	addSslListener(InetSocketAddress addr, Configuration sslConf, boolean needCertsAuth) Configure an ssl listener on the server.
void	addSslListener(InetSocketAddress addr, String keystore, String storPass, String keyPass) Deprecated. Use addSslListener(InetSocketAddress, Configuration, boolean)
org.eclipse.jetty.server.ServerConnector	createBaseListener(Configuration conf) Create a required listener for the Jetty instance listening on the port provided.
static org.eclipse.jetty.server.ServerConnector	createDefaultChannelConnector(org.eclipse.jetty.server.Server server)
static org.eclipse.jetty.server.Server	createServer(Configuration conf)
void	defineFilter(org.eclipse.jetty.servlet.ServletContextHandler ctx, String name, String classname, Map<String,String> parameters, String[] urls) Define a filter for a context and set up default url mappings.
Object	getAttribute(String name) Get the value in the webapp context.
InetSocketAddress	getListenerAddress() Return the bind address of the listener.
int	getPort() Get the port that the server is on
org.eclipse.jetty.webapp.WebAppContext	getWebAppContext()
protected String	getWebAppsPath(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.
protected void	initSpnego(Configuration conf, String usernameConfKey, String keytabConfKey)
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(String name, 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
String	toString() Return the host and port of the HttpServer, if live
static boolean	userHasAdministratorAccess(javax.servlet.ServletContext servletContext, 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.apache.commons.logging.Log LOG

CONF_CONTEXT_ATTRIBUTE

public static final String CONF_CONTEXT_ATTRIBUTE

See Also:

Constant Field Values

ADMINS_ACL

public static final String ADMINS_ACL

See Also:

Constant Field Values

SPNEGO_FILTER

public static final String SPNEGO_FILTER

See Also:

Constant Field Values

NO_CACHE_FILTER

public static final String NO_CACHE_FILTER

See Also:

Constant Field Values

BIND_ADDRESS

public static final String BIND_ADDRESS

See Also:

Constant Field Values

webServer

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

contexts

protected final org.eclipse.jetty.server.handler.ContextHandlerCollection contexts

listener

protected final org.eclipse.jetty.server.ServerConnector listener

webAppContext

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

findPort

protected final boolean findPort

defaultContexts

protected final Map<org.eclipse.jetty.servlet.ServletContextHandler,Boolean> defaultContexts

filterNames

protected final List<String> filterNames

Constructor Detail

HttpServer

public HttpServer(String name,
          String bindAddress,
          int port,
          boolean findPort)
           throws IOException

Same as this(name, bindAddress, port, findPort, null);

Throws:

IOException

HttpServer

public HttpServer(String name,
          String bindAddress,
          int port,
          boolean findPort,
          Configuration conf,
          org.eclipse.jetty.server.ServerConnector connector)
           throws IOException

Throws:

IOException

HttpServer

public HttpServer(String name,
          String bindAddress,
          int port,
          boolean findPort,
          Configuration conf,
          String[] pathSpecs)
           throws IOException

Create a status server on the given port. Allows you to specify the path specifications that this server will be serving so that they will be added to the filters properly.

Parameters:

name - The name of the server

bindAddress - The address for this server

port - The port to use on the server

findPort - whether the server should start at the given port and increment by 1 until it finds a free port.

conf - Configuration

pathSpecs - Path specifications that this httpserver will be serving. These will be added to any filters.

Throws:

IOException

HttpServer

public HttpServer(String name,
          String bindAddress,
          int port,
          boolean findPort,
          Configuration conf)
           throws IOException

Create a status server on the given port. The jsp scripts are taken from src/webapps/.

Parameters:

name - The name of the server

port - The port to use on the server

findPort - whether the server should start at the given port and increment by 1 until it finds a free port.

conf - Configuration

Throws:

IOException

HttpServer

public HttpServer(String name,
          String bindAddress,
          int port,
          boolean findPort,
          Configuration conf,
          AccessControlList adminsAcl)
           throws IOException

Throws:

IOException

HttpServer

public HttpServer(String name,
          String bindAddress,
          int port,
          boolean findPort,
          Configuration conf,
          AccessControlList adminsAcl,
          org.eclipse.jetty.server.ServerConnector connector)
           throws IOException

Create a status server on the given port. The jsp scripts are taken from src/webapps/.

Parameters:

name - The name of the server

bindAddress - The address for this server

port - The port to use on the server

findPort - whether the server should start at the given port and increment by 1 until it finds a free port.

conf - Configuration

adminsAcl - AccessControlList of the admins

Throws:

IOException

HttpServer

public HttpServer(String name,
          String bindAddress,
          int port,
          boolean findPort,
          Configuration conf,
          AccessControlList adminsAcl,
          org.eclipse.jetty.server.ServerConnector connector,
          String[] pathSpecs,
          org.eclipse.jetty.server.Server server)
           throws IOException

Create a status server on the given port. The jsp scripts are taken from src/webapps/.

Parameters:

name - The name of the server

bindAddress - The address for this server

port - The port to use on the server

findPort - whether the server should start at the given port and increment by 1 until it finds a free port.

conf - Configuration

adminsAcl - AccessControlList of the admins

connector - A jetty connection listener

pathSpecs - Path specifications that this httpserver will be serving. These will be added to any filters.

Throws:

IOException

Method Detail

createBaseListener

public org.eclipse.jetty.server.ServerConnector createBaseListener(Configuration conf)
                                                            throws IOException

Create a required listener for the Jetty instance listening on the port provided. This wrapper and all subclasses must create at least one listener.

Throws:

IOException

createDefaultChannelConnector

@InterfaceAudience.Private
public static org.eclipse.jetty.server.ServerConnector createDefaultChannelConnector(org.eclipse.jetty.server.Server server)

createServer

@InterfaceAudience.Private
public static org.eclipse.jetty.server.Server createServer(Configuration conf)

addDefaultApps

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

Add default apps.

Parameters:

appDir - The application directory

Throws:

IOException

addDefaultServlets

protected void addDefaultServlets()

Add default servlets.

addContext

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

Throws:

IOException

addContext

protected void addContext(String pathSpec,
              String dir,
              boolean isFiltered)
                   throws IOException

Add a context

Parameters:

pathSpec - The path spec for the context

dir - The directory containing the context

isFiltered - if true, the servlet is added to the filter path mapping

Throws:

IOException

setAttribute

public void setAttribute(String name,
                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(String packageName,
                            String pathSpec)

Add a Jersey resource package.

Parameters:

packageName - The Java package name containing the Jersey resource.

pathSpec - The path spec for the servlet

addServlet

public void addServlet(String name,
              String pathSpec,
              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(String name,
                      String pathSpec,
                      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(String name,
                      String pathSpec,
                      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

addFilter

public void addFilter(String name,
             String classname,
             Map<String,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(String name,
                   String classname,
                   Map<String,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 void defineFilter(org.eclipse.jetty.servlet.ServletContextHandler ctx,
                String name,
                String classname,
                Map<String,String> parameters,
                String[] urls)

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

addFilterPathMapping

protected void addFilterPathMapping(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 Object getAttribute(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 String getWebAppsPath(String appName)
                         throws FileNotFoundException

Get the pathname to the webapps files.

Parameters:

appName - eg "secondary" or "datanode"

Returns:

the pathname as a URL

Throws:

FileNotFoundException - if 'webapps' directory cannot be found on CLASSPATH.

getPort

public int getPort()

Get the port that the server is on

Returns:

the port

setThreads

public void setThreads(int min,
              int max)

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

addSslListener

@Deprecated
public void addSslListener(InetSocketAddress addr,
                             String keystore,
                             String storPass,
                             String keyPass)
                    throws IOException

Deprecated. Use addSslListener(InetSocketAddress, Configuration, boolean)

Configure an ssl listener on the server.

Parameters:

addr - address to listen on

keystore - location of the keystore

storPass - password for the keystore

keyPass - password for the key

Throws:

IOException

addSslListener

public void addSslListener(InetSocketAddress addr,
                  Configuration sslConf,
                  boolean needCertsAuth)
                    throws IOException

Configure an ssl listener on the server.

Parameters:

addr - address to listen on

sslConf - conf to retrieve ssl options

needCertsAuth - whether x509 certificate authentication is required

Throws:

IOException

initSpnego

protected void initSpnego(Configuration conf,
              String usernameConfKey,
              String keytabConfKey)
                   throws IOException

Throws:

IOException

start

public void start()
           throws IOException

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

Throws:

IOException

getListenerAddress

public InetSocketAddress getListenerAddress()

Return the bind address of the listener.

Returns:

InetSocketAddress of the listener

stop

public void stop()
          throws Exception

stop the server

Throws:

Exception

join

public void join()
          throws InterruptedException

Throws:

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 String toString()

Return the host and port of the HttpServer, if live

Overrides:

toString in class Object

Returns:

the classname and any HTTP URL

isInstrumentationAccessAllowed

public static boolean isInstrumentationAccessAllowed(javax.servlet.ServletContext servletContext,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                                              throws 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:

IOException

hasAdministratorAccess

public static boolean hasAdministratorAccess(javax.servlet.ServletContext servletContext,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                                      throws 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 -

request -

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

Returns:

true if admin-authorized, false otherwise

Throws:

IOException

userHasAdministratorAccess

public static boolean userHasAdministratorAccess(javax.servlet.ServletContext servletContext,
                                 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