com.github.tashoyan.httpspy

Class CamelJettyHttpSpy

java.lang.Object

com.github.tashoyan.httpspy.CamelJettyHttpSpy

All Implemented Interfaces:

HttpSpy

@NotThreadSafe
public class CamelJettyHttpSpy
extends Object
implements HttpSpy

Implementation of HttpSpy based on camel-jetty component.

TODO Configurable chunked attribute for jetty endpoint (now hardcoded).

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_HOSTNAME Default host name for the spy server.
protected static int	DEFAULT_SERVICE_THREADS_NUMBER Default service threads number.

Constructor Summary

Constructors

Constructor and Description
CamelJettyHttpSpy(int port, String path) Creates new instance of spy server running on default host DEFAULT_HOSTNAME.
CamelJettyHttpSpy(String hostname, int port, String path) Creates new instance of spy server.

Method Summary

Modifier and Type	Method and Description
protected org.apache.camel.Processor	createSpyProcessor() Creates Camel Processor that will be used to record actual requests and send responses back.
String	getHostname() Gets host name.
String	getPath() Gets HTTP path.
int	getPort() Gets network port.
protected int	getRealJettyThreadsNumber() Gets real number of threads that is necessary to be configured for Jetty server.
int	getServiceThreadsNumber() Gets number of threads that concurrently service incoming requests.
void	reset() Reset the spy server.
protected void	sendResponseInExchange(HttpResponse response, org.apache.camel.Exchange exchange) Send the response in Camel exchange.
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.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOSTNAME

protected static final String DEFAULT_HOSTNAME

Default host name for the spy server.

See Also:

Constant Field Values

DEFAULT_SERVICE_THREADS_NUMBER

protected static final int DEFAULT_SERVICE_THREADS_NUMBER

Default service threads number.

See Also:

getServiceThreadsNumber(), Constant Field Values

Constructor Detail

CamelJettyHttpSpy

public CamelJettyHttpSpy(int port,
                         String path)

Creates new instance of spy server running on default host DEFAULT_HOSTNAME.

Parameters:

port - Network port where server will run.

path - HTTP path where server will be available. If null or empty, then default path / is used. Otherwise normalized path value is used with leading and trailing slash characters: /path/to/service/.

Throws:

IllegalArgumentException - port is negative.

IllegalArgumentException - path contains illegal characters.

CamelJettyHttpSpy

public CamelJettyHttpSpy(String hostname,
                         int port,
                         String path)

Creates new instance of spy server.

TODO; Do we need this constructor as far as we run it always on localhost?

Parameters:

hostname - Host name where server will run.

port - Network port where server will run.

path - HTTP path where server will be available. If null or empty, then default path / is used. Otherwise normalized path value is used with leading and trailing slash characters: /path/to/service/.

Throws:

NullPointerException - hostname is null.

IllegalArgumentException - hostname is empty or blank.

IllegalArgumentException - port is negative.

IllegalArgumentException - path contains illegal characters.

Method Detail

getRealJettyThreadsNumber

protected int getRealJettyThreadsNumber()

Gets real number of threads that is necessary to be configured for Jetty server.

Calculate the number of threads to be configured in Jetty server in order to guarantee that Jetty server provides at least getServiceThreadsNumber() threads servicing client requests. This method leverages the secret knowledge about Jetty: no more than 4 threads for acceptors, no more than 4 threads for selectors.

Returns:

Number of threads to specify for Jetty server configuration.

getHostname

public String getHostname()

Description copied from interface: HttpSpy

Gets host name.

Specified by:

getHostname in interface HttpSpy

Returns:

Network host name where server runs.

getPort

public int getPort()

Description copied from interface: HttpSpy

Gets network port.

Specified by:

getPort in interface HttpSpy

Returns:

Network port where server runs. Should be positive.

getPath

public String getPath()

Description copied from interface: HttpSpy

Gets HTTP path.

Specified by:

getPath in interface HttpSpy

Returns:

HTTP path where server is available.

setServiceThreadsNumber

public void setServiceThreadsNumber(int serviceThreadsNumber)

Description copied from interface: HttpSpy

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.

Specified by:

setServiceThreadsNumber in interface HttpSpy

Parameters:

serviceThreadsNumber - Number of threads that service requests.

getServiceThreadsNumber

public int getServiceThreadsNumber()

Description copied from interface: HttpSpy

Gets number of threads that concurrently service incoming requests.

Specified by:

getServiceThreadsNumber in interface HttpSpy

Returns:

Number of threads.

testPlan

public HttpSpy testPlan(TestPlanBuilder testPlanBuilder)

Description copied from interface: HttpSpy

Specify test plan.

Specified by:

testPlan in interface HttpSpy

Parameters:

testPlanBuilder - Builder that provides the test plan.

Returns:

This object

start

public void start()

Description copied from interface: HttpSpy

Start the spy server.

After start the spy server services client requests.

Specified by:

start in interface HttpSpy

createSpyProcessor

protected org.apache.camel.Processor createSpyProcessor()

Creates Camel Processor that will be used to record actual requests and send responses back.

Returns:

Processor instance.

Throws:

IllegalStateException - Test plan is not set.

sendResponseInExchange

protected void sendResponseInExchange(HttpResponse response,
                                      org.apache.camel.Exchange exchange)
                               throws InterruptedException

Send the response in Camel exchange.

This implementation sends response body in platform default encoding.

If the response has multiple headers with the same name, then this method follows RFC 2616, Section 4.2 Message Headers: combine all values into one string of comma-separated values.

Parameters:

response - The response to send.

exchange - Send the response as Out message within this exchange object. Out message allows to drop all headers came with In message.

Throws:

NullPointerException - response is null, exchange is null.

InterruptedException - Interrupted while waiting the delay, specified for the response.

See Also:

HttpResponse.getDelayMillis()

verify

public void verify()

Description copied from interface: HttpSpy

Verify that expectations are met.

This method delegates verification to the test plan.

Specified by:

verify in interface HttpSpy

See Also:

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

reset

public void reset()

Description copied from interface: HttpSpy

Reset the spy server.

The spy server resets its current test plan.

Specified by:

reset in interface HttpSpy

See Also:

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

stop

public void stop()

Description copied from interface: HttpSpy

Stop the spy server.

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

Specified by:

stop in interface HttpSpy