1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/*
This file is part of libkldap.
Copyright (c) 2004-2006 Szombathelyi György <gyurco@freemail.hu>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KLDAP_LDAPURL_H
#define KLDAP_LDAPURL_H
#include <QtCore/QMap>
#include <QtCore/QStringList>
#include <kurl.h>
#include "ldapdn.h"
#include "kldap_export.h"
namespace KLDAP {
/**
* LdapUrl
* LdapUrl implements an RFC 2255 compliant LDAP Url parser, with minimal
* differences. LDAP Urls implemented by this class has the following format:
* ldap[s]://[user[:password]@]hostname[:port]["/" [dn ["?" [attributes]
* ["?" [scope] ["?" [filter] ["?" extensions]]]]]]
*/
class KLDAP_EXPORT LdapUrl : public KUrl
{
public:
typedef struct {
QString value;
bool critical;
} Extension;
typedef enum {
Base, One, Sub
} Scope;
/** Constructs an empty KLdapUrl. */
LdapUrl();
/** Constructs a KLdapUrl from a KUrl. */
explicit LdapUrl( const KUrl &url );
/** Constructs a KLdapUrl from a LdapUrl. */
LdapUrl( const LdapUrl &that );
LdapUrl &operator=( const LdapUrl &that );
virtual ~LdapUrl();
/**
* Returns the dn part of the LDAP Url (same as path(), but slash removed
* from the beginning).
*/
LdapDN dn() const;
/** Sets the the dn part of the LDAP Url. */
void setDn( const LdapDN &dn );
/** Returns the attributes part of the LDAP Url */
QStringList attributes() const;
/** Sets the attributes part of the LDAP Url */
void setAttributes( const QStringList &attributes );
/** Returns the scope part of the LDAP Url */
Scope scope() const;
/** Sets the scope part of the LDAP Url */
void setScope( Scope scope );
/** Returns the filter part of the LDAP Url */
QString filter() const;
/** Sets the filter part of the LDAP Url */
void setFilter( const QString &filter );
/** Returns if the specified extension exists in the LDAP Url */
bool hasExtension( const QString &key ) const;
/** Returns the specified extension */
Extension extension( const QString &key ) const;
/** Returns the specified extension */
QString extension( const QString &key, bool &critical ) const;
/** Sets the specified extension key with the value and criticality in ext */
void setExtension( const QString &key, const Extension &ext );
/** Sets the specified extension key with the value and criticality specified */
void setExtension( const QString &key, const QString &value, bool critical = false );
/** Sets the specified extension key with the value and criticality specified */
void setExtension( const QString &key, int value, bool critical = false );
/** Removes the specified extension */
void removeExtension( const QString &key );
/** Updates the query component from the attributes, scope, filter and extensions */
void updateQuery();
/** Parses the query argument of the URL and makes it available via the
* attributes(), extension(), filter() and scope() methods
*/
void parseQuery();
private:
class LdapUrlPrivate;
LdapUrlPrivate *const d;
};
}
#endif
|
