command-options.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
22 #ifndef NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
23 #define NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
24 
25 #include "../../security/signing-info.hpp"
26 
27 #define NDN_MGMT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS
28 
29 namespace ndn {
30 
31 namespace security {
32 namespace v1 {
33 class IdentityCertificate;
34 } // namespace v1
35 } // namespace security
36 
37 namespace nfd {
38 
43 class CommandOptions
44 {
45 public:
51  CommandOptions();
52 
55  const time::milliseconds&
56  getTimeout() const
57  {
58  return m_timeout;
59  }
60 
66  CommandOptions&
67  setTimeout(const time::milliseconds& timeout);
68 
71  const Name&
72  getPrefix() const
73  {
74  return m_prefix;
75  }
76 
80  CommandOptions&
81  setPrefix(const Name& prefix);
82 
85  const security::SigningInfo&
86  getSigningInfo() const
87  {
88  return m_signingInfo;
89  }
90 
94  CommandOptions&
95  setSigningInfo(const security::SigningInfo& signingInfo);
96 
97 #ifdef NDN_MGMT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS
98 public: // signing parameters
102  enum SigningParamsKind {
105  SIGNING_PARAMS_DEFAULT,
108  SIGNING_PARAMS_IDENTITY,
111  SIGNING_PARAMS_CERTIFICATE
112  };
113 
117  DEPRECATED(
118  SigningParamsKind
119  getSigningParamsKind() const);
120 
125  DEPRECATED(
126  const Name&
127  getSigningIdentity() const);
128 
133  DEPRECATED(
134  const Name&
135  getSigningCertificate() const);
136 
142  DEPRECATED(
143  CommandOptions&
144  setSigningDefault());
145 
152  DEPRECATED(
153  CommandOptions&
154  setSigningIdentity(const Name& identityName));
155 
164  DEPRECATED(
165  CommandOptions&
166  setSigningCertificate(const Name& certificateName));
167 
172  DEPRECATED(
173  CommandOptions&
174  setSigningCertificate(const security::v1::IdentityCertificate& certificate));
175 
176 #endif // NDN_MGMT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS
177 
178 public:
181  static const time::milliseconds DEFAULT_TIMEOUT;
182 
185  static const Name DEFAULT_PREFIX;
186 
187 private:
188  time::milliseconds m_timeout;
189  Name m_prefix;
190  security::SigningInfo m_signingInfo;
191 };
192 
193 } // namespace nfd
194 } // namespace ndn
195 
196 #endif // NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
ndn::nfd::CommandOptions::getSigningIdentity
const Name & getSigningIdentity() const
ndn
Copyright (c) 2013-2016 Regents of the University of California.
Definition: common.hpp:74
ndn::nfd::CommandOptions::CommandOptions
CommandOptions()
constructs CommandOptions
Definition: command-options.cpp:35
ndn::nfd::CommandOptions::setSigningCertificate
CommandOptions & setSigningCertificate(const Name &certificateName)
chooses to use a specific identity certificate
ndn::nfd::CommandOptions::getSigningParamsKind
SigningParamsKind getSigningParamsKind() const
ndn::nfd::CommandOptions::DEFAULT_PREFIX
static const Name DEFAULT_PREFIX
gives the default command prefix: ndn:/localhost/nfd
Definition: command-options.hpp:185
ndn::nfd::CommandOptions::SigningParamsKind
SigningParamsKind
indicates the selection of signing parameters
Definition: command-options.hpp:102
ndn::nfd::CommandOptions::getPrefix
const Name & getPrefix() const
Definition: command-options.hpp:72
ndn::security::SigningInfo
Signing parameters passed to KeyChain.
Definition: signing-info.hpp:40
ndn::nfd::CommandOptions::setTimeout
CommandOptions & setTimeout(const time::milliseconds &timeout)
sets command timeout
Definition: command-options.cpp:42
ndn::nfd::CommandOptions::SIGNING_PARAMS_IDENTITY
picks the default certificate of a specific identity Name
Definition: command-options.hpp:108
ndn::nfd::CommandOptions
contains options for ControlCommand execution
Definition: command-options.hpp:43
ndn::Name
Name abstraction to represent an absolute name.
Definition: name.hpp:46
ndn::nfd::CommandOptions::setSigningDefault
CommandOptions & setSigningDefault()
chooses to use default identity and certificate
ndn::nfd::CommandOptions::setSigningInfo
CommandOptions & setSigningInfo(const security::SigningInfo &signingInfo)
sets signing parameters
Definition: command-options.cpp:60
ndn::nfd::CommandOptions::setSigningIdentity
CommandOptions & setSigningIdentity(const Name &identityName)
chooses to use a specific identity and its default certificate
ndn::nfd::CommandOptions::SIGNING_PARAMS_CERTIFICATE
picks a specific identity certificate
Definition: command-options.hpp:111
ndn::nfd::CommandOptions::DEFAULT_TIMEOUT
static const time::milliseconds DEFAULT_TIMEOUT
gives the default command timeout: 10000ms
Definition: command-options.hpp:181
DEPRECATED
#define DEPRECATED(func)
Definition: common.hpp:71
ndn::nfd::CommandOptions::getSigningCertificate
const Name & getSigningCertificate() const
ndn::nfd::CommandOptions::getTimeout
const time::milliseconds & getTimeout() const
Definition: command-options.hpp:56
ndn::nfd::CommandOptions::SIGNING_PARAMS_DEFAULT
picks the default signing identity and certificate
Definition: command-options.hpp:105
ndn::nfd::CommandOptions::setPrefix
CommandOptions & setPrefix(const Name &prefix)
sets command prefix
Definition: command-options.cpp:53
ndn::nfd::CommandOptions::getSigningInfo
const security::SigningInfo & getSigningInfo() const
Definition: command-options.hpp:86