http_message.h

Go to the documentation of this file.

// Copyright (C) 2017-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef HTTP_MESSAGE_H
#define HTTP_MESSAGE_H
 
#include <exceptions/exceptions.h>
#include <http/http_header.h>
#include <http/http_types.h>
#include <map>
#include <set>
#include <cstdint>
#include <string>
 
namespace isc {
namespace http {
 
class HttpMessageError : public Exception {
public:
    HttpMessageError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};
 
class HttpMessageNonExistingHeader : public HttpMessageError {
public:
    HttpMessageNonExistingHeader(const char* file, size_t line,
                                 const char* what) :
        HttpMessageError(file, line, what) { }
};
 
 
class HttpMessage {
public:
 
    enum Direction {
        INBOUND,
        OUTBOUND
    };
 
    explicit HttpMessage(const Direction& direction);
 
    virtual ~HttpMessage();
 
    Direction getDirection() const {
        return (direction_);
    }
 
    void setDirection(const Direction& direction) {
        direction_ = direction;
    }
 
    void requireHttpVersion(const HttpVersion& version);
 
    void requireHeader(const std::string& header_name);
 
    void requireHeaderValue(const std::string& header_name,
                            const std::string& header_value);
 
    bool requiresBody() const;
 
    virtual void create() = 0;
 
    virtual void finalize() = 0;
 
    virtual void reset() = 0;
 
    HttpVersion getHttpVersion() const;
 
    HttpHeaderPtr getHeader(const std::string& header_name) const;
 
    std::string getHeaderValue(const std::string& header_name) const;
 
    uint64_t getHeaderValueAsUint64(const std::string& header_name) const;
 
    virtual std::string getBody() const = 0;
 
    virtual std::string toString() const = 0;
 
    bool isFinalized() const {
        return (finalized_);
    }
 
protected:
 
    void checkCreated() const;
 
    void checkFinalized() const;
 
    template<typename T>
    bool inRequiredSet(const T& element,
                       const std::set<T>& element_set) const {
        return (element_set.empty() || element_set.count(element) > 0);
    }
 
    Direction direction_;
 
    std::set<HttpVersion> required_versions_;
 
    HttpVersion http_version_;
 
    typedef std::map<std::string, HttpHeaderPtr> HttpHeaderMap;
 
    HttpHeaderMap required_headers_;
 
    bool created_;
 
    bool finalized_;
 
    HttpHeaderMap headers_;
};
 
} // end of namespace isc::http
} // end of namespace isc
 
#endif // HTTP_MESSAGE_H