com.atlassian.crowd.directory.ldap.mapper.attribute
Class UserAccountControlMapper

java.lang.Object
  com.atlassian.crowd.directory.ldap.mapper.attribute.UserAccountControlMapper

All Implemented Interfaces:

AttributeMapper

public class UserAccountControlMapper
extends Object
implements AttributeMapper

Maps the userAccountControl on a user. This concept only applies to Active Directory.

Since:

2.7

Field Summary

static String

ATTRIBUTE_KEY

Constructor Summary

UserAccountControlMapper()

Method Summary

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(DirContextAdapter) will be called on the results.
Set<String>	getValues(org.springframework.ldap.core.DirContextAdapter ctx) Map the value of the key from the directory context.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_KEY

public static final String ATTRIBUTE_KEY

See Also:

Constant Field Values

Constructor Detail

UserAccountControlMapper

public UserAccountControlMapper()

Method Detail

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(org.springframework.ldap.core.DirContextAdapter ctx)
                      throws Exception

Description copied from interface: AttributeMapper

Map the value of the key from the directory context.

Specified by:

getValues in interface AttributeMapper

Parameters:

ctx - directory context 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(DirContextAdapter) 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