OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESResponseHandler.h
Go to the documentation of this file.
1 // BESResponseHandler.h
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 #ifndef I_BESResponseHandler_h
34 #define I_BESResponseHandler_h 1
35 
36 #include <string>
37 
38 #include "BESObj.h"
39 #include "BESResponseObject.h"
41 #include "BESTransmitter.h"
42 
43 using std::string ;
44 #if 0
45 class BESResponseObject ;
46 #endif
47 
81 class BESResponseHandler : public BESObj
82 {
83 protected:
84  string _response_name ;
86 
87  BESResponseHandler( const string &name ) ;
88 public:
89  virtual ~BESResponseHandler(void) ;
90 
101 
117 
132  virtual void execute( BESDataHandlerInterface &dhi ) = 0 ;
133 
145  virtual void transmit( BESTransmitter *transmitter,
146  BESDataHandlerInterface &dhi ) = 0 ;
147 
156  virtual string get_name( ) const { return _response_name ; }
157 
158  virtual void dump( ostream &strm ) const ;
159 };
160 
161 #endif // I_BESResponseHandler_h
162 
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the response object built by the execute command using the specified transmitter object ...
virtual void execute(BESDataHandlerInterface &dhi)=0
knows how to build a requested response object
virtual ~BESResponseHandler(void)
BESResponseObject * _response
virtual BESResponseObject * set_response_object(BESResponseObject *o)
replaces the current response object with the specified one, returning the current response object ...
Base object for bes objects.
Definition: BESObj.h:52
handler object that knows how to create a specific response object
virtual BESResponseObject * get_response_object()
return the current response object
virtual void dump(ostream &strm) const
dumps information about this object
Structure storing information used by the BES to handle the request.
virtual string get_name() const
return the name of this response object
Abstract base class representing a specific set of information in response to a request to the BES...
BESResponseHandler(const string &name)