server::http::CustomHandlerException Class Reference

Your opinion will help to improve our service

Leave a feedback >

Table of Contents

• Detailed Description
• Public Types
• Public Member Functions
• Member Typedef Documentation
• ExternalBody
• ExtraHeaders
• HandlerErrorCode
• InternalMessage
• ServiceErrorCode
• Constructor & Destructor Documentation
• CustomHandlerException()
• Member Function Documentation
• GetCode()
• GetDetails()
• GetExternalErrorBody()
• GetExtraHeaders()
• GetHttpStatus()
• GetServiceCode()
• IsExternalErrorBodyFormatted()

#include <userver/server/http/http_error.hpp>

Detailed Description

An extension of server::handlers::CustomHandlerException that allows to specify a custom HttpStatus.

For non-HTTP protocols, the status code will be derived from the attached server::handlers::HandlerErrorCode.

Definition at line 36 of file http_error.hpp.

Inheritance diagram for server::http::CustomHandlerException:

Public Types
using	HandlerErrorCode = handlers::HandlerErrorCode
using	ServiceErrorCode = handlers::ServiceErrorCode
using	InternalMessage = handlers::InternalMessage
using	ExternalBody = handlers::ExternalBody
using	ExtraHeaders = handlers::ExtraHeaders

Public Member Functions
template<typename... Args>
	CustomHandlerException (handlers::HandlerErrorCode error_code, HttpStatus http_status, Args &&... args)
HttpStatus	GetHttpStatus () const
HandlerErrorCode	GetCode () const
const std::string &	GetServiceCode () const
bool	IsExternalErrorBodyFormatted () const
const std::string &	GetExternalErrorBody () const
const formats::json::Value &	GetDetails () const
const Headers &	GetExtraHeaders () const

Member Typedef Documentation

ExternalBody

using server::handlers::CustomHandlerException::ExternalBody = handlers::ExternalBody

inherited

Definition at line 206 of file exceptions.hpp.

ExtraHeaders

using server::handlers::CustomHandlerException::ExtraHeaders = handlers::ExtraHeaders

inherited

Definition at line 207 of file exceptions.hpp.

HandlerErrorCode

using server::handlers::CustomHandlerException::HandlerErrorCode = handlers::HandlerErrorCode

inherited

Definition at line 203 of file exceptions.hpp.

InternalMessage

using server::handlers::CustomHandlerException::InternalMessage = handlers::InternalMessage

inherited

Definition at line 205 of file exceptions.hpp.

ServiceErrorCode

using server::handlers::CustomHandlerException::ServiceErrorCode = handlers::ServiceErrorCode

inherited

Definition at line 204 of file exceptions.hpp.

Constructor & Destructor Documentation

CustomHandlerException()

template<typename... Args>

server::http::CustomHandlerException::CustomHandlerException ( handlers::HandlerErrorCode error_code, HttpStatus http_status, Args &&... args )

inline

See also

server::handlers::CustomHandlerException for the description of how args that can augment error messages.

TEST(CustomHandlerException, DirectHttpSample) {
    auto exc = server::http::CustomHandlerException(
        server::handlers::HandlerErrorCode::kClientError,
        server::http::HttpStatus::kUnprocessableEntity,
        server::handlers::ExternalBody{"The provided password is too short"}
    );
 
    EXPECT_EQ(exc.GetCode(), server::handlers::HandlerErrorCode::kClientError);
    EXPECT_EQ(server::http::GetHttpStatus(exc), server::http::HttpStatus::kUnprocessableEntity);
    EXPECT_EQ(exc.GetExternalErrorBody(), "The provided password is too short");
    EXPECT_THAT(exc.what(), testing::HasSubstr("Client error"));
}

Definition at line 42 of file http_error.hpp.

Member Function Documentation

GetCode()

HandlerErrorCode server::handlers::CustomHandlerException::GetCode ( ) const

inlineinherited

Definition at line 286 of file exceptions.hpp.

GetDetails()

const formats::json::Value & server::handlers::CustomHandlerException::GetDetails ( ) const

inlineinherited

Definition at line 294 of file exceptions.hpp.

GetExternalErrorBody()

const std::string & server::handlers::CustomHandlerException::GetExternalErrorBody ( ) const

inlineinherited

Definition at line 292 of file exceptions.hpp.

GetExtraHeaders()

const Headers & server::handlers::CustomHandlerException::GetExtraHeaders ( ) const

inlineinherited

Definition at line 296 of file exceptions.hpp.

GetHttpStatus()

HttpStatus server::http::CustomHandlerException::GetHttpStatus ( ) const

inline

Definition at line 45 of file http_error.hpp.

GetServiceCode()

const std::string & server::handlers::CustomHandlerException::GetServiceCode ( ) const

inlineinherited

Definition at line 288 of file exceptions.hpp.

IsExternalErrorBodyFormatted()

bool server::handlers::CustomHandlerException::IsExternalErrorBodyFormatted ( ) const

inlineinherited

Definition at line 290 of file exceptions.hpp.

---

The documentation for this class was generated from the following file:

• userver/server/http/http_error.hpp