OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
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:
Inheritance graph
Collaboration diagram for BESSetContextResponseHandler:
Collaboration graph

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 BESResponseObjectget_response_object ()
 return the current response object More...
 
virtual BESResponseObjectset_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...
 
virtual ~BESSetContextResponseHandler (void)
 

Static Public Member Functions

static BESResponseHandlerSetContextResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

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

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.

Constructor & Destructor Documentation

BESSetContextResponseHandler::BESSetContextResponseHandler ( const string &  name)

Definition at line 40 of file BESSetContextResponseHandler.cc.

Referenced by SetContextResponseBuilder().

BESSetContextResponseHandler::~BESSetContextResponseHandler ( void  )
virtual

Definition at line 45 of file BESSetContextResponseHandler.cc.

Member Function Documentation

void BESSetContextResponseHandler::dump ( ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

Definition at line 117 of file BESSetContextResponseHandler.cc.

References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

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
dhistructure that holds request and response information
Exceptions
BESSyntaxUserErrorif no context name was given object
See also
BESDataHandlerInterface
BESInfo
BESContextManager

Implements BESResponseHandler.

Definition at line 65 of file BESSetContextResponseHandler.cc.

References BESResponseHandler::_response, BESDataHandlerInterface::action_name, CONTEXT_NAME, CONTEXT_VALUE, BESDataHandlerInterface::data, BESContextManager::set_context(), SET_CONTEXT_STR, and BESContextManager::TheManager().

Here is the call graph for this function:

virtual string BESResponseHandler::get_name ( ) const
inlinevirtualinherited

return the name of this response object

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::_response_name.

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

References BESResponseHandler::_response.

Referenced by DapRequestHandler::dap_build_das(), DapRequestHandler::dap_build_data(), DapRequestHandler::dap_build_dds(), DapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_help(), DapRequestHandler::dap_build_vers(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_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
onew 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.

References BESResponseHandler::_response.

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

Definition at line 127 of file BESSetContextResponseHandler.cc.

References BESSetContextResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

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
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESInfo
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 98 of file BESSetContextResponseHandler.cc.

References BESResponseHandler::_response, and BESInfo::transmit().

Here is the call graph for this function:

Member Data Documentation

BESResponseObject* BESResponseHandler::_response
protectedinherited

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESServicesResponseHandler::execute(), BESConfigResponseHandler::execute(), BESDDSResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESStatusResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESVersionResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESHelpResponseHandler::execute(), execute(), BESDelDefResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDDXResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDDXResponseHandler::transmit(), transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

string BESResponseHandler::_response_name
protectedinherited

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