bes  Updated for version 3.20.6
BESShowDefsResponseHandler.cc
1 // BESShowDefsResponseHandler.cc
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #include "BESShowDefsResponseHandler.h"
34 #include "BESInfoList.h"
35 #include "BESInfo.h"
36 #include "BESDefinitionStorageList.h"
37 #include "BESResponseNames.h"
38 
39 using std::endl;
40 using std::string;
41 using std::ostream;
42 
43 BESShowDefsResponseHandler::BESShowDefsResponseHandler( const string &name )
44  : BESResponseHandler( name )
45 {
46 }
47 
48 BESShowDefsResponseHandler::~BESShowDefsResponseHandler( )
49 {
50 }
51 
64 void
66 {
67  BESInfo *info = BESInfoList::TheList()->build_info() ;
68  d_response_object = info ;
69  dhi.action_name = SHOWDEFS_RESPONSE_STR ;
70  info->begin_response( SHOWDEFS_RESPONSE_STR, dhi ) ;
71  BESDefinitionStorageList::TheList()->show_definitions( *info ) ;
72  info->end_response() ;
73 }
74 
87 void
90 {
91  if( d_response_object )
92  {
93  BESInfo *info = dynamic_cast<BESInfo *>(d_response_object) ;
94  if( !info )
95  throw BESInternalError( "cast error", __FILE__, __LINE__ ) ;
96  info->transmit( transmitter, dhi ) ;
97  }
98 }
99 
106 void
107 BESShowDefsResponseHandler::dump( ostream &strm ) const
108 {
109  strm << BESIndent::LMarg << "BESShowDefsResponseHandler::dump - ("
110  << (void *)this << ")" << endl ;
111  BESIndent::Indent() ;
112  BESResponseHandler::dump( strm ) ;
113  BESIndent::UnIndent() ;
114 }
115 
117 BESShowDefsResponseHandler::ShowDefsResponseBuilder( const string &name )
118 {
119  return new BESShowDefsResponseHandler( name ) ;
120 }
121 
BESShowDefsResponseHandler
response handler that returns list of definitions currently defined
Definition: BESShowDefsResponseHandler.h:49
BESShowDefsResponseHandler::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command using the specified transmitter object
Definition: BESShowDefsResponseHandler.cc:88
BESResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESResponseHandler.cc:102
BESInfo::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the informational object
BESInfo
informational response object
Definition: BESInfo.h:63
BESShowDefsResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESShowDefsResponseHandler.cc:107
BESInternalError
exception thrown if internal error encountered
Definition: BESInternalError.h:43
BESResponseHandler
handler object that knows how to create a specific response object
Definition: BESResponseHandler.h:77
BESTransmitter
Definition: BESTransmitter.h:47
BESShowDefsResponseHandler::execute
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'show definitions;' by returning the list of currently defined definitions
Definition: BESShowDefsResponseHandler.cc:65
BESDefinitionStorageList::show_definitions
virtual void show_definitions(BESInfo &info)
show information for each definition in each persistence store
Definition: BESDefinitionStorageList.cc:272
BESInfo::begin_response
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESInfo.cc:124
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56