Package org.apache.hadoop.hbase.http

Class InfoServer

java.lang.Object

org.apache.hadoop.hbase.http.InfoServer

@Private
public class InfoServer
extends Object

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: "/stacks/" -> points to stack trace "/static/" -> points to common static files (src/hbase-webapps/static) "/" -> the jsp server code from (src/hbase-webapps/<name>)

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	HADOOP_WEB_TLS_CONFIG_PREFIX
private static final String	HBASE_APP_DIR
(package private) static final String	HBASE_UI_SSL_CLIENT_AUTH_MODE	Config key controlling whether the UI's TLS connector requests or requires a client certificate.
private static final String	HBASE_WEB_TLS_CONFIG_PREFIX
private static final String	HBASE_WEB_TLS_SERVER_CONFIG_PREFIX
private final HttpServer	httpServer
private static final String	TRUSTSTORE_LOCATION

Constructor Summary

Constructors

Constructor	Description
InfoServer(String name, String bindAddress, int port, boolean findPort, org.apache.hadoop.conf.Configuration c)	Create a status server on the given port.

Method Summary

Modifier and Type	Method	Description
void	addPrivilegedServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz)	Adds a servlet in the server that any user can access.
void	addServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz)	Deprecated. Use addUnprivilegedServlet(String, String, Class) or addPrivilegedServlet(String, String, Class) instead of this method which does not state outwardly what kind of authz rules will be applied to this servlet.
void	addUnprivilegedServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz)	Adds a servlet in the server that any user can access.
void	addUnprivilegedServlet(String name, String pathSpec, org.apache.hbase.thirdparty.org.eclipse.jetty.ee8.servlet.ServletHolder holder)	Adds a servlet in the server that any user can access.
(package private) static org.apache.hadoop.security.authorize.AccessControlList	buildAdminAcl(org.apache.hadoop.conf.Configuration conf)	Builds an ACL that will restrict the users who can issue commands to endpoints on the UI which are meant only for administrators.
static boolean	canUserModifyUI(javax.servlet.http.HttpServletRequest req, javax.servlet.ServletContext ctx, org.apache.hadoop.conf.Configuration conf)	Returns true if and only if UI authentication (spnego) is enabled, UI authorization is enabled, and the requesting user is defined as an administrator.
private static String	getAdminUsers(org.apache.hadoop.conf.Configuration conf, String httpAuthType)
int	getPort()	Deprecated. Since 0.99.0
(package private) static String	getTLSPassword(org.apache.hadoop.conf.Configuration c, String postfix)	Resolves a TLS-related password with a 3-tier fallback: the role-scoped hbase.ui.ssl.server.<postfix> key is checked first, then the unscoped hbase.ui.ssl.<postfix> key, and finally Hadoop's ssl.server.<postfix>.
(package private) static String	getTLSProperty(org.apache.hadoop.conf.Configuration c, String postfix)
(package private) static String	getTLSProperty(org.apache.hadoop.conf.Configuration c, String postfix, String defaultValue)	Resolves a TLS-related property with a 3-tier fallback: role-scoped hbase.ui.ssl.server.<postfix> → hbase.ui.ssl.<postfix> → ssl.server.<postfix> → defaultValue.
void	setAttribute(String name, Object value)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Details

HBASE_APP_DIR

private static final String HBASE_APP_DIR

See Also:

• Constant Field Values

httpServer

private final HttpServer httpServer

HADOOP_WEB_TLS_CONFIG_PREFIX

private static final String HADOOP_WEB_TLS_CONFIG_PREFIX

See Also:

• Constant Field Values

HBASE_WEB_TLS_CONFIG_PREFIX

private static final String HBASE_WEB_TLS_CONFIG_PREFIX

See Also:

• Constant Field Values

HBASE_WEB_TLS_SERVER_CONFIG_PREFIX

private static final String HBASE_WEB_TLS_SERVER_CONFIG_PREFIX

See Also:

• Constant Field Values

TRUSTSTORE_LOCATION

private static final String TRUSTSTORE_LOCATION

See Also:

• Constant Field Values

HBASE_UI_SSL_CLIENT_AUTH_MODE

static final String HBASE_UI_SSL_CLIENT_AUTH_MODE

Config key controlling whether the UI's TLS connector requests or requires a client certificate. Valid values: NONE (default), WANT, NEED.

See Also:

• Constant Field Values

Constructor Details

InfoServer

public InfoServer(String name,
 String bindAddress,
 int port,
 boolean findPort,
 org.apache.hadoop.conf.Configuration c)
           throws IOException

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

Parameters:

name - The name of the server

bindAddress - address to bind to

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.

c - the Configuration to build the server

Throws:

IOException - if getting one of the password fails or the server cannot be created

Method Details

getTLSPassword

static String getTLSPassword(org.apache.hadoop.conf.Configuration c,
 String postfix)
                      throws IOException

Resolves a TLS-related password with a 3-tier fallback: the role-scoped hbase.ui.ssl.server.<postfix> key is checked first, then the unscoped hbase.ui.ssl.<postfix> key, and finally Hadoop's ssl.server.<postfix>. Package-private for direct testing.

Throws:

IOException

getTLSProperty

static String getTLSProperty(org.apache.hadoop.conf.Configuration c,
 String postfix)

getTLSProperty

static String getTLSProperty(org.apache.hadoop.conf.Configuration c,
 String postfix,
 String defaultValue)

Resolves a TLS-related property with a 3-tier fallback: role-scoped hbase.ui.ssl.server.<postfix> → hbase.ui.ssl.<postfix> → ssl.server.<postfix> → defaultValue. Package-private for direct testing.

buildAdminAcl

static org.apache.hadoop.security.authorize.AccessControlList buildAdminAcl(org.apache.hadoop.conf.Configuration conf)

Builds an ACL that will restrict the users who can issue commands to endpoints on the UI which are meant only for administrators.

getAdminUsers

private static String getAdminUsers(org.apache.hadoop.conf.Configuration conf,
 String httpAuthType)

addServlet

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

Deprecated.

Use addUnprivilegedServlet(String, String, Class) or addPrivilegedServlet(String, String, Class) instead of this method which does not state outwardly what kind of authz rules will be applied to this servlet.

Explicitly invoke addPrivilegedServlet(String, String, Class) or addUnprivilegedServlet(String, String, Class) instead of this method. This method will add a servlet which any authenticated user can access.

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.

See Also:

• HttpServer.addUnprivilegedServlet(String, String, Class)

addUnprivilegedServlet

public void addUnprivilegedServlet(String name,
 String pathSpec,
 org.apache.hbase.thirdparty.org.eclipse.jetty.ee8.servlet.ServletHolder holder)

Adds a servlet in the server that any user can access.

See Also:

• HttpServer.addUnprivilegedServlet(String, ServletHolder)

addPrivilegedServlet

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

Adds a servlet in the server that any user can access.

See Also:

• HttpServer.addPrivilegedServlet(String, String, Class)

setAttribute

public void setAttribute(String name,
 Object value)

start

public void start()
           throws IOException

Throws:

IOException

getPort

@Deprecated
public int getPort()

Deprecated.

Since 0.99.0

Returns:

the port of the info server

stop

public void stop()
          throws Exception

Throws:

Exception

canUserModifyUI

public static boolean canUserModifyUI(javax.servlet.http.HttpServletRequest req,
 javax.servlet.ServletContext ctx,
 org.apache.hadoop.conf.Configuration conf)

Returns true if and only if UI authentication (spnego) is enabled, UI authorization is enabled, and the requesting user is defined as an administrator. If the UI is set to readonly, this method always returns false.