authservice.h

/*
 * This file is part of signon
 *
 * Copyright (C) 2009-2010 Nokia Corporation.
 * Copyright (C) 2012-2016 Canonical Ltd.
 *
 * 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 AUTHSERVICE_H
#define AUTHSERVICE_H
 
#include <QObject>
#include <QStringList>
#include <QMap>
 
#include "libsignoncommon.h"
#include "identityinfo.h"
#include "signonerror.h"
 
namespace SignOn {
 
class SIGNON_EXPORT AuthService: public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(AuthService)
 
    friend class AuthServiceImpl;
 
public:
    enum ServiceError {
        UnknownError = 1,               
        InternalServerError = 2,        
        InternalCommunicationError = 3, 
        PermissionDeniedError = 4,      
        AuthServiceErr = 100,           /* Placeholder to rearrange enumeration */
        MethodNotKnownError,            
        NotAvailableError,              
        InvalidQueryError               
    };
 
    typedef enum {
        AuthMethod = 0,
        Username,
        Realm,
        Caption
    } IdentityFilterCriteria;
 
    class IdentityRegExp
    {
    public:
        IdentityRegExp(const QString &pattern);
 
        IdentityRegExp(const IdentityRegExp &src);
 
        bool isValid() const;
 
        QString pattern() const;
 
    private:
        QString m_pattern;
    };
 
public:
    typedef QMap<IdentityFilterCriteria, IdentityRegExp> IdentityFilter;
 
    AuthService(QObject *parent = 0);
 
    ~AuthService();
 
    void queryMethods();
 
    void queryMechanisms(const QString &method);
 
    void queryIdentities(const IdentityFilter &filter = IdentityFilter());
 
    void clear();
 
Q_SIGNALS:
 
    void error(const SignOn::Error &err);
 
    void methodsAvailable(const QStringList &methods);
 
    void mechanismsAvailable(const QString &method, const QStringList &mechanisms);
 
    void identities(const QList<SignOn::IdentityInfo> &identityList);
 
    void cleared();
 
private:
    class AuthServiceImpl *impl;
};
 
} // namespace SignOn
 
#endif // AUTHSERVICE_H