1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
// Copyright Maarten L. Hekkelman, 2014-2026
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
#pragma once
/// \file
/// definition of the base class zeep::error_handler, the default
/// creates very simple HTTP replies. Override to do something more fancy.
#include "zeep/http/server.hpp"
#include "zeep/http/template-processor.hpp"
namespace zeep::http
{
/// \brief A base class for error-handler classes
///
/// To handle errors decently when there are multiple controllers.
class error_handler
{
public:
error_handler(const error_handler &) = delete;
error_handler &operator=(const error_handler &) = delete;
virtual ~error_handler() = default;
/// \brief set the server object we're bound to
void set_server(basic_server *s) { m_server = s; }
/// \brief get the server object we're bound to
[[nodiscard]] basic_server *get_server() { return m_server; }
/// \brief set the server object we're bound to
[[nodiscard]] const basic_server *get_server() const { return m_server; }
/// \brief Create an error reply for an exception
///
/// This function is called by server with the captured exception.
/// \param req The request that triggered this call
/// \param eptr The captured exception, use std::rethrow_exception to use this
/// \param rep Write the reply in this object
/// \return Return true if the reply was created successfully
[[nodiscard]] virtual bool create_error_reply(const request &req, const std::exception_ptr &eptr, reply &rep);
/// \brief Create an error reply for the error containing a validation header
///
/// When a authentication violation is encountered, this function is called to generate
/// the appropriate reply.
/// \param req The request that triggered this call
/// \param rep Write the reply in this object
/// \return Return true if the reply was created successfully
[[nodiscard]] virtual bool create_unauth_reply(const request &req, reply &rep);
/// \brief Create an error reply for the error
///
/// An error should be returned with HTTP status code \a status. This method will create a default error page.
/// \param req The request that triggered this call
/// \param status The status code, describing the error
/// \param rep Write the reply in this object
/// \return Return true if the reply was created successfully
[[nodiscard]] virtual bool create_error_reply(const request &req, status_type status, reply &rep);
/// \brief Create an error reply for the error with an additional message for the user
///
/// An error should be returned with HTTP status code \a status and additional information \a message.
/// This method will create a default error page.
/// \param req The request that triggered this call
/// \param status The error that triggered this call
/// \param message The message describing the error
/// \param rep Write the reply in this object
/// \return Return true if the reply was created successfully
[[nodiscard]] virtual bool create_error_reply(const request &req, status_type status, std::string message, reply &rep);
protected:
/// \brief constructor
///
/// If \a error_template is not empty, the error handler will try to
/// load this XHTML template using the server's template_processor.
/// If that fails or error_template is empty, a simple stock message
/// is returned.
error_handler(std::string error_template = "error");
basic_server *m_server = nullptr;
std::string m_error_template;
};
// --------------------------------------------------------------------
/// \brief A default implementation of @ref error_handler
///
/// This default handler will reply with a HTML page rendered using
/// a template named "error"
class default_error_handler : public error_handler
{
public:
default_error_handler(std::string error_template = "error")
: error_handler(std::move(error_template))
{
}
[[nodiscard]] bool create_error_reply(const request &req, const std::exception_ptr &eptr, reply &rep) override;
};
} // namespace zeep::http
|
