signonerror.h

/*
 * This file is part of signon
 *
 * Copyright (C) 2009-2010 Nokia Corporation.
 *
 * Contact: Aurel Popirtac <ext-aurel.popirtac@nokia.com>
 * Contact: Alberto Mardegan <alberto.mardegan@canonical.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * 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 St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */
#ifndef SIGNONERROR_H
#define SIGNONERROR_H


#ifdef SIGNON_INTERNAL
    #include <QObject>
#endif

#include <QMetaType>
#include <QString>

#include <SignOn/libsignoncommon.h>

namespace SignOn {

class SIGNON_EXPORT Error
#ifdef SIGNON_INTERNAL
: public QObject { Q_OBJECT
#else
{
#endif
public:
    enum ErrorType {
        Unknown = 1,               
        InternalServer = 2,        
        InternalCommunication = 3, 
        PermissionDenied = 4,      
        EncryptionFailure,         
        AuthServiceErr = 100,           /* Placeholder to rearrange enumeration
                                         - AuthService specific */
        MethodNotKnown,            
        ServiceNotAvailable,       
        InvalidQuery,              
        IdentityErr = 200,              /* Placeholder to rearrange enumeration
                                         - Identity specific */
        MethodNotAvailable,        
        IdentityNotFound,          
        StoreFailed,               
        RemoveFailed,              
        SignOutFailed,             
        IdentityOperationCanceled, 
        CredentialsNotAvailable,   
        ReferenceNotFound,         
        AuthSessionErr = 300,      /* Placeholder to rearrange enumeration
                                     - AuthSession/AuthPluginInterface
                                     specific */
        MechanismNotAvailable,     
        MissingData,               
        InvalidCredentials,        
        NotAuthorized,             
        WrongState,                
        OperationNotSupported,     
        NoConnection,              
        Network,                   
        Ssl,                       
        Runtime,                   
        SessionCanceled,           
        TimedOut,                  
        UserInteraction,           
        OperationFailed,           
        EncryptionFailed,          
        TOSNotAccepted,            
        ForgotPassword,            
        MethodOrMechanismNotAllowed, 
        IncorrectDate,             
        UserErr = 400                   /* Placeholder to rearrange enumeration
                                         - User space specific */
    };

    Error() : m_type((int)Unknown), m_message(QString()) { registerType(); }

    Error(const Error &src) :
#ifdef SIGNON_INTERNAL
        QObject(),
#endif
        m_type(src.type()), m_message(src.message()) {}

    Error(int type, const QString &message = QString()):
        m_type(type), m_message(message) { registerType(); }

    Error &operator=(const Error &src)
        { m_type = src.type(); m_message = src.message(); return *this; }

    virtual ~Error() {}

    void setType(int type) { m_type = type; }

    void setMessage(const QString &message) { m_message = message; }

    int type() const { return m_type; }

    QString message() const { return m_message; }

private:
    inline void registerType();

private:
    int m_type;
    QString m_message;
};

} //namespace SignOn

Q_DECLARE_METATYPE(SignOn::Error)

void SignOn::Error::registerType() {
    qRegisterMetaType<SignOn::Error>("SignOn::Error");
}

#endif // SIGNONERROR_H