Package com.unboundid.scim2.server.utils

Class ScimResourceTrimmer

java.lang.Object

com.unboundid.scim2.server.utils.ResourceTrimmer

com.unboundid.scim2.server.utils.ScimResourceTrimmer

public class ScimResourceTrimmer
extends ResourceTrimmer

A resource trimmer implementing the SCIM standard for returning attributes.

Constructor Summary

Constructors

Constructor	Description
ScimResourceTrimmer(ResourceTypeDefinition resourceType, Set<Path> requestAttributes, Set<Path> queryAttributes, boolean excluded)	Create a new SCIMResourceTrimmer.

Method Summary

Modifier and Type	Method	Description
boolean	shouldReturn(Path path)	Determine if the attribute specified by the path should be returned.

Methods inherited from class com.unboundid.scim2.server.utils.ResourceTrimmer

trimArrayNode, trimObjectNode

Methods inherited from class java.lang.Object

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

Constructor Detail

ScimResourceTrimmer

public ScimResourceTrimmer(@NotNull
                           ResourceTypeDefinition resourceType,
                           @NotNull
                           Set<Path> requestAttributes,
                           @NotNull
                           Set<Path> queryAttributes,
                           boolean excluded)

Create a new SCIMResourceTrimmer.

Parameters:

resourceType - The resource type definition for resources to trim.

requestAttributes - The attributes in the request object or null for other requests.

queryAttributes - The attributes from the 'attributes' or 'excludedAttributes' query parameter.

excluded - true if the queryAttributes came from the excludedAttributes query parameter.

Method Detail

shouldReturn

public boolean shouldReturn(@NotNull
                            Path path)

Determine if the attribute specified by the path should be returned.

Specified by:

shouldReturn in class ResourceTrimmer

Parameters:

path - The path for the attribute.

Returns:

true to return the attribute or false to remove the attribute from the returned resource.