Package com.atlassian.crowd.directory.ldap.name

Class SearchDN

java.lang.Object

com.atlassian.crowd.directory.ldap.name.SearchDN

public class SearchDN
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
SearchDN(LDAPPropertiesMapper propertiesMapper)

Method Summary

Modifier and Type	Method	Description
CrowdLdapName	getBase()	Returns a Name representing the DN beneath which all objects should reside.
CrowdLdapName	getGroup()	Returns a Name representing the DN to anchor the search for groups.
CrowdLdapName	getNamingContext()	Returns a Name representing the DN beneath which all objects should reside OR the blank root DSE if none is specified.
CrowdLdapName	getRole()	Deprecated.
protected CrowdLdapName	getSearchDN(String propertyName)	Given an additional DN (e.g.
CrowdLdapName	getUser()	Returns a Name representing the DN to search beneath for users.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

SearchDN

public SearchDN(LDAPPropertiesMapper propertiesMapper)

Method Details

getGroup

public CrowdLdapName getGroup()

Returns a Name representing the DN to anchor the search for groups. Reads directory configuration to build the dn.

getRole

@Deprecated
public CrowdLdapName getRole()

Deprecated.

Returns a Name representing the DN form which to search for roles. Reads directory configuration to build the dn.

getUser

public CrowdLdapName getUser()

Returns a Name representing the DN to search beneath for users. Reads directory configuration to build the dn.

getBase

public CrowdLdapName getBase()
                      throws LdapNameFormatException

Returns a Name representing the DN beneath which all objects should reside.

Throws:

LdapNameFormatException

getNamingContext

public CrowdLdapName getNamingContext()

Returns a Name representing the DN beneath which all objects should reside OR the blank root DSE if none is specified.

getSearchDN

protected CrowdLdapName getSearchDN(String propertyName)
                             throws LdapNameFormatException

Given an additional DN (e.g. "ou=Groups") and a base search DN (e.g. "dc=example, dc=org") builds a full search DN "ou=Groups, dc=example, dc=org". Handles if there's no additional DN specified.

Throws:

LdapNameFormatException