com.gooddata

Class GoodData

java.lang.Object

com.gooddata.GoodData

public class GoodData
extends Object

Entry point for GoodData SDK usage.

Configure connection to GoodData using one of constructors. One can then get initialized service he needs from the newly constructed instance. This instance can be also used later for logout from GoodData Platform.

Usage example:

     GoodData gd = new GoodData("roman@gooddata.com", "Roman1");
     // do something useful like: gd.getSomeService().doSomething()
     gd.logout();
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	GDC_REQUEST_ID_HEADER

Constructor Summary

Constructors

Constructor and Description
GoodData(String login, String password) Create instance configured to communicate with GoodData Platform under user with given credentials.
GoodData(String hostname, String login, String password) Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
GoodData(String hostname, String login, String password, int port) Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.http.client.HttpClient	createHttpClient(String login, String password, String hostname, int port, String protocol, org.apache.http.impl.client.HttpClientBuilder builder)
AccountService	getAccountService() Get initialized service for account management (to get current account information, logout, ...)
ConnectorService	getConnectorService()
DatasetService	getDatasetService() Get initialized service for dataset management (to list manifest, get datasets, load dataset, ...)
DataStoreService	getDataStoreService() Get initialized service for data store (user staging/WebDAV) management (to upload, download, delete, ...)
GdcService	getGdcService() Get initialized service for API root management (to get API root links, ...)
MetadataService	getMetadataService() Get initialized service for metadata management (to query, create and update project metadata like attributes, facts, metrics, reports, ...)
ModelService	getModelService() Get initialized service for model management (to get model diff, update model, ...)
ProcessService	getProcessService()
ProjectService	getProjectService() Get initialized service for project management (to list projects, create a project, ...)
ReportService	getReportService() Get initialized service for report management (to execute and export report, ...)
WarehouseService	getWarehouseService() Get initialized service for ADS management (create, access and delete ads instances).
void	logout() Logout from GoodData Platform

Methods inherited from class java.lang.Object

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

Field Detail

GDC_REQUEST_ID_HEADER

public static final String GDC_REQUEST_ID_HEADER

See Also:

Constant Field Values

Constructor Detail

GoodData

public GoodData(String login,
        String password)

Create instance configured to communicate with GoodData Platform under user with given credentials.

Parameters:

login - GoodData user's login

password - GoodData user's password

GoodData

public GoodData(String hostname,
        String login,
        String password)

Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.

Parameters:

hostname - GoodData Platform's host name (e.g. secure.gooddata.com)

login - GoodData user's login

password - GoodData user's password

GoodData

public GoodData(String hostname,
        String login,
        String password,
        int port)

Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.

Parameters:

hostname - GoodData Platform's host name (e.g. secure.gooddata.com)

login - GoodData user's login

password - GoodData user's password

port - GoodData Platform's API port (e.g. 443)

Method Detail

createHttpClient

protected org.apache.http.client.HttpClient createHttpClient(String login,
                                                 String password,
                                                 String hostname,
                                                 int port,
                                                 String protocol,
                                                 org.apache.http.impl.client.HttpClientBuilder builder)

logout

public void logout()

Logout from GoodData Platform

getProjectService

public ProjectService getProjectService()

Get initialized service for project management (to list projects, create a project, ...)

Returns:

initialized service for project management

getAccountService

public AccountService getAccountService()

Get initialized service for account management (to get current account information, logout, ...)

Returns:

initialized service for account management

getMetadataService

public MetadataService getMetadataService()

Get initialized service for metadata management (to query, create and update project metadata like attributes, facts, metrics, reports, ...)

Returns:

initialized service for metadata management

getModelService

public ModelService getModelService()

Get initialized service for model management (to get model diff, update model, ...)

Returns:

initialized service for model management

getGdcService

public GdcService getGdcService()

Get initialized service for API root management (to get API root links, ...)

Returns:

initialized service for API root management

getDataStoreService

public DataStoreService getDataStoreService()

Get initialized service for data store (user staging/WebDAV) management (to upload, download, delete, ...)

Returns:

initialized service for data store management

getDatasetService

public DatasetService getDatasetService()

Get initialized service for dataset management (to list manifest, get datasets, load dataset, ...)

Returns:

initialized service for dataset management

getReportService

public ReportService getReportService()

Get initialized service for report management (to execute and export report, ...)

Returns:

initialized service for report management

getProcessService

public ProcessService getProcessService()

getWarehouseService

public WarehouseService getWarehouseService()

Get initialized service for ADS management (create, access and delete ads instances).

Returns:

initialized service for ADS management

getConnectorService

public ConnectorService getConnectorService()