ldapurl.h

/*
    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 {

class KLDAP_EXPORT LdapUrl : public KUrl
{
  public:

    typedef struct {
      QString value;
      bool critical;
    } Extension;

    typedef enum {
      Base,  
      One,   
      Sub    
    } Scope;

    LdapUrl();

    explicit LdapUrl( const KUrl &url );

    LdapUrl( const LdapUrl &other );

    LdapUrl &operator=( const LdapUrl &other );

    virtual ~LdapUrl();

    void setDn( const LdapDN &dn );

    LdapDN dn() const;

    void setAttributes( const QStringList &attributes );

    QStringList attributes() const;

    void setScope( Scope scope );

    Scope scope() const;

    void setFilter( const QString &filter );

    QString filter() const;

    bool hasExtension( const QString &extension ) const;

    Extension extension( const QString &extension ) const;

    QString extension( const QString &extension, bool &critical ) const;

    void setExtension( const QString &key, const Extension &extension );

    void setExtension( const QString &key, const QString &value, bool critical = false );

    void setExtension( const QString &key, int value, bool critical = false );

    void removeExtension( const QString &extension );

    void updateQuery();

    void parseQuery();

  private:
    class LdapUrlPrivate;
    LdapUrlPrivate *const d;
};

}

#endif