org.apache.syncope.common.services

Interface ReportService

All Superinterfaces:

JAXRSService

@Path(value="reports")
public interface ReportService
extends JAXRSService

REST operations for reports.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
void	actionJob(Long reportId, JobAction action) Execute a control action on an existing report
javax.ws.rs.core.Response	create(ReportTO reportTO) Creates a new report.
void	delete(Long reportId) Deletes report with matching id.
void	deleteExecution(Long executionId) Deletes report execution with matching id.
BulkActionResult	deleteExecutions(Long reportId, Date startedBefore, Date startedAfter, Date endedBefore, Date endedAfter) Deletes the report executions belonging to the given report and matching the date conditions.
ReportExecTO	execute(Long reportId) Executes the report with matching id.
javax.ws.rs.core.Response	exportExecutionResult(Long executionId, ReportExecExportFormat fmt) Exports the report execution with matching id in the requested format.
List<ReportletConfClass>	getReportletConfClasses() Returns a list of available classes for reportlet configuration.
PagedResult<ReportTO>	list() Returns a paged list of all existing reports.
PagedResult<ReportTO>	list(Integer page, Integer size) Returns a paged list of all existing reports matching page/size conditions.
PagedResult<ReportTO>	list(Integer page, Integer size, String orderBy) Returns a paged list of all existing reports matching page/size conditions.
PagedResult<ReportTO>	list(String orderBy) Returns a paged list of all existing reports.
List<ReportExecTO>	listJobs(JobStatusType type) List report jobs of the given type
ReportTO	read(Long reportId) Returns report with matching id.
ReportExecTO	readExecution(Long executionId) Returns report execution with matching id.
void	update(Long reportId, ReportTO reportTO) Updates report with matching id.

Method Detail

getReportletConfClasses

@GET
@Path(value="reportletConfClasses")
@Produces(value={"application/xml","application/json"})
List<ReportletConfClass> getReportletConfClasses()

Returns a list of available classes for reportlet configuration.

Returns:

list of available classes for reportlet configuration

read

@GET
@Path(value="{reportId}")
@Produces(value={"application/xml","application/json"})
ReportTO read(@NotNull@PathParam(value="reportId")
                              Long reportId)

Returns report with matching id.

Parameters:

reportId - id of report to be read

Returns:

report with matching id

readExecution

@GET
@Path(value="executions/{executionId}")
@Produces(value={"application/xml","application/json"})
ReportExecTO readExecution(@NotNull@PathParam(value="executionId")
                                           Long executionId)

Returns report execution with matching id.

Parameters:

executionId - report execution id to be selected

Returns:

report execution with matching id

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<ReportTO> list()

Returns a paged list of all existing reports.

Returns:

paged list of all existing reports

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<ReportTO> list(@QueryParam(value="orderby")
                                      String orderBy)

Returns a paged list of all existing reports.

Parameters:

orderBy - list of ordering clauses, separated by comma

Returns:

paged list of all existing reports

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<ReportTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                      Integer page,
                                      @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                      Integer size)

Returns a paged list of all existing reports matching page/size conditions.

Parameters:

page - selected page in relation to size

size - number of entries per page

Returns:

paged list of existing reports matching page/size conditions

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<ReportTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                      Integer page,
                                      @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                      Integer size,
                                      @QueryParam(value="orderby")
                                      String orderBy)

Returns a paged list of all existing reports matching page/size conditions.

Parameters:

page - selected page in relation to size

size - number of entries per page

orderBy - list of ordering clauses, separated by comma

Returns:

paged list of existing reports matching page/size conditions

create

@POST
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response create(@NotNull
                                             ReportTO reportTO)

Creates a new report.

Parameters:

reportTO - report to be created

Returns:

Response object featuring Location header of created report

update

@PUT
@Path(value="{reportId}")
@Consumes(value={"application/xml","application/json"})
void update(@NotNull@PathParam(value="reportId")
                            Long reportId,
                            ReportTO reportTO)

Updates report with matching id.

Parameters:

reportId - id for report to be updated

reportTO - report to be stored

delete

@DELETE
@Path(value="{reportId}")
void delete(@NotNull@PathParam(value="reportId")
                      Long reportId)

Deletes report with matching id.

Parameters:

reportId - Deletes report with matching id

deleteExecution

@DELETE
@Path(value="executions/{executionId}")
void deleteExecution(@NotNull@PathParam(value="executionId")
                               Long executionId)

Deletes report execution with matching id.

Parameters:

executionId - id of execution report to be deleted

deleteExecutions

@DELETE
@Path(value="{reportId}/executions")
@Produces(value={"application/xml","application/json"})
BulkActionResult deleteExecutions(@NotNull@PathParam(value="reportId")
                                                     Long reportId,
                                                     @QueryParam(value="startedBefore")
                                                     Date startedBefore,
                                                     @QueryParam(value="startedAfter")
                                                     Date startedAfter,
                                                     @QueryParam(value="endedBefore")
                                                     Date endedBefore,
                                                     @QueryParam(value="endedAfter")
                                                     Date endedAfter)

Deletes the report executions belonging to the given report and matching the date conditions.

Parameters:

reportId - report to which executions belong

startedBefore - selects executions started before this timestamp

startedAfter - selects executions started after this timestamp

endedBefore - selects executions ended before this timestamp

endedAfter - selects executions ended after this timestamp

Returns:

bulk action result

execute

@POST
@Path(value="{reportId}/execute")
@Produces(value={"application/xml","application/json"})
ReportExecTO execute(@NotNull@PathParam(value="reportId")
                                      Long reportId)

Executes the report with matching id.

Parameters:

reportId - id of report to be executed

Returns:

report execution result

exportExecutionResult

@GET
@Path(value="executions/{executionId}/stream")
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response exportExecutionResult(@NotNull@PathParam(value="executionId")
                                                                Long executionId,
                                                                @QueryParam(value="format")
                                                                ReportExecExportFormat fmt)

Exports the report execution with matching id in the requested format.

Parameters:

executionId - id of execution report to be selected

fmt - file-format selection

Returns:

a stream for content download

listJobs

@GET
@Path(value="jobs")
@Produces(value={"application/xml","application/json"})
List<ReportExecTO> listJobs(@MatrixParam(value="type")
                                            JobStatusType type)

List report jobs of the given type

Parameters:

type - of report job

Returns:

List of ReportExecTO

actionJob

@POST
@Path(value="{reportId}")
void actionJob(@PathParam(value="reportId")
                       Long reportId,
                       @QueryParam(value="action")
                       JobAction action)

Execute a control action on an existing report

Parameters:

reportId - id of report

action - action to execute