HttpServer (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.http.HttpServer

All Implemented Interfaces:

FilterContainer
```
@InterfaceAudience.Private
@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/<name>)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpServer.Builder` Class to construct instances of HTTP server with specific options.
`private static class`	`HttpServer.ListenerInfo`
`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`
`private org.apache.hadoop.security.authorize.AccessControlList`	`adminsAcl`
`static String`	`APP_DIR`
`protected String`	`appDir`
`static String`	`BIND_ADDRESS`
`static String`	`CONF_CONTEXT_ATTRIBUTE`
`protected Map<org.mortbay.jetty.servlet.Context,Boolean>`	`defaultContexts`
`(package private) static String`	`FILTER_INITIALIZERS_PROPERTY`
`protected List<String>`	`filterNames`
`protected boolean`	`findPort`
`(package private) static String`	`HTTP_MAX_THREADS`
`private List<HttpServer.ListenerInfo>`	`listeners`
`private static org.apache.commons.logging.Log`	`LOG`
`protected String`	`logDir`
`static String`	`NO_CACHE_FILTER`
`static String`	`SPNEGO_FILTER`
`(package private) static String`	`STATE_DESCRIPTION_ALIVE`
`(package private) static String`	`STATE_DESCRIPTION_NOT_LIVE`
`protected org.mortbay.jetty.webapp.WebAppContext`	`webAppContext`
`protected org.mortbay.jetty.Server`	`webServer`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`HttpServer(HttpServer.Builder b)`
	`HttpServer(String name, String bindAddress, int port, boolean findPort)` Deprecated.
	`HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf)` Deprecated.
	`HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.authorize.AccessControlList adminsAcl)` Deprecated.
	`HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.authorize.AccessControlList adminsAcl, org.mortbay.jetty.Connector connector)` Deprecated.
	`HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.authorize.AccessControlList adminsAcl, org.mortbay.jetty.Connector connector, String[] pathSpecs)` Deprecated.
	`HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, org.mortbay.jetty.Connector connector)` Deprecated.
	`HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, String[] pathSpecs)` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addContext(org.mortbay.jetty.servlet.Context ctxt, boolean isFiltered)`
`protected void`	`addContext(String pathSpec, String dir, boolean isFiltered)` Add a context
`protected void`	`addDefaultApps(org.mortbay.jetty.handler.ContextHandlerCollection parent, String appDir, org.apache.hadoop.conf.Configuration conf)` Add default apps.
`protected void`	`addDefaultServlets(org.mortbay.jetty.handler.ContextHandlerCollection contexts)` 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.mortbay.jetty.servlet.Context 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 - This global filter will be applied to all available web contexts.
`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.
`private void`	`addManagedListener(org.mortbay.jetty.Connector connector)`
`private org.mortbay.util.MultiException`	`addMultiException(org.mortbay.util.MultiException exception, Exception e)`
`private static void`	`addNoCacheFilter(org.mortbay.jetty.webapp.WebAppContext ctxt)`
`void`	`addServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz)` Add a servlet in the server.
`private void`	`addUnmanagedListener(org.mortbay.jetty.Connector connector)`
`org.mortbay.jetty.Connector`	`createBaseListener(org.apache.hadoop.conf.Configuration conf)` Create a required listener for the Jetty instance listening on the port provided.
`static org.mortbay.jetty.Connector`	`createDefaultChannelConnector()`
`private static org.mortbay.jetty.webapp.WebAppContext`	`createWebAppContext(String name, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.authorize.AccessControlList adminsAcl, String appDir)`
`static void`	`defineFilter(org.mortbay.jetty.servlet.Context 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`	`getConnectorAddress(int index)` Get the address that corresponds to a particular connector.
`private static FilterInitializer[]`	`getFilterInitializers(org.apache.hadoop.conf.Configuration conf)` Get an array of FilterConfiguration specified in the conf
`int`	`getPort()` Deprecated.
`org.mortbay.jetty.webapp.WebAppContext`	`getWebAppContext()`
`String`	`getWebAppsPath(String appName)`
`protected String`	`getWebAppsPath(String webapps, 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.
`private void`	`initializeWebServer(String name, String hostName, org.apache.hadoop.conf.Configuration conf, String[] pathSpecs)`
`private void`	`initSpnego(org.apache.hadoop.conf.Configuration conf, String hostName, 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()`
`private void`	`loadListeners()`
`(package private) void`	`openListeners()` Open the main listener for the server
`void`	`setAttribute(String name, Object value)` Set a value in the webapp context.
`private void`	`setContextAttributes(org.mortbay.jetty.servlet.Context context, org.apache.hadoop.conf.Configuration conf)`
`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

private static final org.apache.commons.logging.Log LOG

FILTER_INITIALIZERS_PROPERTY
```
static final String FILTER_INITIALIZERS_PROPERTY
```
See Also:
Constant Field Values

HTTP_MAX_THREADS
```
static final String HTTP_MAX_THREADS
```
See Also:
Constant Field Values

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

BIND_ADDRESS

public static final String BIND_ADDRESS

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

APP_DIR
```
public static final String APP_DIR
```
See Also:
Constant Field Values

adminsAcl

private final org.apache.hadoop.security.authorize.AccessControlList adminsAcl

webServer

protected final org.mortbay.jetty.Server webServer

appDir
```
protected String appDir
```

logDir
```
protected String logDir
```

listeners

private final List<HttpServer.ListenerInfo> listeners

webAppContext

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

findPort
```
protected final boolean findPort
```

defaultContexts

protected final Map<org.mortbay.jetty.servlet.Context,Boolean> defaultContexts

filterNames

protected final List<String> filterNames

STATE_DESCRIPTION_ALIVE
```
static final String STATE_DESCRIPTION_ALIVE
```
See Also:
Constant Field Values

STATE_DESCRIPTION_NOT_LIVE
```
static final String STATE_DESCRIPTION_NOT_LIVE
```
See Also:
Constant Field Values

Constructor Detail

HttpServer

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

Deprecated.

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

Throws:: IOException

HttpServer

@Deprecated
public HttpServer(String name,
                     String bindAddress,
                     int port,
                     boolean findPort,
                     org.apache.hadoop.conf.Configuration conf,
                     org.mortbay.jetty.Connector connector)
           throws IOException

Deprecated.

Throws:: IOException

HttpServer
```
@Deprecated
public HttpServer(String name,
                     String bindAddress,
                     int port,
                     boolean findPort,
                     org.apache.hadoop.conf.Configuration conf,
                     String[] pathSpecs)
           throws IOException
```
Deprecated.

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
```
@Deprecated
public HttpServer(String name,
                     String bindAddress,
                     int port,
                     boolean findPort,
                     org.apache.hadoop.conf.Configuration conf)
           throws IOException
```
Deprecated.

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

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

@Deprecated
public HttpServer(String name,
                     String bindAddress,
                     int port,
                     boolean findPort,
                     org.apache.hadoop.conf.Configuration conf,
                     org.apache.hadoop.security.authorize.AccessControlList adminsAcl)
           throws IOException

Deprecated.

Throws:: IOException

HttpServer
```
@Deprecated
public HttpServer(String name,
                     String bindAddress,
                     int port,
                     boolean findPort,
                     org.apache.hadoop.conf.Configuration conf,
                     org.apache.hadoop.security.authorize.AccessControlList adminsAcl,
                     org.mortbay.jetty.Connector connector)
           throws IOException
```
Deprecated.

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

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 - The jetty Connector to use

Throws:

IOException

HttpServer
```
@Deprecated
public HttpServer(String name,
                     String bindAddress,
                     int port,
                     boolean findPort,
                     org.apache.hadoop.conf.Configuration conf,
                     org.apache.hadoop.security.authorize.AccessControlList adminsAcl,
                     org.mortbay.jetty.Connector connector,
                     String[] pathSpecs)
           throws IOException
```
Deprecated.

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

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

HttpServer

private HttpServer(HttpServer.Builder b)
            throws IOException

Throws:: IOException

Method Detail

initializeWebServer

private void initializeWebServer(String name,
                       String hostName,
                       org.apache.hadoop.conf.Configuration conf,
                       String[] pathSpecs)
                          throws FileNotFoundException,
                                 IOException

Throws:: FileNotFoundException; IOException

addUnmanagedListener

private void addUnmanagedListener(org.mortbay.jetty.Connector connector)

addManagedListener

private void addManagedListener(org.mortbay.jetty.Connector connector)

createWebAppContext

private static org.mortbay.jetty.webapp.WebAppContext createWebAppContext(String name,
                                                         org.apache.hadoop.conf.Configuration conf,
                                                         org.apache.hadoop.security.authorize.AccessControlList adminsAcl,
                                                         String appDir)

addNoCacheFilter

private static void addNoCacheFilter(org.mortbay.jetty.webapp.WebAppContext ctxt)

createBaseListener
```
public org.mortbay.jetty.Connector createBaseListener(org.apache.hadoop.conf.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.mortbay.jetty.Connector createDefaultChannelConnector()

getFilterInitializers

private static FilterInitializer[] getFilterInitializers(org.apache.hadoop.conf.Configuration conf)

Get an array of FilterConfiguration specified in the conf

addDefaultApps

protected void addDefaultApps(org.mortbay.jetty.handler.ContextHandlerCollection parent,
                  String appDir,
                  org.apache.hadoop.conf.Configuration conf)
                       throws IOException

Add default apps.

Parameters:: appDir - The application directory
Throws:: IOException

setContextAttributes

private void setContextAttributes(org.mortbay.jetty.servlet.Context context,
                        org.apache.hadoop.conf.Configuration conf)

addDefaultServlets

protected void addDefaultServlets(org.mortbay.jetty.handler.ContextHandlerCollection contexts)
                           throws IOException

Add default servlets.

Throws:: IOException

addContext

public void addContext(org.mortbay.jetty.servlet.Context 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 - This global filter will be applied to all available web contexts.

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.mortbay.jetty.servlet.Context 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.mortbay.jetty.servlet.Context 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.mortbay.jetty.webapp.WebAppContext getWebAppContext()

getWebAppsPath

public String getWebAppsPath(String appName)
                      throws FileNotFoundException

Throws:: FileNotFoundException

getWebAppsPath
```
protected String getWebAppsPath(String webapps,
                    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
```
@Deprecated
public int getPort()
```
Deprecated.

Get the port that the server is on

Returns:
the port

getConnectorAddress
```
public InetSocketAddress getConnectorAddress(int index)
```
Get the address that corresponds to a particular connector.

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

setThreads
```
public void setThreads(int min,
              int max)
```
Set the min, max number of worker threads (simultaneous connections).

initSpnego

private void initSpnego(org.apache.hadoop.conf.Configuration conf,
              String hostName,
              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

loadListeners
```
private void loadListeners()
```

openListeners
```
void openListeners()
             throws Exception
```
Open the main listener for the server

Throws:

Exception

stop

public void stop()
          throws Exception

stop the server

Throws:: Exception

addMultiException

private org.mortbay.util.MultiException addMultiException(org.mortbay.util.MultiException exception,
                                                Exception e)

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

Class HttpServer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

FILTER_INITIALIZERS_PROPERTY

HTTP_MAX_THREADS

CONF_CONTEXT_ATTRIBUTE

ADMINS_ACL

BIND_ADDRESS

SPNEGO_FILTER

NO_CACHE_FILTER

APP_DIR

adminsAcl

webServer

appDir

logDir

listeners

webAppContext

findPort

defaultContexts

filterNames

STATE_DESCRIPTION_ALIVE

STATE_DESCRIPTION_NOT_LIVE

Constructor Detail

HttpServer

HttpServer

HttpServer

HttpServer

HttpServer

HttpServer

HttpServer

HttpServer

Method Detail

initializeWebServer

addUnmanagedListener

addManagedListener

createWebAppContext

addNoCacheFilter

createBaseListener

createDefaultChannelConnector

getFilterInitializers

addDefaultApps

setContextAttributes

addDefaultServlets

addContext

addContext

setAttribute

addJerseyResourcePackage

addServlet

addInternalServlet

addInternalServlet

addFilter

addGlobalFilter

defineFilter

addFilterPathMapping

getAttribute

getWebAppContext

getWebAppsPath

getWebAppsPath

getPort

getConnectorAddress

setThreads

initSpnego

start

loadListeners

openListeners

stop

addMultiException

join

isAlive

toString

isInstrumentationAccessAllowed

hasAdministratorAccess

userHasAdministratorAccess