com.unboundid.scim2.server.utils

Class ResourceTrimmer

java.lang.Object

com.unboundid.scim2.server.utils.ResourceTrimmer

Direct Known Subclasses:

ScimResourceTrimmer

public abstract class ResourceTrimmer
extends Object

An abstract class which may be implemented to trim resources down to selected attributes.

Constructor Summary

Constructors

Constructor and Description
ResourceTrimmer()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	shouldReturn(com.unboundid.scim2.common.Path path) Determine if the attribute specified by the path should be returned.
protected com.fasterxml.jackson.databind.node.ArrayNode	trimArrayNode(com.fasterxml.jackson.databind.node.ArrayNode arrayNode, com.unboundid.scim2.common.Path parentPath) Trim attributes of the values in the array node to return.
com.fasterxml.jackson.databind.node.ObjectNode	trimObjectNode(com.fasterxml.jackson.databind.node.ObjectNode objectNode) Trim attributes of the object node to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceTrimmer

public ResourceTrimmer()

Method Detail

trimObjectNode

public com.fasterxml.jackson.databind.node.ObjectNode trimObjectNode(com.fasterxml.jackson.databind.node.ObjectNode objectNode)

Trim attributes of the object node to return.

Parameters:

objectNode - The object node to return.

Returns:

The trimmed object node ready to return to the client.

trimArrayNode

protected com.fasterxml.jackson.databind.node.ArrayNode trimArrayNode(com.fasterxml.jackson.databind.node.ArrayNode arrayNode,
                                                          com.unboundid.scim2.common.Path parentPath)

Trim attributes of the values in the array node to return.

Parameters:

arrayNode - The array node to return.

parentPath - The parent path of attributes in the array.

Returns:

The trimmed object node ready to return to the client.

shouldReturn

public abstract boolean shouldReturn(com.unboundid.scim2.common.Path path)

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

Parameters:

path - The path for the attribute.

Returns:

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