com.unboundid.scim.sdk

Class SCIMAttribute

java.lang.Object

com.unboundid.scim.sdk.SCIMAttribute

public final class SCIMAttribute
extends Object

This class represents a System for Cross-Domain Identity Management (SCIM) attribute. Attributes are categorized as either single-valued or multi-valued. This class allows for the following kinds of attributes.

1. Simple type (String, Boolean, DateTime, Integer or Binary). An example is the 'userName' attribute in the core schema.
2. Complex type. An example is the 'name' attribute in the core schema.
3. Multi-valued simple type. Represented using multi-valued complex values, because the values may have 'type' and 'primary' sub-attributes to distinguish each primitive value. Examples of this are the 'emails' and 'photos' attributes in the core schema.
4. Multi-valued complex type. An examples is the 'addresses' attribute in the core schema.

Method Summary

Methods

Modifier and Type	Method and Description
static SCIMAttribute	create(AttributeDescriptor descriptor, SCIMAttributeValue... values) Create an attribute.
boolean	equals(Object o)
AttributeDescriptor	getAttributeDescriptor() Retrieves the SCIM attribute mapping of this this attribute.
String	getName() Retrieve the name of this attribute.
String	getSchema() Retrieve the name of the schema to which this attribute belongs.
SCIMAttributeValue	getValue() Retrieves the value of this attribute.
SCIMAttributeValue[]	getValues() Retrieves the values of this attribute.
int	hashCode()
boolean	matchesFilter(SCIMFilter filter) Determine whether this attribute matches the provided filter parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static SCIMAttribute create(AttributeDescriptor descriptor,
                   SCIMAttributeValue... values)

Create an attribute.

Parameters:

descriptor - The mapping descriptor for this attribute.

values - The value(s) of this attribute.

Returns:

A new attribute.

getSchema

public String getSchema()

Retrieve the name of the schema to which this attribute belongs.

Returns:

The name of the schema to which this attribute belongs.

getName

public String getName()

Retrieve the name of this attribute. The name does not indicate which schema the attribute belongs to.

Returns:

The name of this attribute.

getValue

public SCIMAttributeValue getValue()

Retrieves the value of this attribute. This method should only be called if the attribute is single valued.

Returns:

The value of this attribute.

getValues

public SCIMAttributeValue[] getValues()

Retrieves the values of this attribute. This method should only be called if the attribute is multi-valued.

Returns:

The values of this attribute.

getAttributeDescriptor

public AttributeDescriptor getAttributeDescriptor()

Retrieves the SCIM attribute mapping of this this attribute.

Returns:

The attribute descriptor

matchesFilter

public boolean matchesFilter(SCIMFilter filter)

Determine whether this attribute matches the provided filter parameters.

Parameters:

filter - The filter parameters to be compared against this attribute.

Returns:

true if this attribute matches the provided filter, and false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object