Package com.unboundid.scim2.server.resources

Class ResourceTypesEndpoint

java.lang.Object

com.unboundid.scim2.server.resources.ResourceTypesEndpoint

@Path("ResourceTypes")
public class ResourceTypesEndpoint
extends Object

An abstract JAX-RS resource class for servicing the Resource Types endpoint.

Constructor Summary

Constructors

Constructor	Description
ResourceTypesEndpoint()

Method Summary

Modifier and Type	Method	Description
ScimResource	get(String id, jakarta.ws.rs.core.UriInfo uriInfo)	Service SCIM request to retrieve a resource type by ID.
Collection<ResourceTypeResource>	getResourceTypes()	Retrieve all resource types defined at the service provider.
ListResponse<GenericScimResource>	search(String filterString, jakarta.ws.rs.core.UriInfo uriInfo)	Service SCIM request to retrieve all resource types defined at the service provider using GET.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceTypesEndpoint

public ResourceTypesEndpoint()

Method Detail

search

@GET
@Produces({"application/scim+json","application/json"})
@NotNull
public ListResponse<GenericScimResource> search(@Nullable @QueryParam("filter")
                                                String filterString,
                                                @NotNull @Context
                                                jakarta.ws.rs.core.UriInfo uriInfo)
                                         throws ScimException

Service SCIM request to retrieve all resource types defined at the service provider using GET.

Parameters:

filterString - The filter string used to request a subset of resources. Will throw 403 Forbidden if specified.

uriInfo - UriInfo of the request.

Returns:

All resource types in a ListResponse container.

Throws:

ScimException - If an error occurs.

get

@Path("{id}")
@GET
@Produces({"application/scim+json","application/json"})
@NotNull
public ScimResource get(@NotNull @PathParam("id")
                        String id,
                        @NotNull @Context
                        jakarta.ws.rs.core.UriInfo uriInfo)
                 throws ScimException

Service SCIM request to retrieve a resource type by ID.

Parameters:

id - The ID of the resource type to retrieve.

uriInfo - UriInfo of the request.

Returns:

The retrieved resource type.

Throws:

ScimException - If an error occurs.

getResourceTypes

@NotNull
public Collection<ResourceTypeResource> getResourceTypes()
                                                  throws ScimException

Retrieve all resource types defined at the service provider. The default implementation will generate ResourceType definitions from all JAX-RS resource classes with the ResourceType annotation.

Returns:

All resource types defined at the service provider.

Throws:

ScimException - If an error occurs.