com.gooddata.project

Class ProjectService

java.lang.Object

com.gooddata.AbstractService

com.gooddata.project.ProjectService

public class ProjectService
extends AbstractService

List projects, create a project, ...

Usage example:

     ProjectService projectService = gd.getProjectService();
     Collection<Project> projects = projectService.getProjects();
     Project project = projectService.createProject(new Project("my project", "MyToken"));
 

Nested Class Summary

Nested classes/interfaces inherited from class com.gooddata.AbstractService

AbstractService.OutputStreamResponseExtractor

Field Summary

Fields inherited from class com.gooddata.AbstractService

mapper, noopRequestCallback, restTemplate, WAIT_BEFORE_RETRY_IN_MILLIS

Constructor Summary

Constructors

Constructor and Description
ProjectService(org.springframework.web.client.RestTemplate restTemplate, AccountService accountService) Constructs service for GoodData project management (list projects, create a project, ...).

Method Summary

Modifier and Type	Method and Description
ProjectFeatureFlag	createFeatureFlag(Project project, ProjectFeatureFlag featureFlag) Creates new feature flag for given project.
FutureResult<Project>	createProject(Project project) Create new project.
void	deleteFeatureFlag(ProjectFeatureFlag featureFlag) Deletes existing project feature flag.
Set<ProjectValidationType>	getAvailableProjectValidationTypes(Project project) Get available validation types for project.
ProjectFeatureFlag	getFeatureFlag(Project project, String featureFlagName) Get feature flag by unique name (aka "key").
Project	getProjectById(String id) Get project by id.
Project	getProjectByUri(String uri) Get project by URI.
Collection<Project>	getProjects() Get all projects current user has access to.
Collection<ProjectTemplate>	getProjectTemplates(Project project)
Role	getRoleByUri(String uri) Get role by given URI.
Set<Role>	getRoles(Project project) Get set of user role by given project.
List<FeatureFlag>	listAggregatedFeatureFlags(Project project) Lists aggregated feature flags for given project and current user (aggregates global, project group, project and user feature flags).
List<ProjectFeatureFlag>	listFeatureFlags(Project project) Lists all project feature flags (only project scoped flags, use listAggregatedFeatureFlags(Project) for aggregated flags from all scopes).
List<User>	listUsers(Project project) Get first page of paged list of users by given project.
List<User>	listUsers(Project project, Page page) Get defined page of paged list of users by given project.
void	removeProject(Project project) Removes given project
ProjectFeatureFlag	updateFeatureFlag(ProjectFeatureFlag featureFlag) Updates existing feature flag.
FutureResult<ProjectValidationResults>	validateProject(Project project) Validate project using all available validations.
FutureResult<ProjectValidationResults>	validateProject(Project project, ProjectValidationType... validations) Validate project with given validations
FutureResult<ProjectValidationResults>	validateProject(Project project, Set<ProjectValidationType> validations) Validate project with given validations

Methods inherited from class com.gooddata.AbstractService

extractData

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectService

public ProjectService(org.springframework.web.client.RestTemplate restTemplate,
                      AccountService accountService)

Constructs service for GoodData project management (list projects, create a project, ...).

Parameters:

restTemplate - RESTful HTTP Spring template

accountService - GoodData account service

Method Detail

getProjects

public Collection<Project> getProjects()

Get all projects current user has access to.

Returns:

collection of all projects current user has access to

Throws:

GoodDataException - when projects can't be accessed

createProject

public FutureResult<Project> createProject(Project project)

Create new project.

Parameters:

project - project to be created

Returns:

created project (including very useful id)

Throws:

GoodDataException - when projects creation fails

getProjectByUri

public Project getProjectByUri(String uri)

Get project by URI.

Parameters:

uri - URI of project resource (/gdc/projects/{id})

Returns:

project

Throws:

GoodDataException - when project can't be accessed

getProjectById

public Project getProjectById(String id)

Get project by id.

Parameters:

id - id of project

Returns:

project

Throws:

GoodDataException - when project can't be accessed

removeProject

public void removeProject(Project project)

Removes given project

Parameters:

project - project to be removed

Throws:

GoodDataException - when project can't be deleted

getProjectTemplates

public Collection<ProjectTemplate> getProjectTemplates(Project project)

getAvailableProjectValidationTypes

public Set<ProjectValidationType> getAvailableProjectValidationTypes(Project project)

Get available validation types for project. Which can be passed to validateProject(Project, ProjectValidationType...).

Parameters:

project - project to fetch validation types for

Returns:

available validations

validateProject

public FutureResult<ProjectValidationResults> validateProject(Project project)

Validate project using all available validations.

Parameters:

project - project to validate

Returns:

results of validation

validateProject

public FutureResult<ProjectValidationResults> validateProject(Project project,
                                                              ProjectValidationType... validations)

Validate project with given validations

Parameters:

project - project to validate

validations - validations to use

Returns:

results of validation

validateProject

public FutureResult<ProjectValidationResults> validateProject(Project project,
                                                              Set<ProjectValidationType> validations)

Validate project with given validations

Parameters:

project - project to validate

validations - validations to use

Returns:

results of validation

listUsers

public List<User> listUsers(Project project)

Get first page of paged list of users by given project.

Parameters:

project - project of users

Returns:

list of found users or empty list

listUsers

public List<User> listUsers(Project project,
                            Page page)

Get defined page of paged list of users by given project.

Parameters:

project - project of users

page - page to be retrieved

Returns:

list of found users or empty list

getRoles

public Set<Role> getRoles(Project project)

Get set of user role by given project. Note: This makes n+1 API calls to retrieve all role details.

Parameters:

project - project of roles

Returns:

set of found roles or empty set

getRoleByUri

public Role getRoleByUri(String uri)

Get role by given URI.

Parameters:

uri - role uri

Returns:

found role

Throws:

RoleNotFoundException - when the role doesn't exist

listAggregatedFeatureFlags

public List<FeatureFlag> listAggregatedFeatureFlags(Project project)

Lists aggregated feature flags for given project and current user (aggregates global, project group, project and user feature flags). It doesn't matter whether feature flag is enabled or not, it'll be included in all cases.

Parameters:

project - project, cannot be null

Returns:

list of aggregated feature flags for given project and current user

listFeatureFlags

public List<ProjectFeatureFlag> listFeatureFlags(Project project)

Lists all project feature flags (only project scoped flags, use listAggregatedFeatureFlags(Project) for aggregated flags from all scopes). It doesn't matter whether feature flag is enabled or not, it'll be included in all cases.

Parameters:

project - project, cannot be null

Returns:

list of all feature flags for given project

createFeatureFlag

public ProjectFeatureFlag createFeatureFlag(Project project,
                                            ProjectFeatureFlag featureFlag)

Creates new feature flag for given project. Usually, it doesn't make sense to create feature flag that is disabled because this is the same as having no feature flag at all.

Parameters:

project - project for which the feature flag should be created, cannot be null

featureFlag - feature flag to be created, cannot be null

Returns:

created feature flag

getFeatureFlag

public ProjectFeatureFlag getFeatureFlag(Project project,
                                         String featureFlagName)

Get feature flag by unique name (aka "key").

Parameters:

project - project, cannot be null

featureFlagName - name of feature flag, cannot be empty

Returns:

feature flag

updateFeatureFlag

public ProjectFeatureFlag updateFeatureFlag(ProjectFeatureFlag featureFlag)

Updates existing feature flag. Note that it doesn't make sense to update any other field than ProjectFeatureFlag.enabled.

Parameters:

featureFlag - updated feature flag

Returns:

updated feature flag

deleteFeatureFlag

public void deleteFeatureFlag(ProjectFeatureFlag featureFlag)

Deletes existing project feature flag.

Parameters:

featureFlag - existing project feature flag with links set properly, cannot be null