com.gooddata.dataload.processes

Class ProcessService

java.lang.Object

com.gooddata.AbstractService

com.gooddata.dataload.processes.ProcessService

public class ProcessService
extends AbstractService

Service to manage dataload processes and process executions.

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
ProcessService(org.springframework.web.client.RestTemplate restTemplate, AccountService accountService) Sets RESTful HTTP Spring template.

Method Summary

Methods

Modifier and Type	Method and Description
DataloadProcess	createProcess(Project project, DataloadProcess process, File processData) Create new process with given data by given project.
FutureResult<ProcessExecutionDetail>	executeProcess(ProcessExecution execution) Run given execution under given process
void	getExecutionLog(ProcessExecutionDetail executionDetail, OutputStream outputStream) Get process execution log
DataloadProcess	getProcessById(Project project, String id) Get process by given id and project.
DataloadProcess	getProcessByUri(String uri) Get process by given URI.
void	getProcessSource(DataloadProcess process, OutputStream outputStream) Get process source data.
Collection<DataloadProcess>	listProcesses(Project project) Get list of processes by given project.
Collection<DataloadProcess>	listUserProcesses() Get list of current user processes by given user account.
void	removeProcess(DataloadProcess process) Delete given process
DataloadProcess	updateProcess(Project project, DataloadProcess process, File processData) Update process with given data by given project.

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

ProcessService

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

Sets RESTful HTTP Spring template. Should be called from constructor of concrete service extending this abstract one.

Parameters:

restTemplate - RESTful HTTP Spring template

accountService - service to access accounts

Method Detail

createProcess

public DataloadProcess createProcess(Project project,
                            DataloadProcess process,
                            File processData)

Create new process with given data by given project.

Parameters:

project - project to which the process belongs

process - to create

processData - process data to upload

Returns:

created process

updateProcess

public DataloadProcess updateProcess(Project project,
                            DataloadProcess process,
                            File processData)

Update process with given data by given project.

Parameters:

project - project to which the process belongs

process - to create

processData - process data to upload

Returns:

updated process

getProcessByUri

public DataloadProcess getProcessByUri(String uri)

Get process by given URI.

Parameters:

uri - process uri

Returns:

found process

Throws:

ProcessNotFoundException - when the process doesn't exist

getProcessById

public DataloadProcess getProcessById(Project project,
                             String id)

Get process by given id and project.

Parameters:

project - project to which the process belongs

id - process id

Returns:

found process

Throws:

ProcessNotFoundException - when the process doesn't exist

listProcesses

public Collection<DataloadProcess> listProcesses(Project project)

Get list of processes by given project.

Parameters:

project - project of processes

Returns:

list of found processes or empty list

listUserProcesses

public Collection<DataloadProcess> listUserProcesses()

Get list of current user processes by given user account.

Returns:

list of found processes or empty list

removeProcess

public void removeProcess(DataloadProcess process)

Delete given process

Parameters:

process - to delete

getProcessSource

public void getProcessSource(DataloadProcess process,
                    OutputStream outputStream)

Get process source data. Source data are fetched as zip and written to given stream.

Parameters:

process - process to fetch data of

outputStream - stream where to write fetched data

getExecutionLog

public void getExecutionLog(ProcessExecutionDetail executionDetail,
                   OutputStream outputStream)

Get process execution log

Parameters:

executionDetail - execution to log of

outputStream - stream to write the log to

executeProcess

public FutureResult<ProcessExecutionDetail> executeProcess(ProcessExecution execution)

Run given execution under given process

Parameters:

execution - to run

Returns:

result of the execution

Throws:

ProcessExecutionException - in case process can't be executed