com.unboundid.scim.sdk

Class SCIMAttributeValue

java.lang.Object

com.unboundid.scim.sdk.SCIMAttributeValue

public abstract class SCIMAttributeValue
extends Object

This class represents a System for Cross-Domain Identity Management (SCIM) attribute value. Values are categorized as either Simple or Complex.

• Simple values can be String, Boolean, DateTime, Integer or Binary.
• Complex values are composed of a set of subordinate SCIM attributes.

Constructor Summary

Constructors

Constructor and Description
SCIMAttributeValue()

Method Summary

Methods

Modifier and Type	Method and Description
static SCIMAttributeValue	createBinaryValue(byte[] value) Create a new simple binary attribute value.
static SCIMAttributeValue	createBooleanValue(Boolean value) Create a new simple Boolean attribute value.
static SCIMAttributeValue	createComplexValue(Collection<SCIMAttribute> attributes) Create a new complex attribute value from a collection of attributes.
static SCIMAttributeValue	createComplexValue(SCIMAttribute... attributes) Create a new complex attribute value from the provided attributes.
static SCIMAttributeValue	createDateValue(Date value) Create a new simple Date attribute value.
static SCIMAttributeValue	createSimpleValue(SimpleValue simpleValue) Create a new simple attribute value.
static SCIMAttributeValue	createStringValue(String value) Create a new simple String attribute value.
static SCIMAttributeValue	createValue(AttributeDescriptor.DataType dataType, String value) Create a new simple attribute value of the specified data type.
SCIMAttribute	getAttribute(String attributeName) Retrieves the attribute with the provided name from the complex value, or null if there is no such attribute or the attribute value is simple.
abstract Map<String,SCIMAttribute>	getAttributes() Retrieves the attributes comprising the complex value, keyed by the lower case name of the attribute, or null if the attribute value is simple.
byte[]	getBinaryValue() Retrieves the simple Binary value, or null if the attribute value is complex.
Boolean	getBooleanValue() Retrieves the simple Boolean value, or null if the attribute value is complex.
Date	getDateValue() Retrieves the simple Date value, or null if the attribute value is complex.
Double	getDecimalValue() Retrieves the simple Decimal value, or null if the attribute value is complex.
Long	getIntegerValue() Retrieves the simple Long value, or null if the attribute value is complex.
String	getStringValue() Retrieves the simple String value, or null if the attribute value is complex.
<T> T	getSubAttributeValue(String name, AttributeValueResolver<T> resolver) Retrieves the value of a sub-attribute.
<T> Collection<T>	getSubAttributeValues(String name, AttributeValueResolver<T> resolver) Retrieves the value of a multi-valued sub-attribute value.
abstract SimpleValue	getValue() Retrieves the simple value, or null if the attribute value is complex.
boolean	hasAttribute(String attributeName) Indicates whether a complex value has an attribute with the provided name.
abstract boolean	isComplex() Determines whether this attribute value is simple or complex.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCIMAttributeValue

public SCIMAttributeValue()

Method Detail

createValue

public static SCIMAttributeValue createValue(AttributeDescriptor.DataType dataType,
                             String value)

Create a new simple attribute value of the specified data type.

Parameters:

dataType - The data type of the value.

value - The string representation of the value.

Returns:

The new simple attribute value.

createStringValue

public static SCIMAttributeValue createStringValue(String value)

Create a new simple String attribute value.

Parameters:

value - The String attribute value.

Returns:

The new simple attribute.

createBooleanValue

public static SCIMAttributeValue createBooleanValue(Boolean value)

Create a new simple Boolean attribute value.

Parameters:

value - The Boolean attribute value.

Returns:

The new simple attribute.

createDateValue

public static SCIMAttributeValue createDateValue(Date value)

Create a new simple Date attribute value.

Parameters:

value - The Date attribute value.

Returns:

The new simple attribute.

createBinaryValue

public static SCIMAttributeValue createBinaryValue(byte[] value)

Create a new simple binary attribute value.

Parameters:

value - The binary attribute value.

Returns:

The new simple attribute.

createSimpleValue

public static SCIMAttributeValue createSimpleValue(SimpleValue simpleValue)

Create a new simple attribute value.

Parameters:

simpleValue - The SimpleValue attribute value.

Returns:

The new Simple attribute.

getSubAttributeValue

public <T> T getSubAttributeValue(String name,
                         AttributeValueResolver<T> resolver)

Retrieves the value of a sub-attribute.

Type Parameters:

T - The type of the resolved instance representing the value of sub-attribute.

Parameters:

name - The name of the sub-attribute.

resolver - The AttributeValueResolver that should be used to resolve the value into an instance.

Returns:

The resolved instance representing the value of sub-attribute.

getSubAttributeValues

public <T> Collection<T> getSubAttributeValues(String name,
                                      AttributeValueResolver<T> resolver)

Retrieves the value of a multi-valued sub-attribute value.

Type Parameters:

T - The type of the resolved instance representing the value of sub-attribute.

Parameters:

name - The name of the attribute value to retrieve.

resolver - The AttributeValueResolver the should be used to resolve the value to an instance.

Returns:

The collection of resolved value instances or null if the specified attribute does not exist.

createComplexValue

public static SCIMAttributeValue createComplexValue(SCIMAttribute... attributes)

Create a new complex attribute value from the provided attributes.

Parameters:

attributes - The attributes comprising the complex value.

Returns:

The new complex attribute.

createComplexValue

public static SCIMAttributeValue createComplexValue(Collection<SCIMAttribute> attributes)

Create a new complex attribute value from a collection of attributes.

Parameters:

attributes - The attributes comprising the complex value.

Returns:

The new complex attribute value.

isComplex

public abstract boolean isComplex()

Determines whether this attribute value is simple or complex.

Returns:

true if this attribute value is complex, or false otherwise.

getValue

public abstract SimpleValue getValue()

Retrieves the simple value, or null if the attribute value is complex.

Returns:

The simple value, or null if the attribute value is complex.

getStringValue

public String getStringValue()

Retrieves the simple String value, or null if the attribute value is complex.

Returns:

The simple String value, or null if the attribute value is complex.

getBooleanValue

public Boolean getBooleanValue()

Retrieves the simple Boolean value, or null if the attribute value is complex.

Returns:

The simple Boolean value, or null if the attribute value is complex.

getDecimalValue

public Double getDecimalValue()

Retrieves the simple Decimal value, or null if the attribute value is complex.

Returns:

The simple Decimal value, or null if the attribute value is complex.

getIntegerValue

public Long getIntegerValue()

Retrieves the simple Long value, or null if the attribute value is complex.

Returns:

The simple Long value, or null if the attribute value is complex.

getDateValue

public Date getDateValue()

Retrieves the simple Date value, or null if the attribute value is complex.

Returns:

The simple Date value, or null if the attribute value is complex.

getBinaryValue

public byte[] getBinaryValue()

Retrieves the simple Binary value, or null if the attribute value is complex.

Returns:

The simple Binary value, or null if the attribute value is complex.

getAttributes

public abstract Map<String,SCIMAttribute> getAttributes()

Retrieves the attributes comprising the complex value, keyed by the lower case name of the attribute, or null if the attribute value is simple.

Returns:

The attributes comprising the complex value.

getAttribute

public SCIMAttribute getAttribute(String attributeName)

Retrieves the attribute with the provided name from the complex value, or null if there is no such attribute or the attribute value is simple.

Parameters:

attributeName - The name of the desired attribute.

Returns:

The attribute with the provided name, or null if there is no such attribute or the attribute value is simple.

hasAttribute

public boolean hasAttribute(String attributeName)

Indicates whether a complex value has an attribute with the provided name.

Parameters:

attributeName - The attribute name for which to make the determination.

Returns:

true if there is an attribute with the provided name, false if there is no such attribute or this attribute value is simple.