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

Interface DelegationService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

DelegationServiceImpl

@Path(value="delegations")
public interface DelegationService
extends JAXRSService

REST operations for delegations.

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 DelegationTO delegationTO) Creates a new delegation.
void	delete(@NotNull String key) Deletes the delegation matching the provided key.
List<DelegationTO>	list() Returns a list of all delegations.
DelegationTO	read(@NotNull String key) Returns delegation with matching key.
void	update(@NotNull DelegationTO delegationTO) Updates the delegation matching the provided key.

Method Detail

list

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

Returns a list of all delegations.

Returns:

list of all delegations.

read

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

Returns delegation with matching key.

Parameters:

key - delegation key to be read

Returns:

delegation with matching key

create

@POST
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                               @NotNull DelegationTO delegationTO)

Creates a new delegation.

Parameters:

delegationTO - delegation to be created

Returns:

Response object featuring Location header of created delegation

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull
                                                                                                                                                                                               @NotNull DelegationTO delegationTO)

Updates the delegation matching the provided key.

Parameters:

delegationTO - delegation to be stored

delete

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

Deletes the delegation matching the provided key.

Parameters:

key - delegation key to be deleted