OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESDDXResponseHandler.cc
Go to the documentation of this file.
1 // BESDDXResponseHandler.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 "BESDDXResponseHandler.h"
34 #include "BESDASResponse.h"
35 #include "BESDDSResponse.h"
36 #include "BESDapNames.h"
37 #include "BESDataNames.h"
38 #include "BESRequestHandlerList.h"
39 //#include "BESDapTransmit.h"
40 
41 #include "BESDebug.h"
42 
44  BESResponseHandler(name)
45 {
46 }
47 
49 {
50 }
51 
67 {
68  BESDEBUG( "dap", "Entering BESDDXResponseHandler::execute" << endl );
69 
71  // Create the DDS.
72  // NOTE: It is the responsibility of the specific request handler to set
73  // the BaseTypeFactory. It is set to NULL here
74  DDS *dds = new DDS(NULL, "virtual");
75 
76  BESDDSResponse *bdds = new BESDDSResponse(dds);
77  _response = bdds;
79  dhi.action = DDS_RESPONSE;
80 
81  BESDEBUG( "bes", "about to set dap version to: " << bdds->get_dap_client_protocol() << endl);
82  BESDEBUG( "bes", "about to set xml:base to: " << bdds->get_request_xml_base() << endl);
83 
84  // I added these two lines from BESDDXResponse. jhrg 10/05/09
85  // Note that the get_dap_client_protocol(), ..., methods
86  // are defined in BESDapResponse - these are not the methods of the
87  // same name in DDS. 2/23/11 jhrg
88 
89  // Set the DAP protocol version requested by the client. 2/25/11 jhrg
90 
91  dhi.first_container();
92  BESDEBUG("version", "Initial CE: " << dhi.container->get_constraint() << endl);
93  dhi.container->set_constraint(dds->get_keywords().parse_keywords(dhi.container->get_constraint()));
94  BESDEBUG("version", "CE after keyword processing: " << dhi.container->get_constraint() << endl);
95 
96  if (dds->get_keywords().has_keyword("dap")) {
97  BESDEBUG("version",
98  "Has keyword 'dap', setting version to: " << dds->get_keywords().get_keyword_value("dap") << endl);
99  dds->set_dap_version(dds->get_keywords().get_keyword_value("dap"));
100  }
101  else if (!bdds->get_dap_client_protocol().empty()) {
102  BESDEBUG("version",
103  "Has non-empty dap version info in bdds, setting version to: " << bdds->get_dap_client_protocol() << endl);
104  dds->set_dap_version(bdds->get_dap_client_protocol());
105  }
106  else {
107  BESDEBUG("version", "Has no clue about dap version, using default." << endl);
108  }
109 
110  dds->set_request_xml_base(bdds->get_request_xml_base());
111 
113 
114  dhi.action = DDX_RESPONSE;
115  _response = bdds;
116 
117  BESDEBUG( "dap", "Leaving BESDDXResponseHandler::execute" << endl);
118 }
119 
133 {
134  if (_response) {
135  transmitter->send_response(DDX_SERVICE, _response, dhi);
136  }
137 }
138 
145 void BESDDXResponseHandler::dump(ostream &strm) const
146 {
147  strm << BESIndent::LMarg << "BESDDXResponseHandler::dump - (" << (void *) this << ")" << endl;
151 }
152 
155 {
156  return new BESDDXResponseHandler(name);
157 }
158 
string get_dap_client_protocol() const
Return the dap version string sent by the client (e.g., the OLFS)
string get_constraint() const
retrieve the constraint expression for this container
Definition: BESContainer.h:150
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command
#define DDX_RESPONSE
Definition: BESDapNames.h:64
Represents an OPeNDAP DDS DAP2 data object within the BES.
static void Indent()
Definition: BESIndent.cc:38
static BESResponseHandler * DDXResponseBuilder(const string &name)
BESResponseObject * _response
BESDDXResponseHandler(const string &name)
handler object that knows how to create a specific response object
virtual void dump(ostream &strm) const
dumps information about this object
virtual void send_response(const string &method, BESResponseObject *obj, BESDataHandlerInterface &dhi)
static ostream & LMarg(ostream &strm)
Definition: BESIndent.cc:73
#define DDX_SERVICE
Definition: BESDapNames.h:65
virtual void execute_each(BESDataHandlerInterface &dhi)
for each container in the given data handler interface, execute the given request ...
void set_constraint(const string &s)
set the constraint for this container
Definition: BESContainer.h:102
string get_request_xml_base() const
Return the xml:base URL for this request.
virtual void dump(ostream &strm) const
dumps information about this object
static BESRequestHandlerList * TheList()
Structure storing information used by the BES to handle the request.
#define DDX_RESPONSE_STR
Definition: BESDapNames.h:67
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'get ddx for def_name;'
void first_container()
set the container pointer to the first container in the containers list
#define BESDEBUG(x, y)
macro used to send debug information to the debug stream
Definition: BESDebug.h:64
static void UnIndent()
Definition: BESIndent.cc:44
virtual ~BESDDXResponseHandler(void)
string action
the response object requested, e.g.
#define DDS_RESPONSE
Definition: BESDapNames.h:59
BESContainer * container
pointer to current container in this interface