com.atlassian.crowd.integration.directory.connector
Class LDAPPropertiesMapperImpl

java.lang.Object
  com.atlassian.crowd.integration.directory.connector.LDAPPropertiesMapperImpl

All Implemented Interfaces:

LDAPPropertiesMapper

public class LDAPPropertiesMapperImpl
extends java.lang.Object
implements LDAPPropertiesMapper

Field Summary

static java.lang.String	CONNECTION_BINARY_ATTRIBUTES LDAP binary attributes.
static java.lang.String	CONNECTION_FACTORY LDAP connection factory.
static java.lang.String	CONNECTION_FACTORY_SSL_IMPL LDAP secure connection factory.
static java.lang.String	CONNECTION_INITIAL_CONTEXT_FACTORY LDAP initial context factory.
static java.lang.String	CONNECTION_SECURITY_AUTHENTICATION LDAP connection method.
static java.lang.String	CONNECTION_SSL_SECURITY_PROTOCOL LDAP secure connection method.

Fields inherited from interface com.atlassian.crowd.integration.directory.connector.LDAPPropertiesMapper

GROUP_DESCRIPTION_KEY, GROUP_DN_ADDITION, GROUP_NAME_KEY, GROUP_OBJECTCLASS_KEY, GROUP_OBJECTFILTER_KEY, GROUP_USERNAMES_KEY, LDAP_BASEDN_KEY, LDAP_NESTED_GROUPS_DISABLED, LDAP_PAGEDRESULTS_KEY, LDAP_PAGEDRESULTS_SIZE, LDAP_PASSWORD_KEY, LDAP_POOLING_KEY, LDAP_REFERRAL_KEY, LDAP_RELAXED_DN_STANDARDISATION, LDAP_SECURE_KEY, LDAP_URL_KEY, LDAP_USER_ENCRYPTION_METHOD, LDAP_USERDN_KEY, LDAP_USING_USER_MEMBERSHIP_ATTRIBUTE, LDAP_USING_USER_MEMBERSHIP_ATTRIBUTE_FOR_GROUP_MEMBERSHIP, ROLE_DESCRIPTION_KEY, ROLE_DN_ADDITION, ROLE_NAME_KEY, ROLE_OBJECTCLASS_KEY, ROLE_OBJECTFILTER_KEY, ROLE_USERNAMES_KEY, ROLES_DISABLED, USER_DISPLAYNAME_KEY, USER_DN_ADDITION, USER_EMAIL_KEY, USER_FIRSTNAME_KEY, USER_GROUP_KEY, USER_LASTNAME_KEY, USER_OBJECTCLASS_KEY, USER_OBJECTFILTER_KEY, USER_PASSWORD_KEY, USER_USERNAME_KEY, USER_USERNAME_RDN_KEY

Constructor Summary

LDAPPropertiesMapperImpl()

Method Summary

java.lang.String	getAttribute(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.lang.String	getBaseDN()
protected boolean	getBooleanKey(java.lang.String key)
protected boolean	getBooleanKey(java.lang.String key, boolean defaultValue)
java.util.Map<java.lang.String,java.util.Properties>	getConfigurationDetails() Returns a map of the LDAP names as the keys and the properties associated with that LDAP connector.
java.lang.String	getConnectionURL()
java.util.Hashtable<java.lang.String,java.lang.String>	getEnvironment()
java.lang.String	getGroupBaseDN()
java.lang.String	getGroupDescriptionAttribute()
java.lang.String	getGroupFilter()
java.lang.String	getGroupMemberAttribute()
java.lang.String	getGroupNameAttribute()
java.lang.String	getGroupObjectClass()
java.util.Map<java.lang.String,java.lang.String>	getImplementations() Returns a map of the LDAP names as the keys and the implementation class as Strings.
LDAPPropertiesHelper	getLdapPropertiesHelper()
java.lang.String	getObjectClassAttribute()
int	getPagedResultsSize()
java.lang.String	getPassword()
java.lang.String	getPrincipalBaseDN()
java.lang.String	getRoleBaseDN()
java.lang.String	getRoleDescriptionAttribute()
java.lang.String	getRoleFilter()
java.lang.String	getRoleMemberAttribute()
java.lang.String	getRoleNameAttribute()
java.lang.String	getRoleObjectClass()
java.lang.String	getUserDisplayNameAttribute()
java.lang.String	getUserEmailAttribute()
java.lang.String	getUserEncryptionMethod()
java.lang.String	getUserFilter()
java.lang.String	getUserFirstNameAttribute()
java.lang.String	getUserGroupMembershipsAttribute() The attribute on a principal that specifies their group memberships (usually "memberOf").
java.lang.String	getUserLastNameAttribute()
java.lang.String	getUsername()
java.lang.String	getUserNameAttribute()
java.lang.String	getUserNameRdnAttribute()
java.lang.String	getUserObjectClass()
java.lang.String	getUserPasswordAttribute()
boolean	isNestedGroupsDisabled()
boolean	isPagedResultsControl() Checks if the configuration of the LDAP directory server uses paged results.
protected boolean	isReferral()
boolean	isRelaxedDnStandardisation() Whether we should use the more expensive but completely cross-directory compatible method for standardising DNs when mapping object DNs and and memberDNs (value = false); or if we can use a more efficient but relaxed form of standardisation (value = true).
boolean	isRolesDisabled() Returns true if roles should be disabled, as in some caching setups.
protected boolean	isSecureSSL() If the connection must be secure.
protected boolean	isUsingConnectionPooling()
boolean	isUsingUserMembershipAttribute() Whether we should use the "memberOf" (or equivalent) attribute in LDAP queries.
boolean	isUsingUserMembershipAttributeForGroupMembership() Whether we should use the "memberOf" (or equivalent) attribute when fetching the list of groups a user belongs to.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
void	setLdapPropertiesHelper(LDAPPropertiesHelper ldapPropertiesHelper)

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_INITIAL_CONTEXT_FACTORY

public static final java.lang.String CONNECTION_INITIAL_CONTEXT_FACTORY

LDAP initial context factory.

See Also:

Constant Field Values

CONNECTION_SECURITY_AUTHENTICATION

public static final java.lang.String CONNECTION_SECURITY_AUTHENTICATION

LDAP connection method.

See Also:

Constant Field Values

CONNECTION_SSL_SECURITY_PROTOCOL

public static final java.lang.String CONNECTION_SSL_SECURITY_PROTOCOL

LDAP secure connection method.

See Also:

Constant Field Values

CONNECTION_FACTORY

public static final java.lang.String CONNECTION_FACTORY

LDAP connection factory.

See Also:

Constant Field Values

CONNECTION_FACTORY_SSL_IMPL

public static final java.lang.String CONNECTION_FACTORY_SSL_IMPL

LDAP secure connection factory.

See Also:

Constant Field Values

CONNECTION_BINARY_ATTRIBUTES

public static final java.lang.String CONNECTION_BINARY_ATTRIBUTES

LDAP binary attributes.

See Also:

Constant Field Values

Constructor Detail

LDAPPropertiesMapperImpl

public LDAPPropertiesMapperImpl()

Method Detail

getImplementations

public java.util.Map<java.lang.String,java.lang.String> getImplementations()

Returns a map of the LDAP names as the keys and the implementation class as Strings.

Specified by:

getImplementations in interface LDAPPropertiesMapper

Returns:

The implementations.

getConfigurationDetails

public java.util.Map<java.lang.String,java.util.Properties> getConfigurationDetails()

Returns a map of the LDAP names as the keys and the properties associated with that LDAP connector.

Specified by:

getConfigurationDetails in interface LDAPPropertiesMapper

Returns:

The configuration details.

getEnvironment

public java.util.Hashtable<java.lang.String,java.lang.String> getEnvironment()

Specified by:

getEnvironment in interface LDAPPropertiesMapper

isSecureSSL

protected boolean isSecureSSL()

If the connection must be secure.

Returns:

true if and only if the connection must be securem, otherwise false.

isReferral

protected boolean isReferral()

isUsingConnectionPooling

protected boolean isUsingConnectionPooling()

getBooleanKey

protected boolean getBooleanKey(java.lang.String key)

getBooleanKey

protected boolean getBooleanKey(java.lang.String key,
                                boolean defaultValue)

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Specified by:

getAttributes in interface LDAPPropertiesMapper

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Specified by:

setAttributes in interface LDAPPropertiesMapper

getAttribute

public java.lang.String getAttribute(java.lang.String key)

Specified by:

getAttribute in interface LDAPPropertiesMapper

getBaseDN

public java.lang.String getBaseDN()
                           throws javax.naming.InvalidNameException

Throws:

javax.naming.InvalidNameException

getGroupBaseDN

public java.lang.String getGroupBaseDN()
                                throws javax.naming.InvalidNameException

Throws:

javax.naming.InvalidNameException

getGroupFilter

public java.lang.String getGroupFilter()

Specified by:

getGroupFilter in interface LDAPPropertiesMapper

getConnectionURL

public java.lang.String getConnectionURL()

Specified by:

getConnectionURL in interface LDAPPropertiesMapper

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface LDAPPropertiesMapper

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface LDAPPropertiesMapper

getGroupNameAttribute

public java.lang.String getGroupNameAttribute()

Specified by:

getGroupNameAttribute in interface LDAPPropertiesMapper

getObjectClassAttribute

public java.lang.String getObjectClassAttribute()

Specified by:

getObjectClassAttribute in interface LDAPPropertiesMapper

getRoleFilter

public java.lang.String getRoleFilter()

Specified by:

getRoleFilter in interface LDAPPropertiesMapper

getRoleBaseDN

public java.lang.String getRoleBaseDN()
                               throws javax.naming.InvalidNameException

Throws:

javax.naming.InvalidNameException

getRoleNameAttribute

public java.lang.String getRoleNameAttribute()

Specified by:

getRoleNameAttribute in interface LDAPPropertiesMapper

getUserFilter

public java.lang.String getUserFilter()

Specified by:

getUserFilter in interface LDAPPropertiesMapper

getPrincipalBaseDN

public java.lang.String getPrincipalBaseDN()

getUserNameAttribute

public java.lang.String getUserNameAttribute()

Specified by:

getUserNameAttribute in interface LDAPPropertiesMapper

getUserNameRdnAttribute

public java.lang.String getUserNameRdnAttribute()

Specified by:

getUserNameRdnAttribute in interface LDAPPropertiesMapper

getUserEmailAttribute

public java.lang.String getUserEmailAttribute()

Specified by:

getUserEmailAttribute in interface LDAPPropertiesMapper

getUserGroupMembershipsAttribute

public java.lang.String getUserGroupMembershipsAttribute()

Description copied from interface: LDAPPropertiesMapper

The attribute on a principal that specifies their group memberships (usually "memberOf"). Not implemented by all directories.

Specified by:

getUserGroupMembershipsAttribute in interface LDAPPropertiesMapper

Returns:

getGroupObjectClass

public java.lang.String getGroupObjectClass()

Specified by:

getGroupObjectClass in interface LDAPPropertiesMapper

getGroupDescriptionAttribute

public java.lang.String getGroupDescriptionAttribute()

Specified by:

getGroupDescriptionAttribute in interface LDAPPropertiesMapper

getGroupMemberAttribute

public java.lang.String getGroupMemberAttribute()

Specified by:

getGroupMemberAttribute in interface LDAPPropertiesMapper

getRoleObjectClass

public java.lang.String getRoleObjectClass()

Specified by:

getRoleObjectClass in interface LDAPPropertiesMapper

getRoleDescriptionAttribute

public java.lang.String getRoleDescriptionAttribute()

Specified by:

getRoleDescriptionAttribute in interface LDAPPropertiesMapper

getRoleMemberAttribute

public java.lang.String getRoleMemberAttribute()

Specified by:

getRoleMemberAttribute in interface LDAPPropertiesMapper

getUserObjectClass

public java.lang.String getUserObjectClass()

Specified by:

getUserObjectClass in interface LDAPPropertiesMapper

getUserFirstNameAttribute

public java.lang.String getUserFirstNameAttribute()

Specified by:

getUserFirstNameAttribute in interface LDAPPropertiesMapper

getUserLastNameAttribute

public java.lang.String getUserLastNameAttribute()

Specified by:

getUserLastNameAttribute in interface LDAPPropertiesMapper

getUserDisplayNameAttribute

public java.lang.String getUserDisplayNameAttribute()

Specified by:

getUserDisplayNameAttribute in interface LDAPPropertiesMapper

getUserPasswordAttribute

public java.lang.String getUserPasswordAttribute()

Specified by:

getUserPasswordAttribute in interface LDAPPropertiesMapper

getUserEncryptionMethod

public java.lang.String getUserEncryptionMethod()

Specified by:

getUserEncryptionMethod in interface LDAPPropertiesMapper

isPagedResultsControl

public boolean isPagedResultsControl()

Checks if the configuration of the LDAP directory server uses paged results.

Specified by:

isPagedResultsControl in interface LDAPPropertiesMapper

Returns:

true if and only if paged results is enabled for the LDAP server, otherwise false.

getPagedResultsSize

public int getPagedResultsSize()

Specified by:

getPagedResultsSize in interface LDAPPropertiesMapper

isNestedGroupsDisabled

public boolean isNestedGroupsDisabled()

Specified by:

isNestedGroupsDisabled in interface LDAPPropertiesMapper

isUsingUserMembershipAttribute

public boolean isUsingUserMembershipAttribute()

Description copied from interface: LDAPPropertiesMapper

Whether we should use the "memberOf" (or equivalent) attribute in LDAP queries.

Specified by:

isUsingUserMembershipAttribute in interface LDAPPropertiesMapper

Returns:

isUsingUserMembershipAttributeForGroupMembership

public boolean isUsingUserMembershipAttributeForGroupMembership()

Description copied from interface: LDAPPropertiesMapper

Whether we should use the "memberOf" (or equivalent) attribute when fetching the list of groups a user belongs to.

Specified by:

isUsingUserMembershipAttributeForGroupMembership in interface LDAPPropertiesMapper

Returns:

isRelaxedDnStandardisation

public boolean isRelaxedDnStandardisation()

Description copied from interface: LDAPPropertiesMapper

Whether we should use the more expensive but completely cross-directory compatible method for standardising DNs when mapping object DNs and and memberDNs (value = false); or if we can use a more efficient but relaxed form of standardisation (value = true). See DNStandardiser for more information.

Specified by:

isRelaxedDnStandardisation in interface LDAPPropertiesMapper

Returns:

false if proper standardisation is required.

isRolesDisabled

public boolean isRolesDisabled()

Description copied from interface: LDAPPropertiesMapper

Returns true if roles should be disabled, as in some caching setups. The grammatical atrocity that is the name of this method pains me more than you can imagine.

Specified by:

isRolesDisabled in interface LDAPPropertiesMapper

Returns:

getLdapPropertiesHelper

public LDAPPropertiesHelper getLdapPropertiesHelper()

setLdapPropertiesHelper

public void setLdapPropertiesHelper(LDAPPropertiesHelper ldapPropertiesHelper)