WSRequest.h

/*
╔══════════════════════════════════════════════════════════════════════════════╗
║                       SIMPLY POWERFUL TOOLKIT (SPTK)                         ║
╟──────────────────────────────────────────────────────────────────────────────╢
║  copyright            © 1999-2022 Alexey Parshin. All rights reserved.       ║
║  email                alexeyp@gmail.com                                      ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│   This library is free software; you can redistribute it and/or modify it    │
│   under the terms of the GNU Library General Public License as published by  │
│   the Free Software Foundation; either version 2 of the License, or (at your │
│   option) any later version.                                                 │
│                                                                              │
│   This library is distributed in the hope that it will be useful, but        │
│   WITHOUT ANY WARRANTY; without even the implied warranty of                 │
│   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library   │
│   General Public License for more details.                                   │
│                                                                              │
│   You should have received a copy of the GNU Library General Public License  │
│   along with this library; if not, write to the Free Software Foundation,    │
│   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.               │
│                                                                              │
│   Please report all bugs and problems to alexeyp@gmail.com.                  │
└──────────────────────────────────────────────────────────────────────────────┘
*/
 
#pragma once
 
#include <sptk5/cthreads>
#include <sptk5/net/HttpAuthentication.h>
 
namespace sptk {
 
class SP_EXPORT WSNameSpace
{
public:
    WSNameSpace(const String& alias = "", const String& location = "")
        : m_alias(alias)
        , m_location(location)
    {
    }
 
    WSNameSpace(const WSNameSpace& other)
        : m_alias(other.m_alias)
        , m_location(other.m_location)
    {
    }
 
    ~WSNameSpace() noexcept = default;
 
    WSNameSpace& operator=(const WSNameSpace& other)
    {
        if (&other != this)
        {
            std::scoped_lock lock(m_mutex);
            m_alias = other.m_alias;
            m_location = other.m_location;
        }
        return *this;
    }
 
    String getAlias() const
    {
        std::scoped_lock lock(m_mutex);
        return m_alias;
    }
 
    String getLocation() const
    {
        std::scoped_lock lock(m_mutex);
        return m_location;
    }
 
private:
    mutable std::mutex m_mutex; 
    String m_alias;             
    String m_location;          
};
 
class SP_EXPORT WSRequest
    : public std::mutex
{
public:
    explicit WSRequest(sptk::LogEngine* logEngine = nullptr)
        : m_logEngine(logEngine)
    {
    }
 
    virtual ~WSRequest() = default;
 
    void processRequest(const xdoc::SNode& xmlContent, const xdoc::SNode& jsonContent,
                        HttpAuthentication* authentication, String& requestName);
 
    [[nodiscard]] virtual String title() const
    {
        return "Generic SPTK WS Request Broker";
    }
 
    [[nodiscard]] virtual String defaultPage() const
    {
        return "index.html";
    }
 
    virtual String wsdl() const
    {
        return String("Not defined");
    }
 
    static String tagName(const String& nodeName);
 
    static String nameSpace(const String& nodeName);
 
    sptk::LogEngine* getLogEngine()
    {
        return m_logEngine;
    }
 
protected:
    using RequestMethod = std::function<void(const sptk::xdoc::SNode&, const sptk::xdoc::SNode&,
                                             sptk::HttpAuthentication*, const sptk::WSNameSpace&)>;
 
    virtual void requestBroker(const String& requestName, const xdoc::SNode& xmlContent, const xdoc::SNode& jsonContent,
                               HttpAuthentication* authentication, const WSNameSpace& requestNameSpace);
 
    virtual void handleError(const xdoc::SNode& xmlContent, const xdoc::SNode& jsonContent,
                             const sptk::String& error, int errorCode) const;
 
    virtual void logError(const sptk::String& requestName, const sptk::String& error, int errorCode) const;
 
    xdoc::SNode findSoapBody(const xdoc::SNode& soapEnvelope, const WSNameSpace& soapNamespace);
 
    void setRequestMethods(std::map<sptk::String, RequestMethod>&& requestMethods);
 
private:
    sptk::LogEngine* m_logEngine;                           
    std::map<sptk::String, RequestMethod> m_requestMethods; 
};
 
using SWSRequest = std::shared_ptr<WSRequest>;
 
} // namespace sptk