com.atlassian.sal.core.net
Class HttpClientRequest

java.lang.Object
  com.atlassian.sal.core.net.HttpClientRequest

All Implemented Interfaces:

Request<HttpClientRequest,HttpClientResponse>

public class HttpClientRequest
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

static int

MAX_REDIRECTS

Constructor Summary

HttpClientRequest(org.apache.commons.httpclient.HttpClient httpClient, Request.MethodType methodType, String url, CertificateFactory certificateFactory, UserManager userManager)

Method Summary

HttpClientRequest	addAuthentication(Authenticator authenticator)
HttpClientRequest	addBasicAuthentication(String username, String password)
HttpClientRequest	addHeader(String headerName, String headerValue)
HttpClientRequest	addHeaders(String... params)
HttpClientRequest	addRequestParameters(String... params)
HttpClientRequest	addSeraphAuthentication(String username, String password)
HttpClientRequest	addTrustedTokenAuthentication()
HttpClientRequest	addTrustedTokenAuthentication(String username)
protected void	configureProxy() Configures the proxy for the underlying HttpClient.
String	execute()
void	execute(ResponseHandler<HttpClientResponse> responseHandler)
<E> E	executeAndReturn(ReturningResponseHandler<HttpClientResponse,E> httpClientResponseResponseHandler)
Map<String,List<String>>	getHeaders()
Request.MethodType	getMethodType()
protected org.apache.commons.httpclient.HttpMethod	makeMethod()
HttpClientRequest	setConnectionTimeout(int connectionTimeout)
HttpClientRequest	setEntity(Object entity)
HttpClientRequest	setFiles(List<RequestFilePart> files)
HttpClientRequest	setFollowRedirects(boolean follow)
HttpClientRequest	setHeader(String headerName, String headerValue)
HttpClientRequest	setRequestBody(String requestBody)
HttpClientRequest	setRequestContentType(String requestContentType)
HttpClientRequest	setSoTimeout(int soTimeout)
HttpClientRequest	setUrl(String url)
static void	shutdownStream(InputStream input) Unconditionally close an InputStream.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REDIRECTS

public static final int MAX_REDIRECTS

See Also:

Constant Field Values

Constructor Detail

HttpClientRequest

public HttpClientRequest(org.apache.commons.httpclient.HttpClient httpClient,
                         Request.MethodType methodType,
                         String url,
                         CertificateFactory certificateFactory,
                         UserManager userManager)

Method Detail

setUrl

public HttpClientRequest setUrl(String url)

Specified by:

setUrl in interface Request<HttpClientRequest,HttpClientResponse>

addAuthentication

public HttpClientRequest addAuthentication(Authenticator authenticator)

Specified by:

addAuthentication in interface Request<HttpClientRequest,HttpClientResponse>

addTrustedTokenAuthentication

public HttpClientRequest addTrustedTokenAuthentication()

Specified by:

addTrustedTokenAuthentication in interface Request<HttpClientRequest,HttpClientResponse>

addTrustedTokenAuthentication

public HttpClientRequest addTrustedTokenAuthentication(String username)

Specified by:

addTrustedTokenAuthentication in interface Request<HttpClientRequest,HttpClientResponse>

addBasicAuthentication

public HttpClientRequest addBasicAuthentication(String username,
                                                String password)

Specified by:

addBasicAuthentication in interface Request<HttpClientRequest,HttpClientResponse>

addSeraphAuthentication

public HttpClientRequest addSeraphAuthentication(String username,
                                                 String password)

Specified by:

addSeraphAuthentication in interface Request<HttpClientRequest,HttpClientResponse>

setConnectionTimeout

public HttpClientRequest setConnectionTimeout(int connectionTimeout)

Specified by:

setConnectionTimeout in interface Request<HttpClientRequest,HttpClientResponse>

setSoTimeout

public HttpClientRequest setSoTimeout(int soTimeout)

Specified by:

setSoTimeout in interface Request<HttpClientRequest,HttpClientResponse>

setRequestBody

public HttpClientRequest setRequestBody(String requestBody)

Specified by:

setRequestBody in interface Request<HttpClientRequest,HttpClientResponse>

setFiles

public HttpClientRequest setFiles(List<RequestFilePart> files)

Specified by:

setFiles in interface Request<HttpClientRequest,HttpClientResponse>

setEntity

public HttpClientRequest setEntity(Object entity)

Specified by:

setEntity in interface Request<HttpClientRequest,HttpClientResponse>

setRequestContentType

public HttpClientRequest setRequestContentType(String requestContentType)

Specified by:

setRequestContentType in interface Request<HttpClientRequest,HttpClientResponse>

addRequestParameters

public HttpClientRequest addRequestParameters(String... params)

Specified by:

addRequestParameters in interface Request<HttpClientRequest,HttpClientResponse>

addHeader

public HttpClientRequest addHeader(String headerName,
                                   String headerValue)

Specified by:

addHeader in interface Request<HttpClientRequest,HttpClientResponse>

setHeader

public HttpClientRequest setHeader(String headerName,
                                   String headerValue)

Specified by:

setHeader in interface Request<HttpClientRequest,HttpClientResponse>

setFollowRedirects

public HttpClientRequest setFollowRedirects(boolean follow)

Specified by:

setFollowRedirects in interface Request<HttpClientRequest,HttpClientResponse>

addHeaders

public HttpClientRequest addHeaders(String... params)

executeAndReturn

public <E> E executeAndReturn(ReturningResponseHandler<HttpClientResponse,E> httpClientResponseResponseHandler)
                   throws ResponseException

Specified by:

executeAndReturn in interface Request<HttpClientRequest,HttpClientResponse>

Throws:

ResponseException

execute

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

Specified by:

execute in interface Request<HttpClientRequest,HttpClientResponse>

Throws:

ResponseException

shutdownStream

public static void shutdownStream(InputStream input)

Unconditionally close an InputStream. Equivalent to InputStream.close(), except any exceptions will be ignored.

Parameters:

input - A (possibly null) InputStream

execute

public String execute()
               throws ResponseException

Specified by:

execute in interface Request<HttpClientRequest,HttpClientResponse>

Throws:

ResponseException

makeMethod

protected org.apache.commons.httpclient.HttpMethod makeMethod()

configureProxy

protected void configureProxy()

Configures the proxy for the underlying HttpClient.

getHeaders

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

Specified by:

getHeaders in interface Request<HttpClientRequest,HttpClientResponse>

getMethodType

public Request.MethodType getMethodType()

toString

public String toString()

Overrides:

toString in class Object