Package org.springframework.ldap.core
Class LdapEntryIdentification
- java.lang.Object
-
- org.springframework.ldap.core.LdapEntryIdentification
-
public class LdapEntryIdentification extends java.lang.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 theDistinguishedName
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 asbase
to theContextSource
).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(javax.naming.ldap.LdapName absoluteDn, javax.naming.ldap.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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
DistinguishedName
getAbsoluteDn()
Deprecated.DistinguishedName
and associated classes and methods are deprecated as of 2.0.javax.naming.ldap.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.javax.naming.ldap.LdapName
getRelativeName()
Get the absolute DN of the identified entry, e.g.int
hashCode()
-
-
-
Constructor Detail
-
LdapEntryIdentification
public LdapEntryIdentification(DistinguishedName absoluteDn, DistinguishedName relativeDn)
Deprecated.DistinguishedName
and associated classes and methods are deprecated as of 2.0. useLdapEntryIdentification(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 byContext.getNameInNamespace()
.relativeDn
- the DN of the identified entry relative to the base LDAP path, e.g. as returned byLdapDataEntry.getDn()
.
-
LdapEntryIdentification
public LdapEntryIdentification(javax.naming.ldap.LdapName absoluteDn, javax.naming.ldap.LdapName relativeDn)
Construct an LdapEntryIdentification instance.- Parameters:
absoluteDn
- the absolute DN of the identified entry, e.g. as returned byContext.getNameInNamespace()
.relativeDn
- the DN of the identified entry relative to the base LDAP path, e.g. as returned byLdapDataEntry.getDn()
.- Since:
- 2.0
-
-
Method Detail
-
getAbsoluteName
public javax.naming.ldap.LdapName getAbsoluteName()
Get the DN of the identified entry relative to the base LDAP path, e.g. as returned byLdapDataEntry.getDn()
.- Returns:
- the relative DN.
- Since:
- 2.0
-
getRelativeName
public javax.naming.ldap.LdapName getRelativeName()
Get the absolute DN of the identified entry, e.g. as returned byContext.getNameInNamespace()
.- Returns:
- the absolute DN.
- Since:
- 2.0
-
getRelativeDn
public DistinguishedName getRelativeDn()
Deprecated.DistinguishedName
and associated classes and methods are deprecated as of 2.0. usegetRelativeName()
instead.Get the DN of the identified entry relative to the base LDAP path, e.g. as returned byLdapDataEntry.getDn()
.- Returns:
- the relative DN.
-
getAbsoluteDn
public DistinguishedName getAbsoluteDn()
Deprecated.DistinguishedName
and associated classes and methods are deprecated as of 2.0. usegetAbsoluteName()
instead.Get the absolute DN of the identified entry, e.g. as returned byContext.getNameInNamespace()
.- Returns:
- the absolute DN.
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-