BESShowErrorResponseHandler Class Reference

response handler that throws the requested exception type More...

#include <BESShowErrorResponseHandler.h>

Inheritance diagram for BESShowErrorResponseHandler:

Collaboration diagram for BESShowErrorResponseHandler:

Public Member Functions
	BESShowErrorResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	throws a specific exception to test error handling in clients
virtual BESResponseObject *	get_response_object ()
	return the current response object
virtual BESResponseObject *	set_response_object (BESResponseObject *o)
	replaces the current response object with the specified one, returning the current response object
virtual void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit the response object built by the execute command using the specified transmitter object

Static Public Member Functions
static BESResponseHandler *	ResponseBuilder (const std::string &name)

Protected Attributes
std::string	d_annotation_service_url
std::string	d_response_name
BESResponseObject *	d_response_object = nullptr

Detailed Description

response handler that throws the requested exception type

This response handler tests error handling of a client by throwing the requested error type

show error error_type_num;

See also

BESResponseObject

BESContainer

BESTransmitter

BESError

Definition at line 50 of file BESShowErrorResponseHandler.h.

Constructor & Destructor Documentation

BESShowErrorResponseHandler()

BESShowErrorResponseHandler::BESShowErrorResponseHandler

(

const std::string &

name

)

Definition at line 49 of file BESShowErrorResponseHandler.cc.

~BESShowErrorResponseHandler()

BESShowErrorResponseHandler::~BESShowErrorResponseHandler ( void )

virtual

Definition at line 54 of file BESShowErrorResponseHandler.cc.

Member Function Documentation

dump()

void BESShowErrorResponseHandler::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance

Parameters

strm	C++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

Definition at line 135 of file BESShowErrorResponseHandler.cc.

execute()

void BESShowErrorResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

throws a specific exception to test error handling in clients

Where error_type_num is one of the following

1. Internal Error - the error is internal to the BES Server
2. Internal Fatal Error - error is fatal, can not continue
3. Syntax User Error - the requester has a syntax error in request or config
4. Forbidden Error - the requester is forbidden to see the resource
5. Not Found Error - the resource can not be found

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESInfo

BESContextManager

Implements BESResponseHandler.

Definition at line 72 of file BESShowErrorResponseHandler.cc.

get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )

virtualinherited

return the current response object

Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.

Returns

current response object

See also

BESResponseObject

Definition at line 62 of file BESResponseHandler.cc.

ResponseBuilder()

BESResponseHandler * BESShowErrorResponseHandler::ResponseBuilder ( const std::string & name )

static

Definition at line 144 of file BESShowErrorResponseHandler.cc.

set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject * o )

virtualinherited

replaces the current response object with the specified one, returning the current response object

This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.

The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.

Parameters

o	new response object used to replace the current one

Returns

the response object being replaced

See also

BESResponseObject

Definition at line 68 of file BESResponseHandler.cc.

transmit()

void BESShowErrorResponseHandler::transmit ( BESTransmitter * transmitter, BESDataHandlerInterface & dhi )

virtual

transmit the response object built by the execute command using the specified transmitter object

If a response object was built then transmit it as text using the specified transmitter object.

Parameters

transmitter	object that knows how to transmit specific basic types
dhi	structure that holds the request and response information

See also

BESInfo

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 123 of file BESShowErrorResponseHandler.cc.

Member Data Documentation

d_annotation_service_url

std::string BESResponseHandler::d_annotation_service_url

protectedinherited

Definition at line 82 of file BESResponseHandler.h.

d_response_name

std::string BESResponseHandler::d_response_name

protectedinherited

Definition at line 79 of file BESResponseHandler.h.

d_response_object

BESResponseObject* BESResponseHandler::d_response_object = nullptr

protectedinherited

Definition at line 80 of file BESResponseHandler.h.

---

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

• BESShowErrorResponseHandler.h
• BESShowErrorResponseHandler.cc