org.apache.syncope.common.rest.api.service

Interface ReportTemplateService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

ReportTemplateServiceImpl

@Path(value="reportTemplates")
public interface ReportTemplateService
extends JAXRSService

REST operations for report templates.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(@NotNull ReportTemplateTO reportTemplateTO) Creates a new report template.
void	delete(@NotNull String key) Deletes the report template matching the given key.
javax.ws.rs.core.Response	getFormat(@NotNull String key, @NotNull ReportTemplateFormat format) Gets the template for the given key and format, if available.
List<ReportTemplateTO>	list() Returns a list of all report templates.
ReportTemplateTO	read(@NotNull String key) Returns report template with matching key.
void	removeFormat(@NotNull String key, @NotNull ReportTemplateFormat format) Removes the template for the given key and format, if available.
void	setFormat(@NotNull String key, @NotNull ReportTemplateFormat format, InputStream templateIn) Sets the template for the given key and format, if available.

Method Detail

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ReportTemplateTO> list()

Returns a list of all report templates.

Returns:

list of all report templates.

create

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

Creates a new report template.

Parameters:

reportTemplateTO - Creates a new report template.

Returns:

Response object featuring Location header of created report template

read

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
ReportTemplateTO read(@NotNull @PathParam(value="key")
                                                                                                                             @NotNull String key)

Returns report template with matching key.

Parameters:

key - key of report template to be read

Returns:

report template with matching key

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                      @NotNull String key)

Deletes the report template matching the given key.

Parameters:

key - key for report template to be deleted

getFormat

@GET
 @Path(value="{key}/{format}")
javax.ws.rs.core.Response getFormat(@NotNull @PathParam(value="key")
                                                                        @NotNull String key,
                                                                        @NotNull @PathParam(value="format")
                                                                        @NotNull ReportTemplateFormat format)

Gets the template for the given key and format, if available.

Parameters:

key - report template

format - template format

Returns:

report template with matching key and format, if available

setFormat

@PUT
 @Path(value="{key}/{format}")
void setFormat(@NotNull @PathParam(value="key")
                                                   @NotNull String key,
                                                   @NotNull @PathParam(value="format")
                                                   @NotNull ReportTemplateFormat format,
                                                   InputStream templateIn)

Sets the template for the given key and format, if available.

Parameters:

key - report template

format - template format

templateIn - template to be set

removeFormat

@DELETE
 @Path(value="{key}/{format}")
void removeFormat(@NotNull @PathParam(value="key")
                                                         @NotNull String key,
                                                         @NotNull @PathParam(value="format")
                                                         @NotNull ReportTemplateFormat format)

Removes the template for the given key and format, if available.

Parameters:

key - report template

format - template format