Simias::LdapProvider::LdapWebUtility Class Reference

LDAP Utility Object. More...

List of all members.

Public Member Functions
	LdapWebUtility (string url, string dn, string password)
	Constructor.
void	Connect ()
	Connect and/or Bind to the LDAP Server.
void	Disconnect ()
	Disconnect from the LDAP Server.
bool	CreateUser (string dn, string password)
	Create a New User in the LDAP Tree.
void	GrantReadRights (string userDN, string containerDN)
	Grant Read Rights to the LDAP User on the the LDAP Container.
LdapDirectoryType	QueryDirectoryType ()
	Queries to find the type of directory.
bool	ValidateSearchContext (string context)
	Validates a context.
Static Public Attributes
static readonly string	LDAP_SCHEME = "ldap"
	LDAP Scheme.
static readonly string	LDAP_SCHEME_SECURE = "ldaps"
	Secure LDAP Scheme.
Properties
string	DN [get]
	LDAP Bind User DN.
string	Host [get]
	LDAP Host.
LdapDirectoryType	DirectoryType [get]
	Gets the LDAP directory type.
string	Password [get]
	LDAP Bind User Password.
int	Port [get]
	LDAP Port.
bool	Secure [get]
	LDAP Secure Connection.

---

Detailed Description

LDAP Utility Object.

---

Constructor & Destructor Documentation

Simias::LdapProvider::LdapWebUtility::LdapWebUtility	(	string	url,
		string	dn,
		string	password
	)			[inline]

Constructor.

Parameters:

	url	LDAP URL
	dn	LDAP User DN
	password	LDAP User Password

---

Member Function Documentation

void Simias::LdapProvider::LdapWebUtility::Connect

(

)

[inline]

Connect and/or Bind to the LDAP Server.

void Simias::LdapProvider::LdapWebUtility::Disconnect

(

)

[inline]

Disconnect from the LDAP Server.

bool Simias::LdapProvider::LdapWebUtility::CreateUser	(	string	dn,
		string	password
	)			[inline]

Create a New User in the LDAP Tree.

Parameters:

	dn	The New User DN
	password	The New User Password

Returns:

true, if the user was created. false, if the user already exists.

void Simias::LdapProvider::LdapWebUtility::GrantReadRights	(	string	userDN,
		string	containerDN
	)			[inline]

Grant Read Rights to the LDAP User on the the LDAP Container.

Parameters:

	userDN	The LDAP User DN
	containerDN	The LDAP Container DN

LdapDirectoryType Simias::LdapProvider::LdapWebUtility::QueryDirectoryType

(

)

[inline]

Queries to find the type of directory.

Returns:

The LDAP directory type.

bool Simias::LdapProvider::LdapWebUtility::ValidateSearchContext

(

string

context

)

[inline]

Validates a context.

Parameters:

context

The context to validate.

Returns:

True if the context is valid; otherwise, False is returned.

---

Member Data Documentation

readonly string Simias::LdapProvider::LdapWebUtility::LDAP_SCHEME = "ldap" [static]

LDAP Scheme.

readonly string Simias::LdapProvider::LdapWebUtility::LDAP_SCHEME_SECURE = "ldaps" [static]

Secure LDAP Scheme.

---

Property Documentation

string Simias::LdapProvider::LdapWebUtility::DN [get]

LDAP Bind User DN.

string Simias::LdapProvider::LdapWebUtility::Host [get]

LDAP Host.

LdapDirectoryType Simias::LdapProvider::LdapWebUtility::DirectoryType [get]

Gets the LDAP directory type.

string Simias::LdapProvider::LdapWebUtility::Password [get]

LDAP Bind User Password.

int Simias::LdapProvider::LdapWebUtility::Port [get]

LDAP Port.

bool Simias::LdapProvider::LdapWebUtility::Secure [get]

LDAP Secure Connection.

---

The documentation for this class was generated from the following file:

• src/server/Simias.LdapProvider/LdapWebUtility.cs