webservice.h

Go to the documentation of this file.

/*
 * MusicBrainz -- The Internet music metadatabase
 *
 * Copyright (C) 2006 Lukas Lalinsky
 *  
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * $Id: webservice.h 8470 2006-09-05 14:06:16Z luks $
 */
 
#ifndef __MUSICBRAINZ3_WEBSERVICE_H__
#define __MUSICBRAINZ3_WEBSERVICE_H__

#include <string>
#include <musicbrainz3/musicbrainz.h> 
#include <musicbrainz3/iwebservice.h>

namespace MusicBrainz
{
  
    class MB_API WebServiceError : public Exception
    {
    public:
        WebServiceError(const std::string &msg = std::string()) : Exception(msg) {}
    };
    
    class MB_API ConnectionError : public WebServiceError
    {
    public:
        ConnectionError(const std::string &msg = std::string()) : WebServiceError(msg) {}
    };
    
    class MB_API TimeOutError : public WebServiceError
    {
    public:
        TimeOutError(const std::string &msg = std::string()) : WebServiceError(msg) {}
    };
    
    class MB_API ResourceNotFoundError : public WebServiceError
    {
    public:
        ResourceNotFoundError(const std::string &msg = std::string()) : WebServiceError(msg) {}
    };
    
    class MB_API AuthenticationError : public WebServiceError
    {
    public:
        AuthenticationError(const std::string &msg = std::string()) : WebServiceError(msg) {}
    };
    
    class MB_API ResponseError : public WebServiceError
    {
    public:
        ResponseError(const std::string &msg = std::string()) : WebServiceError(msg) {}
    };
    
    class MB_API RequestError : public WebServiceError
    {
    public:
        RequestError(const std::string &msg = std::string()) : WebServiceError(msg) {}
    };
    
    class MB_API WebService : public IWebService
    {
    public:
    
        WebService(const std::string &host = "musicbrainz.org",
                   const int port = 80,
                   const std::string &pathPrefix = "/ws",
                   const std::string &username = std::string(),
                   const std::string &password = std::string(),
                   const std::string &realm = "musicbrainz.org");

        virtual ~WebService();
        
        void setHost(const std::string &host);
        
        std::string getHost() const;
        
        void setPort(const int port);
        
        int getPort() const;
        
        void setPathPrefix(const std::string &pathPrefix);
        
        std::string getPathPrefix() const;
        
        void setUserName(const std::string &username);
        
        std::string getUserName() const;
        
        void setPassword(const std::string &password);
        
        std::string getPassword() const;
        
        void setRealm(const std::string &realm);
        
        std::string getRealm() const;
        
        void setProxyHost(const std::string &host);
        
        std::string getProxyHost() const;
        
        void setProxyPort(const int port);
        
        int getProxyPort() const;
        
        void setProxyUserName(const std::string &username);
        
        std::string getProxyUserName() const;
        
        void setProxyPassword(const std::string &password);
        
        std::string getProxyPassword() const;
        
        std::string get(const std::string &entity,
                        const std::string &id,
                        const IIncludes::IncludeList &include,
                        const IFilter::ParameterList &filter,
                        const std::string &version = "1"); 

         void post(const std::string &entity,
                   const std::string &id,
                   const std::string &data,
                   const std::string &version = "1");
        
    private:
    
        static int httpAuth(void *userdata, const char *realm, int attempts,
                            char *username, char *password);
        static int proxyAuth(void *userdata, const char *realm, int attempts,
                            char *username, char *password);
        static int httpResponseReader(void *userdata, const char *buf, size_t len);

        class WebServicePrivate;
        WebServicePrivate *d;
    };
    
}

#endif