KDSoapClientInterface.h

Go to the documentation of this file.

/****************************************************************************
**
** This file is part of the KD Soap project.
**
** SPDX-FileCopyrightText: 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** SPDX-License-Identifier: MIT
**
****************************************************************************/
#ifndef KDSOAPCLIENTINTERFACE_H
#define KDSOAPCLIENTINTERFACE_H
 
#include "KDSoapMessage.h"
#include "KDSoapPendingCall.h"
#include <QtCore/QString>
#include <QtCore/QtGlobal>
 
class KDSoapAuthentication;
class KDSoapSslHandler;
class KDSoapClientInterfacePrivate;
QT_BEGIN_NAMESPACE
class QSslError;
class QSslConfiguration;
class QNetworkCookieJar;
class QNetworkProxy;
QT_END_NAMESPACE
 
class KDSOAP_EXPORT KDSoapClientInterface
{
public:
    enum SoapVersion
    {
        SOAP1_1 = 1,
        SOAP1_2 = 2
    };
 
    explicit KDSoapClientInterface(const QString &endPoint, const QString &messageNamespace);
    ~KDSoapClientInterface();
 
    KDSoapClientInterface(const KDSoapClientInterface &) = delete;
    KDSoapClientInterface &operator=(const KDSoapClientInterface &) = delete;
 
    KDSoapPendingCall asyncCall(const QString &method, const KDSoapMessage &message, const QString &soapAction = QString(),
                                const KDSoapHeaders &headers = KDSoapHeaders());
 
    KDSoapMessage call(const QString &method, const KDSoapMessage &message, const QString &soapAction = QString(),
                       const KDSoapHeaders &headers = KDSoapHeaders());
 
    void callNoReply(const QString &method, const KDSoapMessage &message, const QString &soapAction = QString(),
                     const KDSoapHeaders &headers = KDSoapHeaders());
 
    void setAuthentication(const KDSoapAuthentication &authentication);
 
    void setHeader(const QString &name, const KDSoapMessage &header);
 
    void setSoapVersion(KDSoapClientInterface::SoapVersion version);
 
    KDSoapClientInterface::SoapVersion soapVersion() const;
 
    QString endPoint() const;
 
    void setEndPoint(const QString &endPoint);
 
    QNetworkCookieJar *cookieJar() const;
 
    void setCookieJar(QNetworkCookieJar *jar);
 
    QNetworkProxy proxy() const;
 
    void setProxy(const QNetworkProxy &proxy);
 
    void setRawHTTPHeaders(const QMap<QByteArray, QByteArray> &headers);
 
    enum Style
    {
        RPCStyle, 
        DocumentStyle 
    };
 
    void setStyle(Style style);
 
    Style style() const;
 
    KDSoapHeaders lastResponseHeaders() const;
 
    void ignoreSslErrors();
 
#ifndef QT_NO_SSL
    void ignoreSslErrors(const QList<QSslError> &errors);
#endif
 
    KDSoapSslHandler *sslHandler() const;
 
#ifndef QT_NO_SSL
    QSslConfiguration sslConfiguration() const;
 
    void setSslConfiguration(const QSslConfiguration &config);
#endif
 
    int timeout() const;
 
    void setTimeout(int msecs);
 
    void setMessageAddressingProperties(const KDSoapMessageAddressingProperties &map);
 
    void setSendSoapActionInHttpHeader(bool sendInHttpHeader);
 
    bool sendSoapActionInHttpHeader() const;
 
    void setSendSoapActionInWsAddressingHeader(bool sendInWsAddressingHeader);
 
    bool sendSoapActionInWsAddressingHeader() const;
 
private:
    friend class KDSoapThreadTask;
    KDSoapClientInterfacePrivate *const d;
};
 
#endif // KDSOAPCLIENTINTERFACE_H