com.atlassian.user.impl.ldap.properties
Class DefaultLdapSearchProperties

java.lang.Object
  com.atlassian.user.impl.ldap.properties.DefaultLdapSearchProperties

All Implemented Interfaces:

LdapSearchProperties

public class DefaultLdapSearchProperties

extends java.lang.Object

implements LdapSearchProperties

Constructor Summary

DefaultLdapSearchProperties()

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).
void	setBaseGroupNamespace(java.lang.String baseGroupNamespace)
void	setBaseUserNamespace(java.lang.String baseUserNamespace)
void	setEmailAttribute(java.lang.String emailAttribute)
void	setFirstnameAttribute(java.lang.String firstnameAttribute)
void	setGroupFilter(java.lang.String groupFilter)
void	setGroupnameAttribute(java.lang.String groupnameAttribute)
void	setGroupSearchScopeAllDepths(boolean groupSearchScopeAllDepths)
void	setSurnameAttribute(java.lang.String surnameAttribute)
void	setTimeLimitMillis(int timeLimitMillis)
void	setUserFilter(java.lang.String userFilter)
void	setUsernameAttribute(java.lang.String usernameAttribute)
void	setUserSearchScopeAllDepths(boolean userSearchScopeAllDepths)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLdapSearchProperties

public DefaultLdapSearchProperties()

Method Detail

getBaseUserNamespace

public java.lang.String getBaseUserNamespace()

Specified by:

getBaseUserNamespace in interface LdapSearchProperties

Returns:

base DN of user tree in LDAP server, for example 'ou=users,dc=atlassian,dc=com'

getUserFilter

public java.lang.String getUserFilter()

Specified by:

getUserFilter in interface LdapSearchProperties

Returns:

LDAP search filter for users, for example '(objectClass=inetOrgPerson)'

getBaseGroupNamespace

public java.lang.String getBaseGroupNamespace()

Specified by:

getBaseGroupNamespace in interface LdapSearchProperties

Returns:

base DN of group tree in LDAP server, for example 'ou=groups,dc=atlassian,dc=com'

getGroupFilter

public java.lang.String getGroupFilter()

Specified by:

getGroupFilter in interface LdapSearchProperties

Returns:

LDAP search filter for group, for example '(objectClass=groupOfNames)'

getUsernameAttribute

public java.lang.String getUsernameAttribute()

Specified by:

getUsernameAttribute in interface LdapSearchProperties

Returns:

attribute name of the user identifier attribute on an LDAP user record, for example 'sAMAccountName'

getGroupnameAttribute

public java.lang.String getGroupnameAttribute()

Specified by:

getGroupnameAttribute in interface LdapSearchProperties

Returns:

attribute name of the group identifier attribute on an LDAP group record, for example 'cn'

getFirstnameAttribute

public java.lang.String getFirstnameAttribute()

Specified by:

getFirstnameAttribute in interface LdapSearchProperties

Returns:

attribute name of the first name attribute on an LDAP user record, for example 'givenName'

getSurnameAttribute

public java.lang.String getSurnameAttribute()

Specified by:

getSurnameAttribute in interface LdapSearchProperties

Returns:

attribute name of the surname attribute on an LDAP user record, for example 'sn'

getEmailAttribute

public java.lang.String getEmailAttribute()

Specified by:

getEmailAttribute in interface LdapSearchProperties

Returns:

attribute name of the email attribute on an LDAP user record, for example 'mail'

isUserSearchScopeAllDepths

public boolean isUserSearchScopeAllDepths()

Description copied from interface: LdapSearchProperties

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

Specified by:

isUserSearchScopeAllDepths in interface LdapSearchProperties

See Also:

SearchControls.SUBTREE_SCOPE, SearchControls.ONELEVEL_SCOPE

isGroupSearchScopeAllDepths

public boolean isGroupSearchScopeAllDepths()

Description copied from interface: LdapSearchProperties

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

Specified by:

isGroupSearchScopeAllDepths in interface LdapSearchProperties

See Also:

SearchControls.SUBTREE_SCOPE, SearchControls.ONELEVEL_SCOPE

getTimeLimitMillis

public int getTimeLimitMillis()

Specified by:

getTimeLimitMillis in interface LdapSearchProperties

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()

setBaseUserNamespace

public void setBaseUserNamespace(java.lang.String baseUserNamespace)

setBaseGroupNamespace

public void setBaseGroupNamespace(java.lang.String baseGroupNamespace)

setUsernameAttribute

public void setUsernameAttribute(java.lang.String usernameAttribute)

setGroupnameAttribute

public void setGroupnameAttribute(java.lang.String groupnameAttribute)

setFirstnameAttribute

public void setFirstnameAttribute(java.lang.String firstnameAttribute)

setSurnameAttribute

public void setSurnameAttribute(java.lang.String surnameAttribute)

setEmailAttribute

public void setEmailAttribute(java.lang.String emailAttribute)

setUserSearchScopeAllDepths

public void setUserSearchScopeAllDepths(boolean userSearchScopeAllDepths)

setGroupSearchScopeAllDepths

public void setGroupSearchScopeAllDepths(boolean groupSearchScopeAllDepths)

setTimeLimitMillis

public void setTimeLimitMillis(int timeLimitMillis)

setUserFilter

public void setUserFilter(java.lang.String userFilter)

setGroupFilter

public void setGroupFilter(java.lang.String groupFilter)