bes Updated for version 3.20.13
BESResponseHandler.h
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., 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#ifndef I_BESResponseHandler_h
34#define I_BESResponseHandler_h 1
35
36#include <string>
37
38#include "BESObj.h"
39
42class BESTransmitter;
43
78protected:
79 std::string d_response_name;
80 BESResponseObject *d_response_object;
81
82 std::string d_annotation_service_url; //< If not null, include this in the DAS/DMR
83#if 0
84 // Do this later if it seems advisable to 'bake the web api' into this. jhrg 12/19/18
85 bool d_include_dataset_in_annotation_url; //< include the dataset URL if true
86#endif
87
88 friend class resplistT;
89
90 BESResponseHandler(const std::string &name);
91
92public:
93 virtual ~BESResponseHandler();
94
105
121
136 virtual void execute(BESDataHandlerInterface &dhi) = 0;
137
149 virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi) = 0;
150
151#if 0
164 virtual std::string get_name() const {
165 return d_response_name;
166 }
167#endif
168
169 virtual void dump(std::ostream &strm) const;
170};
171
172#endif // I_BESResponseHandler_h
173
Structure storing information used by the BES to handle the request.
top level BES object to house generic methods
Definition: BESObj.h:54
handler object that knows how to create a specific response object
virtual void dump(std::ostream &strm) const
dumps information about this object
virtual BESResponseObject * set_response_object(BESResponseObject *o)
replaces the current response object with the specified one, returning the current response object
virtual BESResponseObject * get_response_object()
return the current response object
virtual void execute(BESDataHandlerInterface &dhi)=0
knows how to build a requested response object
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the response object built by the execute command using the specified transmitter object
Abstract base class representing a specific set of information in response to a request to the BES.