com.github.restdriver.clientdriver

Class ClientDriverResponse

java.lang.Object

com.github.restdriver.clientdriver.ClientDriverResponse

public final class ClientDriverResponse
extends Object

Class for encapsulating an HTTP response.

Constructor Summary

Constructors

Constructor and Description
ClientDriverResponse() Creates a new response with an empty body, a status code of 204 and no Content-Type.
ClientDriverResponse(InputStream content, String contentType) Creates a new response with the given body, a suitable default status code and a given content-type.
ClientDriverResponse(String content) Deprecated. Use ClientDriverResponse(String, String) instead.
ClientDriverResponse(String content, String contentType) Creates a new response with the given body, a suitable default status code and a given content-type.

Method Summary

Modifier and Type	Method and Description
ClientDriverResponse	after(long delay, TimeUnit timeUnit) Modifies a ClientDriverRequest to specify some time to wait before responding.
boolean	canExpire()
String	getContent()
byte[]	getContentAsBytes()
String	getContentType()
long	getDelayTime()
TimeUnit	getDelayTimeUnit()
Map<String,String>	getHeaders()
int	getStatus()
boolean	hasBody()
boolean	hasNotExpired()
ClientDriverResponse	withContentType(String withContentType) Deprecated. You shouldn't need to use this method any more. Use one of the creator methods which specifies a content-type.
ClientDriverResponse	withHeader(String name, String value) Set headers on the response.
ClientDriverResponse	within(long interval, TimeUnit unit) Sets the amount of time to allow this response to match within.
ClientDriverResponse	withStatus(int withStatus)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientDriverResponse

public ClientDriverResponse()

Creates a new response with an empty body, a status code of 204 and no Content-Type.

ClientDriverResponse

@Deprecated
public ClientDriverResponse(String content)

Deprecated. Use ClientDriverResponse(String, String) instead.

Creates a new response with the given body, a suitable default status code and a Content-Type of 'text/plain'.

If the content given is null a 204 status code is given, otherwise 200.

Parameters:

content - The content of the response

ClientDriverResponse

public ClientDriverResponse(String content,
                            String contentType)

Creates a new response with the given body, a suitable default status code and a given content-type.

If the content given is null a 204 status code is given, otherwise 200.

Parameters:

content - The content of the response

contentType - The content type

ClientDriverResponse

public ClientDriverResponse(InputStream content,
                            String contentType)

Creates a new response with the given body, a suitable default status code and a given content-type.

If the content given is null a 204 status code is given, otherwise 200.

Parameters:

content - The content of the response

contentType - The content type

Method Detail

getContentAsBytes

public byte[] getContentAsBytes()

Returns:

The content as a byte array

getContent

public String getContent()

Returns:

The content as a string, or an empty string if the content byte array is null or empty.

withStatus

public ClientDriverResponse withStatus(int withStatus)

Parameters:

withStatus - the status to set

Returns:

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

after

public ClientDriverResponse after(long delay,
                                  TimeUnit timeUnit)

Modifies a ClientDriverRequest to specify some time to wait before responding. This enables you to simulate slow services or networks, eg for testing timeout behaviour of your clients.

Parameters:

delay - How long to delay for.

timeUnit - The time unit to use when counting the delay.

Returns:

The modified ClientDriverRequest.

getDelayTime

public long getDelayTime()

Returns:

the amount of time to delay the response

getDelayTimeUnit

public TimeUnit getDelayTimeUnit()

Returns:

the unit of time for which we will delay the response

canExpire

public boolean canExpire()

hasNotExpired

public boolean hasNotExpired()

getStatus

public int getStatus()

Returns:

the status

getContentType

public String getContentType()

Returns:

the contentType

withContentType

@Deprecated
public ClientDriverResponse withContentType(String withContentType)

Deprecated. You shouldn't need to use this method any more. Use one of the creator methods which specifies a content-type.

Parameters:

withContentType - the contentType to set

Returns:

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

withHeader

public ClientDriverResponse withHeader(String name,
                                       String value)

Set headers on the response.

Parameters:

name - The header name

value - The header value

Returns:

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

within

public ClientDriverResponse within(long interval,
                                   TimeUnit unit)

Sets the amount of time to allow this response to match within.

Parameters:

interval - The number of given unit to wait

unit - The unit to wait for

Returns:

This object, so you can chain these calls.

getHeaders

public Map<String,String> getHeaders()

Returns:

the headers

hasBody

public boolean hasBody()

Returns:

whether the response has a body