KD SOAP  1.9.1
KDSoapClientInterface.h
1 /****************************************************************************
2 ** Copyright (C) 2010-2020 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.com.
3 ** All rights reserved.
4 **
5 ** This file is part of the KD Soap library.
6 **
7 ** Licensees holding valid commercial KD Soap licenses may use this file in
8 ** accordance with the KD Soap Commercial License Agreement provided with
9 ** the Software.
10 **
11 **
12 ** This file may be distributed and/or modified under the terms of the
13 ** GNU Lesser General Public License version 2.1 and version 3 as published by the
14 ** Free Software Foundation and appearing in the file LICENSE.LGPL.txt included.
15 **
16 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
17 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
18 **
19 ** Contact info@kdab.com if any conditions of this licensing are not
20 ** clear to you.
21 **
22 **********************************************************************/
23 #ifndef KDSOAPCLIENTINTERFACE_H
24 #define KDSOAPCLIENTINTERFACE_H
25 
26 #include <QtCore/QtGlobal>
27 #include <QtCore/QString>
28 #include "KDSoapMessage.h"
29 #include "KDSoapPendingCall.h"
30 
32 class KDSoapSslHandler;
33 class KDSoapClientInterfacePrivate;
34 QT_BEGIN_NAMESPACE
35 class QSslError;
36 class QSslConfiguration;
37 class QNetworkCookieJar;
38 class QNetworkProxy;
39 QT_END_NAMESPACE
40 
63 class KDSOAP_EXPORT KDSoapClientInterface
64 {
65 public:
70  enum SoapVersion {
72  SOAP1_1 = 1,
74  SOAP1_2 = 2
75  };
76 
87  explicit KDSoapClientInterface(const QString &endPoint, const QString &messageNamespace);
93 
138  KDSoapPendingCall asyncCall(const QString &method, const KDSoapMessage &message,
139  const QString &soapAction = QString(),
140  const KDSoapHeaders &headers = KDSoapHeaders());
141 
156  KDSoapMessage call(const QString &method, const KDSoapMessage &message,
157  const QString &soapAction = QString(),
158  const KDSoapHeaders &headers = KDSoapHeaders());
159 
173  void callNoReply(const QString &method, const KDSoapMessage &message,
174  const QString &soapAction = QString(),
175  const KDSoapHeaders &headers = KDSoapHeaders());
176 
181  void setAuthentication(const KDSoapAuthentication &authentication);
182 
188  void setHeader(const QString &name, const KDSoapMessage &header);
189 
195  void setSoapVersion(KDSoapClientInterface::SoapVersion version);
196 
200  KDSoapClientInterface::SoapVersion soapVersion() const;
201 
206  QString endPoint() const;
207 
214  void setEndPoint(const QString &endPoint);
215 
222  QNetworkCookieJar *cookieJar() const;
223 
230  void setCookieJar(QNetworkCookieJar *jar);
231 
237  QNetworkProxy proxy() const;
238 
244  void setProxy(const QNetworkProxy &proxy);
245 
251  void setRawHTTPHeaders(const QMap<QByteArray, QByteArray> &headers);
252 
266  enum Style {
268  DocumentStyle
269  };
270 
275  void setStyle(Style style);
276 
281  Style style() const;
282 
288  KDSoapHeaders lastResponseHeaders() const;
289 
294  void ignoreSslErrors();
295 
296 #ifndef QT_NO_OPENSSL
297 
306  void ignoreSslErrors(const QList<QSslError> &errors);
307 #endif
308 
319  KDSoapSslHandler *sslHandler() const;
320 
321 #ifndef QT_NO_OPENSSL
322 
326  QSslConfiguration sslConfiguration() const;
327 
332  void setSslConfiguration(const QSslConfiguration &config);
333 #endif
334 
340  int timeout() const;
341 
347  void setTimeout(int msecs);
348 
349 private:
350  friend class KDSoapThreadTask;
351 
352  KDSoapClientInterfacePrivate *const d;
353 };
354 
355 #endif // KDSOAPCLIENTINTERFACE_H
Style
Definition: KDSoapClientInterface.h:266
the method name is sent as an xml element wrapping the message parameters
Definition: KDSoapClientInterface.h:267
Definition: KDSoapPendingCall.h:51
Definition: KDSoapMessage.h:195
Definition: KDSoapAuthentication.h:43
A class for handling SSL errors during SOAP calls.
Definition: KDSoapSslHandler.h:43
Definition: KDSoapMessage.h:41
Definition: KDSoapClientInterface.h:63
SoapVersion
Definition: KDSoapClientInterface.h:70

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/