com.unboundid.scim2.server.resources

Class SchemasEndpoint

java.lang.Object

com.unboundid.scim2.server.resources.SchemasEndpoint

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

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

Constructor Summary

Constructors

Constructor and Description
SchemasEndpoint()

Method Summary

Methods

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

@GET
@Produces(value={"application/scim+json","application/json"})
public com.unboundid.scim2.common.messages.ListResponse<com.unboundid.scim2.common.GenericScimResource> search(@QueryParam(value="filter")
                                                                                                                   String filterString,
                                                                                                                   @Context
                                                                                                                   javax.ws.rs.core.UriInfo uriInfo)
                                                                                                        throws com.unboundid.scim2.common.exceptions.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:

com.unboundid.scim2.common.exceptions.ScimException - If an error occurs.

get

@Path(value="{id}")
@GET
@Produces(value={"application/scim+json","application/json"})
public com.unboundid.scim2.common.ScimResource get(@PathParam(value="id")
                                                            String id,
                                                            @Context
                                                            javax.ws.rs.core.UriInfo uriInfo)
                                            throws com.unboundid.scim2.common.exceptions.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:

com.unboundid.scim2.common.exceptions.ScimException - If an error occurs.

getSchemas

public Collection<com.unboundid.scim2.common.types.SchemaResource> getSchemas()
                                                                       throws com.unboundid.scim2.common.exceptions.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:

com.unboundid.scim2.common.exceptions.ScimException - If an error occurs.