com.rli.util.identityData

Class IdentityAttributePath

java.lang.Object

com.rli.util.identityData.IdentityAttributePath

public class IdentityAttributePath
extends java.lang.Object

An attribute path is an attribute selector: it provides a way to selectively target specific attributes in an IdentityData object. When combined with an operation, the attribute path is used to express exactly which attribute (or sub-attribute) 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:

• Simple primitive attributes: fullName
• Complex sub-attributes: name.firstName
• Complex sub-attributes with filters: addresses[type eq "work"].country

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdentityAttributePath(SCIMPath scimPath)

Method Summary

Modifier and Type	Method and Description
static IdentityAttributePath	build(java.lang.String attribute) Returns an attribute path instance composed of a single attribute name (e.g: fullName)
static IdentityAttributePath	build(java.lang.String attribute, java.lang.String subAttribute) Returns an attribute path instance composed of a single attribute name and a single sub-attribute for that attribute (e.g: name.givenName)
static IdentityAttributePath	build(java.lang.String attribute, java.lang.String subAttribute, java.lang.String equalityFilterSubAttrName, java.lang.String equalityFilterValue) Returns an attribute path instance composed of a single attribute name and a single sub-attribute with a sub-attribute filter equality filter (e.g: addresses[type eq "work"].city).
static IdentityAttributePath	fromString(java.lang.String attributePathStr) Returns an instance of an IdentityAttributePath object built from the specified attribute path String.
IdentityFilter	getAttributeFilter() Returns the filter for this attribute path.
java.lang.String	getAttributeName() Returns the attribute name for this attribute path.
java.lang.String	getSubAttributeName() Returns the sub-attribute name for this attribute path.
boolean	isSimple() Indicates whether this attribute path is simple.
void	setAttributeName(java.lang.String attributeName) change the attibute name for this attribute path
java.lang.String	toString() Returns the String representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityAttributePath

protected IdentityAttributePath(SCIMPath scimPath)

Method Detail

fromString

public static IdentityAttributePath fromString(java.lang.String attributePathStr)
                                        throws IdentityDataException

Returns an instance of an IdentityAttributePath object built from the specified attribute path String. Examples of valid attribute paths:

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

Parameters:

attributePathStr - A valid attribute path String.

Returns:

an instance of an IdentityAttributePath object built from the specified attribute path String.

Throws:

IdentityDataException - If the specified attribute path is not valid or cannot be parsed properly.

isSimple

public boolean isSimple()

Indicates whether this attribute path is simple. A simple attribute path is simply composed of an attribute name and does not use sub-attribute or any kind of attribute filtering.

Returns:

true if this attribute path is simple (no sub-attributes, no filtering, just a simple attribute name), or false otherwise.

build

public static IdentityAttributePath build(java.lang.String attribute)

Returns an attribute path instance composed of a single attribute name (e.g: fullName)

Parameters:

attribute - The name of an attribute.

Returns:

an attribute path instance composed of a single attribute name.

build

public static IdentityAttributePath build(java.lang.String attribute,
                                          java.lang.String subAttribute)

Returns an attribute path instance composed of a single attribute name and a single sub-attribute for that attribute (e.g: name.givenName)

Parameters:

attribute - The name of an attribute.

subAttribute - The name of the sub-attribute.

Returns:

an attribute path instance composed of a single attribute name and a single sub-attribute for that attribute.

build

public static IdentityAttributePath build(java.lang.String attribute,
                                          java.lang.String subAttribute,
                                          java.lang.String equalityFilterSubAttrName,
                                          java.lang.String equalityFilterValue)

Returns an attribute path instance composed of a single attribute name and a single sub-attribute with a sub-attribute filter equality filter (e.g: addresses[type eq "work"].city).

Parameters:

attribute - The name of an attribute.

subAttribute - The name of a sub-attribute.

equalityFilterSubAttrName - The name of a sub-attribute for the equality filter (left side of the equals sign)

equalityFilterValue - The value for the equality filter (right side of the equals sign)

Returns:

an attribute path instance composed of a single attribute name and a single sub-attribute with a * sub-attribute filter equality filter (e.g: addresses[type eq "work"].city).

getAttributeName

public java.lang.String getAttributeName()

Returns the attribute name for this attribute path.

Returns:

the attribute name for this attribute path.

setAttributeName

public void setAttributeName(java.lang.String attributeName)

change the attibute name for this attribute path

getSubAttributeName

public java.lang.String getSubAttributeName()

Returns the sub-attribute name for this attribute path.

Returns:

the sub-attribute name for this attribute path.

getAttributeFilter

public IdentityFilter getAttributeFilter()

Returns the filter for this attribute path.

Returns:

the filter for this attribute path.

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.