LDAPUrl.h

Go to the documentation of this file.

// $OpenLDAP$
/*
 * Copyright 2000-2011 The OpenLDAP Foundation, All Rights Reserved.
 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
 */


#ifndef LDAP_URL_H
#define LDAP_URL_H

#include <StringList.h>

class LDAPUrlException;
class LDAPUrl{

    public : 
        LDAPUrl(const std::string &url="");

        ~LDAPUrl();

        int getPort() const;
        
        void setPort(int port);

        int getScope() const;

        void setScope(const std::string& scope);

        const std::string& getURLString() const;

        void setURLString(const std::string &url);

        const std::string& getHost() const;

        void setHost( const std::string &host);

        const std::string& getScheme() const;

        void setScheme( const std::string &scheme );

        const std::string& getDN() const;
        
        void setDN( const std::string &dn);

        
        const std::string& getFilter() const;
        
        void setFilter( const std::string &filter);

        const StringList& getAttrs() const;
        
        void setAttrs( const StringList &attrs);
        void setExtensions( const StringList &ext);
        const StringList& getExtensions() const;

        void percentDecode( const std::string& src, std::string& dest );
        
        std::string& percentEncode( const std::string& src, 
                    std::string& dest, 
                    int flags=0 ) const;
   
    protected : 
        void parseUrl();
        
        void components2Url() const;
        
        void string2list(const std::string &src, StringList& sl,
                bool percentDecode=false);

    protected :
        mutable 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;
        mutable std::string m_urlString;
        std::string m_Scheme;
        enum mode { base, attrs, scope, filter, extensions };
};

struct code2string_s {
    int code;
    const char* string;
};

class LDAPUrlException {
    public :
        LDAPUrlException(int code, const std::string &msg="" );

        int getCode() const;
        const std::string getErrorMessage() const;
        const std::string getAdditionalInfo() const;

        static const int INVALID_SCHEME      = 1;
        static const int INVALID_PORT        = 2;
        static const int INVALID_SCOPE       = 3;
        static const int INVALID_URL         = 4;
        static const int URL_DECODING_ERROR  = 5; 
        static const code2string_s code2string[]; 

    private:
        int m_code;
        std::string m_addMsg;
};
#endif //LDAP_URL_H