com.gooddata.integration.rest

Class GdcRESTApiWrapper

java.lang.Object

com.gooddata.integration.rest.GdcRESTApiWrapper

public class GdcRESTApiWrapper
extends Object

The GoodData REST API Java wrapper.

Version:

1.0

Author:

Zdenek Svoboda

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GdcRESTApiWrapper.GdcRole
static class	GdcRESTApiWrapper.GdcUser
static class	GdcRESTApiWrapper.ProjectExportResult
static class	GdcRESTApiWrapper.TaskmanStatus

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_QUERY
protected org.apache.commons.httpclient.HttpClient	client
protected NamePasswordConfiguration	config
static String	DLI_MANIFEST_FILENAME
static String	DML_EXEC_URI
static String	ETL_MODE_DLI
static String	ETL_MODE_URI
static String	ETL_MODE_VOID
static String	EXECUTOR
static String	EXPORT_EXECUTOR
static String	INVITATION_URI
static String	LINKS_UPLOADS_KEY
static String	MAQL_ASYNC_EXEC_URI
static String	OBJ_URI
static String	PROJECT_EXPORT_URI
static String	PROJECT_IMPORT_URI
static String	PROJECT_PARTIAL_EXPORT_URI
static String	PROJECT_PARTIAL_IMPORT_URI
static String	QUERY_DATASETS
static String	QUERY_DIMENSIONS
static String	QUERY_FOLDERS
static String	QUERY_PREFIX
static String	QUERY_PROJECTDASHBOARDS
static String	REPORT_QUERY
static String	ROLES_URI
static String	USERS_URI

Constructor Summary

Constructors

Constructor and Description
GdcRESTApiWrapper(NamePasswordConfiguration config) Constructs the GoodData REST API Java wrapper

Method Summary

Modifier and Type	Method and Description
void	addUsersToProject(String projectId, List<String> uris, String role) Create a new user
void	addUsersToProjectWithRoleUri(String projectId, List<String> uris, String roleUri)
double	computeMetric(String metricUri) Computes the metric value
String	computeReport(String reportUri) Computes a simple report and returns the report text
net.sf.json.JSONObject	createMetadataObject(String projectId, net.sf.json.JSON content) Creates a new object in the metadata server
String	createProject(String name, String desc, String templateUri) Deprecated.
String	createProject(String name, String desc, String templateUri, String driver, String accessToken) Create a new GoodData project
String	createUser(String domain, GdcRESTApiWrapper.GdcUser user) Create a new user
void	deleteMetadataObject(String uri) Deletes an object in the metadata server
void	deleteMetadataObject(String projectId, int objectId) Deletes an object in the metadata server
void	disableUsersInProject(String projectId, List<String> uris) Disables a user in project
void	dropProject(String projectId) Drops a GoodData project
List<String>	enumerateAttributes(String projectId) Enumerates all attributes in the project
List<String>	enumerateDashboards(String projectId)
List<String>	enumerateDataSets(String projectId)
List<String>	enumerateDimensions(String projectId)
List<String>	enumerateFolders(String projectId)
List<String>	enumerateReports(String projectId) Enumerates all reports on in a project
protected List<String>	enumerateResource(String projectId, String resource)
String	executeDML(String projectId, String maql) Executes the MAQL and creates/modifies the project's LDM
void	executeMAQLAsync(String projectId, String maql) Executes the MAQL and creates/modifies the project's LDM asynchronously
protected String	executeMethodOk(org.apache.commons.httpclient.HttpMethod method)
protected String	executeMethodOk(org.apache.commons.httpclient.HttpMethod method, boolean reloginOn401)
net.sf.json.JSONObject	executeReport(String reportUri) Report to execute.
String	executeReportDefinition(String reportDefUri) Report definition to execute
GdcRESTApiWrapper.ProjectExportResult	exportMD(String projectId, List<Integer> ids) Exports selected MD object with dependencies from the project
GdcRESTApiWrapper.ProjectExportResult	exportMDByUrl(String projectId, List<String> urls)
GdcRESTApiWrapper.ProjectExportResult	exportProject(String projectId, boolean exportUsers, boolean exportData, String[] authorizedUsers) Exports the project
byte[]	exportReportResult(net.sf.json.JSONObject execResult, String format) Export a report result
protected void	finalize()
net.sf.json.JSONObject	getAttribute(String attrUri) Enumerates all attributes in the project
List<net.sf.json.JSONObject>	getAttributeFk(String attrUri) Gets attribute FK
List<net.sf.json.JSONObject>	getAttributePk(String attrUri) Gets attribute PK
String	getColumnDbName(net.sf.json.JSONObject column) Gets column DB name
String	getColumnTableName(net.sf.json.JSONObject column) Gets column table name
String	getCopyStatus(String link) Checks if report copying is finished.
GdcRESTApiWrapper.TaskmanStatus	getDetailedTaskManStatus(String link)
String	getLoadingStatus(String link) Checks if the loading is finished
protected net.sf.json.JSONObject	getMDExportStructureStrings(String projectId, List<String> urls)
MetadataObject	getMetadataObject(String objectUri) Retrieves a metadata object definition
MetadataObject	getMetadataObject(String projectId, int objectId) Retrieves a metadata object definition
MetadataObject	getMetadataObject(String projectId, String identifier) Retrieves a metadata object definition
protected net.sf.json.JSONObject	getMigrationRequest(List<String> manifests)
String	getMigrationStatus(String link) Checks if the migration is finished
NamePasswordConfiguration	getNamePasswordConfiguration()
net.sf.json.JSONObject	getObjectByUri(String objectUri) Retrieves a metadata object definition by Uri
protected net.sf.json.JSONObject	getProfile() Profile getter
Project	getProjectById(String id) Retrieves the project info by the project's ID
Project	getProjectByName(String name) Deprecated.
String	getProjectDeleteUri(String projectId) Gets the project delete URI from the project id
String	getProjectEtlMode(String pid) Determines the projet's ETL mode (SLI/DLI/VOID)
protected String	getProjectId(String uri) Retrieves the project id from the URI returned by the create project
String	getProjectIdFromUri(String projectUri) Gets the project ID from the project URI
protected String	getProjectMdUrl(String projectId) Constructs project's metadata uri
ArrayList<GdcRESTApiWrapper.GdcRole>	getProjectRoles(String pid) Returns the selected project's roles
String	getProjectStatus(String id) Returns the project status
protected String	getProjectUrl(String projectId) Constructs project's projects uri
ArrayList<GdcRESTApiWrapper.GdcUser>	getProjectUsers(String pid, boolean activeUsersOnly) Returns the selected project's users
String	getReportDefinition(String reportUri) Deprecated.
byte[]	getReportResult(String uri) Retrieves the report export result
ArrayList<String>	getRoleUsers(GdcRESTApiWrapper.GdcRole role, boolean activeUsersOnly) Returns the selected project's roles
protected String	getServerUrl()
static SLI	getSLIById(String id, List<SLI> slis, String projectId) Finds a project SLI in list of SLI
SLI	getSLIById(String id, String projectId) Finds a project SLI by it's id
String	getSLIColumnDataType(String projectId, String sliColumnIdentifier) Retrieves the SLI column data type
List<Column>	getSLIColumns(String uri) Retrieves the SLI columns
net.sf.json.JSONObject	getSLIManifest(String uri) Retrieves the SLI columns
List<SLI>	getSLIs(String projectId) Returns a list of project's SLIs
String	getSLIsUri(String projectId) Returns the data interfaces URI
String	getSLIUri(String sliId, String projectId) Returns the SLI URI
String	getTaskManStatus(String link) Checks if the migration is finished
Map<String,GdcRESTApiWrapper.GdcUser>	getUsers(String domain) API for querying users in a domain
URL	getWebDavURL()
Map<String,String>	identifierToUri(String projectId, String[] identifiers) Converst MD identifier to uri
String	importMD(String projectId, String token, boolean overwrite, boolean updateLDM) Imports a MD object to the project
String	importProject(String projectId, String token) Imports the project
void	inviteUser(String projectId, String eMail, String message) Invites a new user to a project
void	inviteUser(String projectId, String eMail, String message, String role) Invites a new user to a project
List<Project>	listProjects() Deprecated.
void	login() GDC login - obtain GDC SSToken
void	logout() GDC logout - remove active session, if any exists
String	migrateDataSets(String pid, List<String> manifests) Migrates project datasets from DLI to SLI
net.sf.json.JSONObject	modifyMetadataObject(String projectId, int objectId, net.sf.json.JSON content) Modifies an object in the metadata server
net.sf.json.JSONObject	modifyMetadataObject(String uri, net.sf.json.JSON content) Modifies an object in the metadata server
String	startLoading(String projectId, String remoteDir) Kicks the GDC platform to inform it that the FTP transfer is finished.
List<net.sf.json.JSONObject>	usedBy(String uri) Returns the dependent objects
List<net.sf.json.JSONObject>	using(String uri) Returns the dependent objects

Methods inherited from class java.lang.Object

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

Field Detail

MAQL_ASYNC_EXEC_URI

public static final String MAQL_ASYNC_EXEC_URI

See Also:

Constant Field Values

DML_EXEC_URI

public static final String DML_EXEC_URI

See Also:

Constant Field Values

PROJECT_EXPORT_URI

public static final String PROJECT_EXPORT_URI

See Also:

Constant Field Values

PROJECT_IMPORT_URI

public static final String PROJECT_IMPORT_URI

See Also:

Constant Field Values

PROJECT_PARTIAL_EXPORT_URI

public static final String PROJECT_PARTIAL_EXPORT_URI

See Also:

Constant Field Values

PROJECT_PARTIAL_IMPORT_URI

public static final String PROJECT_PARTIAL_IMPORT_URI

See Also:

Constant Field Values

REPORT_QUERY

public static final String REPORT_QUERY

See Also:

Constant Field Values

ATTR_QUERY

public static final String ATTR_QUERY

See Also:

Constant Field Values

EXECUTOR

public static final String EXECUTOR

See Also:

Constant Field Values

EXPORT_EXECUTOR

public static final String EXPORT_EXECUTOR

See Also:

Constant Field Values

INVITATION_URI

public static final String INVITATION_URI

See Also:

Constant Field Values

ETL_MODE_URI

public static final String ETL_MODE_URI

See Also:

Constant Field Values

OBJ_URI

public static final String OBJ_URI

See Also:

Constant Field Values

ROLES_URI

public static final String ROLES_URI

See Also:

Constant Field Values

USERS_URI

public static final String USERS_URI

See Also:

Constant Field Values

ETL_MODE_DLI

public static final String ETL_MODE_DLI

See Also:

Constant Field Values

ETL_MODE_VOID

public static final String ETL_MODE_VOID

See Also:

Constant Field Values

LINKS_UPLOADS_KEY

public static final String LINKS_UPLOADS_KEY

See Also:

Constant Field Values

DLI_MANIFEST_FILENAME

public static final String DLI_MANIFEST_FILENAME

See Also:

Constant Field Values

QUERY_PROJECTDASHBOARDS

public static final String QUERY_PROJECTDASHBOARDS

See Also:

Constant Field Values

QUERY_FOLDERS

public static final String QUERY_FOLDERS

See Also:

Constant Field Values

QUERY_DATASETS

public static final String QUERY_DATASETS

See Also:

Constant Field Values

QUERY_DIMENSIONS

public static final String QUERY_DIMENSIONS

See Also:

Constant Field Values

QUERY_PREFIX

public static final String QUERY_PREFIX

See Also:

Constant Field Values

client

protected org.apache.commons.httpclient.HttpClient client

config

protected NamePasswordConfiguration config

Constructor Detail

GdcRESTApiWrapper

public GdcRESTApiWrapper(NamePasswordConfiguration config)

Constructs the GoodData REST API Java wrapper

Parameters:

config - NamePasswordConfiguration object with the GDC name and password configuration

Method Detail

login

public void login()
           throws HttpMethodException

GDC login - obtain GDC SSToken

Throws:

HttpMethodException

logout

public void logout()
            throws HttpMethodException

GDC logout - remove active session, if any exists

Throws:

HttpMethodException

getProjectById

public Project getProjectById(String id)
                       throws HttpMethodException,
                              GdcProjectAccessException

Retrieves the project info by the project's ID

Parameters:

id - the project id

Returns:

the GoodDataProjectInfo populated with the project's information

Throws:

HttpMethodException

GdcProjectAccessException

getWebDavURL

public URL getWebDavURL()

Returns:

the WebDav URL from the platform configuration

getSLIs

public List<SLI> getSLIs(String projectId)
                  throws HttpMethodException,
                         GdcProjectAccessException

Returns a list of project's SLIs

Parameters:

projectId - project's ID

Returns:

a list of project's SLIs

Throws:

HttpMethodException - if there is a communication error

GdcProjectAccessException - if the SLI doesn't exist

getSLIColumns

public List<Column> getSLIColumns(String uri)
                           throws GdcProjectAccessException,
                                  HttpMethodException

Retrieves the SLI columns

Parameters:

uri - the SLI uri

Returns:

list of SLI columns

Throws:

GdcProjectAccessException - if the SLI doesn't exist

HttpMethodException - if there is a communication issue with the GDC platform

getSLIColumnDataType

public String getSLIColumnDataType(String projectId,
                                   String sliColumnIdentifier)

Retrieves the SLI column data type

Parameters:

projectId - projectId

sliColumnIdentifier - SLI column identifier (name in the SLI manifest)

Returns:

the SLI column datatype

getSLIManifest

public net.sf.json.JSONObject getSLIManifest(String uri)
                                      throws GdcProjectAccessException,
                                             HttpMethodException

Retrieves the SLI columns

Parameters:

uri - the SLI uri

Returns:

JSON manifest

Throws:

GdcProjectAccessException - if the SLI doesn't exist

HttpMethodException - if there is a communication issue with the GDC platform

getSLIById

public SLI getSLIById(String id,
                      String projectId)
               throws GdcProjectAccessException,
                      HttpMethodException

Finds a project SLI by it's id

Parameters:

id - the SLI id

projectId - the project id

Returns:

the SLI

Throws:

GdcProjectAccessException - if the SLI doesn't exist

HttpMethodException - if there is a communication issue with the GDC platform

getSLIById

public static SLI getSLIById(String id,
                             List<SLI> slis,
                             String projectId)
                      throws GdcProjectAccessException

Finds a project SLI in list of SLI

Parameters:

id - the SLI id

slis - of SLI (related to one project)

projectId - the project id

Returns:

the SLI

Throws:

GdcProjectAccessException - if the SLI doesn't exist

enumerateAttributes

public List<String> enumerateAttributes(String projectId)

Enumerates all attributes in the project

Parameters:

projectId - project Id

Returns:

LIst of attr uris

getAttributePk

public List<net.sf.json.JSONObject> getAttributePk(String attrUri)

Gets attribute PK

Parameters:

attrUri - attribute URI

Returns:

list of attribute PKs (columns)

getAttributeFk

public List<net.sf.json.JSONObject> getAttributeFk(String attrUri)

Gets attribute FK

Parameters:

attrUri - attribute URI

Returns:

list of attribute FKs (columns)

getColumnDbName

public String getColumnDbName(net.sf.json.JSONObject column)

Gets column DB name

Parameters:

column - column object

Returns:

column DB name

getColumnTableName

public String getColumnTableName(net.sf.json.JSONObject column)

Gets column table name

Parameters:

column - column object

Returns:

column table name

getAttribute

public net.sf.json.JSONObject getAttribute(String attrUri)

Enumerates all attributes in the project

Parameters:

attrUri - attribute URI

Returns:

attribute object

enumerateReports

public List<String> enumerateReports(String projectId)

Enumerates all reports on in a project

Parameters:

projectId - project Id

Returns:

LIst of report uris

computeMetric

public double computeMetric(String metricUri)

Computes the metric value

Parameters:

metricUri - metric URI

Returns:

the metric value

computeReport

public String computeReport(String reportUri)

Computes a simple report and returns the report text

Parameters:

reportUri - report URI

Returns:

the report rendered in text

executeReportDefinition

public String executeReportDefinition(String reportDefUri)

Report definition to execute

Parameters:

reportDefUri - report definition to execute

executeReport

public net.sf.json.JSONObject executeReport(String reportUri)

Report to execute.

Parameters:

reportUri - report definition to execute

Returns:

JSON representation of the report result (the "execResult" object including the "execResult" root key)

exportReportResult

public byte[] exportReportResult(net.sf.json.JSONObject execResult,
                                 String format)

Export a report result

Parameters:

execResult - object returned by the executeReport(String) method

format - export format (pdf | xls | png | csv)

getReportResult

public byte[] getReportResult(String uri)

Retrieves the report export result

Parameters:

uri - the export result

Returns:

attribute object

startLoading

public String startLoading(String projectId,
                           String remoteDir)
                    throws GdcRestApiException

Kicks the GDC platform to inform it that the FTP transfer is finished.

Parameters:

projectId - the project's ID

remoteDir - the remote (FTP) directory that contains the data

Returns:

the link that is used for polling the loading progress

Throws:

GdcRestApiException

getLoadingStatus

public String getLoadingStatus(String link)
                        throws HttpMethodException

Checks if the loading is finished

Parameters:

link - the link returned from the start loading

Returns:

the loading status

Throws:

HttpMethodException

createProject

public String createProject(String name,
                            String desc,
                            String templateUri,
                            String driver,
                            String accessToken)
                     throws GdcRestApiException

Create a new GoodData project

Parameters:

name - project name

desc - project description

templateUri - project template uri

driver - underlying database driver

accessToken - access token

Returns:

the project Id

Throws:

GdcRestApiException

getProjectStatus

public String getProjectStatus(String id)

Returns the project status

Parameters:

id - project ID

Returns:

current project status

dropProject

public void dropProject(String projectId)
                 throws GdcRestApiException

Drops a GoodData project

Parameters:

projectId - project id

Throws:

GdcRestApiException

getProjectId

protected String getProjectId(String uri)
                       throws GdcRestApiException

Retrieves the project id from the URI returned by the create project

Parameters:

uri - the create project URI

Returns:

project id

Throws:

GdcRestApiException - in case the project doesn't exist

executeMAQLAsync

public void executeMAQLAsync(String projectId,
                             String maql)
                      throws GdcRestApiException

Executes the MAQL and creates/modifies the project's LDM asynchronously

Parameters:

projectId - the project's ID

maql - String with the MAQL statements

Throws:

GdcRestApiException

exportProject

public GdcRESTApiWrapper.ProjectExportResult exportProject(String projectId,
                                                           boolean exportUsers,
                                                           boolean exportData,
                                                           String[] authorizedUsers)
                                                    throws GdcRestApiException

Exports the project

Parameters:

projectId - the project's ID

exportUsers - flag

exportData - flag

authorizedUsers - list of authorized users

Returns:

result the taskUri and the export token

Throws:

GdcRestApiException

createUser

public String createUser(String domain,
                         GdcRESTApiWrapper.GdcUser user)
                  throws GdcRestApiException

Create a new user

Parameters:

domain - the domain where the user is going to be created

user - new user data

Returns:

the new user's URI

Throws:

GdcRestApiException

addUsersToProject

public void addUsersToProject(String projectId,
                              List<String> uris,
                              String role)
                       throws GdcRestApiException

Create a new user

Parameters:

projectId - project ID

uris - user URIs

role - user's role

Throws:

GdcRestApiException

addUsersToProjectWithRoleUri

public void addUsersToProjectWithRoleUri(String projectId,
                                         List<String> uris,
                                         String roleUri)
                                  throws GdcRestApiException

Throws:

GdcRestApiException

disableUsersInProject

public void disableUsersInProject(String projectId,
                                  List<String> uris)
                           throws GdcRestApiException

Disables a user in project

Parameters:

projectId - project ID

uris - user URIs

Throws:

GdcRestApiException

getProjectRoles

public ArrayList<GdcRESTApiWrapper.GdcRole> getProjectRoles(String pid)

Returns the selected project's roles

Parameters:

pid - project ID

Returns:

array of the project's users

getRoleUsers

public ArrayList<String> getRoleUsers(GdcRESTApiWrapper.GdcRole role,
                                      boolean activeUsersOnly)

Returns the selected project's roles

Returns:

array of the project's users

getProjectUsers

public ArrayList<GdcRESTApiWrapper.GdcUser> getProjectUsers(String pid,
                                                            boolean activeUsersOnly)

Returns the selected project's users

Parameters:

pid - project ID

activeUsersOnly - lists only active users

Returns:

array of the project's users

importProject

public String importProject(String projectId,
                            String token)
                     throws GdcRestApiException

Imports the project

Parameters:

projectId - the project's ID

token - export token

Returns:

result the taskUri

Throws:

GdcRestApiException

importMD

public String importMD(String projectId,
                       String token,
                       boolean overwrite,
                       boolean updateLDM)
                throws GdcRestApiException

Imports a MD object to the project

Parameters:

projectId - the project's ID

token - export token

overwrite - overwrite existing objects

updateLDM - update LDM names, descriptions and tags

Returns:

result the taskUri

Throws:

GdcRestApiException

exportMD

public GdcRESTApiWrapper.ProjectExportResult exportMD(String projectId,
                                                      List<Integer> ids)
                                               throws GdcRestApiException

Exports selected MD object with dependencies from the project

Parameters:

projectId - the project's ID

ids - - list of the exported MD objects IDs

Returns:

result the taskUri and the export token

Throws:

GdcRestApiException

getMigrationStatus

public String getMigrationStatus(String link)
                          throws HttpMethodException

Checks if the migration is finished

Parameters:

link - the link returned from the start loading

Returns:

the loading status

Throws:

HttpMethodException

executeDML

public String executeDML(String projectId,
                         String maql)
                  throws GdcRestApiException

Executes the MAQL and creates/modifies the project's LDM

Parameters:

projectId - the project's ID

maql - String with the MAQL statements

Returns:

result String

Throws:

GdcRestApiException

executeMethodOk

protected String executeMethodOk(org.apache.commons.httpclient.HttpMethod method)
                          throws HttpMethodException

Throws:

HttpMethodException

executeMethodOk

protected String executeMethodOk(org.apache.commons.httpclient.HttpMethod method,
                                 boolean reloginOn401)
                          throws HttpMethodException

Throws:

HttpMethodException

getSLIsUri

public String getSLIsUri(String projectId)

Returns the data interfaces URI

Parameters:

projectId - project ID

Returns:

SLI collection URI

getSLIUri

public String getSLIUri(String sliId,
                        String projectId)

Returns the SLI URI

Parameters:

sliId - SLI ID

projectId - project ID

Returns:

DLI URI

getServerUrl

protected String getServerUrl()

getProjectMdUrl

protected String getProjectMdUrl(String projectId)

Constructs project's metadata uri

Parameters:

projectId - project ID

getProjectUrl

protected String getProjectUrl(String projectId)

Constructs project's projects uri

Parameters:

projectId - project ID

getProjectIdFromUri

public String getProjectIdFromUri(String projectUri)

Gets the project ID from the project URI

Parameters:

projectUri - project URI

Returns:

the project id

getProjectDeleteUri

public String getProjectDeleteUri(String projectId)

Gets the project delete URI from the project id

Parameters:

projectId - project ID

Returns:

the project delete URI

getProfile

protected net.sf.json.JSONObject getProfile()

Profile getter

Returns:

the profile of the currently logged user

inviteUser

public void inviteUser(String projectId,
                       String eMail,
                       String message)

Invites a new user to a project

Parameters:

projectId - project ID

eMail - invited user e-mail

message - invitation message

inviteUser

public void inviteUser(String projectId,
                       String eMail,
                       String message,
                       String role)

Invites a new user to a project

Parameters:

projectId - project ID

eMail - invited user e-mail

message - invitation message

identifierToUri

public Map<String,String> identifierToUri(String projectId,
                                          String[] identifiers)

Converst MD identifier to uri

Parameters:

projectId - project ID

identifiers - MD object identifiers

Returns:

map identifier:uri

getObjectByUri

public net.sf.json.JSONObject getObjectByUri(String objectUri)

Retrieves a metadata object definition by Uri

Parameters:

objectUri - object uri

Returns:

the object to get

getMetadataObject

public MetadataObject getMetadataObject(String objectUri)

Retrieves a metadata object definition

Parameters:

objectUri - object uri

Returns:

the object to get

getMetadataObject

public MetadataObject getMetadataObject(String projectId,
                                        int objectId)

Retrieves a metadata object definition

Parameters:

projectId - project id (hash)

objectId - object id (integer)

Returns:

the object to get

getMetadataObject

public MetadataObject getMetadataObject(String projectId,
                                        String identifier)

Retrieves a metadata object definition

Parameters:

projectId - project id (hash)

identifier - object identifier

Returns:

the object to get

using

public List<net.sf.json.JSONObject> using(String uri)

Returns the dependent objects

Parameters:

uri - the uri of the top-level object

Returns:

list of dependent objects

usedBy

public List<net.sf.json.JSONObject> usedBy(String uri)

Returns the dependent objects

Parameters:

uri - the uri of the top-level object

Returns:

list of dependent objects

createMetadataObject

public net.sf.json.JSONObject createMetadataObject(String projectId,
                                                   net.sf.json.JSON content)

Creates a new object in the metadata server

Parameters:

projectId - project id (hash)

content - the new object content

Returns:

the new object

modifyMetadataObject

public net.sf.json.JSONObject modifyMetadataObject(String projectId,
                                                   int objectId,
                                                   net.sf.json.JSON content)

Modifies an object in the metadata server

Parameters:

projectId - project id (hash)

objectId - object id (integer)

content - the new object content

Returns:

the new object

modifyMetadataObject

public net.sf.json.JSONObject modifyMetadataObject(String uri,
                                                   net.sf.json.JSON content)

Modifies an object in the metadata server

Parameters:

uri - object uri

content - the new object content

Returns:

the new object

deleteMetadataObject

public void deleteMetadataObject(String projectId,
                                 int objectId)

Deletes an object in the metadata server

Parameters:

projectId - project id (hash)

objectId - object id (integer)

deleteMetadataObject

public void deleteMetadataObject(String uri)

Deletes an object in the metadata server

Parameters:

uri - object uri

getProjectEtlMode

public String getProjectEtlMode(String pid)

Determines the projet's ETL mode (SLI/DLI/VOID)

Parameters:

pid - project id

Returns:

project's ETL mode

getMigrationRequest

protected net.sf.json.JSONObject getMigrationRequest(List<String> manifests)

getTaskManStatus

public String getTaskManStatus(String link)
                        throws HttpMethodException

Checks if the migration is finished

Parameters:

link - the link returned from the start loading

Returns:

the loading status

Throws:

HttpMethodException

getDetailedTaskManStatus

public GdcRESTApiWrapper.TaskmanStatus getDetailedTaskManStatus(String link)
                                                         throws HttpMethodException

Throws:

HttpMethodException

migrateDataSets

public String migrateDataSets(String pid,
                              List<String> manifests)

Migrates project datasets from DLI to SLI

Parameters:

pid - project ID

manifests - array of all dataset's manifests

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getUsers

public Map<String,GdcRESTApiWrapper.GdcUser> getUsers(String domain)

API for querying users in a domain

Parameters:

domain -

Returns:

enumerateDimensions

public List<String> enumerateDimensions(String projectId)

enumerateDataSets

public List<String> enumerateDataSets(String projectId)

enumerateFolders

public List<String> enumerateFolders(String projectId)

enumerateDashboards

public List<String> enumerateDashboards(String projectId)

enumerateResource

protected List<String> enumerateResource(String projectId,
                                         String resource)

exportMDByUrl

public GdcRESTApiWrapper.ProjectExportResult exportMDByUrl(String projectId,
                                                           List<String> urls)

getMDExportStructureStrings

protected net.sf.json.JSONObject getMDExportStructureStrings(String projectId,
                                                             List<String> urls)

getNamePasswordConfiguration

public NamePasswordConfiguration getNamePasswordConfiguration()

getCopyStatus

public String getCopyStatus(String link)

Checks if report copying is finished. Workaround implementation due to wrong handling of status code.

Parameters:

link - the link returned from the start loading

Returns:

the loading status

getProjectByName

@Deprecated
public Project getProjectByName(String name)
                                     throws HttpMethodException,
                                            GdcProjectAccessException

Deprecated.

Retrieves the project info by the project's name

Parameters:

name - the project name

Returns:

the GoodDataProjectInfo populated with the project's information

Throws:

HttpMethodException

GdcProjectAccessException

createProject

@Deprecated
public String createProject(String name,
                                        String desc,
                                        String templateUri)
                                 throws GdcRestApiException

Deprecated.

Create a new GoodData project

Parameters:

name - project name

desc - project description

templateUri - project template uri

Returns:

the project Id

Throws:

GdcRestApiException

listProjects

@Deprecated
public List<Project> listProjects()
                                       throws HttpMethodException

Deprecated.

Returns the List of GoodDataProjectInfo structures for the accessible projects

Returns:

the List of GoodDataProjectInfo structures for the accessible projects

Throws:

HttpMethodException

getReportDefinition

@Deprecated
public String getReportDefinition(String reportUri)

Deprecated.

Gets a report definition from the report uri (/gdc/obj...)

Parameters:

reportUri - report uri (/gdc/obj...)

Returns:

report definition