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

Interface ConfParamService

All Superinterfaces:

Serializable

@Path("conf")
public interface ConfParamService
extends Serializable

REST operations for Self Keymaster's conf params.

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	get(@NotNull String key)	Returns the value(s) of the given conf parameter, if defined.
Map<String,Object>	list()	Returns the full list of defined conf parameters, with values.
void	remove(@NotNull String key)	Deletes the conf parameter matching the provided key.
void	set(@NotNull String key, InputStream value)	Sets the value(s) for the given conf parameter.

Method Details

list

@GET
@Produces("application/json")
Map<String,Object> list()

Returns the full list of defined conf parameters, with values.

Returns:

full list of defined conf parameters, with values

get

@GET
@Path("{key}")
@Produces("application/json")
jakarta.ws.rs.core.Response get(@NotNull @PathParam("key")
 @NotNull String key)

Returns the value(s) of the given conf parameter, if defined.

Parameters:

key - conf parameter key

Returns:

the value(s) of the given conf parameter, if defined

set

@POST
@Path("{key}")
@Consumes("application/json")
@Produces("application/json")
void set(@NotNull @PathParam("key")
 @NotNull String key,
 InputStream value)

Sets the value(s) for the given conf parameter.

Parameters:

key - conf parameter key

value - conf parameter value(s)

remove

@DELETE
@Path("{key}")
@Produces("application/json")
void remove(@NotNull @PathParam("key")
 @NotNull String key)

Deletes the conf parameter matching the provided key.

Parameters:

key - conf parameter key