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

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.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
void	delete(@NotNull String schema) Deletes the configuration parameter with matching schema.
javax.ws.rs.core.Response	export() Exports internal storage content as downloadable XML file.
AttrTO	get(@NotNull String schema) Returns configuration parameter with matching schema.
List<AttrTO>	list() Returns all configuration parameters.
void	set(@NotNull AttrTO value) Creates / updates the configuration parameter with the given schema.

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

list

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

Returns all configuration parameters.

Returns:

all configuration parameters

get

@GET
 @Path(value="{schema}")
 @Produces(value={"application/json","application/yaml","application/xml"})
AttrTO get(@NotNull @PathParam(value="schema")
                                                                                                                     @NotNull String schema)

Returns configuration parameter with matching schema.

Parameters:

schema - identifier of configuration to be read

Returns:

configuration parameter with matching schema

set

@PUT
 @Path(value="{schema}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void set(@NotNull
                                                                                                                                                                                               @NotNull AttrTO value)

Creates / updates the configuration parameter with the given schema.

Parameters:

value - parameter value

delete

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

Deletes the configuration parameter with matching schema.

Parameters:

schema - configuration parameter schema