BESXMLDefaultCommands.cc

// BESXMLDefaultCommands.cc

// This file is part of bes, A C++ back-end server implementation framework
// for the OPeNDAP Data Access Protocol.

// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact University Corporation for Atmospheric Research at
// 3080 Center Green Drive, Boulder, CO 80301

// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
// Please read the full copyright statement in the file COPYRIGHT_UCAR.
//
// Authors:
//      pwest       Patrick West <pwest@ucar.edu>
//      jgarcia     Jose Garcia <jgarcia@ucar.edu>

#include "config.h"

#include <iostream>

#include "BESXMLDefaultCommands.h"

#include "BESResponseNames.h"
#include "BESResponseHandlerList.h"

#include "BESXMLShowCommand.h"
#include "BESXMLShowErrorCommand.h"
#include "BESXMLSetContextCommand.h"
#include "BESXMLSetContainerCommand.h"
#include "BESXMLDefineCommand.h"
#include "BESXMLGetCommand.h"
#include "BESXMLDeleteContainerCommand.h"
#include "BESXMLDeleteContainersCommand.h"
#include "BESXMLDeleteDefinitionCommand.h"
#include "BESXMLDeleteDefinitionsCommand.h"

#include "ShowPathInfoCommand.h"
#include "ShowBesKeyCommand.h"
#include "ShowBesKeyResponseHandler.h"

#include "SetContextsNames.h"
#include "XMLSetContextsCommand.h"

#if USE_CONTEXTS_RESPONSE_HANDLER
#include "SetContextsResponseHandler.h"
#else
#include "NullResponseHandler.h"
#endif

#include "BESDebug.h"

using std::endl;
using namespace bes;

/** @brief Loads the default set of BES XML commands
 */
int BESXMLDefaultCommands::initialize(int, char**)
{
    BESDEBUG("besxml", "Initializing default commands:" << endl);

    BESXMLCommand::add_command( SHOW_CONTEXT_STR, BESXMLShowCommand::CommandBuilder);
    BESXMLCommand::add_command( SHOWDEFS_RESPONSE_STR, BESXMLShowCommand::CommandBuilder);
    BESXMLCommand::add_command( SHOWCONTAINERS_RESPONSE_STR, BESXMLShowCommand::CommandBuilder);
    BESXMLCommand::add_command( SHOW_ERROR_STR, BESXMLShowErrorCommand::CommandBuilder);
    BESXMLCommand::add_command( HELP_RESPONSE_STR, BESXMLShowCommand::CommandBuilder);
#ifdef BES_DEVELOPER
    BESXMLCommand::add_command( PROCESS_RESPONSE_STR, BESXMLShowCommand::CommandBuilder );
    BESXMLCommand::add_command( CONFIG_RESPONSE_STR, BESXMLShowCommand::CommandBuilder );
#endif
    BESXMLCommand::add_command( VERS_RESPONSE_STR, BESXMLShowCommand::CommandBuilder);
    BESXMLCommand::add_command( STATUS_RESPONSE_STR, BESXMLShowCommand::CommandBuilder);
    BESXMLCommand::add_command( SERVICE_RESPONSE_STR, BESXMLShowCommand::CommandBuilder);

    BESXMLCommand::add_command( SET_CONTEXT_STR, BESXMLSetContextCommand::CommandBuilder);

    // A new command, added both for utility and to learn. jhrg 2/8/18
    BESXMLCommand::add_command( SET_CONTEXTS_STR, XMLSetContextsCommand::CommandBuilder);

#if USE_CONTEXTS_RESPONSE_HANDLER
    // And we can add the ResponseHandler here too, so it can all be in the same dir. jhrg 2/9/18
    BESResponseHandlerList::TheList()->add_handler(SET_CONTEXTS_ACTION, SetContextsResponseHandler::SetContextsResponseBuilder);
#else
    BESResponseHandlerList::TheList()->add_handler(NULL_ACTION, NullResponseHandler::NullResponseBuilder);
#endif

    BESXMLCommand::add_command( SETCONTAINER_STR, BESXMLSetContainerCommand::CommandBuilder);

    BESXMLCommand::add_command( DEFINE_RESPONSE_STR, BESXMLDefineCommand::CommandBuilder);

    BESXMLCommand::add_command( GET_RESPONSE, BESXMLGetCommand::CommandBuilder);

    BESXMLCommand::add_command( DELETE_CONTAINER_STR, BESXMLDeleteContainerCommand::CommandBuilder);
    BESXMLCommand::add_command( DELETE_CONTAINERS_STR, BESXMLDeleteContainersCommand::CommandBuilder);

    BESXMLCommand::add_command( DELETE_DEFINITION_STR, BESXMLDeleteDefinitionCommand::CommandBuilder);
    BESXMLCommand::add_command( DELETE_DEFINITIONS_STR, BESXMLDeleteDefinitionsCommand::CommandBuilder);

    BESDEBUG( "besxml", "    adding " << SHOW_PATH_INFO_RESPONSE_STR << " command" << endl ) ;
    BESXMLCommand::add_command( SHOW_PATH_INFO_RESPONSE_STR, ShowPathInfoCommand::CommandBuilder ) ;

    BESXMLCommand::add_command( SHOW_BES_KEY_RESPONSE_STR, ShowBesKeyCommand::CommandBuilder ) ;

    BESDEBUG("besxml", "    adding " << SHOW_BES_KEY_RESPONSE << " response handler" << endl ) ;
    BESResponseHandlerList::TheList()->add_handler( SHOW_BES_KEY_RESPONSE, ShowBesKeyResponseHandler::ShowBesKeyResponseBuilder ) ;

    BESDEBUG("besxml", "Done Initializing default commands:" << endl);

    return 0;
}

/** @brief Removes the default set of BES XML commands from the list of
 * possible commands
 */
int BESXMLDefaultCommands::terminate(void)
{
    BESDEBUG("besxml", "Removing default commands:" << endl);

    BESXMLCommand::del_command( GET_RESPONSE);
    BESXMLCommand::del_command( SHOW_CONTEXT_STR);
    BESXMLCommand::del_command( SHOWDEFS_RESPONSE_STR);
    BESXMLCommand::del_command( SHOWCONTAINERS_RESPONSE_STR);
    BESXMLCommand::del_command( HELP_RESPONSE_STR);
#ifdef BES_DEVELOPER
    BESXMLCommand::del_command( PROCESS_RESPONSE_STR );
    BESXMLCommand::del_command( CONFIG_RESPONSE_STR );
#endif
    BESXMLCommand::del_command( VERS_RESPONSE_STR);
    BESXMLCommand::del_command( STATUS_RESPONSE_STR);

    BESXMLCommand::del_command( SET_CONTEXT_STR);
    BESXMLCommand::del_command( SET_CONTEXTS_STR);
#if USE_CONTEXTS_RESPONSE_HANDLER
    BESResponseHandlerList::TheList()->remove_handler(SET_CONTEXTS_ACTION);
#else
    BESResponseHandlerList::TheList()->remove_handler(NULL_ACTION);
#endif
    BESXMLCommand::del_command( SETCONTAINER_STR);
    BESXMLCommand::del_command( DEFINE_RESPONSE_STR);
    BESXMLCommand::del_command( DELETE_CONTAINER_STR);
    BESXMLCommand::del_command( DELETE_CONTAINERS_STR);
    BESXMLCommand::del_command( DELETE_DEFINITION_STR);

    BESDEBUG("besxml", "Done Removing default commands:" << endl);

    return true;
}