pt.digitalis.dif.identity.ldap
Class AttributeConfigurations

java.lang.Object
  pt.digitalis.dif.identity.ldap.AttributeConfigurations

public class AttributeConfigurations
extends Object

Holds the business-to-LDAP-attributes mapping configuration.

Author:

Rodrigo Gonçalves rgoncalves@digitalis.pt

Created on:

2008/09/18

Field Summary

static String

BULK_PARAMETER_PROPERTY_KEY The name of the Properties key that holds the name of the LDAP attribute to store bulk parameters.

Constructor Summary

AttributeConfigurations()
Default ctor.

Method Summary

void	addMappingPair(String businessParameterName, String ldapAttributeName) Adds a new business-to-LDAP mapping to the configurations, if such mapping does not exists yet.
boolean	containsBusinessParameter(String businessParameterName) Checks if the supplied business parameter name is mapped.
boolean	containsLDAPAttribute(String ldapAttributeName) Checks if the supplied LDAP attribute name is mapped.
String	getBulkParameterAttributeName() Inspector for the 'bulkParameterAttributeName' attribute.
String	getBusiness2LDAPMapping(String businessParameterName) Returns the name of the LDAP attribute that maps to the supplied business parameter name.
String	getLDAP2BusinessMapping(String ldapAttributeName) Returns the name of the business parameter that maps to the supplied LDAP attribute name.
void	removeMapping(String businessParameterName, String ldapAttributeName) Removes an existing mapping.
void	setBulkParameterAttributeName(String bulkParameterAttributeName) Modifier for the 'bulkParameterAttributeName' attribute.

Methods inherited from class java.lang.Object

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

Field Detail

BULK_PARAMETER_PROPERTY_KEY

public static final String BULK_PARAMETER_PROPERTY_KEY

The name of the Properties key that holds the name of the LDAP attribute to store bulk parameters.

See Also:

Constant Field Values

Constructor Detail

AttributeConfigurations

public AttributeConfigurations()

Default ctor.

Method Detail

getBusiness2LDAPMapping

public String getBusiness2LDAPMapping(String businessParameterName)

Returns the name of the LDAP attribute that maps to the supplied business parameter name.

Parameters:

businessParameterName - the business parameter name

Returns:

the LDAP attribute name that maps to the supplied business parameter name

getLDAP2BusinessMapping

public String getLDAP2BusinessMapping(String ldapAttributeName)

Returns the name of the business parameter that maps to the supplied LDAP attribute name.

Parameters:

ldapAttributeName - the LDAP attribute name

Returns:

the business parameter that maps to the supplied LDAP attribute name.

addMappingPair

public void addMappingPair(String businessParameterName,
                           String ldapAttributeName)

Adds a new business-to-LDAP mapping to the configurations, if such mapping does not exists yet.

Parameters:

businessParameterName - the business parameter name

ldapAttributeName - the LDAP attribute name

removeMapping

public void removeMapping(String businessParameterName,
                          String ldapAttributeName)

Removes an existing mapping.

Parameters:

businessParameterName - the business parameter name

ldapAttributeName - the LDAP attribute name

containsBusinessParameter

public boolean containsBusinessParameter(String businessParameterName)

Checks if the supplied business parameter name is mapped.

Parameters:

businessParameterName - the business parameter name

Returns:

T if the supplied business parameter name is mapped, F otherwise

containsLDAPAttribute

public boolean containsLDAPAttribute(String ldapAttributeName)

Checks if the supplied LDAP attribute name is mapped.

Parameters:

ldapAttributeName - the LDAP attribute name

Returns:

T if the supplied LDAP attribute name is mapped, F otherwise

getBulkParameterAttributeName

public String getBulkParameterAttributeName()

Inspector for the 'bulkParameterAttributeName' attribute.

Returns:

the bulkParameterAttributeName value

setBulkParameterAttributeName

public void setBulkParameterAttributeName(String bulkParameterAttributeName)

Modifier for the 'bulkParameterAttributeName' attribute.

Parameters:

bulkParameterAttributeName - the new bulkParameterAttributeName value to set