StubPlan (HTTP Spy 1.1 API)

java.lang.Object
- com.github.tashoyan.httpspy.StubPlan

All Implemented Interfaces:

TestPlan
```
@ThreadSafe
public class StubPlan
extends Object
implements TestPlan
```
Test plan that allows to provide responses based on features of of requests.
This test plan implements stub test object that feeds the system under test with responses. The test plan chooses a response based on the features of the request sent by the system under test. For example, user can configure HTTP Spy to respond on all requests having body <html>Hello<html> with the status code 200.
When looking for the matching response, the test plan follows the order of request expectations specified in the constructor StubPlan(java.util.Collection<com.github.tashoyan.httpspy.RequestExpectation>, java.util.Collection<com.github.tashoyan.httpspy.HttpResponse>). In other words, the first specified request expectation has the highest priority and evaluated first.
If none request expectations matched for a request, then the test plan replies with a special response with Internal server error status code. Verification in this case will fail and failure explanation will list all unmatched requests.

Constructor Summary

Constructors
Constructor and Description
`StubPlan(Collection<RequestExpectation> requestExpectations, Collection<HttpResponse> responses)` Creates new test plan with request expectations and responses for them.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected HttpResponse`	`createUnmatchedRequestResponse(HttpRequest actualRequest)` Creates a special response when a request does not match all expectations.
`HttpResponse`	`getResponse(HttpRequest actualRequest)` Gets a response for an actual request.
`boolean`	`isMultithreaded()` Checks if this test plan supports multiple service threads.
`protected void`	`recordUnmatchedRequest(HttpRequest actualRequest)` Records a request unmatched with all expectations.
`void`	`verify()` Verifies actual requests against request expectations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StubPlan
```
public StubPlan(Collection<RequestExpectation> requestExpectations,
                Collection<HttpResponse> responses)
```
    Creates new test plan with request expectations and responses for them.
    Each request expectation has a corresponding response at the same index in the list. Method getResponse(com.github.tashoyan.httpspy.HttpRequest) will look for a matching expectation (and a corresponding response) in the order specified by the arguments.
    
    Parameters:
    
    requestExpectations - The ordered collection of request expectations.
    
    responses - The ordered collection of responses on actual requests.
    
    Throws:
    
    NullPointerException - requestExpectations is null, responses is null.
    
    IllegalArgumentException - requestExpectations is empty, responses is empty, requestExpectations.size != responses.size.
- Method Detail
  - getResponse
```
public HttpResponse getResponse(HttpRequest actualRequest)
```
    Description copied from interface: TestPlan
    
    Gets a response for an actual request.
    
    Specified by:
    
    getResponse in interface TestPlan
    
    Parameters:
    
    actualRequest - A request that has been received from the system under test.
    
    Returns:
    
    Response on the request. Never returns null.
  - recordUnmatchedRequest
```
protected void recordUnmatchedRequest(HttpRequest actualRequest)
```
    Records a request unmatched with all expectations.
    This implementation simply stores the request for the verification.
    
    Parameters:
    
    actualRequest - Actual request.
    
    Throws:
    
    NullPointerException - actualRequest is null.
  - createUnmatchedRequestResponse
```
protected HttpResponse createUnmatchedRequestResponse(HttpRequest actualRequest)
```
    Creates a special response when a request does not match all expectations.
    This implementation responds with Internal server error status code.
    
    Parameters:
    
    actualRequest - Actual request.
    
    Returns:
    
    Response. Never returns null.
    
    Throws:
    
    NullPointerException - actualRequest is null.
  - verify
```
public void verify()
```
    Description copied from interface: TestPlan
    
    Verifies actual requests against request expectations.
    
    Specified by:
    
    verify in interface TestPlan
  - isMultithreaded
```
public boolean isMultithreaded()
```
    Description copied from interface: TestPlan
    
    Checks if this test plan supports multiple service threads.
    
    Specified by:
    
    isMultithreaded in interface TestPlan
    
    Returns:
    
    true if multiple service threads can work with this test plan.

Class StubPlan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StubPlan

Method Detail

getResponse

recordUnmatchedRequest

createUnmatchedRequestResponse

verify

isMultithreaded