Package com.github.paweladamski.httpclientmock

Class HttpClientResponseBuilder

java.lang.Object

com.github.paweladamski.httpclientmock.HttpClientResponseBuilder

public class HttpClientResponseBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
HttpClientResponseBuilder	doAction(Action action)	Adds custom action.
HttpClientResponseBuilder	doReturn(int statusCode, String response)	Adds action which returns provided response in UTF-8 with status code.
HttpClientResponseBuilder	doReturn(int statusCode, String response, Charset charset)	Adds action which returns provided response in provided charset and status code.
HttpClientResponseBuilder	doReturn(int statusCode, String response, org.apache.hc.core5.http.ContentType contentType)	Adds action which returns provided response in provided content type and status code.
HttpClientResponseBuilder	doReturn(String response)	Adds action which returns provided response in UTF-8 and status 200.
HttpClientResponseBuilder	doReturn(String response, Charset charset)	Adds action which returns provided response in provided charset and status 200.
HttpClientResponseBuilder	doReturn(String response, org.apache.hc.core5.http.ContentType contentType)	Adds action which returns provided response in provided charset, content type and status 200.
HttpClientResponseBuilder	doReturnFormParams(Collection<org.apache.hc.core5.http.NameValuePair> formParameters)	Adds action which returns provided name/value pairs as URL-encoded form response in UTF-8 and status 200.
HttpClientResponseBuilder	doReturnFormParams(Collection<org.apache.hc.core5.http.NameValuePair> formParameters, Charset charset)	Adds action which returns provided name/value pairs as URL-encoded form response and status 200.
HttpClientResponseBuilder	doReturnJSON(String response)	Adds action which returns provided JSON in UTF-8 and status 200.
HttpClientResponseBuilder	doReturnJSON(String response, Charset charset)	Adds action which returns provided JSON in provided encoding and status 200.
HttpClientResponseBuilder	doReturnStatus(int statusCode)	Deprecated. use doReturnWithStatus instead
HttpClientResponseBuilder	doReturnWithStatus(int statusCode)	Adds action which returns provided status and null entity.
HttpClientResponseBuilder	doReturnWithStatus(int statusCode, String reason)	Adds action which returns provided status with reason and null entity.
HttpClientResponseBuilder	doReturnXML(String response)	Adds action which returns provided XML in UTF-8 and status 200.
HttpClientResponseBuilder	doReturnXML(String response, Charset charset)	Adds action which returns provided XML in UTF-8 and status 200.
HttpClientResponseBuilder	doThrowException(IOException exception)	Adds action which throws provided exception.
HttpClientResponseBuilder	withCookie(String cookieName, String cookieValue)	Sets response cookie
HttpClientResponseBuilder	withHeader(String name, String value)	Sets response header.
HttpClientResponseBuilder	withStatus(int statusCode)	Sets response status code.
HttpClientResponseBuilder	withStatus(int statusCode, String statusReason)	Sets response status code and status reason.

Methods inherited from class java.lang.Object

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

Method Detail

withHeader

public HttpClientResponseBuilder withHeader(String name,
                                            String value)

Sets response header.

Parameters:

name - header name

value - header value

Returns:

response builder

withStatus

public HttpClientResponseBuilder withStatus(int statusCode)

Sets response status code.

Parameters:

statusCode - response status code

Returns:

response builder

withStatus

public HttpClientResponseBuilder withStatus(int statusCode,
                                            String statusReason)

Sets response status code and status reason.

Parameters:

statusCode - response status code

statusReason - response status reason

Returns:

response builder

withCookie

public HttpClientResponseBuilder withCookie(String cookieName,
                                            String cookieValue)

Sets response cookie

Parameters:

cookieName - cookie name

cookieValue - cookie value

Returns:

response builder

doAction

public HttpClientResponseBuilder doAction(Action action)

Adds custom action.

Parameters:

action - custom action

Returns:

response builder

doReturn

public HttpClientResponseBuilder doReturn(String response)

Adds action which returns provided response in UTF-8 and status 200.

Parameters:

response - response to return

Returns:

response builder

doReturnWithStatus

public HttpClientResponseBuilder doReturnWithStatus(int statusCode)

Adds action which returns provided status and null entity.

Parameters:

statusCode - status to return

Returns:

response builder

doReturnWithStatus

public HttpClientResponseBuilder doReturnWithStatus(int statusCode,
                                                    String reason)

Adds action which returns provided status with reason and null entity.

Parameters:

statusCode - status to return

reason - reason to return

Returns:

response builder

doReturn

public HttpClientResponseBuilder doReturn(int statusCode,
                                          String response)

Adds action which returns provided response in UTF-8 with status code.

Parameters:

statusCode - status to return

response - response to return

Returns:

response builder

doReturn

public HttpClientResponseBuilder doReturn(String response,
                                          Charset charset)

Adds action which returns provided response in provided charset and status 200.

Parameters:

response - response to return

charset - response charset

Returns:

response builder

doReturn

public HttpClientResponseBuilder doReturn(String response,
                                          org.apache.hc.core5.http.ContentType contentType)

Adds action which returns provided response in provided charset, content type and status 200.

Parameters:

response - response to return

contentType - response content type

Returns:

response builder

doReturn

public HttpClientResponseBuilder doReturn(int statusCode,
                                          String response,
                                          Charset charset)

Adds action which returns provided response in provided charset and status code.

Parameters:

statusCode - status to return

response - response to return

charset - the charset

Returns:

response builder

doReturn

public HttpClientResponseBuilder doReturn(int statusCode,
                                          String response,
                                          org.apache.hc.core5.http.ContentType contentType)

Adds action which returns provided response in provided content type and status code.

Parameters:

statusCode - status to return

response - response to return

contentType - response content type

Returns:

response builder

doReturnStatus

@Deprecated
public HttpClientResponseBuilder doReturnStatus(int statusCode)

Deprecated.

use doReturnWithStatus instead

Adds action which returns empty message and provided status.

Parameters:

statusCode - status to return

Returns:

response builder

doThrowException

public HttpClientResponseBuilder doThrowException(IOException exception)

Adds action which throws provided exception.

Parameters:

exception - exception to be thrown

Returns:

response builder

doReturnJSON

public HttpClientResponseBuilder doReturnJSON(String response)

Adds action which returns provided JSON in UTF-8 and status 200. Additionally it sets "Content-type" header to "application/json".

Parameters:

response - JSON to return

Returns:

response builder

doReturnJSON

public HttpClientResponseBuilder doReturnJSON(String response,
                                              Charset charset)

Adds action which returns provided JSON in provided encoding and status 200. Additionally it sets "Content-type" header to "application/json".

Parameters:

response - JSON to return

charset - response charset

Returns:

response builder

doReturnXML

public HttpClientResponseBuilder doReturnXML(String response)

Adds action which returns provided XML in UTF-8 and status 200. Additionally it sets "Content-type" header to "application/xml".

Parameters:

response - JSON to return

Returns:

response builder

doReturnXML

public HttpClientResponseBuilder doReturnXML(String response,
                                             Charset charset)

Adds action which returns provided XML in UTF-8 and status 200. Additionally it sets "Content-type" header to "application/xml".

Parameters:

response - JSON to return

charset - response charset

Returns:

response builder

doReturnFormParams

public HttpClientResponseBuilder doReturnFormParams(Collection<org.apache.hc.core5.http.NameValuePair> formParameters)

Adds action which returns provided name/value pairs as URL-encoded form response in UTF-8 and status 200. Additionally it sets "Content-type" header to "application/x-www-form-urlencoded".

Parameters:

formParameters - the parameters to include in the response

Returns:

response builder

doReturnFormParams

public HttpClientResponseBuilder doReturnFormParams(Collection<org.apache.hc.core5.http.NameValuePair> formParameters,
                                                    Charset charset)

Adds action which returns provided name/value pairs as URL-encoded form response and status 200. Additionally it sets "Content-type" header to "application/x-www-form-urlencoded".

Parameters:

formParameters - the parameters to include in the response

charset - response charset

Returns:

response builder