Package com.unboundid.scim2.server.resources

Class SchemasEndpoint

java.lang.Object

com.unboundid.scim2.server.resources.SchemasEndpoint

@Path("Schemas")
public class SchemasEndpoint
extends Object

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

Constructor Summary

Constructors

Constructor	Description
SchemasEndpoint()

Method Summary

Modifier and Type	Method	Description
ScimResource	get(String id, jakarta.ws.rs.core.UriInfo uriInfo)	Service SCIM request to retrieve a schema by ID.
Collection<SchemaResource>	getSchemas()	Retrieve all schemas defined at the service provider.
ListResponse<GenericScimResource>	search(String filterString, jakarta.ws.rs.core.UriInfo uriInfo)	Service SCIM request to retrieve all schemas 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

SchemasEndpoint

public SchemasEndpoint()

Method Detail

search

@NotNull
@GET
@Produces({"application/scim+json","application/json"})
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 schemas 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 schemas 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 schema by ID.

Parameters:

id - The ID of the schema to retrieve.

uriInfo - UriInfo of the request.

Returns:

The retrieved schema.

Throws:

ScimException - If an error occurs.

getSchemas

@NotNull
public Collection<SchemaResource> getSchemas()
                                      throws ScimException

Retrieve all schemas defined at the service provider. The default implementation will generate Schemas definitions based on the ResourceType of all JAX-RS resource classes with the ResourceType annotation.

Returns:

All schemas defined at the service provider.

Throws:

ScimException - If an error occurs.