KDSoapClientInterface.h

/****************************************************************************
**
** This file is part of the KD Soap library.
**
** SPDX-FileCopyrightText: 2010-2020 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** 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
**
** Licensees holding valid commercial KD Soap licenses may use this file in
** accordance with the KD Soap Commercial License Agreement provided with
** the Software.
**
** Contact info@kdab.com if any conditions of this licensing are not clear to you.
**
****************************************************************************/
#ifndef KDSOAPCLIENTINTERFACE_H
#define KDSOAPCLIENTINTERFACE_H

#include <QtCore/QtGlobal>
#include <QtCore/QString>
#include "KDSoapMessage.h"
#include "KDSoapPendingCall.h"

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();

    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);

private:
    friend class KDSoapThreadTask;

    KDSoapClientInterfacePrivate *const d;
};

#endif // KDSOAPCLIENTINTERFACE_H