KDSoapServerObjectInterface.h

/****************************************************************************
**
** This file is part of the KD Soap library.
**
** SPDX-FileCopyrightText: 2010-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** SPDX-License-Identifier: LicenseRef-KDAB-KDSoap-AGPL3-Modified 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 KDSOAPSERVEROBJECTINTERFACE_H
#define KDSOAPSERVEROBJECTINTERFACE_H
 
#include "KDSoapServerGlobal.h"
#include <KDSoapClient/KDSoapMessage.h>
#include "KDSoapDelayedResponseHandle.h"
 
#include <QtCore/QObject>
#include <QtCore/QByteArray>
#include <QtCore/QVector>
#include <QIODevice>
 
class KDSoapServerSocket;
 
QT_BEGIN_NAMESPACE
class QAbstractSocket;
QT_END_NAMESPACE
 
class KDSOAPSERVER_EXPORT KDSoapServerObjectInterface
{
public:
    KDSoapServerObjectInterface();
    virtual ~KDSoapServerObjectInterface();
 
    virtual void processRequest(const KDSoapMessage &request, KDSoapMessage &response, const QByteArray &soapAction);
 
    virtual QIODevice *processFileRequest(const QString &path, QByteArray &contentType);
 
    virtual void processRequestWithPath(const KDSoapMessage &request, KDSoapMessage &response, const QByteArray &soapAction, const QString &path);
 
    struct KDSOAPSERVER_EXPORT HttpResponseHeaderItem
    {
        HttpResponseHeaderItem();
        HttpResponseHeaderItem(const QByteArray &name, const QByteArray &value);
        QByteArray m_value;
        QByteArray m_name;
    };
 
    typedef QVector<HttpResponseHeaderItem> HttpResponseHeaderItems;
 
    virtual HttpResponseHeaderItems additionalHttpResponseHeaderItems() const;
 
    void doneProcessingRequestWithPath(const KDSoapServerObjectInterface &otherInterface);
 
    KDSoapHeaders requestHeaders() const;
 
    QByteArray soapAction() const;
 
    void setResponseHeaders(const KDSoapHeaders &headers);
 
    void setResponseNamespace(const QString &ns);
 
    void setFault(const QString &faultCode, const QString &faultString, const QString &faultActor = QString(), const QString &detail = QString());
 
    void setFault(const QString &faultCode, const QString &faultString, const QString &faultActor, const KDSoapValue &detail);
 
    bool hasFault() const;
 
    QAbstractSocket *serverSocket() const;
 
    KDSoapDelayedResponseHandle prepareDelayedResponse(); // only valid during processRequest()
    bool isDelayedResponse() const; // only valid during processRequest()
 
    void sendDelayedResponse(const KDSoapDelayedResponseHandle &responseHandle, const KDSoapMessage &response);
 
    void writeHTTP(const QByteArray &httpReply);
 
    void writeXML(const QByteArray &reply, bool isFault = false);
 
private:
    friend class KDSoapServerSocket;
    void setServerSocket(KDSoapServerSocket *serverSocket); // only valid during processRequest()
    void setRequestHeaders(const KDSoapHeaders &headers, const QByteArray &soapAction);
    KDSoapHeaders responseHeaders() const;
    QString responseNamespace() const;
    void storeFaultAttributes(KDSoapMessage &message) const;
    class Private;
    Private *const d;
};
 
QT_BEGIN_NAMESPACE
Q_DECLARE_INTERFACE(KDSoapServerObjectInterface, "com.kdab.KDSoap.ServerObjectInterface/1.0")
QT_END_NAMESPACE
 
#endif // KDSOAPSERVEROBJECTINTERFACE_H