com.gooddata.http.client

Class GoodDataHttpClient

java.lang.Object

com.gooddata.http.client.GoodDataHttpClient

All Implemented Interfaces:

org.apache.http.client.HttpClient

public class GoodDataHttpClient
extends Object
implements org.apache.http.client.HttpClient

Http client with ability to handle GoodData authentication.

Usage

Authentication using login

 // create HTTP client with your settings
 HttpClient httpClient = HttpClientBuilder.create().build();

 // create login strategy, which wil obtain SST via login
 SSTRetrievalStrategy sstStrategy = new LoginSSTRetrievalStrategy("user@domain.com", "my secret");

 // wrap your HTTP client into GoodData HTTP client
 HttpClient client = new GoodDataHttpClient(httpClient, new HttpHost("server.com", 123), sstStrategy);

 // use GoodData HTTP client
 HttpGet getProject = new HttpGet("/gdc/projects");
 getProject.addHeader("Accept", ContentType.APPLICATION_JSON.getMimeType());
 HttpResponse getProjectResponse = client.execute(httpHost, getProject);
 

Authentication using super-secure token (SST)

 // create HTTP client
 HttpClient httpClient = ...

 // create login strategy (you must somehow obtain SST)
 SSTRetrievalStrategy sstStrategy = new SimpleSSTRetrievalStrategy("my super-secure token");

 // wrap your HTTP client into GoodData HTTP client
 HttpClient client = new GoodDataHttpClient(httpClient, new HttpHost("server.com", 123), sstStrategy);

 // use GoodData HTTP client
 HttpGet getProject = new HttpGet("/gdc/projects");
 getProject.addHeader("Accept", ContentType.APPLICATION_JSON.getMimeType());
 HttpResponse getProjectResponse = client.execute(httpHost, getProject);
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	COOKIE_GDC_AUTH_SST
static String	COOKIE_GDC_AUTH_TT

Constructor Summary

Constructors

Constructor and Description
GoodDataHttpClient(org.apache.http.client.HttpClient httpClient, org.apache.http.HttpHost authHost, SSTRetrievalStrategy sstStrategy) Construct object.
GoodDataHttpClient(org.apache.http.client.HttpClient httpClient, SSTRetrievalStrategy sstStrategy) Deprecated. use GoodDataHttpClient(HttpClient, HttpHost, SSTRetrievalStrategy)
GoodDataHttpClient(org.apache.http.HttpHost authHost, SSTRetrievalStrategy sstStrategy) Construct object.
GoodDataHttpClient(SSTRetrievalStrategy sstStrategy) Deprecated. use GoodDataHttpClient(HttpHost, SSTRetrievalStrategy)

Method Summary

Modifier and Type	Method and Description
org.apache.http.HttpResponse	execute(org.apache.http.HttpHost target, org.apache.http.HttpRequest request)
org.apache.http.HttpResponse	execute(org.apache.http.HttpHost target, org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context)
<T> T	execute(org.apache.http.HttpHost target, org.apache.http.HttpRequest request, org.apache.http.client.ResponseHandler<? extends T> responseHandler)
<T> T	execute(org.apache.http.HttpHost target, org.apache.http.HttpRequest request, org.apache.http.client.ResponseHandler<? extends T> responseHandler, org.apache.http.protocol.HttpContext context)
org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpUriRequest request)
org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpUriRequest request, org.apache.http.protocol.HttpContext context)
<T> T	execute(org.apache.http.client.methods.HttpUriRequest request, org.apache.http.client.ResponseHandler<? extends T> responseHandler)
<T> T	execute(org.apache.http.client.methods.HttpUriRequest request, org.apache.http.client.ResponseHandler<? extends T> responseHandler, org.apache.http.protocol.HttpContext context)
org.apache.http.conn.ClientConnectionManager	getConnectionManager()
org.apache.http.params.HttpParams	getParams()

Methods inherited from class java.lang.Object

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

Field Detail

COOKIE_GDC_AUTH_TT

public static final String COOKIE_GDC_AUTH_TT

See Also:

Constant Field Values

COOKIE_GDC_AUTH_SST

public static final String COOKIE_GDC_AUTH_SST

See Also:

Constant Field Values

Constructor Detail

GoodDataHttpClient

@Deprecated
public GoodDataHttpClient(org.apache.http.client.HttpClient httpClient,
                                      SSTRetrievalStrategy sstStrategy)

Deprecated. use GoodDataHttpClient(HttpClient, HttpHost, SSTRetrievalStrategy)

Construct object.

Parameters:

httpClient - Http client

sstStrategy - super-secure token (SST) obtaining strategy

Throws:

IllegalArgumentException - if sstStrategy argument is not an instance of LoginSSTRetrievalStrategy

GoodDataHttpClient

@Deprecated
public GoodDataHttpClient(SSTRetrievalStrategy sstStrategy)

Deprecated. use GoodDataHttpClient(HttpHost, SSTRetrievalStrategy)

Construct object.

Parameters:

sstStrategy - super-secure token (SST) obtaining strategy

GoodDataHttpClient

public GoodDataHttpClient(org.apache.http.client.HttpClient httpClient,
                          org.apache.http.HttpHost authHost,
                          SSTRetrievalStrategy sstStrategy)

Construct object.

Parameters:

httpClient - Http client

authHost - http host

sstStrategy - super-secure token (SST) obtaining strategy

GoodDataHttpClient

public GoodDataHttpClient(org.apache.http.HttpHost authHost,
                          SSTRetrievalStrategy sstStrategy)

Construct object.

Parameters:

authHost - http host

sstStrategy - super-secure token (SST) obtaining strategy

Method Detail

getParams

public org.apache.http.params.HttpParams getParams()

Specified by:

getParams in interface org.apache.http.client.HttpClient

getConnectionManager

public org.apache.http.conn.ClientConnectionManager getConnectionManager()

Specified by:

getConnectionManager in interface org.apache.http.client.HttpClient

execute

public org.apache.http.HttpResponse execute(org.apache.http.HttpHost target,
                                            org.apache.http.HttpRequest request)
                                     throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException

execute

public <T> T execute(org.apache.http.HttpHost target,
                     org.apache.http.HttpRequest request,
                     org.apache.http.client.ResponseHandler<? extends T> responseHandler)
              throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException

execute

public <T> T execute(org.apache.http.HttpHost target,
                     org.apache.http.HttpRequest request,
                     org.apache.http.client.ResponseHandler<? extends T> responseHandler,
                     org.apache.http.protocol.HttpContext context)
              throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException

execute

public org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpUriRequest request)
                                     throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException

execute

public org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpUriRequest request,
                                            org.apache.http.protocol.HttpContext context)
                                     throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException

execute

public <T> T execute(org.apache.http.client.methods.HttpUriRequest request,
                     org.apache.http.client.ResponseHandler<? extends T> responseHandler)
              throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException

execute

public <T> T execute(org.apache.http.client.methods.HttpUriRequest request,
                     org.apache.http.client.ResponseHandler<? extends T> responseHandler,
                     org.apache.http.protocol.HttpContext context)
              throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException

execute

public org.apache.http.HttpResponse execute(org.apache.http.HttpHost target,
                                            org.apache.http.HttpRequest request,
                                            org.apache.http.protocol.HttpContext context)
                                     throws IOException

Specified by:

execute in interface org.apache.http.client.HttpClient

Throws:

IOException