C# Class Novell.Directory.Ldap.LdapEntry

Represents a single entry in a directory, consisting of a distinguished name (DN) and zero or more attributes. An instance of LdapEntry is created in order to add an entry to a directory, and instances of LdapEntry are returned on a search by enumerating an LdapSearchResults.

Inheritance: System.IComparable

Show file Open project: EventStore/csharp-ldap Class Usage Examples

Protected Properties

Property	Type	Description
attrs	LdapAttributeSet
dn	System.String

Private Properties

Property	Type	Description

Public Methods

Method	Description
CompareTo ( System entry ) : int	Compares this object with the specified object for order. Ordering is determined by comparing normalized DN values (see {@link LdapEntry#getDN() } and {@link LdapDN#normalize(java.lang.String)}) using the compareTo method of the String class.
LdapEntry ( ) : System	Constructs an empty entry.
LdapEntry ( System dn ) : System	Constructs a new entry with the specified distinguished name and with an empty attribute set.
LdapEntry ( System dn, LdapAttributeSet attrs ) : System	Constructs a new entry with the specified distinguished name and set of attributes.
ToString ( ) : System.String	Returns a string representation of this LdapEntry
getAttribute ( System attrName ) : LdapAttribute	Returns the attributes matching the specified attrName.
getAttributeSet ( ) : LdapAttributeSet	Returns the attribute set of the entry. All base and subtype variants of all attributes are returned. The LdapAttributeSet returned may be empty if there are no attributes in the entry.
getAttributeSet ( System subtype ) : LdapAttributeSet	Returns an attribute set from the entry, consisting of only those attributes matching the specified subtypes. The getAttributeSet method can be used to extract only a particular language variant subtype of each attribute, if it exists. The "subtype" may be, for example, "lang-ja", "binary", or "lang-ja;phonetic". If more than one subtype is specified, separated with a semicolon, only those attributes with all of the named subtypes will be returned. The LdapAttributeSet returned may be empty if there are no matching attributes in the entry.

Method Details

CompareTo() public method

Compares this object with the specified object for order. Ordering is determined by comparing normalized DN values (see {@link LdapEntry#getDN() } and {@link LdapDN#normalize(java.lang.String)}) using the compareTo method of the String class.

public CompareTo ( System entry ) : int
entry	System	Entry to compare to /// ///
return	int

LdapEntry() public method

Constructs an empty entry.

public LdapEntry ( ) : System
return	System

LdapEntry() public method

Constructs a new entry with the specified distinguished name and with an empty attribute set.

public LdapEntry ( System dn ) : System
dn	System	The distinguished name of the entry. The /// value is not validated. An invalid distinguished /// name will cause operations using this entry to fail. /// ///
return	System

LdapEntry() public method

Constructs a new entry with the specified distinguished name and set of attributes.

public LdapEntry ( System dn, LdapAttributeSet attrs ) : System
dn	System	The distinguished name of the new entry. The /// value is not validated. An invalid distinguished /// name will cause operations using this entry to fail. /// ///
attrs	LdapAttributeSet	The initial set of attributes assigned to the /// entry. ///
return	System

ToString() public method

Returns a string representation of this LdapEntry

public ToString ( ) : System.String
return	System.String

getAttribute() public method

Returns the attributes matching the specified attrName.

public getAttribute ( System attrName ) : LdapAttribute
attrName	System	The name of the attribute or attributes to return. /// ///
return	LdapAttribute

getAttributeSet() public method

Returns the attribute set of the entry. All base and subtype variants of all attributes are returned. The LdapAttributeSet returned may be empty if there are no attributes in the entry.

public getAttributeSet ( ) : LdapAttributeSet
return	LdapAttributeSet

getAttributeSet() public method

Returns an attribute set from the entry, consisting of only those attributes matching the specified subtypes. The getAttributeSet method can be used to extract only a particular language variant subtype of each attribute, if it exists. The "subtype" may be, for example, "lang-ja", "binary", or "lang-ja;phonetic". If more than one subtype is specified, separated with a semicolon, only those attributes with all of the named subtypes will be returned. The LdapAttributeSet returned may be empty if there are no matching attributes in the entry.

public getAttributeSet ( System subtype ) : LdapAttributeSet
subtype	System	One or more subtype specification(s), separated /// with semicolons. The "lang-ja" and /// "lang-en;phonetic" are valid subtype /// specifications. /// ///
return	LdapAttributeSet

Property Details

attrs protected property

protected LdapAttributeSet,Novell.Directory.Ldap attrs
return	LdapAttributeSet

dn protected property

protected String,System dn
return	System.String