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

Interface DynRealmService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

DynRealmServiceImpl

@Path("dynRealms")
public interface DynRealmService
extends JAXRSService

REST operations for dynamic realms.

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_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method	Description
Response	create(@NotNull DynRealmTO dynDynRealmTO)	Creates a new dynamic realm.
void	delete(@NotNull String key)	Deletes the dynamic realm matching the provided key.
List<DynRealmTO>	list()	Returns a list of all dynamic realms.
DynRealmTO	read(@NotNull String key)	Returns dynamic realm with matching key.
void	update(@NotNull DynRealmTO dynDynRealmTO)	Updates the dynamic realm matching the provided key.

Method Details

list

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

Returns a list of all dynamic realms.

Returns:

list of all dynamic realms.

read

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

Returns dynamic realm with matching key.

Parameters:

key - dynamic realm key to be read

Returns:

dynamic realm with matching key

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
Response create(@NotNull
 @NotNull DynRealmTO dynDynRealmTO)

Creates a new dynamic realm.

Parameters:

dynDynRealmTO - dynamic realm to be created

Returns:

Response object featuring Location header of created dynamic realm

update

@PUT
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void update(@NotNull
 @NotNull DynRealmTO dynDynRealmTO)

Updates the dynamic realm matching the provided key.

Parameters:

dynDynRealmTO - dynamic realm to be stored

delete

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

Deletes the dynamic realm matching the provided key.

Parameters:

key - dynamic realm key to be deleted