public class MockRequest extends Object implements Request<MockRequest,MockResponse>
Request.MethodType
Constructor and Description |
---|
MockRequest(Request.MethodType methodType,
String url) |
Modifier and Type | Method and Description |
---|---|
MockRequest |
addBasicAuthentication(String host,
String username,
String password)
Adds basic authentication to the request.
|
MockRequest |
addHeader(String headerName,
String headerValue)
Adds the specified header to the request, not overwriting any previous value.
|
MockRequest |
addRequestParameters(String... params)
Sets parameters of the request.
|
String |
execute()
Executes a request and if response is successful, returns response as a string.
|
void |
execute(ResponseHandler<? super MockResponse> responseHandler)
Executes the request.
|
<RET> RET |
executeAndReturn(ReturningResponseHandler<? super MockResponse,RET> responseHandler)
Executes the request and returns a result value.
|
String |
getBasicHost() |
String |
getBasicPassword() |
String |
getBasicUser() |
int |
getConnectionTimeout() |
List<String> |
getHeader(String headerName) |
Map<String,List<String>> |
getHeaders() |
Request.MethodType |
getMethodType() |
String |
getRequestBody() |
String |
getRequestContentType() |
List<String> |
getRequestParameters() |
Response |
getResponse() |
int |
getSoTimeout() |
String |
getUrl() |
MockRequest |
setConnectionTimeout(int connectionTimeout)
Setting connection timeout in milliseconds.
|
MockRequest |
setEntity(Object entity)
Set an entity as the request body
|
MockRequest |
setFiles(List<RequestFilePart> files)
Sets file parts of the request.
|
MockRequest |
setFollowRedirects(boolean follow)
Sets whether the request should transparently follow a redirect from the server.
|
MockRequest |
setHeader(String headerName,
String headerValue)
Sets the specified header to the request, overwriting any previous value.
|
MockRequest |
setRequestBody(String requestBody)
Sets the body of the request.
|
MockRequest |
setRequestBody(String requestBody,
String contentType)
Sets the body of the request.
|
MockRequest |
setRequestContentType(String contentType) |
void |
setResponse(MockResponse response) |
void |
setResponseBody(String responseBody) |
MockRequest |
setSoTimeout(int soTimeout)
Setting socket timeout in milliseconds.
|
MockRequest |
setUrl(String url) |
public MockRequest(Request.MethodType methodType, String url)
public MockRequest setConnectionTimeout(int connectionTimeout)
Request
setConnectionTimeout
in interface Request<MockRequest,MockResponse>
connectionTimeout
- The timeout in millisecondspublic MockRequest setSoTimeout(int soTimeout)
Request
setSoTimeout
in interface Request<MockRequest,MockResponse>
soTimeout
- the timeout in millisecondspublic MockRequest setUrl(String url)
setUrl
in interface Request<MockRequest,MockResponse>
url
- the url to requestpublic MockRequest setRequestBody(String requestBody)
Request
Request.MethodType.POST
and Request.MethodType.PUT
can have a request body.setRequestBody
in interface Request<MockRequest,MockResponse>
requestBody
- the body of the requestpublic MockRequest setRequestBody(String requestBody, String contentType)
Request
Request.MethodType.POST
and Request.MethodType.PUT
can have a request body.setRequestBody
in interface Request<MockRequest,MockResponse>
requestBody
- the body of the requestcontentType
- the contentType of the requestpublic MockRequest setFiles(List<RequestFilePart> files)
Request
Request.MethodType.POST
and Request.MethodType.PUT
can have file parts.setFiles
in interface Request<MockRequest,MockResponse>
files
- the file parts, cannot be null.public MockRequest setEntity(Object entity)
Request
setEntity
in interface Request<MockRequest,MockResponse>
entity
- the request entity to be marshalled, not nullpublic MockRequest setRequestContentType(String contentType)
public MockRequest addRequestParameters(String... params)
Request
Request.MethodType.POST
can have parameters.
For other requests include parameters in url. This method accepts an even number of arguments, in form of name, value, name, value, name, value, etcaddRequestParameters
in interface Request<MockRequest,MockResponse>
params
- parameters of the request in as name, value pairspublic MockRequest addHeader(String headerName, String headerValue)
Request
addHeader
in interface Request<MockRequest,MockResponse>
headerName
- the header's nameheaderValue
- the header's valueRequestFactory.supportsHeader()
public MockRequest setHeader(String headerName, String headerValue)
Request
setHeader
in interface Request<MockRequest,MockResponse>
headerName
- the header's nameheaderValue
- the header's valueRequestFactory.supportsHeader()
public MockRequest setFollowRedirects(boolean follow)
Request
setFollowRedirects
in interface Request<MockRequest,MockResponse>
follow
- set this to false to have the request not transparently follow redirects.public MockRequest addBasicAuthentication(String host, String username, String password)
Request
addBasicAuthentication
in interface Request<MockRequest,MockResponse>
username
- The user namepassword
- The passwordpublic <RET> RET executeAndReturn(ReturningResponseHandler<? super MockResponse,RET> responseHandler) throws ResponseException
Request
executeAndReturn
in interface Request<MockRequest,MockResponse>
responseHandler
- Callback handler of the response.ResponseProtocolException
- If the server returned a malformed responseResponseTimeoutException
- If a connection timeout or read timeout occurredResponseTransportException
- If an I/O error occurred in request transportResponseException
- For all errors not otherwise specifiedpublic void execute(ResponseHandler<? super MockResponse> responseHandler) throws ResponseException
Request
execute
in interface Request<MockRequest,MockResponse>
responseHandler
- Callback handler of the response.ResponseProtocolException
- If the server returned a malformed responseResponseTimeoutException
- If a connection timeout or read timeout occurredResponseTransportException
- If an I/O error occurred in request transportResponseException
- For all errors not otherwise specifiedpublic String execute() throws ResponseException
Request
Response.getResponseBodyAsString()
execute
in interface Request<MockRequest,MockResponse>
ResponseStatusException
- If the server returned a response that contained an error codeResponseProtocolException
- If the server returned a malformed responseResponseTimeoutException
- If a connection timeout or read timeout occurredResponseTransportException
- If an I/O error occurred in request transportResponseException
- For all errors not otherwise specifiedpublic Request.MethodType getMethodType()
public String getUrl()
public int getConnectionTimeout()
public int getSoTimeout()
public String getRequestBody()
public String getRequestContentType()
public Map<String,List<String>> getHeaders()
getHeaders
in interface Request<MockRequest,MockResponse>
public String getBasicHost()
public String getBasicUser()
public String getBasicPassword()
public Response getResponse()
public void setResponse(MockResponse response)
public void setResponseBody(String responseBody)
Copyright © 2015 Atlassian. All rights reserved.