org.apache.hadoop.hbase.http

类 HttpServer

java.lang.Object

org.apache.hadoop.hbase.http.HttpServer

所有已实现的接口:

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>)

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HttpServer.Builder Class to construct instances of HTTP server with specific options.
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.

字段概要

字段

限定符和类型	字段和说明
static String	ADMINS_ACL
static String	APP_DIR
protected String	appDir
protected boolean	authenticationEnabled
static String	BIND_ADDRESS
static String	CONF_CONTEXT_ATTRIBUTE
protected Map<org.eclipse.jetty.servlet.ServletContextHandler,Boolean>	defaultContexts
protected List<String>	filterNames
protected boolean	findPort
static String	HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_KEY
static boolean	HTTP_PRIVILEGED_CONF_DEFAULT
static String	HTTP_PRIVILEGED_CONF_KEY
static String	HTTP_SPNEGO_AUTHENTICATION_ADMIN_GROUPS_KEY
static String	HTTP_SPNEGO_AUTHENTICATION_ADMIN_USERS_KEY
static String	HTTP_SPNEGO_AUTHENTICATION_KEYTAB_KEY
static String	HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_KEY
static String	HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_KEY
static boolean	HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_DEFAULT
static String	HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_KEY
static String	HTTP_UI_AUTHENTICATION
protected String	logDir
static String	NO_CACHE_FILTER
static String	SPNEGO_FILTER
static String	SPNEGO_PROXYUSER_FILTER
protected org.eclipse.jetty.webapp.WebAppContext	webAppContext
protected org.eclipse.jetty.server.Server	webServer

构造器概要

构造器

构造器和说明
HttpServer(String name, String bindAddress, int port, boolean findPort) 已过时。
HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf) 已过时。
HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.authorize.AccessControlList adminsAcl) 已过时。
HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.authorize.AccessControlList adminsAcl, String[] pathSpecs) 已过时。
HttpServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration conf, String[] pathSpecs) 已过时。

方法概要

限定符和类型	方法和说明
protected void	addDefaultApps(org.eclipse.jetty.server.handler.ContextHandlerCollection parent, String appDir, org.apache.hadoop.conf.Configuration conf) Add default apps.
protected void	addDefaultServlets(org.eclipse.jetty.server.handler.ContextHandlerCollection contexts, org.apache.hadoop.conf.Configuration conf) 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.webapp.WebAppContext 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	addJerseyResourcePackage(String packageName, String pathSpec) Add a Jersey resource package.
void	addPrivilegedServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz) Adds a servlet in the server that only administrators can access.
void	addUnprivilegedServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz) Adds a servlet in the server that any user can access.
static void	defineFilter(org.eclipse.jetty.servlet.ServletContextHandler handler, 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.
int	getPort() 已过时。
List<org.eclipse.jetty.server.ServerConnector>	getServerConnectors()
org.eclipse.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(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.authorize.AccessControlList acl, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
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?
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(org.apache.hadoop.security.authorize.AccessControlList acl, String remoteUser)
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.

从类继承的方法 java.lang.Object

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

字段详细资料

HTTP_UI_AUTHENTICATION

public static final String HTTP_UI_AUTHENTICATION

另请参阅:

常量字段值

HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_KEY

public static final String HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_KEY

另请参阅:

常量字段值

HTTP_SPNEGO_AUTHENTICATION_KEYTAB_KEY

public static final String HTTP_SPNEGO_AUTHENTICATION_KEYTAB_KEY

另请参阅:

常量字段值

HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_KEY

public static final String HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_KEY

另请参阅:

常量字段值

HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_KEY

public static final String HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_KEY

另请参阅:

常量字段值

HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_DEFAULT

public static final boolean HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_DEFAULT

另请参阅:

常量字段值

HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_KEY

public static final String HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_KEY

另请参阅:

常量字段值

HTTP_SPNEGO_AUTHENTICATION_ADMIN_USERS_KEY

public static final String HTTP_SPNEGO_AUTHENTICATION_ADMIN_USERS_KEY

另请参阅:

常量字段值

HTTP_SPNEGO_AUTHENTICATION_ADMIN_GROUPS_KEY

public static final String HTTP_SPNEGO_AUTHENTICATION_ADMIN_GROUPS_KEY

另请参阅:

常量字段值

HTTP_PRIVILEGED_CONF_KEY

public static final String HTTP_PRIVILEGED_CONF_KEY

另请参阅:

常量字段值

HTTP_PRIVILEGED_CONF_DEFAULT

public static final boolean HTTP_PRIVILEGED_CONF_DEFAULT

另请参阅:

常量字段值

CONF_CONTEXT_ATTRIBUTE

public static final String CONF_CONTEXT_ATTRIBUTE

另请参阅:

常量字段值

ADMINS_ACL

public static final String ADMINS_ACL

另请参阅:

常量字段值

BIND_ADDRESS

public static final String BIND_ADDRESS

另请参阅:

常量字段值

SPNEGO_FILTER

public static final String SPNEGO_FILTER

另请参阅:

常量字段值

SPNEGO_PROXYUSER_FILTER

public static final String SPNEGO_PROXYUSER_FILTER

另请参阅:

常量字段值

NO_CACHE_FILTER

public static final String NO_CACHE_FILTER

另请参阅:

常量字段值

APP_DIR

public static final String APP_DIR

另请参阅:

常量字段值

webServer

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

appDir

protected String appDir

logDir

protected String logDir

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

authenticationEnabled

protected final boolean authenticationEnabled

构造器详细资料

HttpServer

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

已过时。

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

抛出:

IOException

HttpServer

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

参数:

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.

抛出:

IOException

HttpServer

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

已过时。

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

参数:

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

抛出:

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

已过时。

抛出:

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,
                              String[] pathSpecs)
                       throws IOException

已过时。

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

参数:

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

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

抛出:

IOException

方法详细资料

getServerConnectors

public List<org.eclipse.jetty.server.ServerConnector> getServerConnectors()

addDefaultApps

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

Add default apps.

参数:

appDir - The application directory

抛出:

IOException

addDefaultServlets

protected void addDefaultServlets(org.eclipse.jetty.server.handler.ContextHandlerCollection contexts,
                                  org.apache.hadoop.conf.Configuration conf)
                           throws IOException

Add default servlets.

抛出:

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)".

参数:

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.

参数:

packageName - The Java package name containing the Jersey resource.

pathSpec - The path spec for the servlet

addUnprivilegedServlet

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

Adds a servlet in the server that any user can access. This method differs from addPrivilegedServlet(String, String, Class) in that any authenticated user can interact with the servlet added by this method.

参数:

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

pathSpec - The path spec for the servlet

clazz - The servlet class

addPrivilegedServlet

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

Adds a servlet in the server that only administrators can access. This method differs from addUnprivilegedServlet(String, String, Class) in that only those authenticated user who are identified as administrators can interact with the servlet added by this method.

addFilter

public void addFilter(String name,
                      String classname,
                      Map<String,String> parameters)

从接口复制的说明: FilterContainer

Add a filter to the container.

指定者:

addFilter 在接口中 FilterContainer

参数:

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)

从接口复制的说明: FilterContainer

Add a global filter to the container - This global filter will be applied to all available web contexts.

指定者:

addGlobalFilter 在接口中 FilterContainer

参数:

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 handler,
                                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.webapp.WebAppContext webAppCtx)

Add the path spec to the filter path mapping.

参数:

pathSpec - The path spec

webAppCtx - The WebApplicationContext to add to

getAttribute

public Object getAttribute(String name)

Get the value in the webapp context.

参数:

name - The name of the attribute

返回:

The value of the attribute

getWebAppContext

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

getWebAppsPath

public String getWebAppsPath(String appName)
                      throws FileNotFoundException

抛出:

FileNotFoundException

getWebAppsPath

protected String getWebAppsPath(String webapps,
                                String appName)
                         throws FileNotFoundException

Get the pathname to the webapps files.

参数:

appName - eg "secondary" or "datanode"

返回:

the pathname as a URL

抛出:

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

getPort

@Deprecated
public int getPort()

已过时。

Get the port that the server is on

返回:

the port

getConnectorAddress

public InetSocketAddress getConnectorAddress(int index)

Get the address that corresponds to a particular connector.

返回:

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).

start

public void start()
           throws IOException

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

抛出:

IOException

stop

public void stop()
          throws Exception

stop the server

抛出:

Exception

join

public void join()
          throws InterruptedException

抛出:

InterruptedException

isAlive

public boolean isAlive()

Test for the availability of the web server

返回:

true if the web server is started, false otherwise

toString

public String toString()

Return the host and port of the HttpServer, if live

覆盖:

toString 在类中 Object

返回:

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.

参数:

servletContext - the servlet context.

request - the servlet request.

response - the servlet response.

返回:

TRUE/FALSE based on the logic decribed above.

抛出:

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.

参数:

servletContext -

request -

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

返回:

true if admin-authorized, false otherwise

抛出:

IOException

hasAdministratorAccess

public static boolean hasAdministratorAccess(org.apache.hadoop.conf.Configuration conf,
                                             org.apache.hadoop.security.authorize.AccessControlList acl,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws IOException

抛出:

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.

参数:

servletContext - the context containing the admin ACL.

remoteUser - the remote user to check for.

返回:

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

userHasAdministratorAccess

public static boolean userHasAdministratorAccess(org.apache.hadoop.security.authorize.AccessControlList acl,
                                                 String remoteUser)