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

Interface RealmService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

RealmServiceImpl

@Path(value="realms")
public interface RealmService
extends JAXRSService

REST operations for 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_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(@NotNull String parentPath, @NotNull RealmTO realmTO) Creates a new realm under the given path.
javax.ws.rs.core.Response	delete(@NotNull String fullPath) Deletes the realm under the given path.
List<RealmTO>	list(@NotNull String fullPath) Returns realms rooted at the given path, including descendant realms.
PagedResult<RealmTO>	search(RealmQuery query) Returns a list of existing realms matching the given query (not including descendant realms) and the total number of descendant realms.
javax.ws.rs.core.Response	update(@NotNull RealmTO realmTO) Updates the realm under the given path.

Method Detail

search

@GET
 @Path(value="search")
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedResult<RealmTO> search(@BeanParam
                                                                                                                                    RealmQuery query)

Returns a list of existing realms matching the given query (not including descendant realms) and the total number of descendant realms.

Parameters:

query - query conditions

Returns:

list of existing realms matching the given query (not including descendant realms) and the total number of descedant realms

list

@GET
 @Path(value="{fullPath:.*}")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<RealmTO> list(@NotNull @PathParam(value="fullPath")
                                                                                                                                  @NotNull String fullPath)

Returns realms rooted at the given path, including descendant realms.

Parameters:

fullPath - full path of the root realm where to read from

Returns:

realms rooted at the given path, including descendant realms

create

@POST
 @Path(value="{parentPath:.*}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull @PathParam(value="parentPath")
                                                                                                                                                                                                                               @NotNull String parentPath,
                                                                                                                                                                                                                               @NotNull
                                                                                                                                                                                                                               @NotNull RealmTO realmTO)

Creates a new realm under the given path.

Parameters:

parentPath - full path of the parent realm

realmTO - new realm

Returns:

Response object featuring Location header of created realm as well as the realm itself enriched with propagation status information

update

@PUT
 @Path(value="{fullPath:.*}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response update(@NotNull
                                                                                                                                                                                                                            @NotNull RealmTO realmTO)

Updates the realm under the given path.

Parameters:

realmTO - realm to be stored

Returns:

Response object featuring the updated realm enriched with propagation status information

delete

@DELETE
 @Path(value="{fullPath:.*}")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response delete(@NotNull @PathParam(value="fullPath")
                                                                                                                                                   @NotNull String fullPath)

Deletes the realm under the given path.

Parameters:

fullPath - realm path

Returns:

Response object featuring the deleted realm enriched with propagation status information