Package org.apache.hadoop.fs.http.server

Class HttpFSServerWebApp

java.lang.Object

org.apache.hadoop.lib.server.Server

org.apache.hadoop.lib.servlet.ServerWebApp

org.apache.hadoop.fs.http.server.HttpFSServerWebApp

All Implemented Interfaces:

java.util.EventListener, javax.servlet.ServletContextListener

@Private
public class HttpFSServerWebApp
extends ServerWebApp

Bootstrap class that manages the initialization and destruction of the HttpFSServer server, it is a javax.servlet.ServletContextListener implementation that is wired in HttpFSServer's WAR WEB-INF/web.xml.

It provides acces to the server context via the singleton get().

All the configuration is loaded from configuration properties prefixed with httpfs..

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.lib.server.Server

Server.Status

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONF_ADMIN_GROUP	Configuration property that defines HttpFSServer admin group.
static java.lang.String	NAME	Server name and prefix for all configuration properties.

Fields inherited from class org.apache.hadoop.lib.servlet.ServerWebApp

SSL_ENABLED

Fields inherited from class org.apache.hadoop.lib.server.Server

CONF_SERVICES, CONF_SERVICES_EXT, CONF_STARTUP_STATUS, DEFAULT_LOG4J_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
HttpFSServerWebApp()	Default constructor.
HttpFSServerWebApp(java.lang.String homeDir, java.lang.String configDir, java.lang.String logDir, java.lang.String tempDir, org.apache.hadoop.conf.Configuration config)	Constructor used for testing purposes.
HttpFSServerWebApp(java.lang.String homeDir, org.apache.hadoop.conf.Configuration config)	Constructor used for testing purposes.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Shutdowns all running services.
static HttpFSServerWebApp	get()	Returns HttpFSServer server singleton, configuration and services are accessible through it.
java.lang.String	getAdminGroup()	Returns HttpFSServer admin group.
static HttpFSServerMetrics	getMetrics()	gets the HttpFSServerMetrics instance.
void	init()	Initializes the HttpFSServer server, loads configuration and required services.

Methods inherited from class org.apache.hadoop.lib.servlet.ServerWebApp

contextDestroyed, contextInitialized, getAuthority, isSslEnabled, resolveAuthority, setAuthority, setHomeDirForCurrentThread

Methods inherited from class org.apache.hadoop.lib.server.Server

checkServiceDependencies, destroyServices, ensureOperational, get, getConfig, getConfigDir, getHomeDir, getLogDir, getName, getPrefix, getPrefixedName, getStatus, getTempDir, initConfig, initLog, initServices, loadServices, setService, setStatus

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

Server name and prefix for all configuration properties.

See Also:

Constant Field Values

CONF_ADMIN_GROUP

public static final java.lang.String CONF_ADMIN_GROUP

Configuration property that defines HttpFSServer admin group.

See Also:

Constant Field Values

Constructor Detail

HttpFSServerWebApp

public HttpFSServerWebApp()
                   throws java.io.IOException

Default constructor.

Throws:

java.io.IOException - thrown if the home/conf/log/temp directory paths could not be resolved.

HttpFSServerWebApp

public HttpFSServerWebApp(java.lang.String homeDir,
                          java.lang.String configDir,
                          java.lang.String logDir,
                          java.lang.String tempDir,
                          org.apache.hadoop.conf.Configuration config)

Constructor used for testing purposes.

HttpFSServerWebApp

public HttpFSServerWebApp(java.lang.String homeDir,
                          org.apache.hadoop.conf.Configuration config)

Constructor used for testing purposes.

Method Detail

init

public void init()
          throws ServerException

Initializes the HttpFSServer server, loads configuration and required services.

Overrides:

init in class Server

Throws:

ServerException - thrown if HttpFSServer server could not be initialized.

destroy

public void destroy()

Shutdowns all running services.

Overrides:

destroy in class Server

get

public static HttpFSServerWebApp get()

Returns HttpFSServer server singleton, configuration and services are accessible through it.

Returns:

the HttpFSServer server singleton.

getMetrics

public static HttpFSServerMetrics getMetrics()

gets the HttpFSServerMetrics instance.

Returns:

the HttpFSServerMetrics singleton.

getAdminGroup

public java.lang.String getAdminGroup()

Returns HttpFSServer admin group.

Returns:

httpfs admin group.