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

SCIMBackend()

Method Summary

abstract boolean	authenticate(String userID, String password) Perform basic authentication using the provided information.
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.
abstract Resources	getResources(GetResourcesRequest request) Retrieve selected resources.
abstract BaseResource	postResource(PostResourceRequest request) Create a new resource.
abstract BaseResource	putResource(PutResourceRequest request) Replace the contents of an existing resource.

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.

authenticate

public abstract boolean authenticate(String userID,
                                     String password)

Perform basic authentication using the provided information.

Parameters:

userID - The user ID to be authenticated.

password - The user password to be verified.

Returns:

true if the provided user ID and password are valid.

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.