com.communote.server.core.common.ldap

Class LdapUserAttributesMapper

java.lang.Object

com.communote.server.core.common.ldap.LdapAttributesMapper<ExternalUserVO>

com.communote.server.core.common.ldap.LdapUserAttributesMapper

public class LdapUserAttributesMapper
extends LdapAttributesMapper<ExternalUserVO>

Mapper for mapping LDAP user attributes to an ExternalUserVO.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
LdapUserAttributesMapper(LdapConfiguration config) Creates a mapper from a string based mapping definition.

Method Summary

Modifier and Type	Method and Description
String[]	getBinaryLdapAttributeName() Returns an array of names of mapped LDAP attributes that are binary.
String	getLdapAttributName(LdapUserAttribute attributeName) Returns the LDAP attribute name for a Kenmei attribute.
protected Set<String>	getRequiredAttributeNames() Returns the subset with required Communote attribute names the mapper can map.
protected Set<String>	getSupportedAttributeNames() Returns the Kenmei attribute names the mapper can map.
static String	getUserPropertyKeyGroup() Return the user property key group.
static String	getUserPropertyKeyName(String externalSystemId, LdapUserAttribute attribute) Return the user property key name.
protected void	init(Map<String,String> mapping) Initializes the mapper and validates that all required properties are contained in the mapping.
ExternalUserVO	mapAttributes(String dn, Attributes ldapAttributes) Maps the LDAP attributes to the generic type.

Methods inherited from class com.communote.server.core.common.ldap.LdapAttributesMapper

getAttributeValue, getAttributeValueForKenmeiAttributeName, getLdapAttributName, getMappedLdapAttributeNames, getMappingAsString, isKenmeiAttributeMapped

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapUserAttributesMapper

public LdapUserAttributesMapper(LdapConfiguration config)
                         throws LdapAttributeMappingException

Creates a mapper from a string based mapping definition.

Parameters:

config - an LDAP configuration

Throws:

LdapAttributeMappingException - if an attribute is not supported or a required attribute is missing

Method Detail

getUserPropertyKeyGroup

public static String getUserPropertyKeyGroup()

Return the user property key group.

Returns:

the key group of the property

getUserPropertyKeyName

public static String getUserPropertyKeyName(String externalSystemId,
                                            LdapUserAttribute attribute)

Return the user property key name.

Parameters:

externalSystemId - the external system id

attribute - the ldap attribute

Returns:

the key name of the user property

getBinaryLdapAttributeName

public String[] getBinaryLdapAttributeName()

Returns an array of names of mapped LDAP attributes that are binary.

Specified by:

getBinaryLdapAttributeName in class LdapAttributesMapper<ExternalUserVO>

Returns:

the array of attribute names or null if there are no binary attributes

getLdapAttributName

public String getLdapAttributName(LdapUserAttribute attributeName)

Returns the LDAP attribute name for a Kenmei attribute.

Parameters:

attributeName - the name

Returns:

the mapped attribute name

getRequiredAttributeNames

protected Set<String> getRequiredAttributeNames()

Returns the subset with required Communote attribute names the mapper can map.

Specified by:

getRequiredAttributeNames in class LdapAttributesMapper<ExternalUserVO>

Returns:

Kenmei attribute names that are required

getSupportedAttributeNames

protected Set<String> getSupportedAttributeNames()

Returns the Kenmei attribute names the mapper can map.

Specified by:

getSupportedAttributeNames in class LdapAttributesMapper<ExternalUserVO>

Returns:

the Kenmei attribute names the mapper can map

init

protected void init(Map<String,String> mapping)
             throws LdapAttributeMappingException

Initializes the mapper and validates that all required properties are contained in the mapping.

Overrides:

init in class LdapAttributesMapper<ExternalUserVO>

Parameters:

mapping - the mapping of Kenmei attribute names to LDAP counterparts to validate

Throws:

LdapAttributeMappingException - if an attribute is not supported or a required attribute is missing

mapAttributes

public ExternalUserVO mapAttributes(String dn,
                                    Attributes ldapAttributes)
                             throws LdapAttributeMappingException

Maps the LDAP attributes to the generic type.

Specified by:

mapAttributes in class LdapAttributesMapper<ExternalUserVO>

Parameters:

dn - the DN of the element providing the attributes

ldapAttributes - The ldap attributes.

Returns:

the target object created from the attributes

Throws:

LdapAttributeMappingException - if the mapping failed