response.h

Go to the documentation of this file.

// Copyright (C) 2016-2026 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_RESPONSE_H
#define HTTP_RESPONSE_H
 
#include <cc/data.h>
#include <http/header_context.h>
#include <http/http_message.h>
#include <http/response_context.h>
 
#include <boost/lexical_cast.hpp>
#include <boost/shared_ptr.hpp>
#include <cstdint>
#include <string>
 
namespace isc {
namespace http {

class HttpResponseError : public HttpMessageError {
public:
    HttpResponseError(const char* file, size_t line, const char* what) :
        HttpMessageError(file, line, what) { }
};

enum class HttpStatusCode : std::uint16_t {
    OK = 200,
    CREATED = 201,
    ACCEPTED = 202,
    NO_CONTENT = 204,
    MULTIPLE_CHOICES = 300,
    MOVED_PERMANENTLY = 301,
    MOVED_TEMPORARILY = 302,
    NOT_MODIFIED = 304,
    BAD_REQUEST = 400,
    UNAUTHORIZED = 401,
    FORBIDDEN = 403,
    NOT_FOUND = 404,
    REQUEST_TIMEOUT = 408,
    INTERNAL_SERVER_ERROR = 500,
    NOT_IMPLEMENTED = 501,
    BAD_GATEWAY = 502,
    SERVICE_UNAVAILABLE = 503
};

struct CallSetGenericBody {

    explicit CallSetGenericBody(const bool set)
        : set_(set) {
    }

    static const CallSetGenericBody& yes() {
        static CallSetGenericBody yes(true);
        return (yes);
    }

    static const CallSetGenericBody& no() {
        static CallSetGenericBody no(false);
        return (no);
    }

    bool set_;
};
 
class HttpResponse;

typedef boost::shared_ptr<HttpResponse> HttpResponsePtr;

typedef boost::shared_ptr<const HttpResponse> ConstHttpResponsePtr;

class HttpResponse : public HttpMessage {
public:

    explicit HttpResponse();
 

    explicit HttpResponse(const HttpVersion& version,
                          const HttpStatusCode& status_code,
                          const CallSetGenericBody& generic_body =
                          CallSetGenericBody::yes());

    const HttpResponseContextPtr& context() const {
        return (context_);
    }

    virtual void create();

    virtual void finalize();

    virtual void reset();

    void resetContentLength();

    HttpStatusCode getStatusCode() const;

    std::string getStatusPhrase() const;

    virtual std::string getBody() const;

    data::ConstElementPtr getJsonElement(const std::string& element_name) const;

    static bool isClientError(const HttpStatusCode& status_code);

    static bool isServerError(const HttpStatusCode& status_code);

    static uint16_t statusCodeToNumber(const HttpStatusCode& status_code);

    static std::string statusCodeToString(const HttpStatusCode& status_code);

    std::string toBriefString() const;

    virtual std::string toString() const;

    virtual std::string getDateHeaderValue() const;
 
private:

    void setGenericBody(const HttpStatusCode& /*status_code*/) { }
 
protected:

    HttpResponseContextPtr context_;
};
 
} // namespace http
} // namespace isc
 
#endif