authsession.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 AUTHSESSION_H
#define AUTHSESSION_H

#include <QObject>
#include <QString>
#include <QStringList>
#include <QByteArray>
#include <QVariant>

#include "libsignoncommon.h"
#include "sessiondata.h"
#include "signonerror.h"


namespace SignOn {

class SIGNON_EXPORT AuthSession: public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(AuthSession)

    friend class IdentityImpl;
    friend class AuthSessionImpl;

public:
    enum AuthSessionError {
        UnknownError = 1,               
        InternalServerError = 2,        
        InternalCommunicationError = 3, 
        PermissionDeniedError = 4,      
        AuthSessionErr = 300,           /* placeholder to rearrange enumeration */
        MechanismNotAvailableError,     
        MissingDataError,               
        InvalidCredentialsError,        
        WrongStateError,                
        OperationNotSupportedError,     
        NoConnectionError,              
        NetworkError,                   
        SslError,                       
        RuntimeError,                   
        CanceledError,                  
        TimedOutError,                  
        UserInteractionError            
    };

    enum AuthSessionState {
        SessionNotStarted = 0,          
        HostResolving,                  
        ServerConnecting,               
        DataSending,                    
        ReplyWaiting,                   
        UserPending,                    
        UiRefreshing,                   
        ProcessPending,                 
        SessionStarted,                 
        ProcessCanceling,               
        ProcessDone,                    
        CustomState,                    
        MaxState,
    };

protected:
    AuthSession(quint32 id, const QString &methodName, QObject *parent = 0);
    ~AuthSession();

public:
    const QString name() const;

     void queryAvailableMechanisms(const QStringList &wantedMechanisms = QStringList());

    void process(const SessionData &sessionData,
                 const QString &mechanism = QString());

    void challenge(const SessionData& sessionData,
                   const QString &mechanism = QString()) {
        process(sessionData, mechanism);
    }

    void request(const SessionData &sessionData,
                 const QString &mechanism = QString()) {
        process(sessionData, mechanism);
    }

    void cancel();

    void signMessage(const SessionData &params,
                     const QString &mechanism = QString()) {
        process(params, mechanism);
    }

Q_SIGNALS:
    void error(const SignOn::Error &err);

    void mechanismsAvailable(const QStringList &mechanisms);

    void response(const SignOn::SessionData &sessionData);

    void stateChanged(AuthSession::AuthSessionState state,
                      const QString &message);

private:
    class AuthSessionImpl *impl;
};

}  // namespace SignOn

Q_DECLARE_METATYPE(SignOn::AuthSession::AuthSessionState)

#endif // AUTHSESSION_H