com.rli.util.identityData

Class IdentityPatchOperation

java.lang.Object

com.rli.util.identityData.IdentityPatchOperation

public abstract class IdentityPatchOperation
extends java.lang.Object

This abstract base class represents a granular operation or change (add value(s), replace value(s), or remove value(s)) on a specific attribute. A patch operation is composed of three main elements:

• The operation type (add/replace/remove), represented by PatchOpType
• The set of value(s) for the operation. This can be simple String values or ComplexValue values.
• The attribute path for the operation, used to represent the target of the operation. This can be a simple attribute, or a specific sub-attribute of a complex value attribute. See IdentityAttributePath for details.

To get an instance of an IdentityPatchOperation, you should use the following static methods, based on the desired operation type:

• For adding basic values: add(String, String) and add(String, List)
• For adding complex values: addComplexValue(String, ComplexValue) and addComplexValues(String, List)
• For replacing basic values: replace(String, String) and replace(String, List)
• For replacing complex values: replaceComplexValue(String, ComplexValue) and replaceComplexValues(String, List)
• For removing basic values: remove(String, String) and remove(String, List)
• For removing complex values: removeComplexValue(String, ComplexValue) and removeComplexValues(String, List)
• For removing an entire attribute and all its values: remove(String)

Method Summary

Modifier and Type	Method and Description
static IdentityPatchOperation	add(java.lang.String attributeName, java.util.List<java.lang.String> values) Creates a new "add value(s)" patch operation for the specified attribute, with the specified list of value(s).
static IdentityPatchOperation	add(java.lang.String attributeName, java.lang.String value) Creates a new "add value" patch operation for the specified attribute, with the specified value.
static IdentityPatchOperation	addComplexValue(java.lang.String attributeName, ComplexValue complexValue) Creates a new "add complex value" patch operation for the specified attribute, with the specified complex value.
static IdentityPatchOperation	addComplexValues(java.lang.String attributeName, java.util.List<ComplexValue> complexValues) Creates a new "add complex value(s)" patch operation for the specified attribute, with the specified complex value(s).
IdentityAttributePath	getAttributePath() Returns the attribute path for this patch operation.
java.util.List<ComplexValue>	getComplexValues() Returns the list of complex values for this patch operation.
ComplexValue	getFirstComplexValue() Returns the first complex value found in the list of values for this patch operation.
java.lang.String	getFirstValueAsString() Returns the first value found in the list of values for this patch operation.
abstract PatchOpType	getOpType() Returns the operation type (add value(s), replace value(s) or delete value(s)) for this patch operation.
java.util.List<java.lang.String>	getValuesAsString() Returns the list of values for this patch operation.
boolean	isValueComplex() Indicates whether this patch operation is using complex values.
static IdentityPatchOperation	remove(java.lang.String attributeName) Creates a new "remove attribute" patch operation for the specified attribute.
static IdentityPatchOperation	remove(java.lang.String attributeName, java.util.List<java.lang.String> values) Creates a new "remove value(s)" patch operation for the specified attribute.
static IdentityPatchOperation	remove(java.lang.String attributeName, java.lang.String value) Creates a new "remove value" patch operation for the specified attribute.
static IdentityPatchOperation	removeComplexValue(java.lang.String attributeName, ComplexValue complexValue) Creates a new "remove complex value" patch operation for the specified attribute.
static IdentityPatchOperation	removeComplexValues(java.lang.String attributeName, java.util.List<ComplexValue> complexValues) Creates a new "remove complex value(s)" patch operation for the specified attribute.
static IdentityPatchOperation	replace(java.lang.String attributeName, java.util.List<java.lang.String> values) Creates a new "replace value(s)" patch operation for the specified attribute.
static IdentityPatchOperation	replace(java.lang.String attributeName, java.lang.String value) Creates a new "replace value" patch operation for the specified attribute.
static IdentityPatchOperation	replaceComplexValue(java.lang.String attributeName, ComplexValue complexValue) Creates a new "replace complex value" patch operation for the specified attribute.
static IdentityPatchOperation	replaceComplexValues(java.lang.String attributeName, java.util.List<ComplexValue> complexValues) Creates a new "replace complex value(s)" patch operation for the specified attribute.
void	setValuesFromString(java.util.List<java.lang.String> values)
java.lang.String	toString() Returns the String representation of this object.
java.lang.String	toString(boolean isHideValueOfPasswordAttributes) Returns the String representation of this object.

Methods inherited from class java.lang.Object

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

Method Detail

getOpType

public abstract PatchOpType getOpType()

Returns the operation type (add value(s), replace value(s) or delete value(s)) for this patch operation.

Returns:

the operation type (add value(s), replace value(s) or delete value(s)) for this patch operation.

getAttributePath

public IdentityAttributePath getAttributePath()

Returns the attribute path for this patch operation. The attribute path is used to express exactly which attribute (or target for the operation) to add/replace/remove value(s) for. In the case of complex value attributes, it can be used to specify exactly which sub-attribute to change. The attribute path notation follows the SCIM2 specification found here: RFC-7644, page 33-34

Examples of valid attribute paths:

• fullName
• city
• name.firstName
• addresses[type eq "home"]
• addresses[type eq "work"].country

Returns:

The attribute path for this patch operation.

getFirstValueAsString

public java.lang.String getFirstValueAsString()

Returns the first value found in the list of values for this patch operation.

Returns:

the first value found in the list of values for this patch operation.

getValuesAsString

public java.util.List<java.lang.String> getValuesAsString()

Returns the list of values for this patch operation.

Returns:

the list of values for this patch operation.

setValuesFromString

public void setValuesFromString(java.util.List<java.lang.String> values)

getFirstComplexValue

public ComplexValue getFirstComplexValue()

Returns the first complex value found in the list of values for this patch operation. Note: if this method is called and the current values for this object are basic String values, the method will throw an IllegalArgumentException. You can call the isValueComplex() method to verify whether this object is using complex values before calling this method to avoid a potential IllegalArgumentException.

Returns:

The first complex value found in the list of values for this patch operation.

getComplexValues

public java.util.List<ComplexValue> getComplexValues()

Returns the list of complex values for this patch operation. Note: if this method is called and the current values for this object are basic String values, the method will throw an IllegalArgumentException. You can call the isValueComplex() method to verify whether this object is using complex values before calling this method to avoid a potential IllegalArgumentException.

Returns:

The list of complex values for this patch operation.

isValueComplex

public boolean isValueComplex()

Indicates whether this patch operation is using complex values.

Returns:

true if this patch operation is using complex values, or false otherwise.

toString

public java.lang.String toString()

Returns the String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

toString

public java.lang.String toString(boolean isHideValueOfPasswordAttributes)

Returns the String representation of this object.

Parameters:

isHideValueOfPasswordAttributes - Indicates whether attributes with password values should be hidden from the returned String.

Returns:

The String representation of this object.

add

public static IdentityPatchOperation add(java.lang.String attributeName,
                                         java.lang.String value)

Creates a new "add value" patch operation for the specified attribute, with the specified value.

Parameters:

attributeName - The name of the attribute.

value - The value for the "add value" patch operation on the attribute.

Returns:

A new "add value" patch operation object.

add

public static IdentityPatchOperation add(java.lang.String attributeName,
                                         java.util.List<java.lang.String> values)

Creates a new "add value(s)" patch operation for the specified attribute, with the specified list of value(s).

Parameters:

attributeName - The name of the attribute.

values - The values for the "add value" patch operation on the attribute.

Returns:

A new "add value(s)" patch operation object.

addComplexValue

public static IdentityPatchOperation addComplexValue(java.lang.String attributeName,
                                                     ComplexValue complexValue)

Creates a new "add complex value" patch operation for the specified attribute, with the specified complex value.

Parameters:

attributeName - The name of the attribute.

complexValue - The complex value for the "add value" patch operation on the attribute.

Returns:

A new "add complex value" patch operation object.

addComplexValues

public static IdentityPatchOperation addComplexValues(java.lang.String attributeName,
                                                      java.util.List<ComplexValue> complexValues)

Creates a new "add complex value(s)" patch operation for the specified attribute, with the specified complex value(s).

Parameters:

attributeName - The name of the attribute.

complexValues - The complex value(s) for the "add value(s)" patch operation on the attribute.

Returns:

A new "add complex value(s)" patch operation object.

remove

public static IdentityPatchOperation remove(java.lang.String attributeName)

Creates a new "remove attribute" patch operation for the specified attribute. This represents an operation that removes the entire attribute and all of its values.

Parameters:

attributeName - The name of the attribute.

Returns:

A new "remove attribute" patch operation for the specified attribute.

remove

public static IdentityPatchOperation remove(java.lang.String attributeName,
                                            java.lang.String value)

Creates a new "remove value" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

value - The value for the "remove value" operation.

Returns:

A new "remove value" patch operation for the specified attribute.

remove

public static IdentityPatchOperation remove(java.lang.String attributeName,
                                            java.util.List<java.lang.String> values)

Creates a new "remove value(s)" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

values - The list of values for the "remove value(s)" operation.

Returns:

A new "remove value(s)" patch operation for the specified attribute.

removeComplexValue

public static IdentityPatchOperation removeComplexValue(java.lang.String attributeName,
                                                        ComplexValue complexValue)

Creates a new "remove complex value" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

complexValue - The complex value to remove as part of the "remove complex value" operation.

Returns:

A new "remove complex value" patch operation for the specified attribute.

removeComplexValues

public static IdentityPatchOperation removeComplexValues(java.lang.String attributeName,
                                                         java.util.List<ComplexValue> complexValues)

Creates a new "remove complex value(s)" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

complexValues - The list of complex value(s) to remove as part of the "remove complex value" operation.

Returns:

A new "remove complex value(s)" patch operation for the specified attribute.

replace

public static IdentityPatchOperation replace(java.lang.String attributeName,
                                             java.lang.String value)

Creates a new "replace value" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

value - The new value to set for the attribute as part of the "replace value" patch operation.

Returns:

A new "replace value" patch operation for the specified attribute.

replace

public static IdentityPatchOperation replace(java.lang.String attributeName,
                                             java.util.List<java.lang.String> values)

Creates a new "replace value(s)" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

values - The new value(s) to set for the attribute as part of the "replace value(s)" patch operation.

Returns:

A new "replace value(s)" patch operation for the specified attribute.

replaceComplexValue

public static IdentityPatchOperation replaceComplexValue(java.lang.String attributeName,
                                                         ComplexValue complexValue)

Creates a new "replace complex value" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

complexValue - The new complex value to set for the attribute as part of the "replace complex value" patch operation.

Returns:

A new "replace complex value" patch operation for the specified attribute.

replaceComplexValues

public static IdentityPatchOperation replaceComplexValues(java.lang.String attributeName,
                                                          java.util.List<ComplexValue> complexValues)

Creates a new "replace complex value(s)" patch operation for the specified attribute.

Parameters:

attributeName - The name of the attribute.

complexValues - The new complex values to set for the attribute as part of the "replace complex value(s)" patch operation.

Returns:

A new "replace complex value(s)" patch operation for the specified attribute.