bes  Updated for version 3.20.6
BESDapResponseBuilder.h
1 // -*- mode: c++; c-basic-offset:4 -*-
2 
3 // This file is part of libdap, A C++ implementation of the OPeNDAP Data
4 // Access Protocol.
5 
6 // Copyright (c) 2011 OPeNDAP, Inc.
7 // Author: James Gallagher <jgallagher@opendap.org>
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 OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
24 
25 #ifndef _response_builder_h
26 #define _response_builder_h
27 
28 #include <string>
29 
30 #define DAP_PROTOCOL_VERSION "3.2"
31 
32 #undef DAP2_STORED_RESULTS
33 
36 class BESResponseObject;
37 class BRDRequestHandler;
38 
39 namespace libdap {
40  class ConstraintEvaluator;
41  class DDS;
42  class DAS;
43 }
44 
45 
54 public:
55  friend class ResponseBuilderTest;
56 
57 protected:
58  std::string d_dataset;
59  std::string d_dap2ce;
60  std::string d_dap4ce;
61  std::string d_dap4function;
62  std::string d_btp_func_ce;
63  int d_timeout;
64  std::string d_default_protocol;
65 
67 
72  std::string d_async_accepted;
73 
80  std::string d_store_result;
81 
82  void initialize();
83 
84 #ifdef DAP2_STORED_RESULTS
85  bool store_dap2_result(ostream &out, libdap::DDS &dds, libdap::ConstraintEvaluator &eval);
86 #endif
87 
88  void send_dap4_data_using_ce(std::ostream &out, libdap::DMR &dmr, bool with_mime_headersr);
89 
90 public:
91 
95  BESDapResponseBuilder(): d_dataset(""), d_dap2ce(""), d_dap4ce(""), d_dap4function(""),
96  d_btp_func_ce(""), d_timeout(0), d_default_protocol(DAP_PROTOCOL_VERSION),
98  {
99  initialize();
100  }
101 
102  virtual ~BESDapResponseBuilder();
103 
104  virtual std::string get_ce() const;
105  virtual void set_ce(std::string _ce);
106 
107  virtual std::string get_dap4ce() const;
108  virtual void set_dap4ce(std::string _ce);
109 
110  virtual std::string get_dap4function() const;
111  virtual void set_dap4function(std::string _func);
112 
113  virtual std::string get_store_result() const;
114  virtual void set_store_result(std::string _sr);
115 
116  virtual std::string get_async_accepted() const;
117  virtual void set_async_accepted(std::string _aa);
118 
119  virtual std::string get_btp_func_ce() const
120  {
121  return d_btp_func_ce;
122  }
123  virtual void set_btp_func_ce(std::string _ce)
124  {
125  d_btp_func_ce = _ce;
126  }
127 
128  virtual std::string get_dataset_name() const;
129  virtual void set_dataset_name(const std::string _dataset);
130 
135  void register_timeout() const;
137  void set_timeout(int timeout = 0);
138  int get_timeout() const;
139  void timeout_on() const;
140  void timeout_off();
141 
142  virtual void establish_timeout(std::ostream &stream) const;
143  virtual void remove_timeout() const;
145 
147 
148  virtual void split_ce(libdap::ConstraintEvaluator &eval, const std::string &expr = "");
149 
150  virtual void send_das(std::ostream &out, libdap::DAS &das, bool with_mime_headers = true) const;
151  virtual void send_das(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator &eval, bool constrained =
152  false, bool with_mime_headers = true);
153 
154  virtual void send_dds(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator &eval, bool constrained =
155  false, bool with_mime_headers = true);
156 
157  virtual void serialize_dap2_data_dds(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator &eval,
158  bool ce_eval = true);
159  virtual void send_dap2_data(std::ostream &data_stream, libdap::DDS **dds, libdap::ConstraintEvaluator &eval,
160  bool with_mime_headers = true);
161  virtual void send_dap2_data(BESDataHandlerInterface &dhi, libdap::DDS **dds, libdap::ConstraintEvaluator &eval,
162  bool with_mime_headers = true);
163 
164 
165  // Added jhrg 9/1/16
166  virtual libdap::DDS *intern_dap2_data(BESResponseObject *obj, BESDataHandlerInterface &dhi);
167  virtual libdap::DDS *process_dap2_dds(BESResponseObject *obj, BESDataHandlerInterface &dhi);
168 
169  // TODO jhrg 9/6/16
170  //
171  // virtual libdap::DMR *intern_dap4_data(BESResponseObject *obj, BESDataHandlerInterface &dhi);
172 
173  virtual void send_ddx(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator &eval,
174  bool with_mime_headers = true);
175 
176 #ifdef DAP2_STORED_RESULTS
177  virtual void serialize_dap2_data_ddx(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator & eval,
178  const std::string &boundary, const std::string &start, bool ce_eval = true);
179 #endif
180  virtual void send_dmr(std::ostream &out, libdap::DMR &dmr, bool with_mime_headers = true);
181 
182  virtual void send_dap4_data(std::ostream &out, libdap::DMR & dmr, bool with_mime_headers = true);
183 
184  virtual void serialize_dap4_data(std::ostream &out, libdap::DMR &dmr, bool with_mime_headers = true);
185 
186  virtual bool store_dap4_result(ostream &out, libdap::DMR &dmr);
187 };
188 
189 
190 #endif // _response_builder_h
BESDapResponseBuilder::establish_timeout
virtual void establish_timeout(std::ostream &stream) const
Definition: BESDapResponseBuilder.cc:363
BESDapResponseBuilder::conditional_timeout_cancel
void conditional_timeout_cancel()
Definition: BESDapResponseBuilder.cc:332
BESDapResponseBuilder::timeout_on
void timeout_on() const
Definition: BESDapResponseBuilder.cc:294
BESDapResponseBuilder::d_async_accepted
std::string d_async_accepted
Should a timeout be cancelled once transmission starts?
Definition: BESDapResponseBuilder.h:72
BESDapResponseBuilder::store_dap4_result
virtual bool store_dap4_result(ostream &out, libdap::DMR &dmr)
Definition: BESDapResponseBuilder.cc:1489
BESDapResponseBuilder::get_dataset_name
virtual std::string get_dataset_name() const
Get the dataset name.
Definition: BESDapResponseBuilder.cc:251
BESDapResponseBuilder::d_default_protocol
std::string d_default_protocol
Response timeout after N seconds.
Definition: BESDapResponseBuilder.h:64
BESDapResponseBuilder::d_dap2ce
std::string d_dap2ce
Name of the dataset/database.
Definition: BESDapResponseBuilder.h:59
BESDapResponseBuilder::send_ddx
virtual void send_ddx(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator &eval, bool with_mime_headers=true)
Definition: BESDapResponseBuilder.cc:1286
BESDapResponseBuilder::register_timeout
void register_timeout() const
Definition: BESDapResponseBuilder.cc:346
BESDapResponseBuilder::split_ce
virtual void split_ce(libdap::ConstraintEvaluator &eval, const std::string &expr="")
Definition: BESDapResponseBuilder.cc:418
BESDapResponseBuilder::get_dap4ce
virtual std::string get_dap4ce() const
Get the DAP4 constraint expression.
Definition: BESDapResponseBuilder.cc:177
BESDapResponseBuilder::d_store_result
std::string d_store_result
Definition: BESDapResponseBuilder.h:80
BESDapResponseBuilder::send_dds
virtual void send_dds(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator &eval, bool constrained=false, bool with_mime_headers=true)
Transmit a DDS.
Definition: BESDapResponseBuilder.cc:605
BESDapResponseBuilder::initialize
void initialize()
Definition: BESDapResponseBuilder.cc:125
BESDapResponseBuilder::BESDapResponseBuilder
BESDapResponseBuilder()
Definition: BESDapResponseBuilder.h:95
BESDapResponseBuilder::get_timeout
int get_timeout() const
Definition: BESDapResponseBuilder.cc:282
libdap
Definition: BESDapFunctionResponseCache.h:35
BESDapResponseBuilder::set_dap4function
virtual void set_dap4function(std::string _func)
Definition: BESDapResponseBuilder.cc:216
BESDapResponseBuilder::d_btp_func_ce
std::string d_btp_func_ce
DAP4 Server Side Function expression.
Definition: BESDapResponseBuilder.h:62
BESDapResponseBuilder::set_dataset_name
virtual void set_dataset_name(const std::string _dataset)
Set the dataset pathname.
Definition: BESDapResponseBuilder.cc:266
BESDapResponseBuilder::d_dap4ce
std::string d_dap4ce
DAP2 Constraint expression.
Definition: BESDapResponseBuilder.h:60
BESDapResponseBuilder::set_ce
virtual void set_ce(std::string _ce)
Definition: BESDapResponseBuilder.cc:169
BESDapResponseBuilder::intern_dap2_data
virtual libdap::DDS * intern_dap2_data(BESResponseObject *obj, BESDataHandlerInterface &dhi)
Definition: BESDapResponseBuilder.cc:980
BESDapResponseBuilder::serialize_dap4_data
virtual void serialize_dap4_data(std::ostream &out, libdap::DMR &dmr, bool with_mime_headers=true)
Definition: BESDapResponseBuilder.cc:1444
BESDapResponseBuilder
Definition: BESDapResponseBuilder.h:53
BESDapResponseBuilder::set_timeout
void set_timeout(int timeout=0)
Definition: BESDapResponseBuilder.cc:276
BESDapResponseBuilder::get_dap4function
virtual std::string get_dap4function() const
Get the DAP4 server side function expression.
Definition: BESDapResponseBuilder.cc:200
BESDapResponseBuilder::set_dap4ce
virtual void set_dap4ce(std::string _ce)
Definition: BESDapResponseBuilder.cc:192
BESDapResponseBuilder::timeout_off
void timeout_off()
Definition: BESDapResponseBuilder.cc:309
BESDapResponseBuilder::process_dap2_dds
virtual libdap::DDS * process_dap2_dds(BESResponseObject *obj, BESDataHandlerInterface &dhi)
Process a DDS (i.e., apply a constraint) for a non-DAP transmitter.
Definition: BESDapResponseBuilder.cc:911
BESDapResponseBuilder::get_ce
virtual std::string get_ce() const
Get the constraint expression.
Definition: BESDapResponseBuilder.cc:154
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
BESDapResponseBuilder::d_cancel_timeout_on_send
bool d_cancel_timeout_on_send
Version string for the library's default protocol version.
Definition: BESDapResponseBuilder.h:66
BESDapResponseBuilder::d_dap4function
std::string d_dap4function
DAP4 Constraint expression.
Definition: BESDapResponseBuilder.h:61
BESDapFunctionResponseCache
Cache the results from server functions.
Definition: BESDapFunctionResponseCache.h:72
BESResponseObject
Abstract base class representing a specific set of information in response to a request to the BES.
Definition: BESResponseObject.h:45
BESDapResponseBuilder::serialize_dap2_data_dds
virtual void serialize_dap2_data_dds(std::ostream &out, libdap::DDS **dds, libdap::ConstraintEvaluator &eval, bool ce_eval=true)
Definition: BESDapResponseBuilder.cc:791
BESDapResponseBuilder::remove_timeout
virtual void remove_timeout() const
Transmit data.
Definition: BESDapResponseBuilder.cc:890
BESDapResponseBuilder::d_timeout
int d_timeout
The BTP functions, extracted from the CE.
Definition: BESDapResponseBuilder.h:63