HttpClient (Rally Rest Toolkit For Java 2.2.1 API)

java.lang.Object
- org.apache.http.impl.client.AbstractHttpClient
- - org.apache.http.impl.client.DefaultHttpClient
  - - com.rallydev.rest.client.HttpClient

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.http.client.HttpClient

Direct Known Subclasses:

ApiKeyClient, BasicAuthClient
```
public class HttpClient
extends org.apache.http.impl.client.DefaultHttpClient
implements Closeable
```
A HttpClient implementation providing connectivity to Rally. This class does not provide any authentication on its own but instead relies on a concrete subclass to do so.

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.http.impl.client.DecompressingHttpClient client

protected URI server

protected String wsapiVersion

Fields
Modifier and Type	Field and Description
`protected org.apache.http.impl.client.DecompressingHttpClient`	`client`
`protected URI`	`server`
`protected String`	`wsapiVersion`

Constructor Summary

Constructors
Modifier Constructor and Description

protected HttpClient(URI server)

Constructors
Modifier	Constructor and Description
`protected`	`HttpClient(URI server)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Release all resources associated with this instance.
`String`	`doDelete(String url)` Perform a delete against the WSAPI
`String`	`doGet(String url)` Perform a get against the WSAPI
`String`	`doPost(String url, String body)` Perform a post against the WSAPI
`String`	`doPut(String url, String body)` Perform a put against the WSAPI
`protected String`	`doRequest(org.apache.http.client.methods.HttpRequestBase request)` Execute a request against the WSAPI
`protected String`	`executeRequest(org.apache.http.client.methods.HttpRequestBase request)` Execute a request against the WSAPI
`String`	`getServer()` Get the current server being targeted.
`String`	`getWsapiUrl()` Get the WSAPI base url based on the current server and WSAPI version
`String`	`getWsapiVersion()` Get the current version of the WSAPI being targeted.
`void`	`setApplicationName(String value)` Set the value of the X-RallyIntegrationName header included on all requests.
`void`	`setApplicationVendor(String value)` Set the value of the X-RallyIntegrationVendor header included on all requests.
`void`	`setApplicationVersion(String value)` Set the value of the X-RallyIntegrationVersion header included on all requests.
`protected org.apache.http.auth.Credentials`	`setClientCredentials(URI server, String userName, String password)`
`void`	`setProxy(URI proxy)` Set the unauthenticated proxy server to use.
`void`	`setProxy(URI proxy, String userName, String password)` Set the authenticated proxy server to use.
`void`	`setWsapiVersion(String wsapiVersion)` Set the current version of the WSAPI being targeted.

Methods inherited from class org.apache.http.impl.client.DefaultHttpClient
createHttpParams, createHttpProcessor, setDefaultHttpParams

Methods inherited from class org.apache.http.impl.client.AbstractHttpClient
addRequestInterceptor, addRequestInterceptor, addResponseInterceptor, addResponseInterceptor, clearRequestInterceptors, clearResponseInterceptors, createAuthSchemeRegistry, createClientConnectionManager, createClientRequestDirector, createClientRequestDirector, createClientRequestDirector, createConnectionKeepAliveStrategy, createConnectionReuseStrategy, createCookieSpecRegistry, createCookieStore, createCredentialsProvider, createHttpContext, createHttpRequestRetryHandler, createHttpRoutePlanner, createProxyAuthenticationHandler, createProxyAuthenticationStrategy, createRedirectHandler, createRequestExecutor, createTargetAuthenticationHandler, createTargetAuthenticationStrategy, createUserTokenHandler, determineParams, execute, execute, execute, execute, execute, execute, execute, execute, getAuthSchemes, getBackoffManager, getConnectionBackoffStrategy, getConnectionKeepAliveStrategy, getConnectionManager, getConnectionReuseStrategy, getCookieSpecs, getCookieStore, getCredentialsProvider, getHttpProcessor, getHttpRequestRetryHandler, getParams, getProxyAuthenticationHandler, getProxyAuthenticationStrategy, getRedirectHandler, getRedirectStrategy, getRequestExecutor, getRequestInterceptor, getRequestInterceptorCount, getResponseInterceptor, getResponseInterceptorCount, getRoutePlanner, getTargetAuthenticationHandler, getTargetAuthenticationStrategy, getUserTokenHandler, removeRequestInterceptorByClass, removeResponseInterceptorByClass, setAuthSchemes, setBackoffManager, setConnectionBackoffStrategy, setCookieSpecs, setCookieStore, setCredentialsProvider, setHttpRequestRetryHandler, setKeepAliveStrategy, setParams, setProxyAuthenticationHandler, setProxyAuthenticationStrategy, setRedirectHandler, setRedirectStrategy, setReuseStrategy, setRoutePlanner, setTargetAuthenticationHandler, setTargetAuthenticationStrategy, setUserTokenHandler

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - server
```
protected URI server
```
  - wsapiVersion
```
protected String wsapiVersion
```
  - client
```
protected org.apache.http.impl.client.DecompressingHttpClient client
```
- Constructor Detail
  - HttpClient
```
protected HttpClient(URI server)
```
- Method Detail
  - setProxy
```
public void setProxy(URI proxy)
```
    Set the unauthenticated proxy server to use. By default no proxy is configured.
    
    Parameters:
    
    proxy - The proxy server, e.g. new URI("http://my.proxy.com:8000")
  - setProxy
```
public void setProxy(URI proxy,
                     String userName,
                     String password)
```
    Set the authenticated proxy server to use. By default no proxy is configured.
    
    Parameters:
    
    proxy - The proxy server, e.g. new URI("http://my.proxy.com:8000")
    
    userName - The username to be used for authentication.
    
    password - The password to be used for authentication.
  - setApplicationVendor
```
public void setApplicationVendor(String value)
```
    Set the value of the X-RallyIntegrationVendor header included on all requests. This should be set to your company name.
    
    Parameters:
    
    value - The vendor header to be included on all requests.
  - setApplicationVersion
```
public void setApplicationVersion(String value)
```
    Set the value of the X-RallyIntegrationVersion header included on all requests. This should be set to the version of your application.
    
    Parameters:
    
    value - The vendor header to be included on all requests.
  - setApplicationName
```
public void setApplicationName(String value)
```
    Set the value of the X-RallyIntegrationName header included on all requests. This should be set to the name of your application.
    
    Parameters:
    
    value - The vendor header to be included on all requests.
  - getServer
```
public String getServer()
```
    Get the current server being targeted.
    
    Returns:
    
    the current server.
  - getWsapiVersion
```
public String getWsapiVersion()
```
    Get the current version of the WSAPI being targeted.
    
    Returns:
    
    the current WSAPI version.
  - setWsapiVersion
```
public void setWsapiVersion(String wsapiVersion)
```
    Set the current version of the WSAPI being targeted.
    
    Parameters:
    
    wsapiVersion - the new version, e.g. "1.30"
  - doRequest
```
protected String doRequest(org.apache.http.client.methods.HttpRequestBase request)
                    throws IOException
```
    Execute a request against the WSAPI
    
    Parameters:
    
    request - the request to be executed
    
    Returns:
    
    the JSON encoded string response
    
    Throws:
    
    IOException - if a non-200 response code is returned or if some other problem occurs while executing the request
  - executeRequest
```
protected String executeRequest(org.apache.http.client.methods.HttpRequestBase request)
                         throws IOException
```
    Execute a request against the WSAPI
    
    Parameters:
    
    request - the request to be executed
    
    Returns:
    
    the JSON encoded string response
    
    Throws:
    
    IOException - if a non-200 response code is returned or if some other problem occurs while executing the request
  - doPost
```
public String doPost(String url,
                     String body)
              throws IOException
```
    Perform a post against the WSAPI
    
    Parameters:
    
    url - the request url
    
    body - the body of the post
    
    Returns:
    
    the JSON encoded string response
    
    Throws:
    
    IOException - if a non-200 response code is returned or if some other problem occurs while executing the request
  - doPut
```
public String doPut(String url,
                    String body)
             throws IOException
```
    Perform a put against the WSAPI
    
    Parameters:
    
    url - the request url
    
    body - the body of the put
    
    Returns:
    
    the JSON encoded string response
    
    Throws:
    
    IOException - if a non-200 response code is returned or if some other problem occurs while executing the request
  - doDelete
```
public String doDelete(String url)
                throws IOException
```
    Perform a delete against the WSAPI
    
    Parameters:
    
    url - the request url
    
    Returns:
    
    the JSON encoded string response
    
    Throws:
    
    IOException - if a non-200 response code is returned or if some other problem occurs while executing the request
  - doGet
```
public String doGet(String url)
             throws IOException
```
    Perform a get against the WSAPI
    
    Parameters:
    
    url - the request url
    
    Returns:
    
    the JSON encoded string response
    
    Throws:
    
    IOException - if a non-200 response code is returned or if some other problem occurs while executing the request
  - close
```
public void close()
           throws IOException
```
    Release all resources associated with this instance.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - if an error occurs releasing resources
  - setClientCredentials
```
protected org.apache.http.auth.Credentials setClientCredentials(URI server,
                                                                String userName,
                                                                String password)
```
  - getWsapiUrl
```
public String getWsapiUrl()
```
    Get the WSAPI base url based on the current server and WSAPI version
    
    Returns:
    
    the fully qualified WSAPI base url, e.g. https://rally1.rallydev.com/slm/webservice/1.33

Class HttpClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.http.impl.client.DefaultHttpClient

Methods inherited from class org.apache.http.impl.client.AbstractHttpClient

Methods inherited from class java.lang.Object

Field Detail

server

wsapiVersion

client

Constructor Detail

HttpClient

Method Detail

setProxy

setProxy

setApplicationVendor

setApplicationVersion

setApplicationName

getServer

getWsapiVersion

setWsapiVersion

doRequest

executeRequest

doPost

doPut

doDelete

doGet

close

setClientCredentials

getWsapiUrl