OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESXMLSetContainerCommand.cc
Go to the documentation of this file.
1 // BESXMLSetContainerCommand.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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 
35 #include "BESXMLUtils.h"
36 #include "BESUtil.h"
37 #include "BESResponseNames.h"
38 #include "BESDataNames.h"
39 #include "BESSyntaxUserError.h"
40 #include "BESDebug.h"
41 
43  : BESXMLCommand( base_dhi )
44 {
45 }
46 
53 void
55 {
56  string action ; // name of the node, should be setContainer
57  string name ; // symbolic name of the container as name=""
58  string storage ; // storage of container, default is default, as space=
59  string value ; // real name of the container, e.g. path
60 
61  map<string, string> props ;
62  BESXMLUtils::GetNodeInfo( node, action, value, props ) ;
63  if( action != SETCONTAINER_STR )
64  {
65  string err = "The specified command " + action
66  + " is not a set container command" ;
67  throw BESSyntaxUserError( err, __FILE__, __LINE__ ) ;
68  }
69 
70  string cname ;
71  string cvalue ;
72  map<string, string> cprops ;
73  xmlNode *real = BESXMLUtils::GetFirstChild( node, cname, cvalue, cprops ) ;
74 
75  if( value.empty() && !real )
76  {
77  string err = action + " command: container real name missing" ;
78  throw BESSyntaxUserError( err, __FILE__, __LINE__ ) ;
79  }
80 
81  // what is the symbolic name of this container
82  name = props["name"] ;
83  if( name.empty() )
84  {
85  string err = action + " command: name property missing" ;
86  throw BESSyntaxUserError( err, __FILE__, __LINE__ ) ;
87  }
88  _dhi.data[SYMBOLIC_NAME] = name ;
89 
90  // where should this container be stored
92  storage = props["space"] ;
93  if( !storage.empty() )
94  {
95  _dhi.data[STORE_NAME] = storage ;
96  }
97  else
98  {
99  storage = PERSISTENCE_VOLATILE ;
100  }
101 
102  // this can be the empty string, so just set it this way
103  string container_type = props["type"] ;
104  _dhi.data[CONTAINER_TYPE] = container_type ;
105 
106  // now that everything has passed tests, set the value in the dhi
107  _dhi.data[REAL_NAME] = value ;
108 
109  // if there is a child node, then the real value of the container is
110  // this content, or is set in this content.
111  if( real )
112  {
113  xmlBufferPtr buf = xmlBufferCreate() ;
114  xmlNodeDump( buf, real->doc, real, 2, 1 ) ;
115  if( buf->content )
116  {
117  value = (char *)buf->content ;
118  _dhi.data[REAL_NAME] = (char *)(buf->content) ;
119  }
120  }
121 
123 
124  _str_cmd = (string)"set container in " + storage
125  + " values " + name + "," + value ;
126  if( !container_type.empty() )
127  {
128  _str_cmd += "," + container_type ;
129  }
130  _str_cmd += ";" ;
131 
132  // now that we've set the action, go get the response handler for the
133  // action
135 }
136 
143 void
144 BESXMLSetContainerCommand::dump( ostream &strm ) const
145 {
146  strm << BESIndent::LMarg << "BESXMLSetContainerCommand::dump - ("
147  << (void *)this << ")" << endl ;
149  BESXMLCommand::dump( strm ) ;
151 }
152 
155 {
156  return new BESXMLSetContainerCommand( base_dhi ) ;
157 }
158 
#define STORE_NAME
Definition: BESDataNames.h:54
static xmlNode * GetFirstChild(xmlNode *node, string &child_name, string &child_value, map< string, string > &child_props)
get the first element child node for the given node
Definition: BESXMLUtils.cc:145
static void GetNodeInfo(xmlNode *node, string &name, string &value, map< string, string > &props)
get the name, value if any, and any properties for the specified node
Definition: BESXMLUtils.cc:105
BESDataHandlerInterface _dhi
Definition: BESXMLCommand.h:57
static void Indent()
Definition: BESIndent.cc:38
error thrown if there is a user syntax error in the request or any other user error ...
virtual void set_response()
The request has been parsed, use the command action name to set the response handler.
#define PERSISTENCE_VOLATILE
#define SETCONTAINER_STR
static BESXMLCommand * CommandBuilder(const BESDataHandlerInterface &base_dhi)
virtual void parse_request(xmlNode *node)
parse a set container command.
static ostream & LMarg(ostream &strm)
Definition: BESIndent.cc:73
#define SETCONTAINER
#define REAL_NAME
Definition: BESDataNames.h:56
#define SYMBOLIC_NAME
Definition: BESDataNames.h:55
#define CONTAINER_TYPE
Definition: BESDataNames.h:58
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.
static void UnIndent()
Definition: BESIndent.cc:44
string action
the response object requested, e.g.
virtual void dump(ostream &strm) const
dumps information about this object
virtual void dump(ostream &strm) const
dumps information about this object
BESXMLSetContainerCommand(const BESDataHandlerInterface &base_dhi)