com.unboundid.scim.sdk

Class ResourceSchemaBackend

java.lang.Object

com.unboundid.scim.sdk.SCIMBackend

com.unboundid.scim.sdk.ResourceSchemaBackend

public class ResourceSchemaBackend
extends SCIMBackend

This class provides an implementation of the SCIM server backend API that serves up the resource schema from a collection of ResourceDescriptors.

Constructor Summary

Constructors

Constructor and Description
ResourceSchemaBackend(SCIMApplication application) Create a new ResourceSchemaBackend that serves up the schema provided from the ResourceDescriptors.

Method Summary

Methods

Modifier and Type	Method and Description
static ResourceDescriptor	copyAndSetIdAndMetaAttributes(ResourceDescriptor resource, ResourceReturningRequest request) Make a copy of the ResourceDescriptor and set the id and meta attributes from the provided information.
void	deleteResource(DeleteResourceRequest request) Delete a specific resource.
void	finalizeBackend() Performs any cleanup which may be necessary when this backend is to be taken out of service.
ResourceDescriptor	getResource(GetResourceRequest request) Retrieve all or selected attributes of a resource.
Collection<ResourceDescriptor>	getResourceDescriptors() Retrieve the resource descriptors served by this backend.
Resources	getResources(GetResourcesRequest request) Retrieve selected resources.
void	getStreamedResources(GetStreamedResourcesRequest request, StreamedResultListener listener) Retrieve selected resources using the UnboundID streamed query SCIM extension.
BaseResource	patchResource(PatchResourceRequest request) Update the contents of an existing resource with attributes specified.
BaseResource	postResource(PostResourceRequest request) Create a new resource.
BaseResource	putResource(PutResourceRequest request) Replace the contents of an existing resource.

Methods inherited from class com.unboundid.scim.sdk.SCIMBackend

getConfig, getResourceDescriptor, getSupportedAuthenticationSchemes, supportsSorting, supportsVersioning

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceSchemaBackend

public ResourceSchemaBackend(SCIMApplication application)

Create a new ResourceSchemaBackend that serves up the schema provided from the ResourceDescriptors.

Parameters:

application - The SCIM JAX-RS application associated with this backend.

Method Detail

finalizeBackend

public void finalizeBackend()

Performs any cleanup which may be necessary when this backend is to be taken out of service.

Specified by:

finalizeBackend in class SCIMBackend

getResource

public ResourceDescriptor getResource(GetResourceRequest request)
                               throws SCIMException

Retrieve all or selected attributes of a resource.

Specified by:

getResource in class SCIMBackend

Parameters:

request - The Get Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

getResources

public Resources getResources(GetResourcesRequest request)
                       throws SCIMException

Retrieve selected resources.

Specified by:

getResources in class SCIMBackend

Parameters:

request - The Get Resources request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

postResource

public BaseResource postResource(PostResourceRequest request)
                          throws SCIMException

Create a new resource.

Specified by:

postResource in class SCIMBackend

Parameters:

request - The Post Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

deleteResource

public void deleteResource(DeleteResourceRequest request)
                    throws SCIMException

Delete a specific resource.

Specified by:

deleteResource in class SCIMBackend

Parameters:

request - The Delete Resource request.

Throws:

SCIMException - if an error occurs while processing the request.

putResource

public BaseResource putResource(PutResourceRequest request)
                         throws SCIMException

Replace the contents of an existing resource.

Specified by:

putResource in class SCIMBackend

Parameters:

request - The Put Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

patchResource

public BaseResource patchResource(PatchResourceRequest request)
                           throws SCIMException

Update the contents of an existing resource with attributes specified.

Specified by:

patchResource in class SCIMBackend

Parameters:

request - The Patch Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

getResourceDescriptors

public Collection<ResourceDescriptor> getResourceDescriptors()

Retrieve the resource descriptors served by this backend.

Specified by:

getResourceDescriptors in class SCIMBackend

Returns:

The resource descriptors served by this backend.

getStreamedResources

public void getStreamedResources(GetStreamedResourcesRequest request,
                        StreamedResultListener listener)
                          throws SCIMException

Retrieve selected resources using the UnboundID streamed query SCIM extension.

Specified by:

getStreamedResources in class SCIMBackend

Parameters:

request - The Get Streamed Resources request.

listener - Listener object to receive results.

Throws:

SCIMException - if an error occurs while processing the request.

copyAndSetIdAndMetaAttributes

public static ResourceDescriptor copyAndSetIdAndMetaAttributes(ResourceDescriptor resource,
                                               ResourceReturningRequest request)

Make a copy of the ResourceDescriptor and set the id and meta attributes from the provided information.

Parameters:

resource - The SCIM object whose id and meta attributes are to be set.

request - The SCIM request.

Returns:

The copy of the ResourceDescriptor.