com.unboundid.scim.sdk

Class SCIMEndpoint<R extends BaseResource>

java.lang.Object

com.unboundid.scim.sdk.SCIMEndpoint<R>

Type Parameters:

R - The type of resource instances handled by this SCIMEndpoint.

public class SCIMEndpoint<R extends BaseResource>
extends Object

This class represents a SCIM endpoint (ie. Users, Groups, etc.) and handles all protocol-level interactions with the service provider. It acts as a helper class for invoking CRUD operations of resources and processing their results.

Method Summary

Methods

Modifier and Type	Method and Description
R	create(R resource, String... requestedAttributes) Create the specified resource instance at the service provider and return only the specified attributes from the newly inserted resource.
void	delete(R resource) Delete the specified resource instance.
void	delete(String id) Deprecated.
void	delete(String id, String etag) Delete the resource instance specified by the provided ID.
R	get(String id) Retrieves a resource instance given the ID.
R	get(String id, String etag, String... requestedAttributes) Retrieves a resource instance given the ID, only if the current version has been modified.
R	newResource() Constructs a new instance of a resource object which is empty.
Resources<R>	query(String filter) Retrieves all resource instances that match the provided filter.
Resources<R>	query(String filter, SortParameters sortParameters, PageParameters pageParameters, Map<String,String> additionalQueryParams, String... requestedAttributes) Retrieves all resource instances that match the provided filter.
Resources<R>	query(String filter, SortParameters sortParameters, PageParameters pageParameters, String... requestedAttributes) Retrieves all resource instances that match the provided filter.
R	update(R resource) Update the existing resource with the one provided (using the HTTP PUT method).
R	update(R resource, List<SCIMAttribute> attributesToUpdate, List<String> attributesToDelete) Update the existing resource with the one provided (using the HTTP PATCH method).
R	update(R resource, String etag, String... requestedAttributes) Deprecated.
void	update(String id, List<SCIMAttribute> attributesToUpdate, List<String> attributesToDelete) Deprecated.
R	update(String id, String etag, List<SCIMAttribute> attributesToUpdate, List<String> attributesToDelete, String... requestedAttributes) Update the existing resource with the one provided (using the HTTP PATCH method).
R	update(String id, String etag, R resource, String... requestedAttributes) Update the existing resource with the one provided (using the HTTP PUT method).

Methods inherited from class java.lang.Object

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

Method Detail

newResource

public R newResource()

Constructs a new instance of a resource object which is empty. This method does not interact with the SCIM service. It creates a local object that may be provided to the create(R, java.lang.String...) method after the attributes have been specified.

Returns:

A new instance of a resource object.

get

public R get(String id)
                           throws SCIMException

Retrieves a resource instance given the ID.

Parameters:

id - The ID of the resource to retrieve.

Returns:

The retrieved resource.

Throws:

SCIMException - If an error occurs.

get

public R get(String id,
    String etag,
    String... requestedAttributes)
                           throws SCIMException

Retrieves a resource instance given the ID, only if the current version has been modified.

Parameters:

id - The ID of the resource to retrieve.

etag - The entity tag that indicates the entry should be returned only if the entity tag of the current resource is different from the provided value and a value of "*" will not return an entry if the resource still exists. A value of null indicates unconditional return.

requestedAttributes - The attributes of the resource to retrieve.

Returns:

The retrieved resource.

Throws:

SCIMException - If an error occurs.

query

public Resources<R> query(String filter)
                                        throws SCIMException

Retrieves all resource instances that match the provided filter.

Parameters:

filter - The filter that should be used.

Returns:

The resource instances that match the provided filter.

Throws:

SCIMException - If an error occurs.

query

public Resources<R> query(String filter,
                 SortParameters sortParameters,
                 PageParameters pageParameters,
                 String... requestedAttributes)
                                        throws SCIMException

Retrieves all resource instances that match the provided filter. Matching resources are returned sorted according to the provided SortParameters. PageParameters maybe used to specify the range of resource instances that are returned.

Parameters:

filter - The filter that should be used.

sortParameters - The sort parameters that should be used.

pageParameters - The page parameters that should be used.

requestedAttributes - The attributes of the resource to retrieve.

Returns:

The resource instances that match the provided filter.

Throws:

SCIMException - If an error occurs.

query

public Resources<R> query(String filter,
                 SortParameters sortParameters,
                 PageParameters pageParameters,
                 Map<String,String> additionalQueryParams,
                 String... requestedAttributes)
                                        throws SCIMException

Retrieves all resource instances that match the provided filter. Matching resources are returned sorted according to the provided SortParameters. PageParameters maybe used to specify the range of resource instances that are returned. Additional query parameters may be specified using a Map of parameter names to their values.

Parameters:

filter - The filter that should be used.

sortParameters - The sort parameters that should be used.

pageParameters - The page parameters that should be used.

additionalQueryParams - A map of additional query parameters that should be included.

requestedAttributes - The attributes of the resource to retrieve.

Returns:

The resource instances that match the provided filter.

Throws:

SCIMException - If an error occurs.

create

public R create(R resource,
       String... requestedAttributes)
                              throws SCIMException

Create the specified resource instance at the service provider and return only the specified attributes from the newly inserted resource.

Parameters:

resource - The resource to create.

requestedAttributes - The attributes of the newly inserted resource to retrieve.

Returns:

The newly inserted resource returned by the service provider.

Throws:

SCIMException - If an error occurs.

update

public R update(R resource)
                              throws SCIMException

Update the existing resource with the one provided (using the HTTP PUT method).

Parameters:

resource - The modified resource to be updated.

Returns:

The updated resource returned by the service provider.

Throws:

SCIMException - If an error occurs.

update

@Deprecated
public R update(R resource,
                  String etag,
                  String... requestedAttributes)
                              throws SCIMException

Deprecated.

Update the existing resource with the one provided (using the HTTP PUT method). This update is conditional upon the provided entity tag matching the tag from the current resource. If (and only if) they match, the update will be performed.

Parameters:

resource - The modified resource to be updated.

etag - The entity tag value that is the expected value for the target resource. A value of null will not set an etag precondition and a value of "*" will perform an unconditional update.

requestedAttributes - The attributes of updated resource to return.

Returns:

The updated resource returned by the service provider.

Throws:

SCIMException - If an error occurs.

update

public R update(String id,
       String etag,
       R resource,
       String... requestedAttributes)
                              throws SCIMException

Update the existing resource with the one provided (using the HTTP PUT method). This update is conditional upon the provided entity tag matching the tag from the current resource. If (and only if) they match, the update will be performed.

Parameters:

id - The ID of the resource to update.

etag - The entity tag value that is the expected value for the target resource. A value of null will not set an etag precondition and a value of "*" will perform an unconditional update.

resource - The modified resource to be updated.

requestedAttributes - The attributes of updated resource to return.

Returns:

The updated resource returned by the service provider.

Throws:

SCIMException - If an error occurs.

update

public R update(R resource,
       List<SCIMAttribute> attributesToUpdate,
       List<String> attributesToDelete)
                              throws SCIMException

Update the existing resource with the one provided (using the HTTP PATCH method). Note that if the attributesToDelete parameter is specified, those attributes will be removed from the resource before the attributesToUpdate are merged into the resource.

Parameters:

resource - The resource to update.

attributesToUpdate - The list of attributes (and their new values) to update on the resource.

attributesToDelete - The list of attributes to delete on the resource.

Returns:

The updated resource returned by the service provider, or an empty resource with returned meta data if the service provider returned no content.

Throws:

SCIMException - If an error occurs.

update

public R update(String id,
       String etag,
       List<SCIMAttribute> attributesToUpdate,
       List<String> attributesToDelete,
       String... requestedAttributes)
                              throws SCIMException

Update the existing resource with the one provided (using the HTTP PATCH method). Note that if the attributesToDelete parameter is specified, those attributes will be removed from the resource before the attributesToUpdate are merged into the resource.

Parameters:

id - The ID of the resource to update.

etag - The entity tag value that is the expected value for the target resource. A value of null will not set an etag precondition and a value of "*" will perform an unconditional update.

attributesToUpdate - The list of attributes (and their new values) to update on the resource. These attributes should conform to Section 3.2.2 of the SCIM 1.1 specification (draft-scim-api-01), "Modifying Resources with PATCH".

attributesToDelete - The list of attributes to delete on the resource.

requestedAttributes - The attributes of updated resource to return.

Returns:

The updated resource returned by the service provider, or an empty resource with returned meta data if the requestedAttributes parameter was not specified and the service provider returned no content.

Throws:

SCIMException - If an error occurs.

update

@Deprecated
public void update(String id,
                     List<SCIMAttribute> attributesToUpdate,
                     List<String> attributesToDelete)
            throws SCIMException

Deprecated.

Update the existing resource with the one provided (using the HTTP PATCH method). Note that if the attributesToDelete parameter is specified, those attributes will be removed from the resource before the attributesToUpdate are merged into the resource.

Parameters:

id - The ID of the resource to update.

attributesToUpdate - The list of attributes (and their new values) to update on the resource.

attributesToDelete - The list of attributes to delete on the resource.

Throws:

SCIMException - If an error occurs.

delete

@Deprecated
public void delete(String id)
            throws SCIMException

Deprecated.

Delete the resource instance specified by the provided ID.

Parameters:

id - The ID of the resource to delete.

Throws:

SCIMException - If an error occurs.

delete

public void delete(R resource)
            throws SCIMException

Delete the specified resource instance.

Parameters:

resource - The resource to delete.

Throws:

SCIMException - If an error occurs.

delete

public void delete(String id,
          String etag)
            throws SCIMException

Delete the resource instance specified by the provided ID. This delete is conditional upon the provided entity tag matching the tag from the current resource. If (and only if) they match, the delete will be performed.

Parameters:

id - The ID of the resource to delete.

etag - The entity tag value that is the expected value for the target resource. A value of null will not set an etag precondition and a value of "*" will perform an unconditional delete.

Throws:

SCIMException - If an error occurs.