blob: 9c1d2eaa55425bf8c0e859ecb8405ad8e2ed30cc [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2013-2014 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*
* ndn-cxx 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 3 of the License, or (at your option) any later version.
*
* ndn-cxx 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 copies of the GNU General Public License and GNU Lesser
* General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
* <http://www.gnu.org/licenses/>.
*
* See AUTHORS.md for complete list of ndn-cxx authors and contributors.
*/
#ifndef NDN_MANAGEMENT_NFD_CONTROL_COMMAND_HPP
#define NDN_MANAGEMENT_NFD_CONTROL_COMMAND_HPP
#include "nfd-control-parameters.hpp"
namespace ndn {
namespace nfd {
/**
* \ingroup management
* \brief base class of NFD ControlCommand
* \sa http://redmine.named-data.net/projects/nfd/wiki/ControlCommand
*/
class ControlCommand : noncopyable
{
public:
/** \brief represents an error in ControlParameters
*/
class ArgumentError : public std::invalid_argument
{
public:
explicit
ArgumentError(const std::string& what)
: std::invalid_argument(what)
{
}
};
/** \brief validate request parameters
* \throw ArgumentError if parameters are invalid
*/
virtual void
validateRequest(const ControlParameters& parameters) const;
/** \brief apply default values to missing fields in request
*/
virtual void
applyDefaultsToRequest(ControlParameters& parameters) const;
/** \brief validate response parameters
* \throw ArgumentError if parameters are invalid
*/
virtual void
validateResponse(const ControlParameters& parameters) const;
/** \brief apply default values to missing fields in response
*/
virtual void
applyDefaultsToResponse(ControlParameters& parameters) const;
/** \brief construct the Name for a request Interest
* \throw ArgumentError if parameters are invalid
*/
Name
getRequestName(const Name& commandPrefix, const ControlParameters& parameters) const;
public: // deprecated
/** \return Name prefix of this ControlCommand
* \deprecated use getRequestName
*/
DEPRECATED(
const Name&
getPrefix() const);
/** \brief construct the Name for a request Interest
* \throw ArgumentError if parameters are invalid
* \deprecated use the two-argument overload
*/
DEPRECATED(
Name
getRequestName(const ControlParameters& parameters) const);
protected:
ControlCommand(const std::string& module, const std::string& verb);
class FieldValidator
{
public:
FieldValidator();
/** \brief declare a required field
*/
FieldValidator&
required(ControlParameterField field)
{
m_required[field] = true;
return *this;
}
/** \brief declare an optional field
*/
FieldValidator&
optional(ControlParameterField field)
{
m_optional[field] = true;
return *this;
}
/** \brief verify that all required fields are present,
* and all present fields are either required or optional
* \throw ArgumentError
*/
void
validate(const ControlParameters& parameters) const;
private:
std::vector<bool> m_required;
std::vector<bool> m_optional;
};
protected:
/** \brief FieldValidator for request ControlParameters
*
* Constructor of subclass should populate this validator.
*/
FieldValidator m_requestValidator;
/** \brief FieldValidator for response ControlParameters
*
* Constructor of subclass should populate this validator.
*/
FieldValidator m_responseValidator;
private:
name::Component m_module;
name::Component m_verb;
/** \deprecated kept to support getPrefix
*/
mutable Name m_prefix;
};
/**
* \ingroup management
* \brief represents a faces/create command
* \sa http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Create-a-face
*/
class FaceCreateCommand : public ControlCommand
{
public:
FaceCreateCommand();
virtual void
validateResponse(const ControlParameters& parameters) const;
};
/**
* \ingroup management
* \brief represents a faces/destroy command
* \sa http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Destroy-a-face
*/
class FaceDestroyCommand : public ControlCommand
{
public:
FaceDestroyCommand();
virtual void
validateRequest(const ControlParameters& parameters) const;
virtual void
validateResponse(const ControlParameters& parameters) const;
};
/**
* \ingroup management
* \brief Base class for faces/[*]-local-control commands
*/
class FaceLocalControlCommand : public ControlCommand
{
public:
virtual void
validateRequest(const ControlParameters& parameters) const;
virtual void
validateResponse(const ControlParameters& parameters) const;
protected:
explicit
FaceLocalControlCommand(const std::string& verb);
};
/**
* \ingroup management
* \brief represents a faces/enable-local-control command
* \sa http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Enable-a-LocalControlHeader-feature
*/
class FaceEnableLocalControlCommand : public FaceLocalControlCommand
{
public:
FaceEnableLocalControlCommand();
};
/**
* \ingroup management
* \brief represents a faces/disable-local-control command
* \sa http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Disable-a-LocalControlHeader-feature
*/
class FaceDisableLocalControlCommand : public FaceLocalControlCommand
{
public:
FaceDisableLocalControlCommand();
};
/**
* \ingroup management
* \brief represents a fib/add-nexthop command
* \sa http://redmine.named-data.net/projects/nfd/wiki/FibMgmt#Add-a-nexthop
*/
class FibAddNextHopCommand : public ControlCommand
{
public:
FibAddNextHopCommand();
virtual void
applyDefaultsToRequest(ControlParameters& parameters) const;
virtual void
validateResponse(const ControlParameters& parameters) const;
};
/**
* \ingroup management
* \brief represents a fib/remove-nexthop command
* \sa http://redmine.named-data.net/projects/nfd/wiki/FibMgmt#Remove-a-nexthop
*/
class FibRemoveNextHopCommand : public ControlCommand
{
public:
FibRemoveNextHopCommand();
virtual void
applyDefaultsToRequest(ControlParameters& parameters) const;
virtual void
validateResponse(const ControlParameters& parameters) const;
};
/**
* \ingroup management
* \brief represents a strategy-choice/set command
* \sa http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice#Set-the-strategy-for-a-namespace
*/
class StrategyChoiceSetCommand : public ControlCommand
{
public:
StrategyChoiceSetCommand();
};
/**
* \ingroup management
* \brief represents a strategy-choice/set command
* \sa http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice#Unset-the-strategy-for-a-namespace
*/
class StrategyChoiceUnsetCommand : public ControlCommand
{
public:
StrategyChoiceUnsetCommand();
virtual void
validateRequest(const ControlParameters& parameters) const;
virtual void
validateResponse(const ControlParameters& parameters) const;
};
/**
* \ingroup management
* \brief represents a rib/register command
* \sa http://redmine.named-data.net/projects/nfd/wiki/RibMgmt#Register-a-route
*/
class RibRegisterCommand : public ControlCommand
{
public:
RibRegisterCommand();
virtual void
applyDefaultsToRequest(ControlParameters& parameters) const;
virtual void
validateResponse(const ControlParameters& parameters) const;
};
/**
* \ingroup management
* \brief represents a rib/unregister command
* \sa http://redmine.named-data.net/projects/nfd/wiki/RibMgmt#Unregister-a-route
*/
class RibUnregisterCommand : public ControlCommand
{
public:
RibUnregisterCommand();
virtual void
applyDefaultsToRequest(ControlParameters& parameters) const;
virtual void
validateResponse(const ControlParameters& parameters) const;
};
} // namespace nfd
} // namespace ndn
#endif // NDN_MANAGEMENT_NFD_CONTROL_COMMAND_HPP