Package org.springframework.ldap.core

Class LdapEntryIdentification

java.lang.Object

org.springframework.ldap.core.LdapEntryIdentification

public class LdapEntryIdentification
extends Object

Wrapper class to handle the full identification of an LDAP entry. An LDAP entry is identified by its Distinguished Name, in Spring LDAP represented by the DistinguishedName class. A Distinguished Name can be absolute - i.e. complete including the very root (base) of the LDAP tree - or relative - i.e relative to the base LDAP path of the current LDAP connection (specified as base to the ContextSource).

The different representations are needed on different occasions, e.g. the relative DN is typically what is needed to perform lookups and searches in the LDAP tree, whereas the absolute DN is needed when authenticating and when an LDAP entry is referred to in e.g. a group. This wrapper class contains both of these representations.

Constructor Summary

Constructors

Constructor	Description
LdapEntryIdentification(LdapName absoluteDn, LdapName relativeDn)	Construct an LdapEntryIdentification instance.
LdapEntryIdentification(DistinguishedName absoluteDn, DistinguishedName relativeDn)	Deprecated. DistinguishedName and associated classes and methods are deprecated as of 2.0.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
DistinguishedName	getAbsoluteDn()	Deprecated. DistinguishedName and associated classes and methods are deprecated as of 2.0.
LdapName	getAbsoluteName()	Get the DN of the identified entry relative to the base LDAP path, e.g.
DistinguishedName	getRelativeDn()	Deprecated. DistinguishedName and associated classes and methods are deprecated as of 2.0.
LdapName	getRelativeName()	Get the absolute DN of the identified entry, e.g.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

LdapEntryIdentification

@Deprecated
public LdapEntryIdentification(DistinguishedName absoluteDn,
 DistinguishedName relativeDn)

Deprecated.

DistinguishedName and associated classes and methods are deprecated as of 2.0. use LdapEntryIdentification(javax.naming.ldap.LdapName, javax.naming.ldap.LdapName) instead.

Construct an LdapEntryIdentification instance.

Parameters:

absoluteDn - the absolute DN of the identified entry, e.g. as returned by Context.getNameInNamespace().

relativeDn - the DN of the identified entry relative to the base LDAP path, e.g. as returned by LdapDataEntry.getDn().

LdapEntryIdentification

public LdapEntryIdentification(LdapName absoluteDn,
 LdapName relativeDn)

Construct an LdapEntryIdentification instance.

Parameters:

absoluteDn - the absolute DN of the identified entry, e.g. as returned by Context.getNameInNamespace().

relativeDn - the DN of the identified entry relative to the base LDAP path, e.g. as returned by LdapDataEntry.getDn().

Since:

2.0

Method Details

getAbsoluteName

public LdapName getAbsoluteName()

Get the DN of the identified entry relative to the base LDAP path, e.g. as returned by LdapDataEntry.getDn().

Returns:

the relative DN.

Since:

2.0

getRelativeName

public LdapName getRelativeName()

Get the absolute DN of the identified entry, e.g. as returned by Context.getNameInNamespace().

Returns:

the absolute DN.

Since:

2.0

getRelativeDn

@Deprecated
public DistinguishedName getRelativeDn()

Deprecated.

DistinguishedName and associated classes and methods are deprecated as of 2.0. use getRelativeName() instead.

Get the DN of the identified entry relative to the base LDAP path, e.g. as returned by LdapDataEntry.getDn().

Returns:

the relative DN.

getAbsoluteDn

@Deprecated
public DistinguishedName getAbsoluteDn()

Deprecated.

DistinguishedName and associated classes and methods are deprecated as of 2.0. use getAbsoluteName() instead.

Get the absolute DN of the identified entry, e.g. as returned by Context.getNameInNamespace().

Returns:

the absolute DN.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object