LdapClient

Overview

Location

 

constructor

 

constructor

 

LdapClient()

 

Sub New()

AllAttributes

 

const AllAttributes: String = "*";

 

const String AllAttributes = "*"

 

Dim AllAttributes As String = "*"

Bind

 

method Bind

 

void Bind()

 

Sub Bind()

Bind (String, String, DigestType)

 

method Bind(dn: String; password: String; digestType: DigestType)

 

void Bind(String dn, String password, DigestType digestType)

 

Sub Bind(dn As String, password As String, digestType As DigestType)

Parameters:

  • dn:
  • password:
  • digestType:

BindDigest

 

property BindDigest: DigestType read write;

 

DigestType BindDigest { get; set; }

 

Property BindDigest() As DigestType

BindDN

 

property BindDN: String read write;

 

String BindDN { get; set; }

 

Property BindDN() As String

BindingV4    (declared in Client)

 

property BindingV4: Binding read;

 

Binding BindingV4 { get; }

 

ReadOnly Property BindingV4() As Binding

BindingV6    (declared in Client)

 

property BindingV6: Binding read;

 

Binding BindingV6 { get; }

 

ReadOnly Property BindingV6() As Binding

BindPassword

 

property BindPassword: String read write;

 

String BindPassword { get; set; }

 

Property BindPassword() As String

Close

 

method Close

 

void Close()

 

Sub Close()

Connect    (declared in Client)

 

method Connect: Connection

 

Connection Connect()

 

Function Connect() As Connection

Connect (IPAddress, Int32): Connection    (declared in Client)

 

method Connect(host: IPAddress; port: Int32): Connection

 

Connection Connect(IPAddress host, Int32 port)

 

Function Connect(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

Connect (String, Int32): Connection    (declared in Client)

 

method Connect(hostname: String; port: Int32): Connection

 

Connection Connect(String hostname, Int32 port)

 

Function Connect(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

Connect (IPAddress, Int32, Binding): Connection    (declared in Client)

 

class method Connect(host: IPAddress; port: Int32; binding: Binding): Connection

 

static Connection Connect(IPAddress host, Int32 port, Binding binding)

 

Shared Function Connect(host As IPAddress, port As Int32, binding As Binding) As Connection

Parameters:

  • host:
  • port:
  • binding:

Connect (String, Int32, Binding): Connection    (declared in Client)

 

class method Connect(hostname: String; port: Int32; binding: Binding): Connection

 

static Connection Connect(String hostname, Int32 port, Binding binding)

 

Shared Function Connect(hostname As String, port As Int32, binding As Binding) As Connection

Parameters:

  • hostname:
  • port:
  • binding:

Connected

 

property Connected: Boolean read;

 

Boolean Connected { get; }

 

ReadOnly Property Connected() As Boolean

ConnectionClass    (declared in Client)

 

property ConnectionClass: Type read write;

 

Type ConnectionClass { get; set; }

 

Property ConnectionClass() As Type

ConnectionFactory    (declared in Client)

 

property ConnectionFactory: IConnectionFactory read write;

 

IConnectionFactory ConnectionFactory { get; set; }

 

Property ConnectionFactory() As IConnectionFactory

ConnectionPool  protected    (declared in Client)

 

property ConnectionPool: ConnectionPool read write;

 

ConnectionPool ConnectionPool { get; set; }

 

Property ConnectionPool() As ConnectionPool

ConnectNew (IPAddress, Int32): Connection    (declared in Client)

 

method ConnectNew(host: IPAddress; port: Int32): Connection

 

Connection ConnectNew(IPAddress host, Int32 port)

 

Function ConnectNew(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

ConnectNew (String, Int32): Connection    (declared in Client)

 

method ConnectNew(hostname: String; port: Int32): Connection

 

Connection ConnectNew(String hostname, Int32 port)

 

Function ConnectNew(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

CurrentConnection

 

property CurrentConnection: Connection read;

 

Connection CurrentConnection { get; }

 

ReadOnly Property CurrentConnection() As Connection

DnsResolveType    (declared in Client)

 

property DnsResolveType: DnsResolveType read write;

 

DnsResolveType DnsResolveType { get; set; }

 

Property DnsResolveType() As DnsResolveType

EnableNagle    (declared in Client)

 

property EnableNagle: Boolean read write;

 

Boolean EnableNagle { get; set; }

 

Property EnableNagle() As Boolean

Escape

 

class method Escape(s: String): String

 

static String Escape(String s)

 

Shared Function Escape(s As String) As String

Parameters:

  • s:

GetConnection  protected    (declared in Client)

 

method GetConnection(host: IPAddress; port: Int32): Connection

 

Connection GetConnection(IPAddress host, Int32 port)

 

Function GetConnection(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

GetDefaultConnectionPool  protected    (declared in Client)

 

method GetDefaultConnectionPool: ConnectionPool

 

ConnectionPool GetDefaultConnectionPool()

 

Function GetDefaultConnectionPool() As ConnectionPool

HostAddress    (declared in Client)

 

property HostAddress: IPAddress read write;

 

IPAddress HostAddress { get; set; }

 

Property HostAddress() As IPAddress

HostName    (declared in Client)

 

property HostName: String read write;

 

String HostName { get; set; }

 

Property HostName() As String

LdapPort

 

const LdapPort: Int32 = 389;

 

const Int32 LdapPort = 389

 

Dim LdapPort As Int32 = 389

LdapSPort

 

const LdapSPort: Int32 = 636;

 

const Int32 LdapSPort = 636

 

Dim LdapSPort As Int32 = 636

LdapVersion

 

property LdapVersion: Int32 read write;

 

Int32 LdapVersion { get; set; }

 

Property LdapVersion() As Int32

LoggedIn

 

property LoggedIn: Boolean read;

 

Boolean LoggedIn { get; }

 

ReadOnly Property LoggedIn() As Boolean

NewConnection  protected    (declared in Client)

 

method NewConnection(binding: Binding): Connection

 

Connection NewConnection(Binding binding)

 

Function NewConnection(binding As Binding) As Connection

Parameters:

  • binding:

NoAttributes

 

const NoAttributes: String = "1.1";

 

const String NoAttributes = "1.1"

 

Dim NoAttributes As String = "1.1"

OnResolvedHostName    (declared in Client)

 

event OnResolvedHostName: EventHandler<ResolvedHostNameEventArgs>;

 

delegate EventHandler<ResolvedHostNameEventArgs> OnResolvedHostName()

 

Event OnResolvedHostName As EventHandler<ResolvedHostNameEventArgs>

OnResolveHostName    (declared in Client)

 

event OnResolveHostName: EventHandler<ResolveHostNameEventArgs>;

 

delegate EventHandler<ResolveHostNameEventArgs> OnResolveHostName()

 

Event OnResolveHostName As EventHandler<ResolveHostNameEventArgs>

Open

 

method Open

 

void Open()

 

Sub Open()

Port    (declared in Client)

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

Property Port() As Int32

ReleaseConnection  protected    (declared in Client)

 

method ReleaseConnection(connection: Connection)

 

void ReleaseConnection(Connection connection)

 

Sub ReleaseConnection(connection As Connection)

Parameters:

  • connection:

ResolveHostName  protected    (declared in Client)

 

method ResolveHostName

 

void ResolveHostName()

 

Sub ResolveHostName()

ResolveHostNameIfNeeded  protected    (declared in Client)

 

method ResolveHostNameIfNeeded

 

void ResolveHostNameIfNeeded()

 

Sub ResolveHostNameIfNeeded()

 

method Search(baseObject: String; scope: SearchScope; aliases: AliasDereferencing; size: Int32; time: Int32; typesOnly: Boolean; filter: String; attributes: array of String): LdapSearchResults

 

LdapSearchResults Search(String baseObject, SearchScope scope, AliasDereferencing aliases, Int32 size, Int32 time, Boolean typesOnly, String filter, String[] attributes)

 

Function Search(baseObject As String, scope As SearchScope, aliases As AliasDereferencing, size As Int32, time As Int32, typesOnly As Boolean, filter As String, attributes As String()) As LdapSearchResults

Parameters:

  • baseObject:
  • scope:
  • aliases:
  • size:
  • time:
  • typesOnly:
  • filter:
  • attributes:

SslOptions    (declared in Client)

 

property SslOptions: SslConnectionFactory read write;

 

SslConnectionFactory SslOptions { get; set; }

 

Property SslOptions() As SslConnectionFactory

TriggerOnResolvedHostName  protected    (declared in Client)

 

method TriggerOnResolvedHostName(e: ResolvedHostNameEventArgs)

 

void TriggerOnResolvedHostName(ResolvedHostNameEventArgs e)

 

Sub TriggerOnResolvedHostName(e As ResolvedHostNameEventArgs)

Parameters:

  • e:

TriggerOnResolveHostName  protected    (declared in Client)

 

method TriggerOnResolveHostName(e: ResolveHostNameEventArgs)

 

void TriggerOnResolveHostName(ResolveHostNameEventArgs e)

 

Sub TriggerOnResolveHostName(e As ResolveHostNameEventArgs)

Parameters:

  • e:

Unbind

 

method Unbind

 

void Unbind()

 

Sub Unbind()

UseStartTLS

 

property UseStartTLS: Boolean read write;

 

Boolean UseStartTLS { get; set; }

 

Property UseStartTLS() As Boolean

 

AllAttributes

 

const AllAttributes: String = "*";

 

const String AllAttributes = "*"

 

Dim AllAttributes As String = "*"

LdapPort

 

const LdapPort: Int32 = 389;

 

const Int32 LdapPort = 389

 

Dim LdapPort As Int32 = 389

LdapSPort

 

const LdapSPort: Int32 = 636;

 

const Int32 LdapSPort = 636

 

Dim LdapSPort As Int32 = 636

NoAttributes

 

const NoAttributes: String = "1.1";

 

const String NoAttributes = "1.1"

 

Dim NoAttributes As String = "1.1"

 

BindDigest

 

property BindDigest: DigestType read write;

 

DigestType BindDigest { get; set; }

 

Property BindDigest() As DigestType

BindDN

 

property BindDN: String read write;

 

String BindDN { get; set; }

 

Property BindDN() As String

BindingV4    (declared in Client)

 

property BindingV4: Binding read;

 

Binding BindingV4 { get; }

 

ReadOnly Property BindingV4() As Binding

BindingV6    (declared in Client)

 

property BindingV6: Binding read;

 

Binding BindingV6 { get; }

 

ReadOnly Property BindingV6() As Binding

BindPassword

 

property BindPassword: String read write;

 

String BindPassword { get; set; }

 

Property BindPassword() As String

Connected

 

property Connected: Boolean read;

 

Boolean Connected { get; }

 

ReadOnly Property Connected() As Boolean

ConnectionClass    (declared in Client)

 

property ConnectionClass: Type read write;

 

Type ConnectionClass { get; set; }

 

Property ConnectionClass() As Type

ConnectionFactory    (declared in Client)

 

property ConnectionFactory: IConnectionFactory read write;

 

IConnectionFactory ConnectionFactory { get; set; }

 

Property ConnectionFactory() As IConnectionFactory

ConnectionPool  protected    (declared in Client)

 

property ConnectionPool: ConnectionPool read write;

 

ConnectionPool ConnectionPool { get; set; }

 

Property ConnectionPool() As ConnectionPool

CurrentConnection

 

property CurrentConnection: Connection read;

 

Connection CurrentConnection { get; }

 

ReadOnly Property CurrentConnection() As Connection

DnsResolveType    (declared in Client)

 

property DnsResolveType: DnsResolveType read write;

 

DnsResolveType DnsResolveType { get; set; }

 

Property DnsResolveType() As DnsResolveType

EnableNagle    (declared in Client)

 

property EnableNagle: Boolean read write;

 

Boolean EnableNagle { get; set; }

 

Property EnableNagle() As Boolean

HostAddress    (declared in Client)

 

property HostAddress: IPAddress read write;

 

IPAddress HostAddress { get; set; }

 

Property HostAddress() As IPAddress

HostName    (declared in Client)

 

property HostName: String read write;

 

String HostName { get; set; }

 

Property HostName() As String

LdapVersion

 

property LdapVersion: Int32 read write;

 

Int32 LdapVersion { get; set; }

 

Property LdapVersion() As Int32

LoggedIn

 

property LoggedIn: Boolean read;

 

Boolean LoggedIn { get; }

 

ReadOnly Property LoggedIn() As Boolean

Port    (declared in Client)

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

Property Port() As Int32

SslOptions    (declared in Client)

 

property SslOptions: SslConnectionFactory read write;

 

SslConnectionFactory SslOptions { get; set; }

 

Property SslOptions() As SslConnectionFactory

UseStartTLS

 

property UseStartTLS: Boolean read write;

 

Boolean UseStartTLS { get; set; }

 

Property UseStartTLS() As Boolean

 

Connect (IPAddress, Int32, Binding): Connection    (declared in Client)

 

class method Connect(host: IPAddress; port: Int32; binding: Binding): Connection

 

static Connection Connect(IPAddress host, Int32 port, Binding binding)

 

Shared Function Connect(host As IPAddress, port As Int32, binding As Binding) As Connection

Parameters:

  • host:
  • port:
  • binding:

Connect (String, Int32, Binding): Connection    (declared in Client)

 

class method Connect(hostname: String; port: Int32; binding: Binding): Connection

 

static Connection Connect(String hostname, Int32 port, Binding binding)

 

Shared Function Connect(hostname As String, port As Int32, binding As Binding) As Connection

Parameters:

  • hostname:
  • port:
  • binding:

Escape

 

class method Escape(s: String): String

 

static String Escape(String s)

 

Shared Function Escape(s As String) As String

Parameters:

  • s:

 

constructor

 

constructor

 

LdapClient()

 

Sub New()

Bind

 

method Bind

 

void Bind()

 

Sub Bind()

Bind (String, String, DigestType)

 

method Bind(dn: String; password: String; digestType: DigestType)

 

void Bind(String dn, String password, DigestType digestType)

 

Sub Bind(dn As String, password As String, digestType As DigestType)

Parameters:

  • dn:
  • password:
  • digestType:

Close

 

method Close

 

void Close()

 

Sub Close()

Connect    (declared in Client)

 

method Connect: Connection

 

Connection Connect()

 

Function Connect() As Connection

Connect (IPAddress, Int32): Connection    (declared in Client)

 

method Connect(host: IPAddress; port: Int32): Connection

 

Connection Connect(IPAddress host, Int32 port)

 

Function Connect(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

Connect (String, Int32): Connection    (declared in Client)

 

method Connect(hostname: String; port: Int32): Connection

 

Connection Connect(String hostname, Int32 port)

 

Function Connect(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

ConnectNew (IPAddress, Int32): Connection    (declared in Client)

 

method ConnectNew(host: IPAddress; port: Int32): Connection

 

Connection ConnectNew(IPAddress host, Int32 port)

 

Function ConnectNew(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

ConnectNew (String, Int32): Connection    (declared in Client)

 

method ConnectNew(hostname: String; port: Int32): Connection

 

Connection ConnectNew(String hostname, Int32 port)

 

Function ConnectNew(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

GetConnection  protected    (declared in Client)

 

method GetConnection(host: IPAddress; port: Int32): Connection

 

Connection GetConnection(IPAddress host, Int32 port)

 

Function GetConnection(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

GetDefaultConnectionPool  protected    (declared in Client)

 

method GetDefaultConnectionPool: ConnectionPool

 

ConnectionPool GetDefaultConnectionPool()

 

Function GetDefaultConnectionPool() As ConnectionPool

NewConnection  protected    (declared in Client)

 

method NewConnection(binding: Binding): Connection

 

Connection NewConnection(Binding binding)

 

Function NewConnection(binding As Binding) As Connection

Parameters:

  • binding:

Open

 

method Open

 

void Open()

 

Sub Open()

ReleaseConnection  protected    (declared in Client)

 

method ReleaseConnection(connection: Connection)

 

void ReleaseConnection(Connection connection)

 

Sub ReleaseConnection(connection As Connection)

Parameters:

  • connection:

ResolveHostName  protected    (declared in Client)

 

method ResolveHostName

 

void ResolveHostName()

 

Sub ResolveHostName()

ResolveHostNameIfNeeded  protected    (declared in Client)

 

method ResolveHostNameIfNeeded

 

void ResolveHostNameIfNeeded()

 

Sub ResolveHostNameIfNeeded()

 

method Search(baseObject: String; scope: SearchScope; aliases: AliasDereferencing; size: Int32; time: Int32; typesOnly: Boolean; filter: String; attributes: array of String): LdapSearchResults

 

LdapSearchResults Search(String baseObject, SearchScope scope, AliasDereferencing aliases, Int32 size, Int32 time, Boolean typesOnly, String filter, String[] attributes)

 

Function Search(baseObject As String, scope As SearchScope, aliases As AliasDereferencing, size As Int32, time As Int32, typesOnly As Boolean, filter As String, attributes As String()) As LdapSearchResults

Parameters:

  • baseObject:
  • scope:
  • aliases:
  • size:
  • time:
  • typesOnly:
  • filter:
  • attributes:

TriggerOnResolvedHostName  protected    (declared in Client)

 

method TriggerOnResolvedHostName(e: ResolvedHostNameEventArgs)

 

void TriggerOnResolvedHostName(ResolvedHostNameEventArgs e)

 

Sub TriggerOnResolvedHostName(e As ResolvedHostNameEventArgs)

Parameters:

  • e:

TriggerOnResolveHostName  protected    (declared in Client)

 

method TriggerOnResolveHostName(e: ResolveHostNameEventArgs)

 

void TriggerOnResolveHostName(ResolveHostNameEventArgs e)

 

Sub TriggerOnResolveHostName(e As ResolveHostNameEventArgs)

Parameters:

  • e:

Unbind

 

method Unbind

 

void Unbind()

 

Sub Unbind()

 

OnResolvedHostName    (declared in Client)

 

event OnResolvedHostName: EventHandler<ResolvedHostNameEventArgs>;

 

delegate EventHandler<ResolvedHostNameEventArgs> OnResolvedHostName()

 

Event OnResolvedHostName As EventHandler<ResolvedHostNameEventArgs>

OnResolveHostName    (declared in Client)

 

event OnResolveHostName: EventHandler<ResolveHostNameEventArgs>;

 

delegate EventHandler<ResolveHostNameEventArgs> OnResolveHostName()

 

Event OnResolveHostName As EventHandler<ResolveHostNameEventArgs>