com.github.tashoyan.httpspy

Interface HttpSpy

All Known Implementing Classes:

CamelJettyHttpSpy

@NotThreadSafe
public interface HttpSpy

HTTP Spy - a spy for an HTTP server.

This is an interface that defines behavior for implementations.

Concurrency notes. All HTTP Spy methods are expected to be called in the only thread - typically main thread that executes a test. However, an implementation has to provide concurrent access to some data inside, for example the test plan: testPlan(com.github.tashoyan.httpspy.TestPlanBuilder).

Method Summary

Modifier and Type	Method and Description
String	getHostname() Gets host name.
String	getPath() Gets HTTP path.
int	getPort() Gets network port.
int	getServiceThreadsNumber() Gets number of threads that concurrently service incoming requests.
void	reset() Reset the spy server.
void	setServiceThreadsNumber(int serviceThreadsNumber) Sets threads number to concurrently service incoming requests.
void	start() Start the spy server.
void	stop() Stop the spy server.
HttpSpy	testPlan(TestPlanBuilder testPlanBuilder) Specify test plan.
void	verify() Verify that expectations are met.

Method Detail

getHostname

String getHostname()

Gets host name.

Returns:

Network host name where server runs.

getPort

int getPort()

Gets network port.

Returns:

Network port where server runs. Should be positive.

getPath

String getPath()

Gets HTTP path.

Returns:

HTTP path where server is available.

setServiceThreadsNumber

void setServiceThreadsNumber(int serviceThreadsNumber)

Sets threads number to concurrently service incoming requests.

This method guarantees that at least the specified number of threads will be available to service client requests. Depending on server implementation, the real number of servicing threads may be greater.

Parameters:

serviceThreadsNumber - Number of threads that service requests.

Throws:

IllegalArgumentException - serviceThreadsNumber is not positive.

IllegalArgumentException - serviceThreadsNumber is greater than one, but current test plan does not support multiple service threads.

IllegalStateException - The spy server has already started.

getServiceThreadsNumber

int getServiceThreadsNumber()

Gets number of threads that concurrently service incoming requests.

Returns:

Number of threads.

testPlan

HttpSpy testPlan(TestPlanBuilder testPlanBuilder)

Specify test plan.

Parameters:

testPlanBuilder - Builder that provides the test plan.

Returns:

This object

Throws:

NullPointerException - testPlanBuilder is null.

IllegalStateException - Test plan is already set.

IllegalArgumentException - New test plan does not support multiple service threads, but service threads number is already set greater than one.

start

void start()

Start the spy server.

After start the spy server services client requests.

Throws:

IllegalStateException - Already started.

verify

void verify()

Verify that expectations are met.

This method delegates verification to the test plan.

Throws:

IllegalStateException - Test plan is not set

See Also:

testPlan(com.github.tashoyan.httpspy.TestPlanBuilder)

reset

void reset()

Reset the spy server.

The spy server resets its current test plan.

See Also:

testPlan(com.github.tashoyan.httpspy.TestPlanBuilder)

stop

void stop()

Stop the spy server.

The spy server stops servicing client requests and frees network resources.