KD SOAP API Documentation: KDSoapClientInterface.h Source File

| KD SOAP API Documentation 2.2

Loading...
Searching...
No Matches
KDSoapClientInterface.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 KDSOAPCLIENTINTERFACE_H
11#define KDSOAPCLIENTINTERFACE_H
12
13#include "KDSoapMessage.h"
14#include "KDSoapPendingCall.h"
15#include <QtCore/QString>
16#include <QtCore/QtGlobal>
17
18class KDSoapAuthentication;
19class KDSoapSslHandler;
20class KDSoapClientInterfacePrivate;
21 QT_BEGIN_NAMESPACE
22class QSslError;
23class QSslConfiguration;
24class QNetworkCookieJar;
25class QNetworkProxy;
26QT_END_NAMESPACE
27
50 class KDSOAP_EXPORT KDSoapClientInterface
51{
52public:
57 enum SoapVersion
58 {
60 SOAP1_1 = 1,
62 SOAP1_2 = 2
63 };
64
75 explicit KDSoapClientInterface(const QString &endPoint, const QString &messageNamespace);
80 ~KDSoapClientInterface();
81
82 KDSoapClientInterface(const KDSoapClientInterface &) = delete;
83 KDSoapClientInterface &operator=(const KDSoapClientInterface &) = delete;
84
129 KDSoapPendingCall asyncCall(const QString &method, const KDSoapMessage &message, const QString &soapAction = QString(),
130 const KDSoapHeaders &headers = KDSoapHeaders());
131
146 KDSoapMessage call(const QString &method, const KDSoapMessage &message, const QString &soapAction = QString(),
147 const KDSoapHeaders &headers = KDSoapHeaders());
148
162 void callNoReply(const QString &method, const KDSoapMessage &message, const QString &soapAction = QString(),
163 const KDSoapHeaders &headers = KDSoapHeaders());
164
169 void setAuthentication(const KDSoapAuthentication &authentication);
170
176 void setHeader(const QString &name, const KDSoapMessage &header);
177
183 void setSoapVersion(KDSoapClientInterface::SoapVersion version);
184
188 KDSoapClientInterface::SoapVersion soapVersion() const;
189
194 QString endPoint() const;
195
202 void setEndPoint(const QString &endPoint);
203
210 QNetworkCookieJar *cookieJar() const;
211
218 void setCookieJar(QNetworkCookieJar *jar);
219
225 QNetworkProxy proxy() const;
226
232 void setProxy(const QNetworkProxy &proxy);
233
239 void setRawHTTPHeaders(const QMap<QByteArray, QByteArray> &headers);
240
254 enum Style
255 {
256 RPCStyle,
257 DocumentStyle
258 };
259
264 void setStyle(Style style);
265
270 Style style() const;
271
277 KDSoapHeaders lastResponseHeaders() const;
278
283 void ignoreSslErrors();
284
285#ifndef QT_NO_SSL
295 void ignoreSslErrors(const QList<QSslError> &errors);
296#endif
297
308 KDSoapSslHandler *sslHandler() const;
309
310#ifndef QT_NO_SSL
315 QSslConfiguration sslConfiguration() const;
316
321 void setSslConfiguration(const QSslConfiguration &config);
322#endif
323
329 int timeout() const;
330
336 void setTimeout(int msecs);
337
345 void setMessageAddressingProperties(const KDSoapMessageAddressingProperties &map);
346
356 void setSendSoapActionInHttpHeader(bool sendInHttpHeader);
357
365 bool sendSoapActionInHttpHeader() const;
366
375 void setSendSoapActionInWsAddressingHeader(bool sendInWsAddressingHeader);
376
386 bool sendSoapActionInWsAddressingHeader() const;
387
388private:
389 friend class KDSoapThreadTask;
390 KDSoapClientInterfacePrivate *const d;
391};
392
393#endif // KDSOAPCLIENTINTERFACE_H
KDSOAP_EXPORT
#define KDSOAP_EXPORT
Definition KDSoapGlobal.h:22
KDSoapMessage.h
KDSoapPendingCall.h
KDSoapAuthentication
Definition KDSoapAuthentication.h:31
KDSoapClientInterfacePrivate
Definition KDSoapClientInterface_p.h:29
KDSoapClientInterface
Definition KDSoapClientInterface.h:51
KDSoapClientInterface::KDSoapClientInterface
KDSoapClientInterface(const KDSoapClientInterface &)=delete
KDSoapClientInterface::SoapVersion
SoapVersion
Definition KDSoapClientInterface.h:58
KDSoapClientInterface::Style
Style
Definition KDSoapClientInterface.h:255
KDSoapClientInterface::RPCStyle
@ RPCStyle
the method name is sent as an xml element wrapping the message parameters
Definition KDSoapClientInterface.h:256
KDSoapClientInterface::operator=
KDSoapClientInterface & operator=(const KDSoapClientInterface &)=delete
KDSoapHeaders
Definition KDSoapMessage.h:185
KDSoapMessageAddressingProperties
Definition KDSoapMessageAddressingProperties.h:76
KDSoapMessage
Definition KDSoapMessage.h:29
KDSoapPendingCall
Definition KDSoapPendingCall.h:39
KDSoapSslHandler
A class for handling SSL errors during SOAP calls.
Definition KDSoapSslHandler.h:31
KDSoapThreadTask
Definition KDSoapClientThread_p.h:68
QList
QMap
QNetworkCookieJar
QNetworkProxy
QObject::qobject_cast
T qobject_cast(QObject *object)
QSslConfiguration
QSslError
QString

© 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