com.github.restdriver.clientdriver

Class ClientDriver

java.lang.Object

com.github.restdriver.clientdriver.ClientDriver

public final class ClientDriver
extends Object

The main class which acts as a facade for the Client Driver.

Constructor Summary

Constructors

Constructor and Description
ClientDriver(ClientDriverJettyHandler handler) Constructor.
ClientDriver(ClientDriverJettyHandler handler, int port) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ClientDriverExpectation	addExpectation(ClientDriverRequest request, ClientDriverResponse response) Add in an expected ClientDriverRequest/ClientDriverResponse pair.
String	getBaseUrl() Get the base URL which the ClientDriver is running on.
static int	getFreePort() Gets a free port on localhost for binding to.
int	getPort()
void	reset()
void	shutdown() Shutdown the server and calls verify().
void	shutdownQuietly() Shutdown the server without verifying expectations.
void	verify() Verifies that all expectations have been met and nothing unexpected has been requested.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientDriver

public ClientDriver(ClientDriverJettyHandler handler)

Constructor. This will find a free port, bind to it and start the server up before it returns.

Parameters:

handler - The ClientDriverJettyHandler to use.

ClientDriver

public ClientDriver(ClientDriverJettyHandler handler,
            int port)

Constructor. This will bind to the given port and start the server up before it returns.

Parameters:

handler - The ClientDriverJettyHandler to use.

port - The port to listen on. Expect startup errors if this port is not free.

Method Detail

getPort

public int getPort()

getBaseUrl

public String getBaseUrl()

Get the base URL which the ClientDriver is running on.

Returns:

The base URL, which will be like "http://localhost:xxxxx".
There is no trailing slash on this

getFreePort

public static int getFreePort()

Gets a free port on localhost for binding to.

Returns:

The port number.

See Also:

"http://chaoticjava.com/posts/retrieving-a-free-port-for-socket-binding/"

verify

public void verify()

Verifies that all expectations have been met and nothing unexpected has been requested. If the verification fails, a ClientDriverFailedExpectationException is thrown with plenty of detail, and your test will fail!

shutdownQuietly

public void shutdownQuietly()

Shutdown the server without verifying expectations.

shutdown

public void shutdown()

Shutdown the server and calls verify().

reset

public void reset()

addExpectation

public ClientDriverExpectation addExpectation(ClientDriverRequest request,
                                     ClientDriverResponse response)

Add in an expected ClientDriverRequest/ClientDriverResponse pair.

Parameters:

request - The expected request

response - The response to serve to that request

Returns:

The newly added expectation.