bes  Updated for version 3.20.8
BESDataDDXResponseHandler.cc
1 // BESDataDDXResponseHandler.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 "config.h"
34 
35 #include <DataDDS.h>
36 
37 #include "BESDataDDXResponseHandler.h"
38 #include "BESDataDDSResponse.h"
39 #include "BESRequestHandlerList.h"
40 #include "BESDapNames.h"
41 #include "BESDataNames.h"
42 #include "BESTransmitter.h"
43 
44 #include "BESDebug.h"
45 
46 using namespace libdap;
47 using namespace std;
48 
49 BESDataDDXResponseHandler::BESDataDDXResponseHandler( const string &name )
50  : BESResponseHandler( name )
51 {
52 }
53 
54 BESDataDDXResponseHandler::~BESDataDDXResponseHandler( )
55 {
56 }
57 
72 void
74 {
75  BESDEBUG( "dap", "Entering BESDataDDXResponseHandler::execute" << endl ) ;
76 
77  dhi.action_name = DATADDX_RESPONSE_STR ;
78  // Create the DDS.
79  // NOTE: It is the responsibility of the specific request handler to set
80  // the BaseTypeFactory. It is set to NULL here
81  DDS *dds = new DDS( NULL, "virtual" ) ;
82  BESDataDDSResponse *bdds = new BESDataDDSResponse( dds ) ;
83  d_response_object = bdds ;
84 
85  // we're actually going to get the data response, it just gets
86  // displayed as a DataDDX
87  d_response_name = DATA_RESPONSE ;
88  dhi.action = DATA_RESPONSE ;
89 
90 #if 0
91  // Read keywords from the CE and use those to set the DAP version; maybe
92  // other things. If the dap version(s) are not included in the CE using
93  // keywords, then see if anything was sent in the Request headers (which
94  // the OLFS will parse); the BES includes that info in the BESDapResponse
95  // object.
96 
97  // Set the DAP protocol version requested by the client. 2/25/11 jhrg
98 
99  dhi.first_container();
100  BESDEBUG("version", "Initial CE: " << dhi.container->get_constraint() << endl);
101  dhi.container->set_constraint(dds->get_keywords().parse_keywords(dhi.container->get_constraint()));
102  BESDEBUG("version", "CE after keyword processing: " << dhi.container->get_constraint() << endl);
103 
104  dhi.data[POST_CONSTRAINT] = dds->get_keywords().parse_keywords(dhi.data[POST_CONSTRAINT]);
105  if (dds->get_keywords().has_keyword("dap")) {
106  dds->set_dap_version(dds->get_keywords().get_keyword_value("dap"));
107  }
108  else if (!bdds->get_dap_client_protocol().empty()) {
109  dds->set_dap_version( bdds->get_dap_client_protocol() );
110  }
111 #endif
112 
113  if (!bdds->get_dap_client_protocol().empty()) {
114  dds->set_dap_version( bdds->get_dap_client_protocol() );
115  }
116 
117  dds->set_request_xml_base( bdds->get_request_xml_base() );
118 
119  BESRequestHandlerList::TheList()->execute_each( dhi ) ;
120 
121  // we've got what we want, now set the action back to data ddx
122  dhi.action = DATADDX_RESPONSE ;
123  d_response_object = bdds ;
124 
125  BESDEBUG( "dap", "Leaving BESDataDDXResponseHandler::execute" << endl ) ;
126 }
127 
140 void
143 {
144  if( d_response_object )
145  {
146  transmitter->send_response( DATADDX_SERVICE, d_response_object, dhi ) ;
147  }
148 }
149 
156 void
157 BESDataDDXResponseHandler::dump( ostream &strm ) const
158 {
159  strm << BESIndent::LMarg << "BESDataDDXResponseHandler::dump - ("
160  << (void *)this << ")" << endl ;
161  BESIndent::Indent() ;
162  BESResponseHandler::dump( strm ) ;
163  BESIndent::UnIndent() ;
164 }
165 
167 BESDataDDXResponseHandler::DataDDXResponseBuilder( const string &name )
168 {
169  return new BESDataDDXResponseHandler( name ) ;
170 }
171 
void set_constraint(const std::string &s)
set the constraint for this container
Definition: BESContainer.h:118
std::string get_constraint() const
retrieve the constraint expression for this container
Definition: BESContainer.h:194
std::string get_dap_client_protocol() const
Return the dap version string sent by the client (e.g., the OLFS)
std::string get_request_xml_base() const
Return the xml:base URL for this request.
Represents an OPeNDAP DataDDS DAP2 data object within the BES.
response handler that builds an OPeNDAP DDX object
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'get ddx for def_name;'
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command
virtual void dump(std::ostream &strm) const
dumps information about this object
Structure storing information used by the BES to handle the request.
std::map< std::string, std::string > data
the map of string data that will be required for the current request.
std::string action
the response object requested, e.g. das, dds
void first_container()
set the container pointer to the first container in the containers list
BESContainer * container
pointer to current container in this interface
virtual void execute_each(BESDataHandlerInterface &dhi)
for each container in the given data handler interface, execute the given request
handler object that knows how to create a specific response object
virtual void dump(std::ostream &strm) const
dumps information about this object