com.github.restdriver.clientdriver

Class ClientDriverRequest

java.lang.Object

com.github.restdriver.clientdriver.ClientDriverRequest

public final class ClientDriverRequest
extends Object

Class for encapsulating an HTTP request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientDriverRequest.Method HTTP method enum for specifying which method you expect to be called with.

Constructor Summary

Constructors

Constructor and Description
ClientDriverRequest(org.hamcrest.Matcher<? extends String> path) Constructor taking String matcher.
ClientDriverRequest(Pattern path) Constructor taking Pattern.
ClientDriverRequest(String path) Constructor taking String.

Method Summary

Methods

Modifier and Type	Method and Description
ClientDriverRequest	capturingBodyIn(BodyCapture<?> bodyCapture) Setter for adding a BodyCapture to the expectation for later assertions/debugging.
BodyCapture<?>	getBodyCapture()
org.hamcrest.Matcher<? extends String>	getBodyContentMatcher()
org.hamcrest.Matcher<? extends String>	getBodyContentType()
Set<String>	getExcludedHeaders()
Map<String,org.hamcrest.Matcher<? extends String>>	getHeaders()
ClientDriverRequest.Method	getMethod()
org.hamcrest.Matcher<? extends String>	getPath() Get the path.
String	toString() toString.
ClientDriverRequest	withAnyParams() Setter for expecting any number of querystring parameters with any values.
ClientDriverRequest	withBasicAuth(String username, String password)
ClientDriverRequest	withBody(org.hamcrest.Matcher<? extends String> bodyContentMatcher, String contentType) Setter for expecting body content and type, where content is in the form of a Matcher and type is in the form of a Pattern.
ClientDriverRequest	withBody(Pattern withBodyContent, Pattern contentType) Setter for expecting body content and type, where content is in the form of a Pattern and type is in the form of a Pattern.
ClientDriverRequest	withBody(Pattern withBodyContent, String contentType) Setter for expecting body content and type, where content is in the form of a Pattern and type is in the form of a String.
ClientDriverRequest	withBody(String withBodyContent, Pattern contentType) Setter for expecting body content and type, where content is in the form of a String and type is in the form of a Pattern.
ClientDriverRequest	withBody(String withBodyContent, String withContentType) Setter for expecting body content and type, where content is in the form of a String and type is in the form of a String.
ClientDriverRequest	withHeader(String withHeaderName, org.hamcrest.Matcher<? extends String> headerValueMatcher) Setter for expecting a specific header name and value matcher.
ClientDriverRequest	withHeader(String withHeaderName, Pattern withHeaderValue) Setter for expecting a specific header name and value pair, where value is in the form of a Pattern.
ClientDriverRequest	withHeader(String withHeaderName, String withHeaderValue) Setter for expecting a specific header name and value pair.
ClientDriverRequest	withMethod(ClientDriverRequest.Method withMethod)
ClientDriverRequest	withoutHeader(String withoutHeaderName) Setter for expecting a specific header name not to be present on the request.
ClientDriverRequest	withParam(String key, boolean value) Setter for expecting query-string parameters on the end of the url.
ClientDriverRequest	withParam(String key, int value) Setter for expecting query-string parameters on the end of the url.
ClientDriverRequest	withParam(String key, long value) Setter for expecting query-string parameters on the end of the url.
ClientDriverRequest	withParam(String key, org.hamcrest.Matcher<? extends String> value) Setter for expecting query-string parameters on the end of the url.
ClientDriverRequest	withParam(String key, Object value) Setter for expecting query-string parameters on the end of the url.
ClientDriverRequest	withParam(String key, Pattern value) Setter for expecting query-string parameters on the end of the url.
ClientDriverRequest	withParam(String key, String value) Setter for expecting query-string parameters on the end of the url.
ClientDriverRequest	withParams(Map<String,Object> newParams) Setter for expecting multiple query-string parameters on the end of the url.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientDriverRequest

public ClientDriverRequest(org.hamcrest.Matcher<? extends String> path)

Constructor taking String matcher.

Parameters:

path - The mandatory argument is the path which will be listened on

ClientDriverRequest

public ClientDriverRequest(String path)

Constructor taking String.

Parameters:

path - The mandatory argument is the path which will be listened on

ClientDriverRequest

public ClientDriverRequest(Pattern path)

Constructor taking Pattern.

Parameters:

path - The mandatory argument is the path which will be listened on

Method Detail

getPath

public org.hamcrest.Matcher<? extends String> getPath()

Get the path.

Returns:

the path which requests are expected on.

withMethod

public ClientDriverRequest withMethod(ClientDriverRequest.Method withMethod)

Parameters:

withMethod - the method to set

Returns:

the object you called the method on, so you can chain these calls.

getMethod

public ClientDriverRequest.Method getMethod()

Returns:

the method

withAnyParams

public ClientDriverRequest withAnyParams()

Setter for expecting any number of querystring parameters with any values. With this set, any expected parameters are ignored.

Returns:

the request

withParam

public ClientDriverRequest withParam(String key,
                            String value)

Setter for expecting query-string parameters on the end of the url.

Parameters:

key - The key from ?key=value

value - The value from ?key=value in the form of a String

Returns:

the object you called the method on, so you can chain these calls.

withParam

public ClientDriverRequest withParam(String key,
                            int value)

Setter for expecting query-string parameters on the end of the url.

Parameters:

key - The key from ?key=value

value - The value from ?key=value in the form of a String

Returns:

the object you called the method on, so you can chain these calls.

withParam

public ClientDriverRequest withParam(String key,
                            long value)

Setter for expecting query-string parameters on the end of the url.

Parameters:

key - The key from ?key=value

value - The value from ?key=value in the form of a String

Returns:

the object you called the method on, so you can chain these calls.

withParam

public ClientDriverRequest withParam(String key,
                            boolean value)

Setter for expecting query-string parameters on the end of the url.

Parameters:

key - The key from ?key=value

value - The value from ?key=value in the form of a String

Returns:

the object you called the method on, so you can chain these calls.

withParam

public ClientDriverRequest withParam(String key,
                            Object value)

Setter for expecting query-string parameters on the end of the url.

Parameters:

key - The key from ?key=value

value - The value from ?key=value in the form of a String

Returns:

the object you called the method on, so you can chain these calls.

withParam

public ClientDriverRequest withParam(String key,
                            Pattern value)

Setter for expecting query-string parameters on the end of the url.

Parameters:

key - The key from ?key=value

value - The value from ?key=value in the form of a Pattern

Returns:

the object you called the method on, so you can chain these calls.

withParam

public ClientDriverRequest withParam(String key,
                            org.hamcrest.Matcher<? extends String> value)

Setter for expecting query-string parameters on the end of the url.

Parameters:

key - The key from ?key=value

value - The value from ?key=value in the form of a Matcher

Returns:

the object you called the method on, so you can chain these calls.

withParams

public ClientDriverRequest withParams(Map<String,Object> newParams)

Setter for expecting multiple query-string parameters on the end of the url.

Parameters:

newParams - The map of key value pairs from ?key=value

Returns:

the object you called the method on, so you can chain these calls.

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String representation of the request

getBodyContentMatcher

public org.hamcrest.Matcher<? extends String> getBodyContentMatcher()

Returns:

The body content matcher

getBodyContentType

public org.hamcrest.Matcher<? extends String> getBodyContentType()

Returns:

the bodyContentType

withBody

public ClientDriverRequest withBody(String withBodyContent,
                           String withContentType)

Setter for expecting body content and type, where content is in the form of a String and type is in the form of a String.

Parameters:

withBodyContent - the bodyContent to set

withContentType - eg "text/plain"

Returns:

the object you called the method on, so you can chain these calls.

withBody

public ClientDriverRequest withBody(String withBodyContent,
                           Pattern contentType)

Setter for expecting body content and type, where content is in the form of a String and type is in the form of a Pattern.

Parameters:

withBodyContent - the bodyContent to set

contentType - eg "text/plain"

Returns:

the object you called the method on, so you can chain these calls.

withBody

public ClientDriverRequest withBody(Pattern withBodyContent,
                           String contentType)

Setter for expecting body content and type, where content is in the form of a Pattern and type is in the form of a String.

Parameters:

withBodyContent - the bodyContent to set

contentType - eg "text/plain"

Returns:

the object you called the method on, so you can chain these calls.

withBody

public ClientDriverRequest withBody(Pattern withBodyContent,
                           Pattern contentType)

Setter for expecting body content and type, where content is in the form of a Pattern and type is in the form of a Pattern.

Parameters:

withBodyContent - the bodyContent to set

contentType - eg "text/plain"

Returns:

the object you called the method on, so you can chain these calls.

withBody

public ClientDriverRequest withBody(org.hamcrest.Matcher<? extends String> bodyContentMatcher,
                           String contentType)

Setter for expecting body content and type, where content is in the form of a Matcher and type is in the form of a Pattern.

Parameters:

bodyContentMatcher - the Matcher<String> to use to set

contentType - eg "text/plain"

Returns:

the object you called the method on, so you can chain these calls.

capturingBodyIn

public ClientDriverRequest capturingBodyIn(BodyCapture<?> bodyCapture)

Setter for adding a BodyCapture to the expectation for later assertions/debugging.

Parameters:

bodyCapture - the capturing object.

Returns:

this, for chaining.

getBodyCapture

public BodyCapture<?> getBodyCapture()

withHeader

public ClientDriverRequest withHeader(String withHeaderName,
                             org.hamcrest.Matcher<? extends String> headerValueMatcher)

Setter for expecting a specific header name and value matcher.

Parameters:

withHeaderName - the headerName to match on

headerValueMatcher - the matcher to use for the header value

Returns:

the object you called the method on, so you can chain these calls

withHeader

public ClientDriverRequest withHeader(String withHeaderName,
                             String withHeaderValue)

Setter for expecting a specific header name and value pair.

Parameters:

withHeaderName - the headerName to match on

withHeaderValue - the headerValue to match on

Returns:

the object you called the method on, so you can chain these calls

withoutHeader

public ClientDriverRequest withoutHeader(String withoutHeaderName)

Setter for expecting a specific header name not to be present on the request.

Parameters:

withoutHeaderName - the headerName to match on

Returns:

the object you called the method on, so you can chain these calls

withHeader

public ClientDriverRequest withHeader(String withHeaderName,
                             Pattern withHeaderValue)

Setter for expecting a specific header name and value pair, where value is in the form of a Pattern.

Parameters:

withHeaderName - the headerName to match on

withHeaderValue - the headerValue to match on

Returns:

the object you called the method on, so you can chain these calls

withBasicAuth

public ClientDriverRequest withBasicAuth(String username,
                                String password)

getHeaders

public Map<String,org.hamcrest.Matcher<? extends String>> getHeaders()

Returns:

the headers

getExcludedHeaders

public Set<String> getExcludedHeaders()

Returns:

the excluded headers