BESSetContextResponseHandler Class Reference

response handler that set context within the BES as a simple name/value pair More...

#include <BESSetContextResponseHandler.h>

Inheritance diagram for BESSetContextResponseHandler:

Collaboration diagram for BESSetContextResponseHandler:

Public Member Functions
	BESSetContextResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command to set context within the BES
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 *	SetContextResponseBuilder (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 set context within the BES as a simple name/value pair

This response handler set context within the BES using the context name and the context value as specified in the command:

set context <context_name> to <context_value>;

It has a silent return ... nothing is returned unless there is an exception condition.

See also

BESResponseObject

BESContainer

BESTransmitter

Definition at line 53 of file BESSetContextResponseHandler.h.

Constructor & Destructor Documentation

BESSetContextResponseHandler()

BESSetContextResponseHandler::BESSetContextResponseHandler

(

const std::string &

name

)

Definition at line 50 of file BESSetContextResponseHandler.cc.

~BESSetContextResponseHandler()

BESSetContextResponseHandler::~BESSetContextResponseHandler ( void )

virtual

Definition at line 55 of file BESSetContextResponseHandler.cc.

Member Function Documentation

dump()

void BESSetContextResponseHandler::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 124 of file BESSetContextResponseHandler.cc.

execute()

void BESSetContextResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command to set context within the BES

Using a context name and a context value, set that context in the context manager.

The response object is silent, i.e. nothing is returned to the client unless there is an exception condition.

Parameters

dhi	structure that holds request and response information

Exceptions

BESSyntaxUserError

if no context name was given object

See also

BESDataHandlerInterface

BESInfo

BESContextManager

Implements BESResponseHandler.

Definition at line 74 of file BESSetContextResponseHandler.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.

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.

SetContextResponseBuilder()

BESResponseHandler * BESSetContextResponseHandler::SetContextResponseBuilder ( const std::string & name )

static

Definition at line 133 of file BESSetContextResponseHandler.cc.

transmit()

void BESSetContextResponseHandler::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 107 of file BESSetContextResponseHandler.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:

• BESSetContextResponseHandler.h
• BESSetContextResponseHandler.cc