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

#include <BESSetContextResponseHandler.h>

Inheritance diagram for BESSetContextResponseHandler:

Public Member Functions
	BESSetContextResponseHandler (const string &name)

virtual void	dump (ostream &strm) const
	dumps information about this object More...

virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command to set context within the BES More...

virtual string	get_name () const
	return the name of this response object More...

virtual BESResponseObject *	get_response_object ()
	return the current response object More...

virtual BESResponseObject *	set_response_object (BESResponseObject *o)
	replaces the current response object with the specified one, returning the current response object More...

virtual void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit the response object built by the execute command using the specified transmitter object More...

Static Public Member Functions
static BESResponseHandler *	SetContextResponseBuilder (const string &name)

Protected Attributes
BESResponseObject *	_response

string	_response_name

Detailed Description

This response handler set context withiin 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.

Member Function Documentation

void BESSetContextResponseHandler::dump ( ostream & strm ) const

virtual

Displays the pointer value of this instance

Parameters

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

Reimplemented from BESResponseHandler.

Definition at line 117 of file BESSetContextResponseHandler.cc.

References BESResponseHandler::dump().

void BESSetContextResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

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 65 of file BESSetContextResponseHandler.cc.

References BESDataHandlerInterface::data, and BESContextManager::set_context().

virtual string BESResponseHandler::get_name ( ) const

inlinevirtualinherited

This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...

Returns: response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::dump().

BESResponseObject * BESResponseHandler::get_response_object ( )

virtualinherited

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 53 of file BESResponseHandler.cc.

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject * o )

virtualinherited

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 59 of file BESResponseHandler.cc.

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

virtual

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 98 of file BESSetContextResponseHandler.cc.

References BESInfo::transmit().

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation