Package org.apache.syncope.ext.scimv2.api.service

Interface SCIMResourceService<R extends SCIMResource>

All Known Subinterfaces:

SCIMAnyObjectService, SCIMGroupService, SCIMUserService

All Known Implementing Classes:

SCIMAnyObjectServiceImpl, SCIMGroupServiceImpl, SCIMUserServiceImpl

public interface SCIMResourceService<R extends SCIMResource>

Method Summary

Modifier and Type	Method	Description
Response	create(R resource)
Response	delete(@NotNull String id)
R	get(@NotNull String id, String attributes, String excludedAttributes)
Response	replace(@NotNull String id, R resource)
ListResponse<R>	search(String attributes, String excludedAttributes, String filter, String sortBy, SortOrder sortOrder, Integer startIndex, Integer count)
ListResponse<R>	search(SCIMSearchRequest request)
Response	update(@NotNull String id, SCIMPatchOp patch)

Method Details

get

@GET
@Path("{id}")
@Produces("application/scim+json")
R get(@NotNull @PathParam("id")
 @NotNull String id,
 @QueryParam("attributes")
 String attributes,
 @QueryParam("excludedAttributes")
 String excludedAttributes)

search

@GET
@Produces("application/scim+json")
ListResponse<R> search(@QueryParam("attributes")
 String attributes,
 @QueryParam("excludedAttributes")
 String excludedAttributes,
 @QueryParam("filter")
 String filter,
 @QueryParam("sortBy")
 String sortBy,
 @QueryParam("sortOrder")
 SortOrder sortOrder,
 @QueryParam("startIndex")
 Integer startIndex,
 @QueryParam("count")
 Integer count)

search

@POST
@Path(".search")
@Produces("application/scim+json")
@Consumes("application/scim+json")
ListResponse<R> search(SCIMSearchRequest request)

create

@POST
@Produces("application/scim+json")
@Consumes("application/scim+json")
Response create(R resource)

update

@PATCH
@Path("{id}")
@Produces("application/scim+json")
@Consumes("application/scim+json")
Response update(@NotNull @PathParam("id")
 @NotNull String id,
 SCIMPatchOp patch)

replace

@PUT
@Path("{id}")
@Produces("application/scim+json")
@Consumes("application/scim+json")
Response replace(@NotNull @PathParam("id")
 @NotNull String id,
 R resource)

delete

@DELETE
@Path("{id}")
@Produces("application/scim+json")
Response delete(@NotNull @PathParam("id")
 @NotNull String id)