com.unboundid.scim.sdk

Class Diff<R extends BaseResource>

java.lang.Object

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

Type Parameters:

R - The type of resource instances the diff was generated from.

public final class Diff<R extends BaseResource>
extends Object

This utility class may be used to generate a set of attribute modifications between two SCIM resources of the same type. This is especially useful for performing a PATCH request to modify a resource so it matches a target resource. For example:

 UserResource target = ...
 UserResource source = userEndpoint.getUser("someUser");

 Diff diff = Diff.generate(source, target);

 userEndpoint.update(source.getId(),
                     diff.getAttributesToUpdate(),
                     diff.getAttributesToDelete());
 

You can also create a Diff instance from a SCIM partial resource which contains PATCH modifications. This can then be applied to a source resource to produce the target resource. For example:

 Diff diff = Diff.fromPartialResource(partialResource);
 BaseResource targetResource = diff.apply(sourceResource);
 

Method Summary

Methods

Modifier and Type	Method and Description
R	apply(R sourceResource, ResourceFactory<R> resourceFactory) Applies the modifications from this Diff to the specified source resource, and returns the resulting SCIM resource.
static <R extends BaseResource> Diff<R>	fromPartialResource(R partialResource, boolean includeReadOnlyAttributes) Generates a diff with modifications that can be applied to the source resource in order to make it match the target resource.
static <R extends BaseResource> Diff<R>	generate(R source, R target, String... attributes) Generates a diff with modifications that can be applied to the source resource in order to make it match the target resource.
List<String>	getAttributesToDelete() Retrieves the list of attributes deleted from the source resource.
List<SCIMAttribute>	getAttributesToUpdate() Retrieves the list of updated attributes (and their new values) to update on the source resource.
R	toPartialResource(ResourceFactory<R> resourceFactory, boolean includeReadOnlyAttributes) Retrieves the partial resource with the modifications that maybe sent in a PATCH request.

Methods inherited from class java.lang.Object

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

Method Detail

getAttributesToDelete

public List<String> getAttributesToDelete()

Retrieves the list of attributes deleted from the source resource. The values here are SCIM attribute names which may or may not contain the schema URN. These can be easily parsed using the AttributePath.parse(java.lang.String) method.

Returns:

The list of attributes deleted from source resource.

getAttributesToUpdate

public List<SCIMAttribute> getAttributesToUpdate()

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

Returns:

The list of attributes (and their new values) to update on the source resource. Note that the attributes are in PATCH form (i.e. they contain the values to merge into the resource).

apply

public R apply(R sourceResource,
      ResourceFactory<R> resourceFactory)

Applies the modifications from this Diff to the specified source resource, and returns the resulting SCIM resource.

Parameters:

sourceResource - the source resource to which the modifications should be applied.

resourceFactory - The ResourceFactory that should be used to create the new resource instance.

Returns:

the target resource with the modifications applied

toPartialResource

public R toPartialResource(ResourceFactory<R> resourceFactory,
                  boolean includeReadOnlyAttributes)
                                         throws InvalidResourceException

Retrieves the partial resource with the modifications that maybe sent in a PATCH request.

Parameters:

resourceFactory - The ResourceFactory that should be used to create the new resource instance.

includeReadOnlyAttributes - whether read-only attributes should be included in the partial resource. If this is false, these attributes will be stripped out.

Returns:

The partial resource with the modifications that maybe sent in a PATCH request.

Throws:

InvalidResourceException - If an error occurs.

fromPartialResource

public static <R extends BaseResource> Diff<R> fromPartialResource(R partialResource,
                                                   boolean includeReadOnlyAttributes)

Generates a diff with modifications that can be applied to the source resource in order to make it match the target resource.

Type Parameters:

R - The type of the source and target resource instances.

Parameters:

partialResource - The partial resource containing the PATCH modifications from which to generate the diff.

includeReadOnlyAttributes - whether read-only attributes should be included in the Diff. If this is false, these attributes will be stripped out.

Returns:

A diff with modifications that can be applied to the source resource in order to make it match the target resource.

generate

public static <R extends BaseResource> Diff<R> generate(R source,
                                        R target,
                                        String... attributes)

Generates a diff with modifications that can be applied to the source resource in order to make it match the target resource.

Type Parameters:

R - The type of the source and target resource instances.

Parameters:

source - The source resource for which the set of modifications should be generated.

target - The target resource, which is what the source resource should look like if the returned modifications are applied.

attributes - The set of attributes to be compared in standard attribute notation (ie. name.givenName). If this is null or empty, then all attributes will be compared.

Returns:

A diff with modifications that can be applied to the source resource in order to make it match the target resource.