KD SOAP API Documentation: KDSoapMessageAddressingProperties.h Source File

| KD SOAP API Documentation 2.2

Loading...
Searching...
No Matches
KDSoapMessageAddressingProperties.h
Go to the documentation of this file.
1/****************************************************************************
2**
3** This file is part of the KD Soap project.
4**
5** SPDX-FileCopyrightText: 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
6**
7** SPDX-License-Identifier: MIT
8**
9****************************************************************************/
10#ifndef KDSOAPMESSAGEADDRESSINGPROPERTIES_H
11#define KDSOAPMESSAGEADDRESSINGPROPERTIES_H
12
13#include "KDSoapGlobal.h"
14#include <QtCore/QSharedDataPointer>
15
16#include "KDSoapEndpointReference.h"
17#include "KDSoapValue.h"
18
19QT_BEGIN_NAMESPACE
20class QString;
21QT_END_NAMESPACE
22
23class KDSoapNamespacePrefixes;
24class KDSoapMessageAddressingPropertiesData;
25
33 namespace KDSoapMessageRelationship {
34
35 struct Relationship
36{
40 Relationship()
41 {
42 }
43
51 Relationship(const QString &URI, const QString &type = QString())
52 : uri(URI)
53 , relationshipType(type)
54 {
55 }
56
57 QString uri;
58 QString relationshipType;
59};
60
61} // namespace
62
75 class KDSOAP_EXPORT KDSoapMessageAddressingProperties
76{
77public:
78 friend class KDSoapMessageWriter;
79 friend class KDSoapMessageReader;
80
86 enum KDSoapAddressingPredefinedAddress
87 {
88 None,
89 Anonymous,
90 Reply,
91 Unspecified
92 };
93
100 enum KDSoapAddressingNamespace
101 {
102 Addressing200303,
103 Addressing200403,
104 Addressing200408,
105 Addressing200508
106 };
107
111 KDSoapMessageAddressingProperties();
112
116 ~KDSoapMessageAddressingProperties();
117
121 KDSoapMessageAddressingProperties(const KDSoapMessageAddressingProperties &other);
122
126 KDSoapMessageAddressingProperties &operator=(const KDSoapMessageAddressingProperties &other);
127
131 QString destination() const;
132
136 void setDestination(const QString &destination);
137
141 QString action() const;
142
146 void setAction(const QString &action);
147
152 KDSoapEndpointReference sourceEndpoint() const;
153
158 QString sourceEndpointAddress() const;
159
164 void setSourceEndpoint(const KDSoapEndpointReference &sourceEndpoint);
165
169 void setSourceEndpointAddress(const QString &sourceEndpoint);
170
175 KDSoapEndpointReference replyEndpoint() const;
176
180 QString replyEndpointAddress() const;
181
186 void setReplyEndpoint(const KDSoapEndpointReference &replyEndpoint);
187
191 void setReplyEndpointAddress(const QString &replyEndpoint);
192
196 KDSoapEndpointReference faultEndpoint() const;
197
201 QString faultEndpointAddress() const;
202
207 void setFaultEndpoint(const KDSoapEndpointReference &faultEndpoint);
208
212 void setFaultEndpointAddress(const QString &faultEndpoint);
213
217 QString messageID() const;
218
222 void setMessageID(const QString &id);
223
229 QVector<KDSoapMessageRelationship::Relationship> relationships() const;
230
238 void setRelationships(const QVector<KDSoapMessageRelationship::Relationship> &relationships);
239
246 void addRelationship(const KDSoapMessageRelationship::Relationship &relationship);
247
251 KDSoapValueList referenceParameters() const;
252
256 void setReferenceParameters(const KDSoapValueList &values);
257
261 void addReferenceParameter(const KDSoapValue &oneReferenceParameter);
262
266 KDSoapValueList metadata() const;
267
271 void setMetadata(const KDSoapValueList &metadataList);
272
276 void addMetadata(const KDSoapValue &metadata);
277
282 KDSoapAddressingNamespace addressingNamespace() const;
283
290 void setAddressingNamespace(KDSoapAddressingNamespace addressingNamespace);
291
295 static QString predefinedAddressToString(KDSoapAddressingPredefinedAddress address,
296 KDSoapAddressingNamespace addressingNamespace = Addressing200508);
297
301 static bool isWSAddressingNamespace(const QString &namespaceUri);
302
307 static QString addressingNamespaceToString(KDSoapAddressingNamespace addressingNamespace);
308
309private:
313 void writeMessageAddressingProperties(KDSoapNamespacePrefixes &namespacePrefixes, QXmlStreamWriter &writer, const QString &messageNamespace,
314 bool forceQualified) const;
315
319 void readMessageAddressingProperty(const KDSoapValue &value);
320
321private:
322 QSharedDataPointer<KDSoapMessageAddressingPropertiesData> d;
323};
324
328 KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapMessageAddressingProperties &msg);
329
330#endif // KDSOAPMESSAGEADDRESSINGPROPERTIES_H
KDSoapEndpointReference.h
KDSoapGlobal.h
KDSOAP_EXPORT
#define KDSOAP_EXPORT
Definition KDSoapGlobal.h:22
operator<<
KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapMessageAddressingProperties &msg)
Definition KDSoapMessageAddressingProperties.cpp:428
KDSoapValue.h
KDSoapEndpointReference
Definition KDSoapEndpointReference.h:28
KDSoapMessageAddressingProperties
Definition KDSoapMessageAddressingProperties.h:76
KDSoapMessageAddressingProperties::KDSoapAddressingPredefinedAddress
KDSoapAddressingPredefinedAddress
Definition KDSoapMessageAddressingProperties.h:87
KDSoapMessageAddressingProperties::None
@ None
Definition KDSoapMessageAddressingProperties.h:88
KDSoapMessageAddressingProperties::Reply
@ Reply
Definition KDSoapMessageAddressingProperties.h:90
KDSoapMessageAddressingProperties::Anonymous
@ Anonymous
Definition KDSoapMessageAddressingProperties.h:89
KDSoapMessageAddressingProperties::KDSoapAddressingNamespace
KDSoapAddressingNamespace
Definition KDSoapMessageAddressingProperties.h:101
KDSoapMessageAddressingProperties::Addressing200403
@ Addressing200403
Definition KDSoapMessageAddressingProperties.h:103
KDSoapMessageAddressingProperties::Addressing200303
@ Addressing200303
Definition KDSoapMessageAddressingProperties.h:102
KDSoapMessageAddressingProperties::Addressing200408
@ Addressing200408
Definition KDSoapMessageAddressingProperties.h:104
KDSoapMessageReader
Definition KDSoapMessageReader_p.h:18
KDSoapMessageWriter
Definition KDSoapMessageWriter_p.h:31
KDSoapNamespacePrefixes
Definition KDSoapNamespacePrefixes_p.h:20
KDSoapValueList
Definition KDSoapValue.h:321
KDSoapValue
Definition KDSoapValue.h:60
KDSoapMessageRelationship
Definition KDSoapMessageAddressingProperties.h:33
QDebug
QSharedDataPointer
QString
QVector
QXmlStreamWriter
KDSoapMessageRelationship::Relationship
Definition KDSoapMessageAddressingProperties.h:36
KDSoapMessageRelationship::Relationship::Relationship
Relationship(const QString &URI, const QString &type=QString())
Definition KDSoapMessageAddressingProperties.h:51
KDSoapMessageRelationship::Relationship::Relationship
Relationship()
Definition KDSoapMessageAddressingProperties.h:40
KDSoapMessageRelationship::Relationship::uri
QString uri
Definition KDSoapMessageAddressingProperties.h:57
KDSoapMessageRelationship::Relationship::relationshipType
QString relationshipType
Definition KDSoapMessageAddressingProperties.h:58

© 2010-2024 Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
https://www.kdab.com/development-resources/qt-tools/kd-soap/
Generated on Sun Jan 7 2024 11:47:36 for KD SOAP API Documentation by doxygen 1.9.8