KD SOAP API Documentation  2.2
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 
19 class KDSoapSslHandler;
21 QT_BEGIN_NAMESPACE
22 class QSslError;
23 class QSslConfiguration;
24 class QNetworkCookieJar;
25 class QNetworkProxy;
26 QT_END_NAMESPACE
27 
51 {
52 public:
58  {
60  SOAP1_1 = 1,
62  SOAP1_2 = 2
63  };
64 
75  explicit KDSoapClientInterface(const QString &endPoint, const QString &messageNamespace);
81 
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  {
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 
388 private:
389  friend class KDSoapThreadTask;
391 };
392 
393 #endif // KDSOAPCLIENTINTERFACE_H
#define KDSOAP_EXPORT
Definition: KDSoapGlobal.h:22
KDSoapClientInterface(const KDSoapClientInterface &)=delete
KDSoapClientInterface & operator=(const KDSoapClientInterface &)=delete
@ RPCStyle
the method name is sent as an xml element wrapping the message parameters
A class for handling SSL errors during SOAP calls.
@ SOAP1_1
Definition: KDSoapValue.h:42
@ SOAP1_2
Definition: KDSoapValue.h:44

© 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 by doxygen 1.9.1