Package org.apache.directory.scim.protocol

Interface BaseResourceTypeResource<T>

All Known Subinterfaces:

GroupResource, UserResource

All Known Implementing Classes:

BaseResourceTypeResourceImpl, GroupResourceImpl, UserResourceImpl

public interface BaseResourceTypeResource<T>

Method Summary

Modifier and Type	Method	Description
default jakarta.ws.rs.core.Response	create(T resource, AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)
default jakarta.ws.rs.core.Response	delete(String id)
default jakarta.ws.rs.core.Response	find(SearchRequest request)
default jakarta.ws.rs.core.Response	getById(String id, AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)
default jakarta.ws.rs.core.Response	patch(PatchRequest patchRequest, String id, AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)
default jakarta.ws.rs.core.Response	query(AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes, FilterWrapper filterWrapper, AttributeReference sortBy, SortOrder sortOrder, Integer startIndex, Integer count)
default jakarta.ws.rs.core.Response	update(T resource, String id, AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)

Method Details

getById

@GET
@Path("{id}")
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response getById(@PathParam("id")
 String id,
 @QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                     throws ScimException,
ResourceException

Returns:

Throws:

ScimException

UnableToRetrieveResourceException

ResourceException

See Also:

• Scim spec, retrieving known resources

query

@GET
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response query(@QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes,
 @QueryParam("filter")
 FilterWrapper filterWrapper,
 @QueryParam("sortBy")
 AttributeReference sortBy,
 @QueryParam("sortOrder")
 SortOrder sortOrder,
 @QueryParam("startIndex")
 Integer startIndex,
 @QueryParam("count")
 Integer count)
                                   throws ScimException,
ResourceException

Returns:

Throws:

ScimException

ResourceException

See Also:

• Scim spec, query resources

create

@POST
@Consumes({"application/scim+json","application/json"})
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response create(T resource,
 @QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                    throws ScimException,
ResourceException

Returns:

Throws:

ScimException

ResourceException

See Also:

• Scim spec, query resources

find

@POST
@Path("/.search")
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response find(SearchRequest request)
                                  throws ScimException,
ResourceException

Returns:

Throws:

ScimException

ResourceException

See Also:

• Scim spec, query with post

update

@PUT
@Path("{id}")
@Consumes({"application/scim+json","application/json"})
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response update(T resource,
 @PathParam("id")
 String id,
 @QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                    throws ScimException,
ResourceException

Returns:

Throws:

ScimException

ResourceException

See Also:

• Scim spec, update

patch

@PATCH
@Path("{id}")
@Consumes({"application/scim+json","application/json"})
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response patch(PatchRequest patchRequest,
 @PathParam("id")
 String id,
 @QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                   throws ScimException,
ResourceException

Throws:

ScimException

ResourceException

delete

@DELETE
@Path("{id}")
default jakarta.ws.rs.core.Response delete(@PathParam("id")
 String id)
                                    throws ScimException,
ResourceException

Throws:

ScimException

ResourceException