net.relaysoft.robot.http.server

Class MockServer

java.lang.Object

net.relaysoft.robot.http.server.MockServer

public class MockServer
extends Object

Mock HTTP server used for storing configured mapped responses and requests made against it.

Author:

relaysoft.net

Method Summary

Modifier and Type	Method and Description
int	getPort()
RequestDataHolder	getRequest()
RequestDataHolder	getRequest(int requestNumber)
String	getRequestAuthType()
String	getRequestAuthType(int requestNumber)
String	getRequestBody()
String	getRequestBody(int requestNumber)
int	getRequestCount()
Map<String,String>	getRequestHeaders()
Map<String,String>	getRequestHeaders(int requestNumber)
String	getRequestMethod()
String	getRequestMethod(int requestNumber)
String	getRequestQueryString()
String	getRequestQueryString(int requestNumber)
void	initializeServer(int port) Initialize mock server.
void	resetRequestData() Reset all saved data from requests made against this mock.
void	resetResponseData() Reset all set response values back to defaults.
void	setDefaultResponse(String body, String contentType, Integer code, Map<String,String> headers) Sets default response to return in case when request URL, method, query string and/or SOAP action does not match any REST or SOAP response configured into this mock server.
void	setDefaultResponseFromFile(String filePath, String contentType, Integer code, Map<String,String> headers) Sets default response to return in case when request URL, method, query string and/or SOAP action does not match any REST or SOAP response configured into this mock server.
void	setRestResponseData(String path, String method, Map<String,String> queryParameters, String body, String contentType, Integer code, Map<String,String> headers) Sets REST response to return in case when request URL, method, and optional query string matches into given values.
void	setRestResponseDataFromFile(String path, String method, Map<String,String> queryParameters, String filePath, String contentType, Integer code, Map<String,String> headers) Sets REST response to return in case when request URL, method, and optional query string matches into given values.
void	setSoapResponseData(String path, String soapAction, String body, String contentType, Integer code, Map<String,String> headers) Sets REST response to return in case when request URL, and SOAP action matches into given values.
void	setSoapResponseDataFromFile(String path, String soapAction, String filePath, String contentType, Integer code, Map<String,String> headers) Sets REST response to return in case when request URL, and SOAP action matches into given values.
void	start() Start mock server
void	stop() Stop mock server.

Methods inherited from class java.lang.Object

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

Method Detail

initializeServer

public void initializeServer(int port)
                      throws IOException

Initialize mock server.

Parameters:

port - - Port to listen when started. If 0 then first available port is selected

Throws:

IOException - - If selecting the first available port fails.

start

public void start()
           throws Exception

Start mock server

Throws:

Exception - - If starting fails.

stop

public void stop()
          throws Exception

Stop mock server.

Throws:

Exception - - If stopping fails.

getPort

public int getPort()

Returns:

Port which mock server is listening.

getRequest

public RequestDataHolder getRequest()

Returns:

Request data holder from the latest request after initialize or reset.

getRequest

public RequestDataHolder getRequest(int requestNumber)

Parameters:

requestNumber - - Number of request to check after initialize or reset

Returns:

Request data holder from the given request after initialize or reset.

getRequestAuthType

public String getRequestAuthType()

Returns:

Authentication type from the latest request after initialize or reset.

getRequestAuthType

public String getRequestAuthType(int requestNumber)

Parameters:

requestNumber - - Number of request to check after initialize or reset

Returns:

Authentication type from the given request after initialize or reset.

getRequestBody

public String getRequestBody()

Returns:

Request body from the latest request after initialize or reset.

getRequestBody

public String getRequestBody(int requestNumber)

Parameters:

requestNumber - - Number of request to check after initialize or reset

Returns:

Request body from the given request after initialize or reset.

getRequestCount

public int getRequestCount()

Returns:

Number of request made against this server since last reset.

getRequestHeaders

public Map<String,String> getRequestHeaders()

Returns:

All request headers from latest request after initialize or reset.

getRequestHeaders

public Map<String,String> getRequestHeaders(int requestNumber)

Parameters:

requestNumber - - Number of request to check after initialize or reset

Returns:

All request headers from given request after initialize or reset.

getRequestMethod

public String getRequestMethod()

Returns:

Request method from latest request after initialize or reset.

getRequestMethod

public String getRequestMethod(int requestNumber)

Parameters:

requestNumber - - Number of request to check after initialize or reset

Returns:

Request method from given request after initialize or reset.

getRequestQueryString

public String getRequestQueryString()

Returns:

Request query string from latest request after initialize or reset.

getRequestQueryString

public String getRequestQueryString(int requestNumber)

Parameters:

requestNumber - - Number of request to check after initialize or reset

Returns:

Request query string from given request after initialize or reset.

resetRequestData

public void resetRequestData()

Reset all saved data from requests made against this mock.

resetResponseData

public void resetResponseData()

Reset all set response values back to defaults.

setDefaultResponse

public void setDefaultResponse(String body,
                               String contentType,
                               Integer code,
                               Map<String,String> headers)

Sets default response to return in case when request URL, method, query string and/or SOAP action does not match any REST or SOAP response configured into this mock server.

Parameters:

body - - Response body content. Can be null, default is empty response

contentType - - Response body content type. Can be null, default is content type from request

code - - Response HTTP status code, Can be null, default is 200.

headers - - Response headers, Can be null.

setDefaultResponseFromFile

public void setDefaultResponseFromFile(String filePath,
                                       String contentType,
                                       Integer code,
                                       Map<String,String> headers)

Sets default response to return in case when request URL, method, query string and/or SOAP action does not match any REST or SOAP response configured into this mock server. Response body content is retrieved from file.

Parameters:

filePath - - Path to file which content is used for response body content

contentType - - Response body content type. Can be null, default is content type from request

code - - Response HTTP status code, Can be null, default is 200.

headers - - Response headers, Can be null.

setRestResponseData

public void setRestResponseData(String path,
                                String method,
                                Map<String,String> queryParameters,
                                String body,
                                String contentType,
                                Integer code,
                                Map<String,String> headers)

Sets REST response to return in case when request URL, method, and optional query string matches into given values.

Parameters:

path - - Request URL path to match

method - - Request method to match

queryParameters - - Optional request query parameters to match

body - - Body content to return in response

contentType - - Response body content type

code - - Response HTTP code

headers - - Response HTTP headers

setRestResponseDataFromFile

public void setRestResponseDataFromFile(String path,
                                        String method,
                                        Map<String,String> queryParameters,
                                        String filePath,
                                        String contentType,
                                        Integer code,
                                        Map<String,String> headers)

Sets REST response to return in case when request URL, method, and optional query string matches into given values. Response body content is retrieved from file.

Parameters:

path - - Request URL path to match

method - - Request method to match

queryParameters - - Optional request query parameters to match

filePath - - Path to file which content is used for response body content

contentType - - Response body content type

code - - Response HTTP code

headers - - Response HTTP headers

setSoapResponseData

public void setSoapResponseData(String path,
                                String soapAction,
                                String body,
                                String contentType,
                                Integer code,
                                Map<String,String> headers)

Sets REST response to return in case when request URL, and SOAP action matches into given values.

Parameters:

path - - Request URL path to match

soapAction - - SOAP action to match

body - - Body content to return in response

contentType - - Response body content type

code - - Response HTTP code

headers - - Response HTTP headers

setSoapResponseDataFromFile

public void setSoapResponseDataFromFile(String path,
                                        String soapAction,
                                        String filePath,
                                        String contentType,
                                        Integer code,
                                        Map<String,String> headers)

Sets REST response to return in case when request URL, and SOAP action matches into given values. Response body content is retrieved from file.

Parameters:

path - - Request URL path to match

soapAction - - SOAP action to match

filePath - - Path to file which content is used for response body content

contentType - - Response body content type

code - - Response HTTP code

headers - - Response HTTP headers