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

Interface MailTemplateService

All Superinterfaces:

JAXRSService

@Path(value="mailTemplates")
public interface MailTemplateService
extends JAXRSService

REST operations for mail templates.

Field Summary

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

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(MailTemplateTO mailTemplateTO) Creates a new mail template.
void	delete(String key) Deletes the mail template matching the given key.
javax.ws.rs.core.Response	getFormat(String key, MailTemplateFormat format) Gets the template for the given key and format, if available.
List<MailTemplateTO>	list() Returns a list of all mail templates.
MailTemplateTO	read(String key) Returns mail template with matching key.
void	removeFormat(String key, MailTemplateFormat format) Removes the template for the given key and format, if available.
void	setFormat(String key, MailTemplateFormat 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<MailTemplateTO> list()

Returns a list of all mail templates.

Returns:

list of all mail templates.

create

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

Creates a new mail template.

Parameters:

mailTemplateTO - Creates a new mail template.

Returns:

Response object featuring Location header of created mail template

read

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

Returns mail template with matching key.

Parameters:

key - key of mail template to be read

Returns:

mail template with matching key

delete

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

Deletes the mail template matching the given key.

Parameters:

key - key for mail template to be deleted

getFormat

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

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

Parameters:

key - mail template

format - template format

Returns:

mail template with matching key and format, if available

setFormat

@PUT
 @Path(value="{key}/{format}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void setFormat(@NotNull @PathParam(value="key")
                                                                                                                               String key,
                                                                                                                               @NotNull @PathParam(value="format")
                                                                                                                               MailTemplateFormat format,
                                                                                                                               InputStream templateIn)

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

Parameters:

key - mail template

format - template format

templateIn - template to be set

removeFormat

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

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

Parameters:

key - mail template

format - template format