KD SOAP  1.10.0
KDSoapClientInterface.h
1 /****************************************************************************
2 **
3 ** This file is part of the KD Soap library.
4 **
5 ** SPDX-FileCopyrightText: 2010-2020 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
6 **
7 ** 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
8 **
9 ** Licensees holding valid commercial KD Soap licenses may use this file in
10 ** accordance with the KD Soap Commercial License Agreement provided with
11 ** the Software.
12 **
13 ** Contact info@kdab.com if any conditions of this licensing are not clear to you.
14 **
15 ****************************************************************************/
16 #ifndef KDSOAPCLIENTINTERFACE_H
17 #define KDSOAPCLIENTINTERFACE_H
18 
19 #include <QtCore/QtGlobal>
20 #include <QtCore/QString>
21 #include "KDSoapMessage.h"
22 #include "KDSoapPendingCall.h"
23 
25 class KDSoapSslHandler;
26 class KDSoapClientInterfacePrivate;
27 QT_BEGIN_NAMESPACE
28 class QSslError;
29 class QSslConfiguration;
30 class QNetworkCookieJar;
31 class QNetworkProxy;
32 QT_END_NAMESPACE
33 
56 class KDSOAP_EXPORT KDSoapClientInterface
57 {
58 public:
63  enum SoapVersion {
65  SOAP1_1 = 1,
67  SOAP1_2 = 2
68  };
69 
80  explicit KDSoapClientInterface(const QString &endPoint, const QString &messageNamespace);
86 
131  KDSoapPendingCall asyncCall(const QString &method, const KDSoapMessage &message,
132  const QString &soapAction = QString(),
133  const KDSoapHeaders &headers = KDSoapHeaders());
134 
149  KDSoapMessage call(const QString &method, const KDSoapMessage &message,
150  const QString &soapAction = QString(),
151  const KDSoapHeaders &headers = KDSoapHeaders());
152 
166  void callNoReply(const QString &method, const KDSoapMessage &message,
167  const QString &soapAction = QString(),
168  const KDSoapHeaders &headers = KDSoapHeaders());
169 
174  void setAuthentication(const KDSoapAuthentication &authentication);
175 
181  void setHeader(const QString &name, const KDSoapMessage &header);
182 
188  void setSoapVersion(KDSoapClientInterface::SoapVersion version);
189 
193  KDSoapClientInterface::SoapVersion soapVersion() const;
194 
199  QString endPoint() const;
200 
207  void setEndPoint(const QString &endPoint);
208 
215  QNetworkCookieJar *cookieJar() const;
216 
223  void setCookieJar(QNetworkCookieJar *jar);
224 
230  QNetworkProxy proxy() const;
231 
237  void setProxy(const QNetworkProxy &proxy);
238 
244  void setRawHTTPHeaders(const QMap<QByteArray, QByteArray> &headers);
245 
259  enum Style {
261  DocumentStyle
262  };
263 
268  void setStyle(Style style);
269 
274  Style style() const;
275 
281  KDSoapHeaders lastResponseHeaders() const;
282 
287  void ignoreSslErrors();
288 
289 #ifndef QT_NO_SSL
290 
299  void ignoreSslErrors(const QList<QSslError> &errors);
300 #endif
301 
312  KDSoapSslHandler *sslHandler() const;
313 
314 #ifndef QT_NO_SSL
315 
319  QSslConfiguration sslConfiguration() const;
320 
325  void setSslConfiguration(const QSslConfiguration &config);
326 #endif
327 
333  int timeout() const;
334 
340  void setTimeout(int msecs);
341 
342 private:
343  friend class KDSoapThreadTask;
344 
345  KDSoapClientInterfacePrivate *const d;
346 };
347 
348 #endif // KDSOAPCLIENTINTERFACE_H
Style
Definition: KDSoapClientInterface.h:259
the method name is sent as an xml element wrapping the message parameters
Definition: KDSoapClientInterface.h:260
Definition: KDSoapPendingCall.h:44
Definition: KDSoapMessage.h:188
Definition: KDSoapAuthentication.h:36
A class for handling SSL errors during SOAP calls.
Definition: KDSoapSslHandler.h:36
Definition: KDSoapMessage.h:34
Definition: KDSoapClientInterface.h:56
SoapVersion
Definition: KDSoapClientInterface.h:63

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/