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

Interface RemediationService

All Superinterfaces:

JAXRSService

@Path(value="remediations")
public interface RemediationService
extends JAXRSService

REST operations for remediations.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete(String key) Deletes the remediation matching the given key.
PagedResult<RemediationTO>	list(RemediationQuery query) Returns a list of all remediations.
RemediationTO	read(String key) Returns remediation with matching key.
javax.ws.rs.core.Response	remedy(String remediationKey, AnyPatch anyPatch) Perform remediation by updating the provided user, group or any object.
javax.ws.rs.core.Response	remedy(String remediationKey, AnyTO anyTO) Perform remediation by creating the provided user, group or any object.
javax.ws.rs.core.Response	remedy(String remediationKey, String anyKey) Perform remediation by deleting the provided user, group or any object.

Method Detail

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedResult<RemediationTO> list(@BeanParam
                                                                                                                 RemediationQuery query)

Returns a list of all remediations.

Parameters:

query - query conditions

Returns:

list of all remediations.

read

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

Returns remediation with matching key.

Parameters:

key - key of remediation to be read

Returns:

remediation with matching key

delete

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

Deletes the remediation matching the given key.

Parameters:

key - key for remediation to be deleted

Returns:

an empty response if operation was successful

remedy

@POST
 @Path(value="{remediationKey}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response remedy(@NotNull @PathParam(value="remediationKey")
                                                                                                                                                                                                                                String remediationKey,
                                                                                                                                                                                                                                @NotNull
                                                                                                                                                                                                                                AnyTO anyTO)

Perform remediation by creating the provided user, group or any object.

Parameters:

remediationKey - key for remediation to act on

anyTO - user, group or any object to create

Returns:

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

remedy

@PATCH
 @Path(value="{remediationKey}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response remedy(@NotNull @PathParam(value="remediationKey")
                                                                                                                                                                                                                                 String remediationKey,
                                                                                                                                                                                                                                 @NotNull
                                                                                                                                                                                                                                 AnyPatch anyPatch)

Perform remediation by updating the provided user, group or any object.

Parameters:

remediationKey - key for remediation to act on

anyPatch - user, group or any object to update

Returns:

Response object featuring the updated object enriched with propagation status information

remedy

@DELETE
 @Path(value="{remediationKey}/{anyKey}")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response remedy(@NotNull @PathParam(value="remediationKey")
                                                                                                                                                               String remediationKey,
                                                                                                                                                               @NotNull @PathParam(value="anyKey")
                                                                                                                                                               String anyKey)

Perform remediation by deleting the provided user, group or any object.

Parameters:

remediationKey - key for remediation to act on

anyKey - user's, group's or any object's key to delete

Returns:

Response object featuring the deleted object enriched with propagation status information