WARNING: This class and its methods are all deprecated; please use <class>SYS.LDAP</class> class instead. More...

Inheritance diagram for Session:

[legend]

Collaboration diagram for Session:

[legend]

Public Member Functions
_.Library.Status	AddNewEntry (_.Library.String DN, _.Net.LDAP.Client.PropList attribs)
	WARNING: This class and its methods are all deprecated; please use <class>SYS.LDAP</class> class instead. More...

_.Library.Boolean	CompareEntryValue (_.Library.String DN, _.Library.String Attrib, _.Library.RawString Value, _.Library.Boolean Binary)
	Comapre an entry attribute value. More...

_.Library.Status	Connect (_.Library.String Server, _.Library.Integer port, _.Library.String UserName, _.Library.String Password, _.Library.Boolean UseSSL)
	Establish connection to a LDAP server. More...

_.Library.Status	DeleteEntry (_.Library.String DN)
	Delete an entry.

_.Net.LDAP.Client.EditEntry	EditEntry (_.Library.String DN)
	Edit/Modify current entry attributes. More...

_.Net.LDAP.Client.PropList	GetPropList ()
	Return a new prop list object. More...

_.Net.LDAP.Client.PropList	GetStringList ()
	Return a new StringList list object. More...

_.Net.LDAP.Client.ValueList	GetValueList (_.Library.Boolean binary)
	Return a new value list object. More...

_.Library.Status	RenameEntry (_.Library.String DN, _.Library.String NewRDN, _.Library.String NewParent, _.Library.Boolean DelOldRDN)
	Rename an entry. More...

_.Library.Status	SASLConnect (_.Library.String Server, _.Library.Integer port, _.Library.String DistinguishedName, _.Library.String AuthMechanism, _.Library.String Credentials, _.Library.String ServerData)
	Authenticates client to an LDAP server using a SASL. More...

_.Net.LDAP.Client.Entries	Search (_.Library.String base, _.Net.LDAP.Client.Search.Scope scope, _.Library.String filter, _.Net.LDAP.Client.StringList attrs, _.Library.Integer timeout)
	Search LDAP DB. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	MaxItems
	Size limit. More...

	Referrals
	If set indicates that LDAP should chase. More...

	SearchAttrsOnly
	Search attributes only (Return no value) More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

WARNING: This class and its methods are all deprecated; please use <class>SYS.LDAP</class> class instead.

Member Function Documentation

◆ AddNewEntry()

_.Library.Status AddNewEntry	(	_.Library.String	DN,
		_.Net.LDAP.Client.PropList	attribs
	)

WARNING: This class and its methods are all deprecated; please use <class>SYS.LDAP</class> class instead.

Create a new entry

◆ CompareEntryValue()

_.Library.Boolean CompareEntryValue	(	_.Library.String	DN,
		_.Library.String	Attrib,
		_.Library.RawString	Value,
		_.Library.Boolean	Binary
	)

Comapre an entry attribute value.

DN Distinguished Name of the entry.

Attrib Attribute to compare its value.

Value The value to compare with.

Binary True if the value is binary.

◆ Connect()

_.Library.Status Connect	(	_.Library.String	Server,
		_.Library.Integer	port,
		_.Library.String	UserName,
		_.Library.String	Password,
		_.Library.Boolean	UseSSL
	)

Establish connection to a LDAP server.

You have to connect first before invoking other methods.

◆ EditEntry()

_.Net.LDAP.Client.EditEntry EditEntry ( _.Library.String DN )

Edit/Modify current entry attributes.

Returns EditEntry object, use the returned object to modify the attributes

◆ GetPropList()

_.Net.LDAP.Client.PropList GetPropList ( )

Return a new prop list object.

Used to maintain attribute and value pairs.See Net.LDAP.Client.PropList object.

◆ GetStringList()

_.Net.LDAP.Client.PropList GetStringList ( )

Return a new StringList list object.

Used to maintain a list of strings i.e. list of attributes.

◆ GetValueList()

_.Net.LDAP.Client.ValueList GetValueList ( _.Library.Boolean binary )

Return a new value list object.

Value list is used to associate multiple values with an attribute. See Net.LDAP.Client.ValueList Object.

◆ RenameEntry()

_.Library.Status RenameEntry	(	_.Library.String	DN,
		_.Library.String	NewRDN,
		_.Library.String	NewParent,
		_.Library.Boolean	DelOldRDN
	)

Rename an entry.

DN Distinguished Name of the entry

NewRDN New Relative Distinguished Name to assign to the entry

NewParent DN of the new parent to move the entry under. Pass "" if you do not want to move the entry to a different location.

DelOldRDN If 0, the old RDN is retained as an attribute in the modified entry

◆ SASLConnect()

_.Library.Status SASLConnect	(	_.Library.String	Server,
		_.Library.Integer	port,
		_.Library.String	DistinguishedName,
		_.Library.String	AuthMechanism,
		_.Library.String	Credentials,
		_.Library.String	ServerData
	)

Authenticates client to an LDAP server using a SASL.

(Simple Authentication and Security Layer) mechanism. (see RFC2222).

Note: The LDAP server must support that SASL mechanism for authentication.

You have to connect first before invoking any methods.

If the server sends a challenge to your client, check the ServerData argument for the server's challenge. Call the SASLConnect() method again to send a response to that challenge.

Example:

set comp=SASLConnect("localhost",0,"uid=u123,ou=people,o=isctest.com","abcMechanism","secret",srvData)

write:(comp=$$$OK) "Server credential is : ",srvData,!

◆ Search()

_.Net.LDAP.Client.Entries Search	(	_.Library.String	base,
		_.Net.LDAP.Client.Search.Scope	scope,
		_.Library.String	filter,
		_.Net.LDAP.Client.StringList	attrs,
		_.Library.Integer	timeout
	)

Search LDAP DB.

base: search base

scope: 0==search base, 1==search one level, 2==search subtree

filter: the search criteria (see RFC2254).

attrs: list of attributes to return per found entry.

If search fails the returned value is $$$ISERR

Member Data Documentation

◆ MaxItems

MaxItems

Size limit.

◆ Referrals

Referrals

If set indicates that LDAP should chase.

referrals/references returned in a search

◆ SearchAttrsOnly

SearchAttrsOnly

Search attributes only (Return no value)

Public Member Functions

Public Attributes

Additional Inherited Members