com.unboundid.scim.sdk

Class SCIMBackend

java.lang.Object

com.unboundid.scim.sdk.SCIMBackend

Direct Known Subclasses:

ResourceSchemaBackend

public abstract class SCIMBackend
extends Object

This class defines an API for a backend that can be plugged into the SCIM server.

Constructor Summary

Constructors

Constructor and Description
SCIMBackend()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	deleteResource(DeleteResourceRequest request) Delete a specific resource.
abstract void	finalizeBackend() Performs any cleanup which may be necessary when this backend is to be taken out of service.
SCIMBackendConfig	getConfig() Retrieve the mutable configuration settings for the backend.
abstract BaseResource	getResource(GetResourceRequest request) Retrieve all or selected attributes of a resource.
ResourceDescriptor	getResourceDescriptor(String endpoint) Retrieve the resource descriptor for the specified endpoint.
abstract Collection<ResourceDescriptor>	getResourceDescriptors() Retrieve the resource descriptors served by this backend.
abstract Resources	getResources(GetResourcesRequest request) Retrieve selected resources.
Collection<AuthenticationScheme>	getSupportedAuthenticationSchemes() Retrieves the authentication schemes supported by this backend.
abstract BaseResource	patchResource(PatchResourceRequest request) Update the contents of an existing resource with attributes specified.
abstract BaseResource	postResource(PostResourceRequest request) Create a new resource.
abstract BaseResource	putResource(PutResourceRequest request) Replace the contents of an existing resource.
boolean	supportsSorting() Retrieves whether this backend supports sorting.
boolean	supportsVersioning() Retrieves whether this backends supports resource versioning.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCIMBackend

public SCIMBackend()

Method Detail

finalizeBackend

public abstract void finalizeBackend()

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

getConfig

public SCIMBackendConfig getConfig()

Retrieve the mutable configuration settings for the backend.

Returns:

The mutable configuration settings for the backend.

getResource

public abstract BaseResource getResource(GetResourceRequest request)
                                  throws SCIMException

Retrieve all or selected attributes of a resource.

Parameters:

request - The Get Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

getResources

public abstract Resources getResources(GetResourcesRequest request)
                                throws SCIMException

Retrieve selected resources.

Parameters:

request - The Get Resources request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

postResource

public abstract BaseResource postResource(PostResourceRequest request)
                                   throws SCIMException

Create a new resource.

Parameters:

request - The Post Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

deleteResource

public abstract void deleteResource(DeleteResourceRequest request)
                             throws SCIMException

Delete a specific resource.

Parameters:

request - The Delete Resource request.

Throws:

SCIMException - if an error occurs while processing the request.

putResource

public abstract BaseResource putResource(PutResourceRequest request)
                                  throws SCIMException

Replace the contents of an existing resource.

Parameters:

request - The Put Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

patchResource

public abstract BaseResource patchResource(PatchResourceRequest request)
                                    throws SCIMException

Update the contents of an existing resource with attributes specified.

Parameters:

request - The Patch Resource request.

Returns:

The response to the request.

Throws:

SCIMException - if an error occurs while processing the request.

supportsSorting

public boolean supportsSorting()

Retrieves whether this backend supports sorting.

Returns:

true if sorting is supported or false otherwise.

supportsVersioning

public boolean supportsVersioning()

Retrieves whether this backends supports resource versioning.

Returns:

true if versioning is supported or false otherwise.

getSupportedAuthenticationSchemes

public Collection<AuthenticationScheme> getSupportedAuthenticationSchemes()

Retrieves the authentication schemes supported by this backend.

Returns:

The authentication schemes supported by this backend.

getResourceDescriptors

public abstract Collection<ResourceDescriptor> getResourceDescriptors()

Retrieve the resource descriptors served by this backend.

Returns:

The resource descriptors served by this backend.

getResourceDescriptor

public ResourceDescriptor getResourceDescriptor(String endpoint)

Retrieve the resource descriptor for the specified endpoint.

Parameters:

endpoint - The endpoint of the resource descriptor to retrieve.

Returns:

The resource descriptor for the specified endpoint or null if no resource descriptors with the specified endpoint was found.