org.apache.syncope.client.console.rest

Class ReportRestClient

java.lang.Object

org.apache.syncope.client.console.rest.BaseRestClient

org.apache.syncope.client.console.rest.ReportRestClient

All Implemented Interfaces:

Serializable, ExecutionRestClient, RestClient, TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

public class ReportRestClient
extends BaseRestClient
implements ExecutionRestClient, TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.syncope.client.console.rest.BaseRestClient

LOG

Constructor Summary

Constructors

Constructor and Description
ReportRestClient()

Method Summary

Modifier and Type	Method and Description
void	actionJob(String refKey, JobAction jobAction)
Map<String,String>	batch(BatchRequest batchRequest)
int	countExecutions(String taskKey)
void	create(ReportTO reportTO)
void	createTemplate(ReportTemplateTO reportTemplateTO)
void	delete(String reportKey) Delete specified report.
void	deleteExecution(String reportExecKey)
void	deleteTemplate(String key)
javax.ws.rs.core.Response	exportExecutionResult(String executionKey, ReportExecExportFormat fmt)
JobTO	getJob(String key)
List<ReportTO>	list()
List<ExecTO>	listExecutions(String taskKey, int page, int size, SortParam<String> sort)
List<JobTO>	listJobs()
List<ExecTO>	listRecentExecutions(int max)
List<ReportTemplateTO>	listTemplates()
ReportTO	read(String reportKey)
ReportTemplateTO	readTemplate(String key)
String	readTemplateFormat(String key, ReportTemplateFormat format)
void	startExecution(String reportKey, Date start)
void	update(ReportTO reportTO)
void	updateTemplateFormat(String key, String content, ReportTemplateFormat format)

Methods inherited from class org.apache.syncope.client.console.rest.BaseRestClient

getObject, getService, getService, getStatus, getSyncopeService, resetClient, toOrderBy

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportRestClient

public ReportRestClient()

Method Detail

read

public ReportTO read(String reportKey)

list

public List<ReportTO> list()

getJob

public JobTO getJob(String key)

listJobs

public List<JobTO> listJobs()

actionJob

public void actionJob(String refKey,
                      JobAction jobAction)

create

public void create(ReportTO reportTO)

update

public void update(ReportTO reportTO)

delete

public void delete(String reportKey)

Delete specified report.

Parameters:

reportKey - report to delete

startExecution

public void startExecution(String reportKey,
                           Date start)

Specified by:

startExecution in interface ExecutionRestClient

deleteExecution

public void deleteExecution(String reportExecKey)

Specified by:

deleteExecution in interface ExecutionRestClient

listRecentExecutions

public List<ExecTO> listRecentExecutions(int max)

Specified by:

listRecentExecutions in interface ExecutionRestClient

exportExecutionResult

public javax.ws.rs.core.Response exportExecutionResult(String executionKey,
                                                       ReportExecExportFormat fmt)

listExecutions

public List<ExecTO> listExecutions(String taskKey,
                                   int page,
                                   int size,
                                   SortParam<String> sort)

Specified by:

listExecutions in interface ExecutionRestClient

countExecutions

public int countExecutions(String taskKey)

Specified by:

countExecutions in interface ExecutionRestClient

listTemplates

public List<ReportTemplateTO> listTemplates()

Specified by:

listTemplates in interface TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

createTemplate

public void createTemplate(ReportTemplateTO reportTemplateTO)

Specified by:

createTemplate in interface TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

deleteTemplate

public void deleteTemplate(String key)

Specified by:

deleteTemplate in interface TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

readTemplate

public ReportTemplateTO readTemplate(String key)

Specified by:

readTemplate in interface TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

readTemplateFormat

public String readTemplateFormat(String key,
                                 ReportTemplateFormat format)

Specified by:

readTemplateFormat in interface TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

updateTemplateFormat

public void updateTemplateFormat(String key,
                                 String content,
                                 ReportTemplateFormat format)

Specified by:

updateTemplateFormat in interface TemplateRestClient<ReportTemplateTO,ReportTemplateFormat>

batch

public Map<String,String> batch(BatchRequest batchRequest)

Specified by:

batch in interface ExecutionRestClient