org.apache.hive.http

Class HttpServer

java.lang.Object

org.apache.hive.http.HttpServer

public class HttpServer
extends Object

A simple embedded Jetty server to serve as HS2/HMS web UI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpServer.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMINS_ACL
static String	CONF_CONTEXT_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
void	addServlet(String name, String pathSpec, Class<? extends javax.servlet.http.HttpServlet> clazz) Add a servlet in the server.
int	getPort()
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	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

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

Method Detail

start

public void start()
           throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Throws:

Exception

getPort

public int getPort()

isInstrumentationAccessAllowed

@InterfaceAudience.LimitedPrivate(value="hive")
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 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 described above.

Throws:

IOException

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