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