com.communote.server.core.common.ldap

Class LdapAttributesMapper<T>

java.lang.Object

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

Type Parameters:

T - the target class this mapper can map to

Direct Known Subclasses:

LdapGroupAttributesMapper, LdapUserAttributesMapper

public abstract class LdapAttributesMapper<T>
extends Object

Generic mapper for LDAP attributes to Communote counterparts.

Author:

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

Constructor Summary

Constructors

Constructor and Description
LdapAttributesMapper(Map<String,String> mapping) Creates a mapper based on a mapping from Communote attribute names to LDAP attribute names.
LdapAttributesMapper(String mapping) Convenience constructor to initialize the mapper from a string based mapping definition.

Method Summary

Modifier and Type	Method and Description
protected String	getAttributeValue(Attributes attributes, String ldapAttributeName) Returns the value for the named LDAP attribute.
protected String	getAttributeValueForKenmeiAttributeName(String dn, Attributes attributes, String communoteAttributeName) Similar to getAttributeValue(Attributes, String) but expects a Communote attribute name which will be automatically mapped to the LDAP attribute name.
abstract String[]	getBinaryLdapAttributeName() Returns an array of names of mapped LDAP attributes that are binary.
String	getLdapAttributName(String name) Returns the LDAP attribute name for a Communote attribute.
String[]	getMappedLdapAttributeNames() Returns the names of the mapped LDAP attributes.
String	getMappingAsString() Returns the mapping of the mapper as string in the form communoteAttribute1=ldapAttribute1,communoteAttribute2=ldapAttribute2
protected abstract Set<String>	getRequiredAttributeNames() Returns the subset with required Communote attribute names the mapper can map.
protected abstract Set<String>	getSupportedAttributeNames() Returns the Kenmei attribute names the mapper can map.
protected void	init(Map<String,String> mapping) Initializes the mapper and validates that all required properties are contained in the mapping.
boolean	isKenmeiAttributeMapped(String communoteAttributeName) Returns whether a Communote attribute is mapped to an LDAP attribute.
abstract T	mapAttributes(String dn, Attributes ldapAttributes) Maps the LDAP attributes to the generic type.

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapAttributesMapper

public LdapAttributesMapper(Map<String,String> mapping)
                     throws LdapAttributeMappingException

Creates a mapper based on a mapping from Communote attribute names to LDAP attribute names.

Parameters:

mapping - a mapping from Communote attribute names to LDAP attribute names

Throws:

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

LdapAttributesMapper

public LdapAttributesMapper(String mapping)
                     throws LdapAttributeMappingException

Convenience constructor to initialize the mapper from a string based mapping definition.

Parameters:

mapping - a mapping in the form communoteAttribute1=ldapAttribute1,communoteAttribute2=ldapAttribute2

Throws:

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

Method Detail

getAttributeValue

protected String getAttributeValue(Attributes attributes,
                                   String ldapAttributeName)
                            throws LdapAttributeMappingException

Returns the value for the named LDAP attribute. If the LDAP attribute is not contained or the attribute has no value null is returned. If the attribute has more than one value only the first will be returned.

Parameters:

attributes - the attributes from which the value should be extracted

ldapAttributeName - the name of the attribute in LDAP

Returns:

the value converted to string

Throws:

LdapAttributeMappingException - if there was an error while retrieving the value

getAttributeValueForKenmeiAttributeName

protected String getAttributeValueForKenmeiAttributeName(String dn,
                                                         Attributes attributes,
                                                         String communoteAttributeName)
                                                  throws LdapAttributeMappingException

Similar to getAttributeValue(Attributes, String) but expects a Communote attribute name which will be automatically mapped to the LDAP attribute name. If the named attribute is a required attribute the value must be non-null otherwise an exception is thrown.

Parameters:

dn - Needed for logging.

attributes - the attributes from which the value should be extracted

communoteAttributeName - the name of the Communote attribute. The attribute must be one of the getSupportedAttributeNames().

Returns:

the value converted to string

Throws:

LdapAttributeMappingException - if there was an error while retrieving the value or the attribute name is not supported or the attribute is required but did not return a value

getBinaryLdapAttributeName

public abstract String[] getBinaryLdapAttributeName()

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

Returns:

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

getLdapAttributName

public String getLdapAttributName(String name)

Returns the LDAP attribute name for a Communote attribute.

Parameters:

name - the name

Returns:

the mapped attribute name or null if the attribute is not mapped

getMappedLdapAttributeNames

public String[] getMappedLdapAttributeNames()

Returns the names of the mapped LDAP attributes.

Returns:

the names of the LDAP attributes. Can be empty if nothing is mapped

getMappingAsString

public String getMappingAsString()

Returns the mapping of the mapper as string in the form communoteAttribute1=ldapAttribute1,communoteAttribute2=ldapAttribute2

Returns:

the mapping as string

getRequiredAttributeNames

protected abstract Set<String> getRequiredAttributeNames()

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

Returns:

Kenmei attribute names that are required

getSupportedAttributeNames

protected abstract Set<String> getSupportedAttributeNames()

Returns the Kenmei attribute names the mapper can map.

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.

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

isKenmeiAttributeMapped

public boolean isKenmeiAttributeMapped(String communoteAttributeName)

Returns whether a Communote attribute is mapped to an LDAP attribute.

Parameters:

communoteAttributeName - the Communote attribute to check

Returns:

true if it is mapped, false otherwise

mapAttributes

public abstract T mapAttributes(String dn,
                                Attributes ldapAttributes)
                         throws LdapAttributeMappingException

Maps the LDAP attributes to the generic type.

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