com.atlassian.sal.core.net

Class HttpClientRequest<T extends Request<?,?>,RESP extends Response>

java.lang.Object

com.atlassian.sal.core.net.HttpClientRequest<T,RESP>

All Implemented Interfaces:

Request<HttpClientRequest<?,?>,HttpClientResponse>

Direct Known Subclasses:

HttpClientTrustedRequest

public class HttpClientRequest<T extends Request<?,?>,RESP extends Response>
extends Object
implements Request<HttpClientRequest<?,?>,HttpClientResponse>

HttpClient implementation of Request interface

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.sal.api.net.Request

Request.MethodType

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.protocol.HttpClientContext	httpClientContext

Constructor Summary

Constructors

Constructor and Description
HttpClientRequest(org.apache.http.impl.client.CloseableHttpClient httpClient, org.apache.http.client.protocol.HttpClientContext httpClientContext, Request.MethodType initialMethodType, String initialUrl)

Method Summary

Methods

Modifier and Type	Method and Description
HttpClientRequest	addBasicAuthentication(String hostname, String username, String password) Adds basic authentication to the request.
HttpClientRequest	addHeader(String headerName, String headerValue) Adds the specified header to the request, not overwriting any previous value.
HttpClientRequest	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 HttpClientResponse> responseHandler) Executes the request.
<RET> RET	executeAndReturn(ReturningResponseHandler<? super HttpClientResponse,RET> responseHandler) Executes the request and returns a result value.
Map<String,List<String>>	getHeaders()
HttpClientRequest	setConnectionTimeout(int connectionTimeout) Setting connection timeout in milliseconds.
HttpClientRequest	setEntity(Object entity) Set an entity as the request body
HttpClientRequest	setFiles(List<RequestFilePart> requestBodyFiles) Sets file parts of the request.
HttpClientRequest	setFollowRedirects(boolean follow) Sets whether the request should transparently follow a redirect from the server.
HttpClientRequest	setHeader(String headerName, String headerValue) Sets the specified header to the request, overwriting any previous value.
HttpClientRequest	setRequestBody(String requestBody) Sets the body of the request.
HttpClientRequest	setRequestBody(String requestBodyString, String contentTypeString) Sets the body of the request.
HttpClientRequest	setSoTimeout(int soTimeout) Setting socket timeout in milliseconds.
HttpClientRequest	setUrl(String url)

Methods inherited from class java.lang.Object

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

Field Detail

httpClientContext

protected final org.apache.http.client.protocol.HttpClientContext httpClientContext

Constructor Detail

HttpClientRequest

public HttpClientRequest(org.apache.http.impl.client.CloseableHttpClient httpClient,
                 org.apache.http.client.protocol.HttpClientContext httpClientContext,
                 Request.MethodType initialMethodType,
                 String initialUrl)

Method Detail

execute

public String execute()
               throws ResponseException

Description copied from interface: Request

Executes a request and if response is successful, returns response as a string. @see Response.getResponseBodyAsString()

Specified by:

execute in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Returns:

response as String

Throws:

ResponseStatusException - If the server returned a response that contained an error code

ResponseProtocolException - If the server returned a malformed response

ResponseTimeoutException - If a connection timeout or read timeout occurred

ResponseTransportException - If an I/O error occurred in request transport

ResponseException - For all errors not otherwise specified

execute

public void execute(ResponseHandler<? super HttpClientResponse> responseHandler)
             throws ResponseException

Description copied from interface: Request

Executes the request.

Specified by:

execute in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

responseHandler - Callback handler of the response.

Throws:

ResponseProtocolException - If the server returned a malformed response

ResponseTimeoutException - If a connection timeout or read timeout occurred

ResponseTransportException - If an I/O error occurred in request transport

ResponseException - For all errors not otherwise specified

executeAndReturn

public <RET> RET executeAndReturn(ReturningResponseHandler<? super HttpClientResponse,RET> responseHandler)
                     throws ResponseException

Description copied from interface: Request

Executes the request and returns a result value.

Specified by:

executeAndReturn in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

responseHandler - Callback handler of the response.

Throws:

ResponseProtocolException - If the server returned a malformed response

ResponseTimeoutException - If a connection timeout or read timeout occurred

ResponseTransportException - If an I/O error occurred in request transport

ResponseException - For all errors not otherwise specified

getHeaders

public Map<String,List<String>> getHeaders()

Specified by:

getHeaders in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Returns:

an immutable Map of headers added to the request so far

addBasicAuthentication

public HttpClientRequest addBasicAuthentication(String hostname,
                                       String username,
                                       String password)

Description copied from interface: Request

Adds basic authentication to the request.

Specified by:

addBasicAuthentication in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

username - The user name

password - The password

Returns:

a reference to this object.

setConnectionTimeout

public HttpClientRequest setConnectionTimeout(int connectionTimeout)

Description copied from interface: Request

Setting connection timeout in milliseconds.

Specified by:

setConnectionTimeout in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

connectionTimeout - The timeout in milliseconds

Returns:

a reference to this object.

setSoTimeout

public HttpClientRequest setSoTimeout(int soTimeout)

Description copied from interface: Request

Setting socket timeout in milliseconds.

Specified by:

setSoTimeout in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

soTimeout - the timeout in milliseconds

Returns:

a reference to this object.

setUrl

public HttpClientRequest setUrl(String url)

Specified by:

setUrl in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

url - the url to request

Returns:

a reference to this object.

setRequestBody

public HttpClientRequest setRequestBody(String requestBody)

Description copied from interface: Request

Sets the body of the request. In default implementation only requests of type Request.MethodType.POST and Request.MethodType.PUT can have a request body.

Specified by:

setRequestBody in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

requestBody - the body of the request

Returns:

a reference to this object.

setRequestBody

public HttpClientRequest setRequestBody(String requestBodyString,
                               String contentTypeString)

Description copied from interface: Request

Sets the body of the request. In default implementation only requests of type Request.MethodType.POST and Request.MethodType.PUT can have a request body.

Specified by:

setRequestBody in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

requestBodyString - the body of the request

contentTypeString - the contentType of the request

Returns:

a reference to this object.

setFiles

public HttpClientRequest setFiles(List<RequestFilePart> requestBodyFiles)

Description copied from interface: Request

Sets file parts of the request. File parts can only be added if the request body is empty. Only requests of type Request.MethodType.POST and Request.MethodType.PUT can have file parts.

Specified by:

setFiles in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

requestBodyFiles - the file parts, cannot be null.

Returns:

a reference to this object.

addRequestParameters

public HttpClientRequest addRequestParameters(String... params)

Description copied from interface: Request

Sets parameters of the request. In default implementation only requests of type 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, etc

Specified by:

addRequestParameters in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

params - parameters of the request in as name, value pairs

Returns:

a reference to this object.

addHeader

public HttpClientRequest addHeader(String headerName,
                          String headerValue)

Description copied from interface: Request

Adds the specified header to the request, not overwriting any previous value. Support for this operation is optional.

Specified by:

addHeader in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

headerName - the header's name

headerValue - the header's value

Returns:

a reference to this object

See Also:

RequestFactory.supportsHeader()

setHeader

public HttpClientRequest setHeader(String headerName,
                          String headerValue)

Description copied from interface: Request

Sets the specified header to the request, overwriting any previous value. Support for this operation is optional.

Specified by:

setHeader in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

headerName - the header's name

headerValue - the header's value

Returns:

a reference to this object

See Also:

RequestFactory.supportsHeader()

setFollowRedirects

public HttpClientRequest setFollowRedirects(boolean follow)

Description copied from interface: Request

Sets whether the request should transparently follow a redirect from the server. The default behavior is that when a response is received with a status code in the 300s, a new request is made using the location header of the response without notifying the client. Set this to false to turn this behavior off.

Specified by:

setFollowRedirects in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

follow - set this to false to have the request not transparently follow redirects.

Returns:

a reference to this object.

setEntity

public HttpClientRequest setEntity(Object entity)

Description copied from interface: Request

Set an entity as the request body

Specified by:

setEntity in interface Request<HttpClientRequest<?,?>,HttpClientResponse>

Parameters:

entity - the request entity to be marshalled, not null

Returns:

this Request object