Package com.atlassian.crowd.directory.ldap.mapper.attribute

Class PrimaryGroupIdMapper

java.lang.Object

com.atlassian.crowd.directory.ldap.mapper.attribute.PrimaryGroupIdMapper

All Implemented Interfaces:

AttributeMapper

public class PrimaryGroupIdMapper
extends Object
implements AttributeMapper

Maps the primaryGroupId of a user. This concept only applies to Active Directory.

Since:

v2.7

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_KEY	Primary Group ID attribute name.

Constructor Summary

Constructors

Constructor	Description
PrimaryGroupIdMapper()

Method Summary

Modifier and Type	Method	Description
String	getKey()	Get the key to use when storing the attribute on an entity with Attributes.
Set<String>	getRequiredLdapAttributes()	Returns the LDAP attributes that should be requested in a search where AttributeMapper.getValues(NameAttributesPair) will be called on the results.
Set<String>	getValues(NameAttributesPair nameAttributesPair)	Map the value of the key from a directory entry.

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_KEY

public static final String ATTRIBUTE_KEY

Primary Group ID attribute name.

See Also:

• Constant Field Values

Constructor Details

PrimaryGroupIdMapper

public PrimaryGroupIdMapper()

Method Details

getKey

public String getKey()

Description copied from interface: AttributeMapper

Get the key to use when storing the attribute on an entity with Attributes.

Specified by:

getKey in interface AttributeMapper

Returns:

non-null key.

getValues

public Set<String> getValues(NameAttributesPair nameAttributesPair)
                      throws Exception

Description copied from interface: AttributeMapper

Map the value of the key from a directory entry.

Specified by:

getValues in interface AttributeMapper

Parameters:

nameAttributesPair - directory entry containing attributes.

Returns:

the set of attribute values associated with the key. If no values are present an empty set will be returned

Throws:

Exception - error retrieving value. The attribute will not be set.

getRequiredLdapAttributes

public Set<String> getRequiredLdapAttributes()

Description copied from interface: AttributeMapper

Returns the LDAP attributes that should be requested in a search where AttributeMapper.getValues(NameAttributesPair) will be called on the results. If an implementation returns null then all attributes will be requested.

Specified by:

getRequiredLdapAttributes in interface AttributeMapper

Returns:

the LDAP attributes that should be requested, or null for all