com.rallydev.rest.client

Class ApiKeyClient

java.lang.Object

org.apache.http.impl.client.AbstractHttpClient

org.apache.http.impl.client.DefaultHttpClient

com.rallydev.rest.client.HttpClient

com.rallydev.rest.client.ApiKeyClient

All Implemented Interfaces:

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

public class ApiKeyClient
extends HttpClient

A HttpClient which authenticates using an API Key.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	API_KEY_HEADER
protected String	apiKey

Fields inherited from class com.rallydev.rest.client.HttpClient

client, server, wsapiVersion

Constructor Summary

Constructors

Constructor and Description
ApiKeyClient(URI server, String apiKey) Construct a new client.

Method Summary

Modifier and Type	Method and Description
protected String	doRequest(org.apache.http.client.methods.HttpRequestBase request) Execute a request against the WSAPI

Methods inherited from class com.rallydev.rest.client.HttpClient

close, doDelete, doGet, doPost, doPut, executeRequest, getServer, getWsapiUrl, getWsapiVersion, setApplicationName, setApplicationVendor, setApplicationVersion, setClientCredentials, setProxy, setProxy, setWsapiVersion

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

apiKey

protected String apiKey

API_KEY_HEADER

protected static final String API_KEY_HEADER

See Also:

Constant Field Values

Constructor Detail

ApiKeyClient

public ApiKeyClient(URI server,
                    String apiKey)

Construct a new client.

Parameters:

server - the server to connect to

apiKey - the key to be used for authentication

Method Detail

doRequest

protected String doRequest(org.apache.http.client.methods.HttpRequestBase request)
                    throws IOException

Execute a request against the WSAPI

Overrides:

doRequest in class HttpClient

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