KDSoapMessageAddressingProperties.h

/****************************************************************************
**
** This file is part of the KD Soap library.
**
** SPDX-FileCopyrightText: 2010-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDAB-KDSoap OR LicenseRef-KDAB-KDSoap-US
**
** Licensees holding valid commercial KD Soap licenses may use this file in
** accordance with the KD Soap Commercial License Agreement provided with
** the Software.
**
** Contact info@kdab.com if any conditions of this licensing are not clear to you.
**
****************************************************************************/
#ifndef KDSOAPMESSAGEADDRESSINGPROPERTIES_H
#define KDSOAPMESSAGEADDRESSINGPROPERTIES_H
 
#include <QtCore/QSharedDataPointer>
#include "KDSoapGlobal.h"
 
#include "KDSoapEndpointReference.h"
#include "KDSoapValue.h"
 
QT_BEGIN_NAMESPACE
class QString;
QT_END_NAMESPACE
 
class KDSoapNamespacePrefixes;
class KDSoapMessageAddressingPropertiesData;
 
namespace KDSoapMessageRelationship {
 
struct Relationship
{
    Relationship()
    {
    }
 
    Relationship(const QString &URI, const QString &type = QString())
        : uri(URI)
        , relationshipType(type)
    {
    }
 
    QString uri;
    QString relationshipType;
};
 
} // namespace
 
class KDSOAP_EXPORT KDSoapMessageAddressingProperties
{
public:
    friend class KDSoapMessageWriter;
    friend class KDSoapMessageReader;
 
    enum KDSoapAddressingPredefinedAddress
    {
        None,
        Anonymous,
        Reply,
        Unspecified
    };
 
    enum KDSoapAddressingNamespace
    {
        Addressing200303,
        Addressing200403,
        Addressing200408,
        Addressing200508
    };
 
    KDSoapMessageAddressingProperties();
 
    ~KDSoapMessageAddressingProperties();
 
    KDSoapMessageAddressingProperties(const KDSoapMessageAddressingProperties &other);
 
    KDSoapMessageAddressingProperties &operator=(const KDSoapMessageAddressingProperties &other);
 
    QString destination() const;
 
    void setDestination(const QString &destination);
 
    QString action() const;
 
    void setAction(const QString &action);
 
    KDSoapEndpointReference sourceEndpoint() const;
 
    QString sourceEndpointAddress() const;
 
    void setSourceEndpoint(const KDSoapEndpointReference &sourceEndpoint);
 
    void setSourceEndpointAddress(const QString &sourceEndpoint);
 
    KDSoapEndpointReference replyEndpoint() const;
 
    QString replyEndpointAddress() const;
 
    void setReplyEndpoint(const KDSoapEndpointReference &replyEndpoint);
 
    void setReplyEndpointAddress(const QString &replyEndpoint);
 
    KDSoapEndpointReference faultEndpoint() const;
 
    QString faultEndpointAddress() const;
 
    void setFaultEndpoint(const KDSoapEndpointReference &faultEndpoint);
 
    void setFaultEndpointAddress(const QString &faultEndpoint);
 
    QString messageID() const;
 
    void setMessageID(const QString &id);
 
    QVector<KDSoapMessageRelationship::Relationship> relationships() const;
 
    void setRelationships(const QVector<KDSoapMessageRelationship::Relationship> &relationships);
 
    void addRelationship(const KDSoapMessageRelationship::Relationship &relationship);
 
    KDSoapValueList referenceParameters() const;
 
    void setReferenceParameters(const KDSoapValueList &values);
 
    void addReferenceParameter(const KDSoapValue &oneReferenceParameter);
 
    KDSoapValueList metadata() const;
 
    void setMetadata(const KDSoapValueList &metadataList);
 
    void addMetadata(const KDSoapValue &metadata);
 
    KDSoapAddressingNamespace addressingNamespace() const;
 
    void setAddressingNamespace(KDSoapAddressingNamespace addressingNamespace);
 
    static QString predefinedAddressToString(KDSoapAddressingPredefinedAddress address,
                                             KDSoapAddressingNamespace addressingNamespace = Addressing200508);
 
    static bool isWSAddressingNamespace(const QString &namespaceUri);
 
    static QString addressingNamespaceToString(KDSoapAddressingNamespace addressingNamespace);
 
private:
    void writeMessageAddressingProperties(KDSoapNamespacePrefixes &namespacePrefixes, QXmlStreamWriter &writer, const QString &messageNamespace,
                                          bool forceQualified) const;
 
    void readMessageAddressingProperty(const KDSoapValue &value);
 
private:
    QSharedDataPointer<KDSoapMessageAddressingPropertiesData> d;
};
 
KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapMessageAddressingProperties &msg);
 
#endif // KDSOAPMESSAGEADDRESSINGPROPERTIES_H