com.atlassian.user.impl.ldap.properties
Interface LdapSearchProperties

All Known Implementing Classes:
DefaultLdapSearchProperties

public interface LdapSearchProperties

Properties which map an LDAP data structure to users and groups for searching an LDAP repository.


Method Summary
 java.lang.String getBaseGroupNamespace()
           
 java.lang.String getBaseUserNamespace()
           
 java.lang.String getEmailAttribute()
           
 java.lang.String getFirstnameAttribute()
           
 java.lang.String getGroupFilter()
           
 java.lang.String getGroupnameAttribute()
           
 java.lang.String getSurnameAttribute()
           
 int getTimeLimitMillis()
           
 java.lang.String getUserFilter()
           
 java.lang.String getUsernameAttribute()
           
 boolean isGroupSearchScopeAllDepths()
          Returns true if group searches will scan the entire LDAP tree beneath the DN specified by getBaseGroupNamespace() (sub-tree scope), or false if only direct children of that DN should be scanned (one-level scope).
 boolean isUserSearchScopeAllDepths()
          Returns true if user searches will scan the entire LDAP tree beneath the DN specified by getBaseUserNamespace() (sub-tree scope), or false if only direct children of that DN should be scanned (one-level scope).
 

Method Detail

getBaseUserNamespace

public java.lang.String getBaseUserNamespace()
Returns:
base DN of user tree in LDAP server, for example 'ou=users,dc=atlassian,dc=com'

getUserFilter

public java.lang.String getUserFilter()
Returns:
LDAP search filter for users, for example '(objectClass=inetOrgPerson)'

isUserSearchScopeAllDepths

public boolean isUserSearchScopeAllDepths()
Returns true if user searches will scan the entire LDAP tree beneath the DN specified by getBaseUserNamespace() (sub-tree scope), or false if only direct children of that DN should be scanned (one-level scope).

See Also:
SearchControls.SUBTREE_SCOPE, SearchControls.ONELEVEL_SCOPE

getUsernameAttribute

public java.lang.String getUsernameAttribute()
Returns:
attribute name of the user identifier attribute on an LDAP user record, for example 'sAMAccountName'

getFirstnameAttribute

public java.lang.String getFirstnameAttribute()
Returns:
attribute name of the first name attribute on an LDAP user record, for example 'givenName'

getSurnameAttribute

public java.lang.String getSurnameAttribute()
Returns:
attribute name of the surname attribute on an LDAP user record, for example 'sn'

getEmailAttribute

public java.lang.String getEmailAttribute()
Returns:
attribute name of the email attribute on an LDAP user record, for example 'mail'

getBaseGroupNamespace

public java.lang.String getBaseGroupNamespace()
Returns:
base DN of group tree in LDAP server, for example 'ou=groups,dc=atlassian,dc=com'

getGroupFilter

public java.lang.String getGroupFilter()
Returns:
LDAP search filter for group, for example '(objectClass=groupOfNames)'

isGroupSearchScopeAllDepths

public boolean isGroupSearchScopeAllDepths()
Returns true if group searches will scan the entire LDAP tree beneath the DN specified by getBaseGroupNamespace() (sub-tree scope), or false if only direct children of that DN should be scanned (one-level scope).

See Also:
SearchControls.SUBTREE_SCOPE, SearchControls.ONELEVEL_SCOPE

getGroupnameAttribute

public java.lang.String getGroupnameAttribute()
Returns:
attribute name of the group identifier attribute on an LDAP group record, for example 'cn'

getTimeLimitMillis

public int getTimeLimitMillis()
Returns:
maximum time LDAP connection will wait for search results to return before aborting the search. Measured in milliseconds, where 0 means wait indefinitely.
See Also:
SearchControls.getTimeLimit()


Copyright © 2005-2008 Atlassian Software Systems Pty Ltd. All Rights Reserved.