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

Interface RealmService

All Superinterfaces:

JAXRSService

@Path("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_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
jakarta.ws.rs.core.Response	create(@NotNull String parentPath, @NotNull org.apache.syncope.common.lib.to.RealmTO realmTO)	Creates a new realm under the given path.
jakarta.ws.rs.core.Response	delete(@NotNull String fullPath)	Deletes the realm under the given path.
org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.RealmTO>	search(RealmQuery query)	Returns a paged list of existing realms matching the given query.
jakarta.ws.rs.core.Response	update(@NotNull org.apache.syncope.common.lib.to.RealmTO realmTO)	Updates the realm under the given path.

Method Details

search

@GET
@Produces({"application/json","application/yaml","application/xml"})
org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.RealmTO> search(@BeanParam
 RealmQuery query)

Returns a paged list of existing realms matching the given query.

Parameters:

query - query conditions

Returns:

paged list of existing realms matching the given query

create

@POST
@Path("{parentPath:.*}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
jakarta.ws.rs.core.Response create(@NotNull @PathParam("parentPath")
 @NotNull String parentPath,
 @NotNull
 @NotNull org.apache.syncope.common.lib.to.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("{fullPath:.*}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
jakarta.ws.rs.core.Response update(@NotNull
 @NotNull org.apache.syncope.common.lib.to.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("{fullPath:.*}")
@Produces({"application/json","application/yaml","application/xml"})
jakarta.ws.rs.core.Response delete(@NotNull @PathParam("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