KDSoapMessage.h

/****************************************************************************
** Copyright (C) 2010-2019 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.com.
** All rights reserved.
**
** This file is part of the KD Soap library.
**
** Licensees holding valid commercial KD Soap licenses may use this file in
** accordance with the KD Soap Commercial License Agreement provided with
** the Software.
**
**
** This file may be distributed and/or modified under the terms of the
** GNU Lesser General Public License version 2.1 and version 3 as published by the
** Free Software Foundation and appearing in the file LICENSE.LGPL.txt included.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** Contact info@kdab.com if any conditions of this licensing are not
** clear to you.
**
**********************************************************************/
#ifndef KDSOAPMESSAGE_H
#define KDSOAPMESSAGE_H

#include <QtCore/QSharedDataPointer>
#include <QtCore/QVariant>

#include "KDSoapValue.h"
#include "KDSoapMessageAddressingProperties.h"

QT_BEGIN_NAMESPACE
class QString;
QT_END_NAMESPACE
class KDSoapMessageData;
class KDSoapHeaders;

class KDSOAP_EXPORT KDSoapMessage : public KDSoapValue
{
public:
    KDSoapMessage();
    ~KDSoapMessage();

    KDSoapMessage(const KDSoapMessage &other);
    KDSoapMessage &operator=(const KDSoapMessage &other);

    KDSoapMessage &operator=(const KDSoapValue &other);

    bool operator==(const KDSoapMessage &other) const;

    bool operator!=(const KDSoapMessage &other) const;

    void setUse(Use use);
    Use use() const;

    void addArgument(const QString &argumentName, const QVariant &argumentValue, const QString &typeNameSpace = QString(), const QString &typeName = QString());

    void addArgument(const QString &argumentName, const KDSoapValueList &argumentValueList, const QString &typeNameSpace = QString(), const QString &typeName = QString());

    KDSoapValueList &arguments();

    const KDSoapValueList &arguments() const;

    bool isFault() const;

    QString faultAsString() const;

    void setFault(bool fault);

    void createFaultMessage(const QString &faultCode, const QString &faultText, KDSoap::SoapVersion soapVersion);

    void setMessageAddressingProperties(const KDSoapMessageAddressingProperties &map);

    bool hasMessageAddressingProperties() const;

    KDSoapMessageAddressingProperties messageAddressingProperties() const;
private:
    bool isNull() const;
    friend class KDSoapPendingCall;
    friend class KDSoapServerSocket;
    friend class KDSoapMessageWriter;
    QSharedDataPointer<KDSoapMessageData> d;
};

class KDSOAP_EXPORT KDSoapHeaders : public QList<KDSoapMessage> //krazy:exclude=dpointer
{
public:
    KDSoapMessage header(const QString &name) const;

    KDSoapMessage header(const QString &name, const QString &namespaceUri) const;
};

KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapMessage &msg);

Q_DECLARE_METATYPE(KDSoapMessage)

#endif // KDSOAPMESSAGE_H