org.apache.http.localserver

Class LocalTestServer

java.lang.Object

org.apache.http.localserver.LocalTestServer

public class LocalTestServer
extends Object

Local HTTP server for tests that require one. Based on the ElementalHttpServer example in HttpCore.

Field Summary

Fields

Modifier and Type	Field and Description
static InetSocketAddress	TEST_SERVER_ADDR The local address to bind to.

Constructor Summary

Constructors

Constructor and Description
LocalTestServer(org.apache.http.protocol.BasicHttpProcessor proc, org.apache.http.ConnectionReuseStrategy reuseStrat, org.apache.http.HttpResponseFactory responseFactory, org.apache.http.protocol.HttpExpectationVerifier expectationVerifier, org.apache.http.params.HttpParams params, SSLContext sslcontext) Creates a new test server.
LocalTestServer(org.apache.http.protocol.BasicHttpProcessor proc, org.apache.http.params.HttpParams params) Creates a new test server.
LocalTestServer(SSLContext sslcontext) Creates a new test server with SSL/TLS encryption.

Method Summary

Modifier and Type	Method and Description
void	awaitTermination(long timeMs)
int	getAcceptedConnectionCount() Returns the number of connections this test server has accepted.
InetSocketAddress	getServiceAddress() Obtains the local address the server is listening on
protected org.apache.http.ConnectionReuseStrategy	newConnectionReuseStrategy()
protected org.apache.http.params.HttpParams	newDefaultParams() Obtains a set of reasonable default parameters for a server.
protected org.apache.http.HttpResponseFactory	newHttpResponseFactory()
protected org.apache.http.protocol.HttpProcessor	newProcessor() Obtains an HTTP protocol processor with default interceptors.
void	register(String pattern, org.apache.http.protocol.HttpRequestHandler handler) Registers a handler with the local registry.
void	registerDefaultHandlers() Registers a set of default request handlers.
void	start() Starts this test server.
void	stop() Stops this test server.
String	toString()
void	unregister(String pattern) Unregisters a handler from the local registry.

Methods inherited from class java.lang.Object

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

Field Detail

TEST_SERVER_ADDR

public static final InetSocketAddress TEST_SERVER_ADDR

The local address to bind to. The host is an IP number rather than "localhost" to avoid surprises on hosts that map "localhost" to an IPv6 address or something else. The port is 0 to let the system pick one.

Constructor Detail

LocalTestServer

public LocalTestServer(org.apache.http.protocol.BasicHttpProcessor proc,
                       org.apache.http.ConnectionReuseStrategy reuseStrat,
                       org.apache.http.HttpResponseFactory responseFactory,
                       org.apache.http.protocol.HttpExpectationVerifier expectationVerifier,
                       org.apache.http.params.HttpParams params,
                       SSLContext sslcontext)

Creates a new test server.

Parameters:

proc - the HTTP processors to be used by the server, or null to use a default processor

reuseStrat - the connection reuse strategy to be used by the server, or null to use default strategy.

params - the parameters to be used by the server, or null to use default parameters

sslcontext - optional SSL context if the server is to leverage SSL/TLS transport security

LocalTestServer

public LocalTestServer(SSLContext sslcontext)

Creates a new test server with SSL/TLS encryption.

Parameters:

sslcontext - SSL context

LocalTestServer

public LocalTestServer(org.apache.http.protocol.BasicHttpProcessor proc,
                       org.apache.http.params.HttpParams params)

Creates a new test server.

Parameters:

proc - the HTTP processors to be used by the server, or null to use a default processor

params - the parameters to be used by the server, or null to use default parameters

Method Detail

newProcessor

protected org.apache.http.protocol.HttpProcessor newProcessor()

Obtains an HTTP protocol processor with default interceptors.

Returns:

a protocol processor for server-side use

newDefaultParams

protected org.apache.http.params.HttpParams newDefaultParams()

Obtains a set of reasonable default parameters for a server.

Returns:

default parameters

newConnectionReuseStrategy

protected org.apache.http.ConnectionReuseStrategy newConnectionReuseStrategy()

newHttpResponseFactory

protected org.apache.http.HttpResponseFactory newHttpResponseFactory()

getAcceptedConnectionCount

public int getAcceptedConnectionCount()

Returns the number of connections this test server has accepted.

registerDefaultHandlers

public void registerDefaultHandlers()

Registers a set of default request handlers.

 URI pattern      Handler
 -----------      -------
 /echo/*          EchoHandler
 /random/*        RandomHandler
 

register

public void register(String pattern,
                     org.apache.http.protocol.HttpRequestHandler handler)

Registers a handler with the local registry.

Parameters:

pattern - the URL pattern to match

handler - the handler to apply

unregister

public void unregister(String pattern)

Unregisters a handler from the local registry.

Parameters:

pattern - the URL pattern

start

public void start()
           throws Exception

Starts this test server.

Throws:

Exception

stop

public void stop()
          throws Exception

Stops this test server.

Throws:

Exception

awaitTermination

public void awaitTermination(long timeMs)
                      throws InterruptedException

Throws:

InterruptedException

toString

public String toString()

Overrides:

toString in class Object

getServiceAddress

public InetSocketAddress getServiceAddress()

Obtains the local address the server is listening on

Returns:

the service address