identityinfo.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 IDENTITY_INFO_H
#define IDENTITY_INFO_H

#include <QStringList>
#include <QMetaType>

#include "libsignoncommon.h"

namespace SignOn {

typedef QString MethodName;

typedef QStringList MechanismsList;

class SIGNON_EXPORT IdentityInfo
{
    friend class AuthServiceImpl;
    friend class IdentityImpl;

public:
    enum CredentialsType {
        Other = 0,
        Application = 1 << 0,
        Web = 1 << 1,
        Network = 1 << 2
    };

public:
    IdentityInfo();

    IdentityInfo(const IdentityInfo &other);

    IdentityInfo &operator=(const IdentityInfo &other);

    IdentityInfo(const QString &caption, const QString &userName,
                 const QMap<MethodName,MechanismsList> &methods);

    ~IdentityInfo();

    quint32 id() const;

    void setSecret(const QString &secret, const bool storeSecret = true);

    bool isStoringSecret() const;

    void setStoreSecret(const bool storeSecret);

    void setUserName(const QString &userName);

    const QString userName() const;

    void setCaption(const QString &caption);

    const QString caption() const;

    void setRealms(const QStringList &realms);

    QStringList realms() const;

    void setOwner(const QString &ownerToken);

    QString owner() const;

    void setAccessControlList(const QStringList &accessControlList);

    QStringList accessControlList() const;

    void setMethod(const MethodName &method,
                   const MechanismsList &mechanismsList);

    void removeMethod(const MethodName &method);

    void setType(CredentialsType type);

    CredentialsType type() const;

    QList<MethodName> methods() const;

    MechanismsList mechanisms(const MethodName &method) const;

    void setRefCount(qint32 refCount);

    qint32 refCount() const;

private:
    void setId(const quint32 id);
    const QString secret() const;

private:
    class IdentityInfoImpl *impl;
};

}  // namespace SignOn

Q_DECLARE_METATYPE(SignOn::IdentityInfo)

#endif /* IDENTITY_INFO_H */