org.apache.hadoop.hbase.http

Class HttpServerFunctionalTest

java.lang.Object

Assert

org.apache.hadoop.hbase.http.HttpServerFunctionalTest

Direct Known Subclasses:

TestGlobalFilter, TestHttpServer, TestHttpServerLifecycle, TestHttpServerWebapps, TestJMXJsonServlet, TestPathFilter, TestServletFilter, TestSpnegoHttpServer, TestSSLHttpServer

public class HttpServerFunctionalTest
extends Assert

This is a base class for functional tests of the HttpServer. The methods are static for other classes to import statically.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TEST_BUILD_WEBAPPS JVM property for the webapp test dir : "test.build.webapps"

Constructor Summary

Constructors

Constructor and Description
HttpServerFunctionalTest()

Method Summary

Modifier and Type	Method and Description
static HttpServer	createAndStartTestServer() Create and start a server with the test webapp
static HttpServer	createServer(java.lang.String webapp) Create an HttpServer instance for the given webapp
static HttpServer	createServer(java.lang.String webapp, Configuration conf) Create an HttpServer instance for the given webapp
static HttpServer	createServer(java.lang.String webapp, Configuration conf, AccessControlList adminsAcl)
static HttpServer	createServer(java.lang.String webapp, Configuration conf, java.lang.String[] pathSpecs) Create an HttpServer instance for the given webapp
static HttpServer	createServer(java.lang.String host, int port) Create an HttpServer instance on the given address for the given webapp
static HttpServer	createTestServer() Create but do not start the test webapp server.
static HttpServer	createTestServer(Configuration conf) Create but do not start the test webapp server.
static HttpServer	createTestServer(Configuration conf, AccessControlList adminsAcl)
static HttpServer	createTestServer(Configuration conf, java.lang.String[] pathSpecs) Create but do not start the test webapp server.
static HttpServer	createTestServerWithSecurity(Configuration conf)
protected static void	deleteRecursively(java.io.File d) Recursively deletes a File.
protected static int	getFreePort() Picks a free port on the host by binding a Socket to '0'.
static java.net.URL	getServerURL(HttpServer server) Pass in a server, return a URL bound to localhost and its port
protected static void	prepareTestWebapp() Prepare the test webapp by creating the directory from the test properties fail if the directory cannot be created.
protected static java.lang.String	readOutput(java.net.URL url) Read in the content from a URL
static void	stop(HttpServer server) If the server is non null, stop it

Methods inherited from class java.lang.Object

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

Field Detail

TEST_BUILD_WEBAPPS

public static final java.lang.String TEST_BUILD_WEBAPPS

JVM property for the webapp test dir : "test.build.webapps"

See Also:

Constant Field Values

Constructor Detail

HttpServerFunctionalTest

public HttpServerFunctionalTest()

Method Detail

createTestServer

public static HttpServer createTestServer()
                                   throws java.io.IOException

Create but do not start the test webapp server. The test webapp dir is prepared/checked in advance.

Returns:

the server instance

Throws:

java.io.IOException - if a problem occurs

java.lang.AssertionError - if a condition was not met

createTestServer

public static HttpServer createTestServer(Configuration conf)
                                   throws java.io.IOException

Create but do not start the test webapp server. The test webapp dir is prepared/checked in advance.

Parameters:

conf - the server configuration to use

Returns:

the server instance

Throws:

java.io.IOException - if a problem occurs

java.lang.AssertionError - if a condition was not met

createTestServer

public static HttpServer createTestServer(Configuration conf,
                                          AccessControlList adminsAcl)
                                   throws java.io.IOException

Throws:

java.io.IOException

createTestServer

public static HttpServer createTestServer(Configuration conf,
                                          java.lang.String[] pathSpecs)
                                   throws java.io.IOException

Create but do not start the test webapp server. The test webapp dir is prepared/checked in advance.

Parameters:

conf - the server configuration to use

Returns:

the server instance

Throws:

java.io.IOException - if a problem occurs

java.lang.AssertionError - if a condition was not met

createTestServerWithSecurity

public static HttpServer createTestServerWithSecurity(Configuration conf)
                                               throws java.io.IOException

Throws:

java.io.IOException

prepareTestWebapp

protected static void prepareTestWebapp()

Prepare the test webapp by creating the directory from the test properties fail if the directory cannot be created.

Throws:

java.lang.AssertionError - if a condition was not met

createServer

public static HttpServer createServer(java.lang.String host,
                                      int port)
                               throws java.io.IOException

Create an HttpServer instance on the given address for the given webapp

Parameters:

host - to bind

port - to bind

Returns:

the server

Throws:

java.io.IOException - if it could not be created

createServer

public static HttpServer createServer(java.lang.String webapp)
                               throws java.io.IOException

Create an HttpServer instance for the given webapp

Parameters:

webapp - the webapp to work with

Returns:

the server

Throws:

java.io.IOException - if it could not be created

createServer

public static HttpServer createServer(java.lang.String webapp,
                                      Configuration conf)
                               throws java.io.IOException

Create an HttpServer instance for the given webapp

Parameters:

webapp - the webapp to work with

conf - the configuration to use for the server

Returns:

the server

Throws:

java.io.IOException - if it could not be created

createServer

public static HttpServer createServer(java.lang.String webapp,
                                      Configuration conf,
                                      AccessControlList adminsAcl)
                               throws java.io.IOException

Throws:

java.io.IOException

createServer

public static HttpServer createServer(java.lang.String webapp,
                                      Configuration conf,
                                      java.lang.String[] pathSpecs)
                               throws java.io.IOException

Create an HttpServer instance for the given webapp

Parameters:

webapp - the webapp to work with

conf - the configuration to use for the server

pathSpecs - the paths specifications the server will service

Returns:

the server

Throws:

java.io.IOException - if it could not be created

createAndStartTestServer

public static HttpServer createAndStartTestServer()
                                           throws java.io.IOException

Create and start a server with the test webapp

Returns:

the newly started server

Throws:

java.io.IOException - on any failure

java.lang.AssertionError - if a condition was not met

stop

public static void stop(HttpServer server)
                 throws java.lang.Exception

If the server is non null, stop it

Parameters:

server - to stop

Throws:

java.lang.Exception - on any failure

getServerURL

public static java.net.URL getServerURL(HttpServer server)
                                 throws java.net.MalformedURLException

Pass in a server, return a URL bound to localhost and its port

Parameters:

server - server

Returns:

a URL bonded to the base of the server

Throws:

java.net.MalformedURLException - if the URL cannot be created.

readOutput

protected static java.lang.String readOutput(java.net.URL url)
                                      throws java.io.IOException

Read in the content from a URL

Parameters:

url - URL To read

Returns:

the text from the output

Throws:

java.io.IOException - if something went wrong

deleteRecursively

protected static void deleteRecursively(java.io.File d)

Recursively deletes a File.

getFreePort

protected static int getFreePort()
                          throws java.io.IOException

Picks a free port on the host by binding a Socket to '0'.

Throws:

java.io.IOException