IdentityData (Radiant Logic, Inc.)

java.lang.Object
- com.rli.util.identityData.IdentityData

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ChangeEvent
```
public class IdentityData
extends java.lang.Object
implements java.lang.Cloneable
```
This class represents a set of attributes and their corresponding value(s) for one specific identity or entry. Note: although this class is named IdentityData, it can be used to represent any kind of entry.
This class includes support for the following types of attributes:
- attributes with a single String value, e.g: firstName = "Susie"
- attributes with multiple String values, e.g: city = [ "Novato", "Chicago", "New York ]
- attributes with a single complex value, e.g: name = { "first": "John", "last": "Smith" }
- attributes with multiple complex values, e.g: name = [ { "first": "John", "last": "Smith" }, { "first": "Jane", "last": "Smith" }]

Note: for a given attribute name, this class does not support having a mix of both String values and complex values. An attribute can have either String values or complex values, but not both.
Examples:

Example #1: Creating a basic entry:
IdentityData newEntry = new IdentityData();
// cn, sn, and givenName are single-valued attributes
newEntry.addAttribute("cn", "John Smith");
newEntry.addAttribute("sn", "Smith");
newEntry.addAttribute("givenName", "John");
// mail and objectclass are multi-valued attributes
newEntry.addAttribute("mail", "jsmith@radiantlogic.com", "jsmith@gmail.com");
newEntry.addAttribute("objectclass", "top", "person", "organizationalPerson", "inetOrgPerson");

Example #2: Creating an entry with some complex attributes (similar to SCIM entries):
IdentityData newEntry = new IdentityData();
// userName is a single-valued attribute
newEntry.addAttribute("userName", "dschrute");

// name is a single-valued complex attribute with 3 sub-attributes: givenName, middleName, and familyName
ComplexValue nameComplexValue = new ComplexValue();
nameComplexValue.add("givenName", "Dwight");
nameComplexValue.add("middleName", "Kurt");
nameComplexValue.add("familyName", "Schrute");

newEntry.addComplexAttribute("name", nameComplexValue);

// phoneNumbers is a multi-valued complex attribute with 2 sub-attributes: type and value
ComplexValue workPhoneValue = new ComplexValue();
workPhoneValue.add("type", "work");
workPhoneValue.add("value", "555-555-8377");

ComplexValue homePhoneValue = new ComplexValue();
homePhoneValue.add("type", "home");
homePhoneValue.add("value", "555-333-4322");

newEntry.addComplexAttribute("phoneNumbers", workPhoneValue, homePhoneValue);

Field Summary

Fields
Modifier and Type Field and Description

protected static com.fasterxml.jackson.databind.ObjectMapper mapper

Fields
Modifier and Type	Field and Description
`protected static com.fasterxml.jackson.databind.ObjectMapper`	`mapper`

Constructor Summary

Constructors
Constructor and Description

IdentityData()

Constructors
Constructor and Description
`IdentityData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(java.lang.String attributeName, java.util.List<java.lang.String> values)` Sets one or more values for the specified attribute.
`void`	`addAttribute(java.lang.String attributeName, java.lang.String... values)` Sets one or more values for the specified attribute.
`void`	`addAttribute(java.lang.String attributeName, java.lang.String value)` Sets a single value for the specified attribute.
`void`	`addComplexAttribute(java.lang.String attributeName, ComplexValue... complexValues)` Sets one or more complex values for the specified complex value.
`void`	`addComplexAttribute(java.lang.String attributeName, ComplexValue complexValue)` Sets a single complex value for the specified attribute.
`void`	`addComplexAttribute(java.lang.String attributeName, java.util.List<ComplexValue> complexValues)` Sets one or more complex values for the specified complex value.
`java.lang.Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`containsAttribute(java.lang.String attributeName)` Indicates whether this IdentityData contains the specified attribute.
`boolean`	`containsComplexAttributeValue(java.lang.String attributeName)` Indicates whether this IdentityData contains an attribute that has at least one complex value.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getAdditionalProperties()`
`java.util.Set<java.lang.String>`	`getAttributeNames()` Returns the names of all the attributes that have been set for this IdentityData object.
`java.util.List<ComplexValue>`	`getComplexValues(java.lang.String attributeName)` Returns the list of complex values associated with the specified attribute or `null` if the attribute does not exist.
`protected java.lang.Object`	`getExtraAttributeValue(java.lang.String attributeName)`
`ComplexValue`	`getFirstComplexValue(java.lang.String attributeName)` Returns the first complex value of the specified attribute or `null` if the attribute does not exist.
`java.lang.String`	`getFirstValueAsString(java.lang.String attributeName)` Returns the first value associated with the specified attribute.
`java.util.List<java.lang.String>`	`getNullSafeValuesAsString(java.lang.String attributeName)` Returns the list of values associated with the specified attribute.
`java.util.List<java.lang.String>`	`getValuesAsString(java.lang.String attributeName)` Returns the list of values associated with the specified attribute.
`boolean`	`isAttributeValueComplex(java.lang.String attributeName)` Indicates whether the specified attribute contains a ComplexValue value.
`java.util.List<java.lang.String>`	`listAttributeNames()` !!!Not public and subject to changes list the attribute names that compose the message, the list is a deep copy of the keys' underlying data structure and can be modified independently
`java.lang.Object`	`putAttribute(java.lang.String attributeName, java.lang.Object value)` !!!Not public and subject to changes force a put into the map - this method can be used when dealing with maintenance of the internal structure, returns the value of the key if already present
`void`	`removeAttribute(java.lang.String attributeName)` Removes the specified attribute and any of its associated values from this IdentityData object.
`java.lang.Object`	`renameAttribute(java.lang.String attributeName, java.lang.String newAttributName)` !!!Not public and subject to changes rename the attribute to the provided new name and return any existing value if the new attribute name is already present
`protected void`	`setAdditionalProperty(java.lang.String name, java.lang.Object value)`
`java.lang.String`	`toString()` Returns the String representation of this IdentityData object.
`java.lang.String`	`toString(boolean isHideValueOfPasswordAttributes)` Returns the String representation of this object.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - mapper
```
protected static final com.fasterxml.jackson.databind.ObjectMapper mapper
```
- Constructor Detail
  - IdentityData
```
public IdentityData()
```
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    Creates and returns a copy of this object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this instance.
  - addAttribute
```
public void addAttribute(java.lang.String attributeName,
                         java.lang.String value)
```
    Sets a single value for the specified attribute. If the attribute already exists, all of its values will be replaced by the specified value.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    value - The value to set for the attribute.
  - addAttribute
```
public void addAttribute(java.lang.String attributeName,
                         java.util.List<java.lang.String> values)
```
    Sets one or more values for the specified attribute. If the attribute already exists, all of its values will be replaced by the specified values.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    values - The values to set for the attributes.
  - addAttribute
```
public void addAttribute(java.lang.String attributeName,
                         java.lang.String... values)
```
    Sets one or more values for the specified attribute. If the attribute already exists, all of its values will be replaced by the specified values.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    values - The values to set for the attributes.
  - addComplexAttribute
```
public void addComplexAttribute(java.lang.String attributeName,
                                ComplexValue complexValue)
```
    Sets a single complex value for the specified attribute. If the attribute already exists, all of its values will be replaced by the specified complex value.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    complexValue - The complex value to set for the attribute.
  - addComplexAttribute
```
public void addComplexAttribute(java.lang.String attributeName,
                                java.util.List<ComplexValue> complexValues)
```
    Sets one or more complex values for the specified complex value. If the attribute already exists, all of its values will be replaced by the specified complex values.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    complexValues - The complex values to set for the attribute.
  - addComplexAttribute
```
public void addComplexAttribute(java.lang.String attributeName,
                                ComplexValue... complexValues)
```
    Sets one or more complex values for the specified complex value. If the attribute already exists, all of its values will be replaced by the specified complex values.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    complexValues - The complex values to set for the attribute.
  - removeAttribute
```
public void removeAttribute(java.lang.String attributeName)
```
    Removes the specified attribute and any of its associated values from this IdentityData object.
    
    Parameters:
    
    attributeName - The attribute to remove.
  - putAttribute
```
public java.lang.Object putAttribute(java.lang.String attributeName,
                                     java.lang.Object value)
```
    !!!Not public and subject to changes
    force a put into the map - this method can be used when dealing with maintenance of the internal structure, returns the value of the key if already present
  - renameAttribute
```
public java.lang.Object renameAttribute(java.lang.String attributeName,
                                        java.lang.String newAttributName)
```
    !!!Not public and subject to changes
    rename the attribute to the provided new name and return any existing value if the new attribute name is already present
  - listAttributeNames
```
public java.util.List<java.lang.String> listAttributeNames()
```
    !!!Not public and subject to changes
    list the attribute names that compose the message, the list is a deep copy of the keys' underlying data structure and can be modified independently
  - getAttributeNames
```
public java.util.Set<java.lang.String> getAttributeNames()
```
    Returns the names of all the attributes that have been set for this IdentityData object.
    
    Returns:
    
    The names of all the attributes that have been set for this IdentityData object.
  - getFirstValueAsString
```
public java.lang.String getFirstValueAsString(java.lang.String attributeName)
```
    Returns the first value associated with the specified attribute. If the value is a complex value, the value will be returned as a JSON Object String, e.g: {"city":["Novato"],"zipcode":["94945"]} . If no value has been set for the attribute, or if the attribute does not exist, returns null.
    
    Parameters:
    
    attributeName - The name of the attribute.
    
    Returns:
    
    The first value associated with the specified attribute.
  - getValuesAsString
```
public java.util.List<java.lang.String> getValuesAsString(java.lang.String attributeName)
```
    Returns the list of values associated with the specified attribute. If the values are complex values, the values will be returned as a list of JSON Object String, e.g: {"city":["Novato"],"zipcode":["94945"]} . If no value has been set for the attribute, or if the attribute does not exist, returns an empty list.
    
    Parameters:
    
    attributeName - The name of the attribute.
    
    Returns:
    
    The list of values associated with the specified attribute.
  - getNullSafeValuesAsString
```
public java.util.List<java.lang.String> getNullSafeValuesAsString(java.lang.String attributeName)
```
    Returns the list of values associated with the specified attribute. If the values are complex values, the values will be returned as a list of JSON Object String, e.g: {"city":["Novato"],"zipcode":["94945"]} . If no value has been set for the attribute, or if the attribute does not exist, returns an empty list. Note: this method is safe to use even if the specified attribute name is null.
    
    Parameters:
    
    attributeName - The name of the attribute.
    
    Returns:
    
    The list of values associated with the specified attribute.
  - getFirstComplexValue
```
public ComplexValue getFirstComplexValue(java.lang.String attributeName)
```
    Returns the first complex value of the specified attribute or null if the attribute does not exist. If the attribute contains a non-complex value (such as a basic String value), this method will throw an IllegalArgumentException. To avoid this exception, you can call the isAttributeValueComplex(String) method to first check if an attribute is complex before calling this method.
    
    Parameters:
    
    attributeName - The name of the attribute.
    
    Returns:
    
    The first complex value of the specified attribute or null if the attribute does not exist.
  - getComplexValues
```
public java.util.List<ComplexValue> getComplexValues(java.lang.String attributeName)
```
    Returns the list of complex values associated with the specified attribute or null if the attribute does not exist. This method will also return null if an empty set of values is found for the specified attribute. If the attribute contains a non-complex value (such as a basic String value), this method will throw an IllegalArgumentException. To avoid this exception, you can call the isAttributeValueComplex(String) method to first check if an attribute is complex before calling this method.
    
    Parameters:
    
    attributeName - The name of the attribute.
    
    Returns:
    
    The list of complex values associated with the specified attribute or null if the attribute does not exist.
  - containsAttribute
```
public boolean containsAttribute(java.lang.String attributeName)
```
    Indicates whether this IdentityData contains the specified attribute.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    Returns:
    
    true if this IdentityData contains the specified attribute, or false otherwise.
  - containsComplexAttributeValue
```
public boolean containsComplexAttributeValue(java.lang.String attributeName)
```
    Indicates whether this IdentityData contains an attribute that has at least one complex value.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    Returns:
    
    true if this IdentityData objects contains the specified attribute, and if that attribute has at least one complex value. Returns false otherwise.
  - isAttributeValueComplex
```
public boolean isAttributeValueComplex(java.lang.String attributeName)
```
    Indicates whether the specified attribute contains a ComplexValue value.
    
    Parameters:
    
    attributeName - The name of an attribute.
    
    Returns:
    
    true if the specified attribute contains a ComplexValue value, or false otherwise.
  - getExtraAttributeValue
```
protected java.lang.Object getExtraAttributeValue(java.lang.String attributeName)
```
  - getAdditionalProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
protected void setAdditionalProperty(java.lang.String name,
                                     java.lang.Object value)
```
  - toString
```
public java.lang.String toString()
```
    Returns the String representation of this IdentityData object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The String representation of this IdentityData 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.

Class IdentityData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mapper

Constructor Detail

IdentityData

Method Detail

clone

addAttribute

addAttribute

addAttribute

addComplexAttribute

addComplexAttribute

addComplexAttribute

removeAttribute

putAttribute

renameAttribute

listAttributeNames

getAttributeNames

getFirstValueAsString

getValuesAsString

getNullSafeValuesAsString

getFirstComplexValue

getComplexValues

containsAttribute

containsComplexAttributeValue

isAttributeValueComplex

getExtraAttributeValue

getAdditionalProperties

setAdditionalProperty

toString

toString