com.unboundid.scim2.common.GenericScimResource Maven / Gradle / Ivy
Show all versions of scim2-sdk-common Show documentation
/*
* Copyright 2015-2020 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.scim2.common;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.databind.node.TextNode;
import com.unboundid.scim2.common.exceptions.ScimException;
import com.unboundid.scim2.common.exceptions.ServerErrorException;
import com.unboundid.scim2.common.types.Meta;
import com.unboundid.scim2.common.utils.GenericScimObjectDeserializer;
import com.unboundid.scim2.common.utils.GenericScimObjectSerializer;
import com.unboundid.scim2.common.utils.JsonUtils;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
/**
* A generic SCIM object. This object can be used if you have no
* Java object representing the SCIM object being returned.
*
* This object can be used when the exact structure of the SCIM object
* that will be received as JSON text is not known. This will provide
* methods that can read attributes from those objects without needing
* to know the schema ahead of time. Another way to work with SCIM
* objects is when you know ahead of time what the schema will be. In
* that case you could still use this object, but {@link BaseScimResource}
* might be a better choice.
*
* If you have a BaseScimResource derived object, you can always get a
* {@link GenericScimResource} by calling {@link #asGenericScimResource()}.
* You could also go the other way by calling
* {@link GenericScimResource#getObjectNode()}, followed by
* {@link JsonUtils#nodeToValue(JsonNode, Class)}.
*
* @see BaseScimResource
*/
@JsonDeserialize(using = GenericScimObjectDeserializer.class)
@JsonSerialize(using = GenericScimObjectSerializer.class)
public final class GenericScimResource implements ScimResource
{
private static final Path SCHEMAS = Path.root().attribute("schemas");
private static final Path ID = Path.root().attribute("id");
private static final Path EXTERNAL_ID = Path.root().attribute("externalId");
private static final Path META = Path.root().attribute("meta");
private final ObjectNode objectNode;
/**
* Create a new empty GenericScimResource.
*/
public GenericScimResource()
{
this.objectNode = JsonUtils.getJsonNodeFactory().objectNode();
}
/**
* Create a new GenericScimResource backed by an ObjectNode.
*
* @param objectNode The ObjectNode that backs this object.
*/
public GenericScimResource(final ObjectNode objectNode)
{
this.objectNode = objectNode;
}
/**
* Gets the ObjectNode that backs this object.
* @return a ObjectNode.
*/
public ObjectNode getObjectNode()
{
return this.objectNode;
}
/**
* {@inheritDoc}
*/
@Override
public Meta getMeta()
{
try
{
List values = JsonUtils.findMatchingPaths(META, objectNode);
if(values.isEmpty())
{
return null;
}
return JsonUtils.nodeToValue(values.get(0), Meta.class);
}
catch (Exception e)
{
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* {@inheritDoc}
*/
@Override
public void setMeta(final Meta meta)
{
try
{
JsonUtils.replaceValue(META, objectNode, JsonUtils.valueToNode(meta));
}
catch (Exception e)
{
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* {@inheritDoc}
*/
@Override
public String getId()
{
try
{
JsonNode value = JsonUtils.getValue(ID, objectNode);
if(value.isNull())
{
return null;
}
return JsonUtils.nodeToValue(value, String.class);
}
catch (Exception e)
{
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* {@inheritDoc}
*/
@Override
public void setId(final String id)
{
try
{
JsonUtils.replaceValue(ID, objectNode, JsonUtils.valueToNode(id));
}
catch (Exception e)
{
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* {@inheritDoc}
*/
public List getSchemaUrns()
{
try
{
JsonNode value = JsonUtils.getValue(SCHEMAS, objectNode);
if(value.isNull() || !value.isArray())
{
return Collections.emptyList();
}
return JsonUtils.nodeToValues((ArrayNode) value, String.class);
}
catch (Exception e)
{
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* {@inheritDoc}
*/
public void setSchemaUrns(final Collection schemaUrns)
{
try
{
JsonUtils.replaceValue(SCHEMAS, objectNode,
JsonUtils.valueToNode(schemaUrns));
}
catch (Exception e)
{
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* {@inheritDoc}
*/
@Override
public String getExternalId()
{
try
{
JsonNode value = JsonUtils.getValue(EXTERNAL_ID, objectNode);
if(value.isNull())
{
return null;
}
return JsonUtils.nodeToValue(value, String.class);
}
catch (Exception e)
{
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* {@inheritDoc}
*/
@Override
public void setExternalId(final String externalId)
{
try
{
JsonUtils.replaceValue(EXTERNAL_ID, objectNode,
JsonUtils.valueToNode(externalId));
}
catch (ScimException e)
{ // This should never happen.
throw new RuntimeException(e);
}
}
/**
* Gets a single JsonNode from a generic SCIM resource. This value may
* be an ArrayNode.
*
*
* For example:
* With a generic SCIM resource representing the folowing JSON:
*
* {
* "name" : "Bob",
* "friends" : [ "Amy", "Beth", "Carol" ]
* }
*
*
* gsr.getValue("name");
* would return a TextNode containing "Bob"
*
*
* gsr.getValue("friends");
* would return an ArrayNode containing 3 TextNodes with the values
* "Amy", "Beth", and "Carol"
*
* @param path the String path of the object.
* @return the JsonNode at the path, or a NullNode if nothing is found
* @throws ScimException thrown if an error occurs.
*/
public JsonNode getValue(final String path)
throws ScimException
{
return getValue(Path.fromString(path));
}
/**
* Gets a single JsonNode from a generic SCIM resource. This value may
* be an ArrayNode.
*
*
* For example:
* With a generic SCIM resource representing the folowing JSON:
*
* {
* "name" : "Bob",
* "friends" : [ "Amy", "Beth", "Carol" ]
* }
*
*
*
* gsr.getValue("name");
* would return a TextNode containing "Bob"
*
*
* gsr.getValue("friends");
* would return an ArrayNode containing 3 TextNodes with the values
* "Amy", "Beth", and "Carol"
*
* @param path the path of the object.
* @return the JsonNode at the path, or a NullNode if nothing is found
* @throws ScimException thrown if an error occurs.
*/
public JsonNode getValue(final Path path)
throws ScimException
{
return JsonUtils.getValue(path, objectNode);
}
/**
* Update the value at the provided path. Equivalent to using the
* {@link JsonUtils#replaceValue(Path, ObjectNode, JsonNode)} method:
* JsonUtils.replaceValues(Path.fromString(path), getObjectNode(), value).
*
*
* The {@link JsonUtils#valueToNode(Object)} method may be used to convert
* the given value instance to a JSON node.
*
*
* @param path The path to the attribute whose value to set.
* @param value The value(s) to set.
* @return This object.
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final String path,
final JsonNode value)
throws ScimException
{
replaceValue(Path.fromString(path), value);
return this;
}
/**
* Update the value at the provided path. Equivalent to using the
* {@link JsonUtils#replaceValue(Path, ObjectNode, JsonNode)} method:
* JsonUtils.replaceValues(path, getObjectNode(), value).
*
*
* The {@link JsonUtils#valueToNode(Object)} method may be used to convert
* the given value instance to a JSON node.
*
*
* @param path The path to the attribute whose value to set.
* @param value The value(s) to set.
* @return This object.
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final Path path,
final JsonNode value)
throws ScimException
{
JsonUtils.replaceValue(path, objectNode, value);
return this;
}
/**
* Add new values at the provided path. Equivalent to using the
* {@link JsonUtils#addValue(Path, ObjectNode, JsonNode)} method:
* JsonUtils.addValue(Path.fromString(path), getObjectNode(), values).
*
*
* The {@link JsonUtils#valueToNode(Object)} method may be used to convert
* the given value instance to a JSON node.
*
*
* @param path The path to the attribute whose values to add.
* @param values The value(s) to add.
* @return This object.
* @throws ScimException If the path is invalid.
*/
public GenericScimResource addValues(final String path,
final ArrayNode values)
throws ScimException
{
addValues(Path.fromString(path), values);
return this;
}
/**
* Add new values at the provided path. Equivalent to using the
* {@link JsonUtils#addValue(Path, ObjectNode, JsonNode)} method:
* JsonUtils.addValue(path, getObjectNode(), values).
*
*
* The {@link JsonUtils#valueToNode(Object)} method may be used to convert
* the given value instance to a JSON node.
*
*
* @param path The path to the attribute whose values to add.
* @param values The value(s) to add.
* @return This object.
* @throws ScimException If the path is invalid.
*/
public GenericScimResource addValues(final Path path,
final ArrayNode values)
throws ScimException
{
JsonUtils.addValue(path, objectNode, values);
return this;
}
/**
* Removes values at the provided path. Equivalent
* to using the {@link JsonUtils#removeValues(Path, ObjectNode)} method:
* JsonUtils.removeValue(Path.fromString(path), getObjectNode(), values).
*
* @param path The path to the attribute whose values to remove.
* @return Whether one or more values where removed.
* @throws ScimException If the path is invalid.
*/
public boolean removeValues(final String path)
throws ScimException
{
return removeValues(Path.fromString(path));
}
/**
* Removes values at the provided path. Equivalent
* to using the {@link JsonUtils#removeValues(Path, ObjectNode)} method:
* JsonUtils.removeValue(Path.fromString(path), getObjectNode(), values).
*
* @param path The path to the attribute whose values to remove.
* @return Whether one or more values where removed.
* @throws ScimException If the path is invalid.
*/
public boolean removeValues(final Path path)
throws ScimException
{
List nodes = JsonUtils.removeValues(path, objectNode);
return !nodes.isEmpty();
}
/**
* {@inheritDoc}
*/
public GenericScimResource asGenericScimResource()
{
return this;
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
try
{
return JsonUtils.getObjectWriter().withDefaultPrettyPrinter().
writeValueAsString(this);
}
catch (JsonProcessingException e)
{
throw new RuntimeException(e);
}
}
/////////////////////////////////////
// SCIM String methods
/////////////////////////////////////
/**
* Adds or replaces a String value in a generic SCIM resource.
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"stringValue"
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is a String
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is a String
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final String path,
final String value) throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces a String value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"stringValue"
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is a String
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is a String
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final Path path,
final String value) throws ScimException
{
return replaceValue(path, JsonUtils.getJsonNodeFactory().textNode(value));
}
/**
* Adds String values to an array node. If no array node exists at the
* specified path, a new array node will be created.
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ "stringValue1", "stringValue2" ]
* }
*
*
* gsr.addStringValues("path1", path1values)
* where path1Value is a List of String.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addStringValues("path2", path2values)
* where path2values is a List of String.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addStringValues(final String path,
final List values) throws ScimException
{
return addStringValues(Path.fromString(path), values);
}
/**
* Adds String values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ "stringValue1", "stringValue2" ]
* }
*
*
* gsr.addStringValues(Path.fromString("path1"), path1values)
* where path1Value is a List of String.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addStringValues(Path.fromString("path2"), path2values)
* where path2values is a List of String.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addStringValues(final Path path,
final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for(String value : values)
{
valuesArrayNode.add(value);
}
return addValues(path, valuesArrayNode);
}
/**
* Gets a String value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a String. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"stringValue1"
* }
*
*
*
* getStringValue("path1")
* returns "stringValue1"
*
*
* getStringValue("bogusPath")
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public String getStringValue(final String path) throws ScimException
{
return getStringValue(Path.fromString(path));
}
/**
* Gets a String value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a String. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"stringValue1"
* }
*
*
*
* getStringValue(Path.fromString("path1"))
* returns Stringexample
*
*
* getStringValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public String getStringValue(final Path path) throws ScimException
{
JsonNode jsonNode = getValue(path);
return jsonNode.isNull() ? null : jsonNode.textValue();
}
/**
* Gets a list of String from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of String. If the path does
* not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1": ["stringValue1", "stringValue2"]
* }
*
*
*
* getStringValueList("path1")
* returns a list containing "stringValue1", "stringValue2"
*
*
* getStringValueList("bogusPath")
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getStringValueList(final String path) throws ScimException
{
return getStringValueList(Path.fromString(path));
}
/**
* Gets a list of String from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of String. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":["stringValue1", "stringValue2"]
* }
*
*
*
* getStringValueList(Path.fromString("path1"))
* returns a list containing "stringValue1", "stringValue2"
*
*
* getStringValueList(Path.fromString("bogusPath"))
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getStringValueList(final Path path) throws ScimException
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
values.add(iterator.next().textValue());
}
return values;
}
/////////////////////////////////////
// SCIM Boolean methods
/////////////////////////////////////
/**
* Adds or replaces a Boolean value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":true
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is a Boolean
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is a Boolean
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final String path,
final Boolean value) throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces a Boolean value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":true
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is a Boolean
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is a Boolean
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(
final Path path, final Boolean value) throws ScimException
{
return replaceValue(path, JsonUtils.getJsonNodeFactory().booleanNode(value));
}
/**
* Adds Boolean values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ true, false ]
* }
*
*
* gsr.addBooleanValues("path1", path1values)
* where path1Value is a List of Boolean.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addBooleanValues("path2", path2values)
* where path2values is a List of Boolean.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addBooleanValues(final String path,
final List values) throws ScimException
{
return addBooleanValues(Path.fromString(path), values);
}
/**
* Adds Boolean values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ true, false ]
* }
*
*
* gsr.addBooleanValues(Path.fromString("path1"), path1values)
* where path1Value is a List of Boolean.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addBooleanValues(Path.fromString("path2"), path2values)
* where path2values is a List of Boolean.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addBooleanValues(final Path path,
final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for(Boolean value : values)
{
valuesArrayNode.add(value);
}
return addValues(path, valuesArrayNode);
}
/**
* Gets a Boolean value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Boolean. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":true
* }
*
*
*
* getBooleanValue("path1")
* returns true
*
*
* getBooleanValue("bogusPath")
* returns null
*
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Boolean getBooleanValue(final String path) throws ScimException
{
return getBooleanValue(Path.fromString(path));
}
/**
* Gets a Boolean value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Boolean. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":true
* }
*
*
*
* getBooleanValue(Path.fromString("path1"))
* returns true
*
*
* getBooleanValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Boolean getBooleanValue(final Path path) throws ScimException
{
JsonNode jsonNode = getValue(path);
return jsonNode.isNull() ? null : jsonNode.booleanValue();
}
/**
* Gets a list of Boolean from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Boolean. If the path does
* not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[true, false]
* }
*
*
*
* getBooleanValueList("path1")
* returns a list containing true, false
*
*
* getBooleanValueList("bogusPath")
* returns an empty list
*
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getBooleanValueList(final String path)
throws ScimException
{
return getBooleanValueList(Path.fromString(path));
}
/**
* Gets a list of Boolean from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Boolean. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
*
* In a GenericScimResource (gsr) representing the following resource:
* {
* "path1":[true, false]
* }
*
*
*
* getBooleanValueList(Path.fromString("path1"))
* returns a list containing true, false
*
*
* getBooleanValueList(Path.fromString("bogusPath"))
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getBooleanValueList(final Path path) throws ScimException
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
values.add(iterator.next().booleanValue());
}
return values;
}
/////////////////////////////////////
// SCIM Decimal methods
/////////////////////////////////////
/**
* Adds or replaces a Double value in a generic SCIM resource.
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":2.0
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is a Double
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is a Double
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final String path,
final Double value) throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces a Double value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":2.0
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is a Double
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is a Double
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final Path path,
final Double value) throws ScimException
{
return replaceValue(path, JsonUtils.getJsonNodeFactory().numberNode(value));
}
/**
* Adds Double values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ 2.1, 2.2 ]
* }
*
*
* gsr.addDoubleValues("path1", path1values)
* where path1Value is a List of Double.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addDoubleValues("path2", path2values)
* where path2values is a List of Double.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addDoubleValues(final String path,
final List values) throws ScimException
{
return addDoubleValues(Path.fromString(path), values);
}
/**
* Adds Double values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ 2.1, 2.2 ]
* }
*
*
* gsr.addDoubleValues(Path.fromString("path1"), path1values)
* where path1Value is a List of Double.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addDoubleValues(Path.fromString("path2"), path2values)
* where path2values is a List of Double.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addDoubleValues(final Path path,
final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for(Double value : values)
{
valuesArrayNode.add(value);
}
return addValues(path, valuesArrayNode);
}
/**
* Gets a Double value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Double. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":2.0
* }
*
*
*
* getDoubleValue("path1")
* returns 2.0
*
*
* getDoubleValue("bogusPath")
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Double getDoubleValue(final String path) throws ScimException
{
return getDoubleValue(Path.fromString(path));
}
/**
* Gets a Double value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Double. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":2.0
* }
*
*
*
* getDoubleValue(Path.fromString("path1"))
* returns 2.0
*
*
* getDoubleValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Double getDoubleValue(final Path path) throws ScimException
{
JsonNode jsonNode = getValue(path);
return jsonNode.isNull() ? null : jsonNode.doubleValue();
}
/**
* Gets a list of Double from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Double. If the path does
* not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[2.1, 2.2]
* }
*
*
*
* getDoubleValueList("path1")
* returns a list containing 2.1, 2.2
*
*
* getDoubleValueList("bogusPath")
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getDoubleValueList(final String path) throws ScimException
{
return getDoubleValueList(Path.fromString(path));
}
/**
* Gets a list of Double from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Double. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[2.1, 2.2]
* }
*
*
*
* getDoubleValueList(Path.fromString("path1"))
* returns a list containing 2.1, 2.2
*
*
* getDoubleValueList(Path.fromString("bogusPath"))
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getDoubleValueList(final Path path) throws ScimException
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
values.add(iterator.next().doubleValue());
}
return values;
}
/////////////////////////////////////
// SCIM Integer methods
/////////////////////////////////////
/**
* Adds or replaces an Integer value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is an Integer
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is an Integer
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final String path,
final Integer value) throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces an Integer value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is an Integer
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is an Integer
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final Path path,
final Integer value) throws ScimException
{
return replaceValue(path, JsonUtils.getJsonNodeFactory().numberNode(value));
}
/**
* Adds Integer values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ 11, 13 ]
* }
*
*
* gsr.addIntegerValues("path1", path1values)
* where path1Value is a List of Integer.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addIntegerValues("path2", path2values)
* where path2values is a List of Integer.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addIntegerValues(final String path,
final List values) throws ScimException
{
return addIntegerValues(Path.fromString(path), values);
}
/**
* Adds Integer values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ 11, 13 ]
* }
*
*
* gsr.addIntegerValues(Path.fromString("path1"), path1values)
* where path1Value is a List of Integer.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addIntegerValues(Path.fromString("path2"), path2values)
* where path2values is a List of Integer.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addIntegerValues(final Path path,
final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for(Integer value : values)
{
valuesArrayNode.add(value);
}
return addValues(path, valuesArrayNode);
}
/**
* Gets an Integer value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be an Integer. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
*
* getIntegerValue("path1")
* returns 7
*
*
* getIntegerValue("bogusPath")
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Integer getIntegerValue(final String path) throws ScimException
{
return getIntegerValue(Path.fromString(path));
}
/**
* Gets an Integer value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be an Integer. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
*
* getIntegerValue(Path.fromString("path1"))
* returns 7
*
*
* getIntegerValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Integer getIntegerValue(final Path path) throws ScimException
{
JsonNode jsonNode = getValue(path);
return jsonNode.isNull() ? null : jsonNode.intValue();
}
/**
* Gets a list of Integer from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Integer. If the path does
* not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[11, 13]
* }
*
*
*
* getIntegerValueList("path1")
* returns a list containing 11, 13
*
*
* getIntegerValueList("bogusPath")
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getIntegerValueList(final String path)
throws ScimException
{
return getIntegerValueList(Path.fromString(path));
}
/**
* Gets a list of Integer from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Integer. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[11, 13]
* }
*
*
*
* getIntegerValueList(Path.fromString("path1"))
* returns a list containing 11, 13
*
*
* getIntegerValueList(Path.fromString("bogusPath"))
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getIntegerValueList(final Path path) throws ScimException
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
values.add(iterator.next().intValue());
}
return values;
}
/////////////////////////////////////
// SCIM Long methods
/////////////////////////////////////
/**
* Adds or replaces a Long value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is a Long
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is a Long
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(
final String path, final Long value) throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces a Long value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is a Long
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is a Long
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(
final Path path, final Long value) throws ScimException
{
return replaceValue(path, JsonUtils.getJsonNodeFactory().numberNode(value));
}
/**
* Adds Long values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ 11, 13 ]
* }
*
*
* gsr.addLongValues("path1", path1values)
* where path1Value is a List of Long.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addLongValues("path2", path2values)
* where path2values is a List of Long.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addLongValues(
final String path, final List values) throws ScimException
{
return addLongValues(Path.fromString(path), values);
}
/**
* Adds Long values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ 11, 13 ]
* }
*
*
* gsr.addLongValues(Path.fromString("path1"), path1values)
* where path1Value is a List of Long.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addLongValues(Path.fromString("path2"), path2values)
* where path2values is a List of Long.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addLongValues(
final Path path, final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for(Long value : values)
{
valuesArrayNode.add(value);
}
return addValues(path, valuesArrayNode);
}
/**
* Gets a Long value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Long. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
*
* getLongValue("path1")
* returns 7
*
*
* getLongValue("bogusPath")
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Long getLongValue(final String path) throws ScimException
{
return getLongValue(Path.fromString(path));
}
/**
* Gets a Long value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Long. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":7
* }
*
*
*
* getLongValue(Path.fromString("path1"))
* returns 7
*
*
* getLongValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Long getLongValue(final Path path) throws ScimException
{
JsonNode jsonNode = getValue(path);
return jsonNode.isNull() ? null : jsonNode.longValue();
}
/**
* Gets a list of Long from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Long. If the path does
* not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[11, 13]
* }
*
*
*
* getLongValueList("path1")
* returns a list containing 11, 13
*
*
* getLongValueList("bogusPath")
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getLongValueList(final String path) throws ScimException
{
return getLongValueList(Path.fromString(path));
}
/**
* Gets a list of Long from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Long. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[11, 13]
* }
*
*
*
* getLongValueList(Path.fromString("path1"))
* returns a list containing 11, 13
*
*
* getLongValueList(Path.fromString("bogusPath"))
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getLongValueList(final Path path) throws ScimException
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
values.add(iterator.next().longValue());
}
return values;
}
/////////////////////////////////////
// SCIM Date/Time methods
/////////////////////////////////////
/**
* Adds or replaces a Date value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"1970-04-20T17:54:47.542Z"
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is a Date
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is a Date
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(
final String path, final Date value) throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces a Date value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"1970-04-20T17:54:47.542Z"
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is a Date
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is a Date
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(
final Path path, final Date value) throws ScimException
{
return replaceValue(path, GenericScimResource.getDateJsonNode(value));
}
/**
* Adds Date values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ "1970-04-20T17:54:47.542Z", "2000-04-20T17:54:47.542Z" ]
* }
*
*
* gsr.addDateValues("path1", path1values)
* where path1Value is a List of Date.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addDateValues("path2", path2values)
* where path2values is a List of Date.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addDateValues(
final String path, final List values) throws ScimException
{
return addDateValues(Path.fromString(path), values);
}
/**
* Adds Date values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ "1970-04-20T17:54:47.542Z", "2000-04-20T17:54:47.542Z" ]
* }
*
*
* gsr.addDateValues(Path.fromString("path1"), path1values)
* where path1Value is a List of Date.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addDateValues(Path.fromString("path2"), path2values)
* where path2values is a List of Date.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addDateValues(
final Path path, final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for (Date value : values)
{
valuesArrayNode.add(GenericScimResource.getDateJsonNode(value));
}
return addValues(path, valuesArrayNode);
}
/**
* Gets a Date value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Date. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"1970-04-20T17:54:47.542Z"
* }
*
*
*
* getDateValue("path1")
* returns a Date representing "1970-04-20T17:54:47.542Z"
*
*
* getDateValue("bogusPath")
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Date getDateValue(final String path) throws ScimException
{
return getDateValue(Path.fromString(path));
}
/**
* Gets a Date value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a Date. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"1970-04-20T17:54:47.542Z"
* }
*
*
*
* getDateValue(Path.fromString("path1"))
* returns a Date representing "1970-04-20T17:54:47.542Z"
*
*
* getDateValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public Date getDateValue(final Path path) throws ScimException
{
JsonNode jsonNode = getValue(path);
if(jsonNode.isNull())
{
return null;
}
return getDateFromJsonNode(jsonNode);
}
/**
* Gets a list of Date from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Date. If the path does
* not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":["1970-04-20T17:54:47.542Z", "2000-04-20T17:54:47.542Z"]
* }
*
*
*
* getDateValueList("path1")
* returns a list containing dates representing
* "1970-04-20T17:54:47.542Z", "2000-04-20T17:54:47.542Z"
*
*
* getDateValueList("bogusPath")
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getDateValueList(final String path) throws ScimException
{
return getDateValueList(Path.fromString(path));
}
/**
* Gets a list of Date from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of Date. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":["1970-04-20T17:54:47.542Z", "2000-04-20T17:54:47.542Z"]
* }
*
*
*
* getDateValueList(Path.fromString("path1"))
* returns a list containing dates representing
* "1970-04-20T17:54:47.542Z", "2000-04-20T17:54:47.542Z"
*
*
* getDateValueList(Path.fromString("bogusPath"))
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getDateValueList(final Path path) throws ScimException
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
values.add(GenericScimResource.getDateFromJsonNode(iterator.next()));
}
return values;
}
/**
* Gets a JsonNode that represents the supplied date.
*
* @param date the date to represent as a JsonNode.
* @return the JsonNode representing the date.
* @throws ScimException thrown if an error occurs.
*/
public static TextNode getDateJsonNode(final Date date)
throws ScimException
{
return JsonUtils.valueToNode(date);
}
/**
* Gets the date represented by the supplied JsonNode.
*
* @param node the JsonNode representing the date.
* @return the date represented by the JsonNode.
* @throws ScimException thrown if an error occurs.
*/
public static Date getDateFromJsonNode(final JsonNode node)
throws ScimException
{
try
{
return JsonUtils.getObjectReader().forType(Date.class).readValue(node);
}
catch(JsonProcessingException ex)
{
throw new ServerErrorException(ex.getMessage());
}
catch(IOException ex)
{
throw new ServerErrorException(ex.getMessage());
}
}
/////////////////////////////////////
// SCIM Binary methods
/////////////////////////////////////
/**
* Adds or replaces a binary value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"AjIzLg=="
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is a byte[]
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is a byte[]
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(
final String path, final byte[] value) throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces a binary value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"AjIzLg=="
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is a byte[]
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is a byte[]
* would add a field called "path2" with the value of the path2value
* variabl
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(
final Path path, final byte[] value) throws ScimException
{
return replaceValue(path, JsonUtils.getJsonNodeFactory().binaryNode(value));
}
/**
* Adds binary values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ "AjIzLg==", "AjNjLp==" ]
* }
*
*
* gsr.addBinaryValues("path1", path1values)
* where path1Value is a List of byte[].
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addBinaryValues("path2", path2values)
* where path2values is a List of byte[].
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addBinaryValues(
final String path, final List values) throws ScimException
{
return addBinaryValues(Path.fromString(path), values);
}
/**
* Adds binary values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":[ "AjIzLg==", "AjNjLp==" ]
* }
*
*
* gsr.addBinaryValues(Path.fromString("path1"), path1values)
* where path1Value is a List of byte[].
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addBinaryValues(Path.fromString("path2"), path2values)
* where path2values is a List of byte[].
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addBinaryValues(
final Path path, final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for (byte[] value : values)
{
valuesArrayNode.add(JsonUtils.getJsonNodeFactory().binaryNode(value));
}
return addValues(path, valuesArrayNode);
}
/**
* Gets a binary value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a binary value. If the path does not
* exist, "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"AjIzLg=="
* }
*
*
*
* getBinaryValue("path1")
* returns the byte array decoded from "AjIzLg=="
*
*
* getBinaryValue("bogusPath")
* returns null
*
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public byte[] getBinaryValue(final String path) throws ScimException
{
return getBinaryValue(Path.fromString(path));
}
/**
* Gets a binary value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a binary value. If the path does
* not exist, "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"AjIzLg=="
* }
*
*
*
* getBinaryValue(Path.fromString("path1"))
* returns the byte array decoded from "AjIzLg=="
*
*
* getBinaryValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public byte[] getBinaryValue(final Path path) throws ScimException
{
JsonNode jsonNode = getValue(path);
if(jsonNode.isNull())
{
return null;
}
try
{
return jsonNode.binaryValue();
}
catch (IOException e)
{
throw new ServerErrorException(e.getMessage());
}
}
/**
* Gets a list of byte[] from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of binary values. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":["AjIzLg==", "AjNjLp=="]
* }
*
*
*
* getBinaryValueList("path1")
* returns a list containing the byte arrays decoded from
* "AjIzLg==", "AjNjLp=="
*
*
* getBinaryValueList("bogusPath")
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getBinaryValueList(final String path) throws ScimException
{
return getBinaryValueList(Path.fromString(path));
}
/**
* Gets a list of byte[] from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of binary values. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":["AjIzLg==", "AjNjLp=="]
* }
*
*
*
* getBinaryValueList(Path.fromString("path1"))
* returns a list containing the byte arrays decoded from
* "AjIzLg==", "AjNjLp=="
*
*
* getBinaryValueList(Path.fromString("bogusPath"))
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getBinaryValueList(final Path path) throws ScimException
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
try
{
byte[] value = iterator.next().binaryValue();
if(value == null)
{
// this is not a binary or text node.
throw new ServerErrorException("Value at path " + path +
" is not a valid base64 string");
}
values.add(value);
}
catch (IOException e)
{
throw new ServerErrorException(e.getMessage());
}
}
return values;
}
/////////////////////////////////////
// SCIM Ref methods
/////////////////////////////////////
/**
* Adds or replaces a URI value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"http://localhost:8080/uri/One"
* }
*
*
* gsr.replaceValue("path1", path1value)
* where path1value is a URI
* would change the "path1" field to the value of the path1value
* variable
*
*
* gsr.replaceValue("path2", path2value)
* where path2value is a URI
* would add a field called "path2" with the value of the path2value
* variable
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final String path, final URI value)
throws ScimException
{
return replaceValue(Path.fromString(path), value);
}
/**
* Adds or replaces a URI value in a generic SCIM resource.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"http://localhost:8080/uri/One"
* }
*
*
* gsr.replaceValue(Path.fromString("path1"), path1value)
* where path1value is a URI
* would change the "path1" field to the value of the path1value
* variable
*
* gsr.replaceValue(Path.fromString("path2"), path2value)
* where path2value is a URI
* would add a field called "path2" with the value of the path2value
* variable
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to replace the value for.
* @param value the new value.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource replaceValue(final Path path, final URI value)
throws ScimException
{
return replaceValue(path,
JsonUtils.getJsonNodeFactory().textNode(value.toString()));
}
/**
* Adds URI values to an array node. If no array node exists at the
* specified path, a new array node will be created.
* For example:
*
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":
* [
* "http://localhost:8080/uri/One", "http://localhost:8080/uri/Two"
* ]
* }
*
*
*
* gsr.addURIValues("path1", path1values)
* where path1Value is a List of URI.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addURIValues("path2", path2values)
* where path2values is a List of URI.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addURIValues(
final String path, final List values) throws ScimException
{
return addURIValues(Path.fromString(path), values);
}
/**
* Adds URI values to an array node. If no array node exists at the
* specified path, a new array node will be created.
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
* {
*
* "path1":
* [
* "http://localhost:8080/uri/One", "http://localhost:8080/uri/Two"
* ]
* }
*
*
* gsr.addURIValues(Path.fromString("path1"), path1values)
* where path1Value is a List of URI.
* Would add each of the items in the path1values list to the
* "path1" list in the generic SCIM resource
*
*
* gsr.addURIValues(Path.fromString("path2"), path2values)
* where path2values is a List of URI.
* Would create a new array called "path2"
*
*
* Note that in a case where multiple paths match (for example
* a path with a filter), all paths that match will be affected.
*
* @param path the path to add the list to.
* @param values a list containing the new values.
* @return returns the new generic SCIM resource (this).
* @throws ScimException thrown if an error occurs (for example
* if the path or value is "{@code null}" or invalid).
*/
public GenericScimResource addURIValues(
final Path path, final List values) throws ScimException
{
ArrayNode valuesArrayNode = JsonUtils.getJsonNodeFactory().arrayNode();
for(URI value : values)
{
valuesArrayNode.add(value.toString());
}
return addValues(path, valuesArrayNode);
}
/**
* Gets a URI value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a URI. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"http://localhost:8080/uri/One"
* }
*
*
*
* getURIValue("path1")
* returns "http://localhost:8080/uri/One"
*
*
* getURIValue("bogusPath")
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public URI getURIValue(final String path) throws ScimException
{
return getURIValue(Path.fromString(path));
}
/**
* Gets a URI value from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a URI. If the path does not exist,
* "{@code null}" will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":"http://localhost:8080/uri/One"
* }
*
*
*
* getURIValue(Path.fromString("path1"))
* returns "http://localhost:8080/uri/One"
*
*
* getURIValue(Path.fromString("bogusPath"))
* returns null
*
* @param path the path to get the value from.
* @return the value at the path, or null.
* @throws ScimException thrown if an error occurs.
*/
public URI getURIValue(final Path path) throws ScimException
{
try
{
JsonNode jsonNode = getValue(path);
return jsonNode.isNull() ? null : new URI(jsonNode.textValue());
}
catch(URISyntaxException ex)
{
throw new ServerErrorException(ex.getMessage());
}
}
/**
* Gets a list of URI from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of URI. If the path does
* not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":
* [
* "http://localhost:8080/uri/One", "http://localhost:8080/uri/Two"
* ]
* }
*
*
*
* getURIValueList("path1")
* returns a list containing
* "http://localhost:8080/uri/One", "http://localhost:8080/uri/Two"
*
*
* getURIValueList("bogusPath")
* returns an empty list
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getURIValueList(final String path) throws ScimException
{
return getURIValueList(Path.fromString(path));
}
/**
* Gets a list of URI from a generic SCIM resource. If the path exists,
* the JSON node at the path must be a list of URI. If the path
* does not exist, an empty list will be returned.
*
*
* For example:
* In a GenericScimResource (gsr) representing the following resource:
*
* {
* "path1":
* [
* "http://localhost:8080/uri/One", "http://localhost:8080/uri/Two"
* ]
* }
*
*
*
* getURIValueList(Path.fromString("path1"))
* returns a list containing
* "http://localhost:8080/uri/One", "http://localhost:8080/uri/Two"
*
*
* getURIValueList(Path.fromString("bogusPath"))
* returns an empty list
*
*
* @param path the path to get the value from.
* @return the value at the path, or an empty list.
* @throws ScimException thrown if an error occurs.
*/
public List getURIValueList(final Path path) throws ScimException
{
try
{
JsonNode valueNode = getValue(path);
List values = new ArrayList();
Iterator iterator = valueNode.iterator();
while (iterator.hasNext())
{
String uriString = iterator.next().textValue();
values.add(new URI(uriString));
}
return values;
}
catch (URISyntaxException ex)
{
throw new ServerErrorException(ex.getMessage());
}
}
}