bes  Updated for version 3.20.6
SiteMapResponseHandler.h
1 // -*- mode: c++; c-basic-offset:4 -*-
2 //
3 // SiteMapResponseHandler.h
4 //
5 // This file is part of the BES default command set
6 //
7 // Copyright (c) 2018 OPeNDAP, Inc.
8 // Author: James Gallagher <jgallagher@opendap.org>
9 //
10 // This library is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU Lesser General Public
12 // License as published by the Free Software Foundation; either
13 // version 2.1 of the License, or (at your option) any later version.
14 //
15 // This library is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 //
24 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
25 // Please read the full copyright statement in the file COPYRIGHT_URI.
26 //
27 
28 #ifndef I_SiteMapResponseHandler_h
29 #define I_SiteMapResponseHandler_h 1
30 
31 #include <string>
32 #include <vector>
33 #include <ostream>
34 
35 #include "BESResponseHandler.h"
36 #include "SiteMapCommand.h"
37 
59 public:
60  SiteMapResponseHandler(const std::string &name);
61  virtual ~SiteMapResponseHandler();
62 
63  virtual void execute(BESDataHandlerInterface &dhi);
64  virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi);
65 
66  virtual void dump(std::ostream &strm) const;
67 
68  static BESResponseHandler *SiteMapResponseBuilder(const std::string &name);
69 };
70 
71 #endif // I_SiteMapResponseHandler_h
72 
SiteMapResponseHandler::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command using the specified transmitter object
Definition: SiteMapResponseHandler.cc:152
SiteMapResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: SiteMapResponseHandler.cc:167
SiteMapResponseHandler::execute
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'show catalog|leaves [for <node>];' by returning nodes or leaves at the top leve...
Definition: SiteMapResponseHandler.cc:75
BESResponseHandler
handler object that knows how to create a specific response object
Definition: BESResponseHandler.h:77
BESTransmitter
Definition: BESTransmitter.h:47
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
SiteMapResponseHandler
Response handler that returns a site map.
Definition: SiteMapResponseHandler.h:58