ldapsdk
0.0.1
|
This class is used to analyze and store LDAP-Urls as returned by a LDAP-Server as Referrals and Search References. More...
#include <LDAPUrl.h>
Public Member Functions | |
LDAPUrl (const std::string &url="") | |
Create a new object from a string that contains a LDAP-Url. More... | |
~LDAPUrl () | |
Destructor. More... | |
int | getPort () const |
void | setPort (int port) |
Set the port value of the URL. More... | |
int | getScope () const |
void | setScope (const std::string &scope) |
Set the Scope part of the URL. More... | |
const std::string & | getURLString () const |
void | setURLString (const std::string &url) |
Set the URL member attribute. More... | |
const std::string & | getHost () const |
void | setHost (const std::string &host) |
Set the Host part of the URL. More... | |
const std::string & | getScheme () const |
void | setScheme (const std::string &scheme) |
Set the Protocol Scheme of the URL. More... | |
const std::string & | getDN () const |
void | setDN (const std::string &dn) |
Set the DN part of the URL. More... | |
const std::string & | getFilter () const |
void | setFilter (const std::string &filter) |
Set the Filter part of the URL. More... | |
const StringList & | getAttrs () const |
void | setAttrs (const StringList &attrs) |
Set the Attributes part of the URL. More... | |
void | setExtensions (const StringList &ext) |
const StringList & | getExtensions () const |
void | percentDecode (const std::string &src, std::string &dest) |
Percent-decode a string. More... | |
std::string & | percentEncode (const std::string &src, std::string &dest, int flags=0) const |
Percent-encoded a string. More... | |
Protected Types | |
enum | mode { base, attrs, scope, filter, extensions } |
Protected Member Functions | |
void | parseUrl () |
Split the url string that is associated with this Object into it components. More... | |
void | components2Url () const |
Generate an URL string from the components that were set with the various set...() methods (this function is mostly for internal use and gets called automatically whenever necessary) More... | |
void | string2list (const std::string &src, StringList &sl, bool percentDecode=false) |
Protected Attributes | |
bool | regenerate |
int | m_Port |
int | m_Scope |
std::string | m_Host |
std::string | m_DN |
std::string | m_Filter |
StringList | m_Attrs |
StringList | m_Extensions |
std::string | m_urlString |
std::string | m_Scheme |
This class is used to analyze and store LDAP-Urls as returned by a LDAP-Server as Referrals and Search References.
LDAP-URLs are defined in RFC1959 and have the following format:
ldap://host:port/baseDN[?attr[?scope[?filter]]]
|
protected |
LDAPUrl::LDAPUrl | ( | const std::string & | url = "" | ) |
Create a new object from a string that contains a LDAP-Url.
url | The URL String |
References DEBUG, LDAP_DEBUG_CONSTRUCT, and LDAP_DEBUG_PARAMETER.
LDAPUrl::~LDAPUrl | ( | ) |
Destructor.
References DEBUG, and LDAP_DEBUG_DESTROY.
|
protected |
Generate an URL string from the components that were set with the various set...() methods (this function is mostly for internal use and gets called automatically whenever necessary)
References PCT_ENCFLAG_SLASH.
const StringList & LDAPUrl::getAttrs | ( | ) | const |
const string & LDAPUrl::getDN | ( | ) | const |
const StringList & LDAPUrl::getExtensions | ( | ) | const |
const string & LDAPUrl::getFilter | ( | ) | const |
const string & LDAPUrl::getHost | ( | ) | const |
int LDAPUrl::getPort | ( | ) | const |
const std::string & LDAPUrl::getScheme | ( | ) | const |
int LDAPUrl::getScope | ( | ) | const |
const string & LDAPUrl::getURLString | ( | ) | const |
|
protected |
Split the url string that is associated with this Object into it components.
The compontens of the URL can be access via the get...() methods. (this function is mostly for internal use and gets called automatically whenever necessary)
References DEBUG, LDAPUrlException::INVALID_PORT, LDAPUrlException::INVALID_SCHEME, LDAPUrlException::INVALID_SCOPE, LDAPUrlException::INVALID_URL, LDAP_DEBUG_TRACE, LDAP_DEFAULT_PORT, and LDAPS_DEFAULT_PORT.
void LDAPUrl::percentDecode | ( | const std::string & | src, |
std::string & | dest | ||
) |
Percent-decode a string.
src | The string that is to be decoded |
dest | The decoded result string |
References DEBUG, LDAP_DEBUG_TRACE, and LDAPUrlException::URL_DECODING_ERROR.
std::string & LDAPUrl::percentEncode | ( | const std::string & | src, |
std::string & | dest, | ||
int | flags = 0 |
||
) | const |
Percent-encoded a string.
src | The string that is to be encoded |
dest | The encoded result string |
flags |
References PCT_ENCFLAG_COMMA, and PCT_ENCFLAG_SLASH.
void LDAPUrl::setAttrs | ( | const StringList & | attrs | ) |
Set the Attributes part of the URL.
attrs | StringList constaining the List of Attributes |
void LDAPUrl::setDN | ( | const std::string & | dn | ) |
Set the DN part of the URL.
dn | The new DN part |
void LDAPUrl::setExtensions | ( | const StringList & | ext | ) |
void LDAPUrl::setFilter | ( | const std::string & | filter | ) |
Set the Filter part of the URL.
filter | The new Filter |
void LDAPUrl::setHost | ( | const std::string & | host | ) |
Set the Host part of the URL.
host | The new host part |
void LDAPUrl::setPort | ( | int | port | ) |
Set the port value of the URL.
dn | The port value |
void LDAPUrl::setScheme | ( | const std::string & | scheme | ) |
Set the Protocol Scheme of the URL.
host | The Protcol scheme. Allowed values are ldap,ldapi,ldaps and cldap |
References LDAPUrlException::INVALID_SCHEME.
void LDAPUrl::setScope | ( | const std::string & | scope | ) |
Set the Scope part of the URL.
scope | The new scope |
References LDAPUrlException::INVALID_SCOPE.
void LDAPUrl::setURLString | ( | const std::string & | url | ) |
Set the URL member attribute.
url | The URL String |
|
protected |
References StringList::add().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
mutableprotected |
|
mutableprotected |