platform/services/ConfigService.hpp

// ------------------------------------------------------------------------
// Pion is a development platform for building Reactors that process Events
// ------------------------------------------------------------------------
// Copyright (C) 2007-2008 Atomic Labs, Inc.  (http://www.atomiclabs.com)
//
// Pion is free software: you can redistribute it and/or modify it under the
// terms of the GNU Affero General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// Pion 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 Affero General Public License for
// more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with Pion.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef __PION_CONFIGSERVICE_HEADER__
#define __PION_CONFIGSERVICE_HEADER__

#include <pion/PionConfig.hpp>
#include "PlatformService.hpp"


namespace pion {        // begin namespace pion
namespace plugins {     // begin namespace plugins


class ConfigService
    : public pion::server::PlatformService
{
public:
    
    class MissingUIDirectoryException : public PionException {
    public:
        MissingUIDirectoryException()
            : PionException("The ConfigService configuration is missing a UIDirectory parameter") {}
    };


    ConfigService(void) : PlatformService("pion.ConfigService"), m_config_logger(PION_GET_LOGGER("config")) {}

    virtual ~ConfigService() {}

    virtual void setConfig(const pion::platform::Vocabulary& v,
                           const xmlNodePtr config_ptr);

    virtual void operator()(pion::net::HTTPRequestPtr& request,
                            pion::net::TCPConnectionPtr& tcp_conn);

protected:

    // Handles logging and sends a 400 (Bad Request) response.
    virtual void handleBadRequest(pion::net::HTTPRequestPtr& request, pion::net::TCPConnectionPtr& tcp_conn, const std::string& error_msg);

    // Handles logging and sends a 403 (Forbidden) response.
    virtual void handleForbiddenRequest(pion::net::HTTPRequestPtr& request, pion::net::TCPConnectionPtr& tcp_conn, const std::string& error_msg);

    // Handles logging and sends a 404 (Not Found) response.
    virtual void handleNotFoundRequest(pion::net::HTTPRequestPtr& request, pion::net::TCPConnectionPtr& tcp_conn);

    // Handles logging and sends a 405 (Method Not Allowed) response.
    virtual void handleMethodNotAllowed(pion::net::HTTPRequestPtr& request, pion::net::TCPConnectionPtr& tcp_conn, const std::string& allowed_methods);

    // Logs the request if it resulted in or might have been intended to result in a configuration change.
    void logRequestIfPotentialConfigChange(pion::net::HTTPRequestPtr& request, unsigned int status);

private:

    PionLogger                      m_config_logger;

    static const std::string        UI_DIRECTORY_ELEMENT_NAME;

    std::string                     m_ui_directory;
};

    
}   // end namespace plugins
}   // end namespace pion

#endif

---