com.github.restdriver.clientdriver

Class ClientDriver

java.lang.Object

com.github.restdriver.clientdriver.ClientDriver

Direct Known Subclasses:

SecureClientDriver

public class ClientDriver
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientDriverJettyHandler	handler
protected org.eclipse.jetty.server.Server	jettyServer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientDriver() Convenience constructor for extending classes.
	ClientDriver(ClientDriverJettyHandler handler) Constructor.
	ClientDriver(ClientDriverJettyHandler handler, int port) Constructor.

Method Summary

Modifier and Type	Method and Description
ClientDriverExpectation	addExpectation(ClientDriverRequest request, ClientDriverResponse response) Add in an expected ClientDriverRequest/ClientDriverResponse pair.
protected org.eclipse.jetty.server.Server	createAndStartJetty(int port)
protected org.eclipse.jetty.server.ServerConnector	createConnector(org.eclipse.jetty.server.Server jetty, int port)
String	getBaseUrl() Get the base URL which the ClientDriver is running on.
int	getPort()
protected org.eclipse.jetty.util.ssl.SslContextFactory	getSslContextFactory()
void	noFailFastOnUnexpectedRequest() Make the mock not fail fast on an unexpected request.
protected void	replaceConnector(org.eclipse.jetty.server.ServerConnector newConnector, org.eclipse.jetty.server.Server jetty)
void	reset() Resets the expectations and requests in the handler.
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.
void	verify(ClientDriverRequest clientDriverRequest, int times)

Methods inherited from class java.lang.Object

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

Field Detail

jettyServer

protected org.eclipse.jetty.server.Server jettyServer

handler

protected ClientDriverJettyHandler handler

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.

ClientDriver

protected ClientDriver()

Convenience constructor for extending classes. This allows overwriting and customization of the setup procedure.

Method Detail

createAndStartJetty

protected org.eclipse.jetty.server.Server createAndStartJetty(int port)

getSslContextFactory

protected org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory()

createConnector

protected org.eclipse.jetty.server.ServerConnector createConnector(org.eclipse.jetty.server.Server jetty,
                                                                   int port)

replaceConnector

protected void replaceConnector(org.eclipse.jetty.server.ServerConnector newConnector,
                                org.eclipse.jetty.server.Server jetty)

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:xxxx".

There is no trailing slash on this

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!

noFailFastOnUnexpectedRequest

public void noFailFastOnUnexpectedRequest()

Make the mock not fail fast on an unexpected request.

reset

public void reset()

Resets the expectations and requests in the handler.

shutdownQuietly

public void shutdownQuietly()

Shutdown the server without verifying expectations.

shutdown

public void shutdown()

Shutdown the server and calls verify().

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.

verify

public void verify(ClientDriverRequest clientDriverRequest,
                   int times)