org.apache.syncope.common.services

Interface ConfigurationService

All Superinterfaces:

JAXRSService

@Path(value="configurations")
public interface ConfigurationService
extends JAXRSService

REST operations for configuration.

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	delete(String key) Deletes the configuration parameter with matching key.
javax.ws.rs.core.Response	export() Exports internal storage content as downloadable XML file.
List<MailTemplate>	getMailTemplates() Returns a list of known mail-template names.
List<Validator>	getValidators() Returns a list of known validator names.
ConfTO	list() Returns all configuration parameters.
AttributeTO	read(String key) Returns configuration parameter with matching key.
void	set(String key, AttributeTO value) Creates / updates the configuration parameter with the given key.

Method Detail

export

@GET
@Path(value="stream")
javax.ws.rs.core.Response export()

Exports internal storage content as downloadable XML file.

Returns:

internal storage content as downloadable XML file

getMailTemplates

@GET
@Path(value="mailTemplates")
@Produces(value={"application/xml","application/json"})
List<MailTemplate> getMailTemplates()

Returns a list of known mail-template names.

Returns:

a list of known mail-template names

getValidators

@GET
@Path(value="validators")
@Produces(value={"application/xml","application/json"})
List<Validator> getValidators()

Returns a list of known validator names.

Returns:

a list of known validator names

list

@GET
@Produces(value={"application/xml","application/json"})
ConfTO list()

Returns all configuration parameters.

Returns:

all configuration parameters

read

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

Returns configuration parameter with matching key.

Parameters:

key - identifier of configuration to be read

Returns:

configuration parameter with matching key

set

@PUT
@Path(value="{key}")
@Consumes(value={"application/xml","application/json"})
void set(@NotNull@PathParam(value="key")
                         String key,
                         @NotNull
                         AttributeTO value)

Creates / updates the configuration parameter with the given key.

Parameters:

key - parameter key

value - parameter value

delete

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

Deletes the configuration parameter with matching key.

Parameters:

key - configuration parameter key