com.rallydev.rest.client

Class BasicAuthClient

java.lang.Object

org.apache.http.impl.client.AbstractHttpClient

org.apache.http.impl.client.DefaultHttpClient

com.rallydev.rest.client.HttpClient

com.rallydev.rest.client.BasicAuthClient

All Implemented Interfaces:

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

public class BasicAuthClient
extends HttpClient

A HttpClient which authenticates using basic authentication (username/password).

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.auth.Credentials	credentials
protected static String	SECURITY_ENDPOINT_DOES_NOT_EXIST
protected static String	SECURITY_TOKEN_KEY
protected static String	SECURITY_TOKEN_PARAM_KEY
protected String	securityToken

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

client, server, wsapiVersion

Constructor Summary

Constructors

Constructor and Description
BasicAuthClient(URI server, String userName, String password) Construct a new client.

Method Summary

Modifier and Type	Method and Description
protected void	attachSecurityInfo(org.apache.http.client.methods.HttpRequestBase request) Attach the security token parameter to the request.
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

SECURITY_ENDPOINT_DOES_NOT_EXIST

protected static final String SECURITY_ENDPOINT_DOES_NOT_EXIST

See Also:

Constant Field Values

SECURITY_TOKEN_PARAM_KEY

protected static final String SECURITY_TOKEN_PARAM_KEY

See Also:

Constant Field Values

SECURITY_TOKEN_KEY

protected static final String SECURITY_TOKEN_KEY

See Also:

Constant Field Values

securityToken

protected String securityToken

credentials

protected org.apache.http.auth.Credentials credentials

Constructor Detail

BasicAuthClient

public BasicAuthClient(URI server,
                       String userName,
                       String password)

Construct a new client.

Parameters:

server - the server to connect to

userName - the username to be used for authentication

password - the password 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

attachSecurityInfo

protected void attachSecurityInfo(org.apache.http.client.methods.HttpRequestBase request)
                           throws IOException,
                                  URISyntaxException

Attach the security token parameter to the request. Response Structure: {"OperationResult": {"SecurityToken": "UUID"}}

Parameters:

request - the request to be modified

Throws:

IOException - if a non-200 response code is returned or if some other problem occurs while executing the request

URISyntaxException - if there is a problem with the url in the request