database.h 73.2 KB
 Michal 'vorner' Vaner committed Aug 01, 2011 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 ``````// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC") // // Permission to use, copy, modify, and/or distribute this software for any // purpose with or without fee is hereby granted, provided that the above // copyright notice and this permission notice appear in all copies. // // THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH // REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY // AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, // INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM // LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE // OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR // PERFORMANCE OF THIS SOFTWARE. #ifndef __DATABASE_DATASRC_H #define __DATABASE_DATASRC_H `````` JINMEI Tatuya committed Aug 12, 2011 18 19 ``````#include `````` JINMEI Tatuya committed Aug 12, 2011 20 ``````#include `````` Stephen Morris committed Nov 21, 2011 21 ``````#include `````` JINMEI Tatuya committed Aug 12, 2011 22 `````` `````` JINMEI Tatuya committed Aug 16, 2011 23 24 ``````#include #include `````` Stephen Morris committed Nov 21, 2011 25 ``````#include `````` JINMEI Tatuya committed Aug 12, 2011 26 `````` `````` JINMEI Tatuya committed Nov 14, 2011 27 28 ``````#include #include `````` JINMEI Tatuya committed Feb 29, 2012 29 ``````#include `````` JINMEI Tatuya committed Nov 22, 2011 30 ``````#include `````` Michal 'vorner' Vaner committed Aug 01, 2011 31 `````` `````` Michal 'vorner' Vaner committed Aug 12, 2011 32 ``````#include `````` Michal 'vorner' Vaner committed Aug 05, 2011 33 ``````#include `````` Michal 'vorner' Vaner committed Aug 12, 2011 34 `````` `````` Michal 'vorner' Vaner committed Sep 09, 2011 35 36 37 ``````#include #include `````` Michal 'vorner' Vaner committed Aug 01, 2011 38 39 40 ``````namespace isc { namespace datasrc { `````` Stephen Morris committed Nov 28, 2011 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 ``````/// \brief Abstraction of lowlevel database with DNS data /// /// This class is defines interface to databases. Each supported database /// will provide methods for accessing the data stored there in a generic /// manner. The methods are meant to be low-level, without much or any knowledge /// about DNS and should be possible to translate directly to queries. /// /// On the other hand, how the communication with database is done and in what /// schema (in case of relational/SQL database) is up to the concrete classes. /// /// This class is non-copyable, as copying connections to database makes little /// sense and will not be needed. /// /// \todo Is it true this does not need to be copied? For example the zone /// iterator might need it's own copy. But a virtual clone() method might /// be better for that than copy constructor. /// /// \note The same application may create multiple connections to the same /// database, having multiple instances of this class. If the database /// allows having multiple open queries at one connection, the connection /// class may share it. `````` Michal 'vorner' Vaner committed Aug 09, 2011 62 ``````class DatabaseAccessor : boost::noncopyable { `````` Michal 'vorner' Vaner committed Aug 01, 2011 63 ``````public: `````` Stephen Morris committed Nov 28, 2011 64 65 66 67 68 69 70 `````` /// \brief Data columns for by IteratorContext::getNext() /// /// When implementing getNext(), the columns array should be filled with /// the values as described in this enumeration, in this order, i.e. /// - TYPE_COLUMN should be the first element (index 0) of the array, /// - TTL_COLUMN should be the second element (index 1), /// - etc. `````` Jelte Jansen committed Aug 19, 2011 71 72 73 `````` enum RecordColumns { TYPE_COLUMN = 0, ///< The RRType of the record (A/NS/TXT etc.) TTL_COLUMN = 1, ///< The TTL of the record (a `````` Stephen Morris committed Nov 28, 2011 74 75 `````` SIGTYPE_COLUMN = 2, ///< For RRSIG records, this contains the RRTYPEs ///< the RRSIG cover. In the current implementation, `````` Jelte Jansen committed Aug 19, 2011 76 77 78 79 80 81 `````` ///< this field is ignored. RDATA_COLUMN = 3, ///< Full text representation of the record's RDATA NAME_COLUMN = 4, ///< The domain name of this RR COLUMN_COUNT = 5 ///< The total number of columns, MUST be value of ///< the largest other element in this enum plus 1. }; `````` Jelte Jansen committed Aug 18, 2011 82 `````` `````` Stephen Morris committed Nov 28, 2011 83 84 85 86 87 `````` /// \brief Definitions of the fields to be passed to addRecordToZone() /// /// Each derived implementation of addRecordToZone() should expect /// the "columns" array to be filled with the values as described in this /// enumeration, in this order. `````` JINMEI Tatuya committed Aug 19, 2011 88 `````` enum AddRecordColumns { `````` Stephen Morris committed Nov 28, 2011 89 90 91 92 93 94 `````` ADD_NAME = 0, ///< The owner name of the record (a domain name) ADD_REV_NAME = 1, ///< Reversed name of NAME (used for DNSSEC) ADD_TTL = 2, ///< The TTL of the record (in numeric form) ADD_TYPE = 3, ///< The RRType of the record (A/NS/TXT etc.) ADD_SIGTYPE = 4, ///< RRSIGs only: RRTYPEs the RRSIG covers. ADD_RDATA = 5, ///< Full text representation of the record's RDATA `````` JINMEI Tatuya committed Aug 19, 2011 95 96 97 `````` ADD_COLUMN_COUNT = 6 ///< Number of columns }; `````` JINMEI Tatuya committed Apr 16, 2012 98 `````` /// \brief Definitions of the fields to be passed to addNSEC3RecordToZone() `````` JINMEI Tatuya committed Apr 13, 2012 99 `````` /// `````` JINMEI Tatuya committed Apr 16, 2012 100 `````` /// Each derived implementation of addNSEC3RecordToZone() should expect `````` JINMEI Tatuya committed Apr 13, 2012 101 102 103 104 105 106 107 `````` /// the "columns" array to be filled with the values as described in this /// enumeration, in this order. /// /// Note that there is no "reversed name" column. Since the conceptual /// separate namespace for NSEC3 is very simplified and essentially only /// consists of a single-label names, there is no need for using reversed /// names to identify the "previous hash". `````` JINMEI Tatuya committed Apr 13, 2012 108 `````` enum AddNSEC3RecordColumns { `````` JINMEI Tatuya committed Apr 13, 2012 109 110 `````` ADD_NSEC3_HASH = 0, ///< The hash (1st) label of the owner name, ///< excluding the dot character `````` JINMEI Tatuya committed Apr 13, 2012 111 112 `````` ADD_NSEC3_TTL = 1, ///< The TTL of the record (in numeric form) ADD_NSEC3_TYPE = 2, ///< The RRType of the record (either NSEC3 or `````` JINMEI Tatuya committed Apr 13, 2012 113 `````` ///< RRSIG for NSEC3) `````` JINMEI Tatuya committed Apr 13, 2012 114 115 116 117 118 `````` ADD_NSEC3_RDATA = 3, ///< Full text representation of the record's ///< RDATA ADD_NSEC3_COLUMN_COUNT = 4 ///< Number of columns }; `````` Stephen Morris committed Nov 28, 2011 119 `````` /// \brief Definitions of the fields to be passed to deleteRecordInZone() `````` JINMEI Tatuya committed Apr 16, 2012 120 `````` /// and deleteNSEC3RecordInZone() `````` Stephen Morris committed Nov 28, 2011 121 122 123 124 `````` /// /// Each derived implementation of deleteRecordInZone() should expect /// the "params" array to be filled with the values as described in this /// enumeration, in this order. `````` JINMEI Tatuya committed Aug 19, 2011 125 126 `````` enum DeleteRecordParams { DEL_NAME = 0, ///< The owner name of the record (a domain name) `````` JINMEI Tatuya committed Apr 16, 2012 127 `````` ///< or the hash label for deleteNSEC3RecordInZone() `````` JINMEI Tatuya committed Aug 19, 2011 128 129 130 131 `````` DEL_TYPE = 1, ///< The RRType of the record (A/NS/TXT etc.) DEL_RDATA = 2, ///< Full text representation of the record's RDATA DEL_PARAM_COUNT = 3 ///< Number of parameters }; `````` JINMEI Tatuya committed Aug 18, 2011 132 `````` `````` Stephen Morris committed Nov 28, 2011 133 134 135 `````` /// \brief Operation mode when adding a record diff. /// /// This is used as the "operation" parameter value of addRecordDiff(). `````` JINMEI Tatuya committed Nov 03, 2011 136 `````` enum DiffOperation { `````` JINMEI Tatuya committed Nov 03, 2011 137 138 `````` DIFF_ADD = 0, ///< This diff is for adding an RR DIFF_DELETE = 1 ///< This diff is for deleting an RR `````` JINMEI Tatuya committed Nov 03, 2011 139 140 `````` }; `````` Stephen Morris committed Nov 28, 2011 141 142 143 144 145 `````` /// \brief Definitions of the fields to be passed to addRecordDiff(). /// /// Each derived implementation of addRecordDiff() should expect /// the "params" array to be filled with the values as described in this /// enumeration, in this order. `````` JINMEI Tatuya committed Nov 03, 2011 146 `````` enum DiffRecordParams { `````` Stephen Morris committed Nov 28, 2011 147 148 149 150 `````` DIFF_NAME = 0, ///< Owner name of the record (a domain name) DIFF_TYPE = 1, ///< The RRType of the record (A/NS/TXT etc.) DIFF_TTL = 2, ///< The TTL of the record (in numeric form) DIFF_RDATA = 3, ///< Full text representation of record's RDATA `````` JINMEI Tatuya committed Nov 03, 2011 151 `````` DIFF_PARAM_COUNT = 4 ///< Number of parameters `````` JINMEI Tatuya committed Nov 03, 2011 152 153 `````` }; `````` Stephen Morris committed Nov 28, 2011 154 155 156 157 `````` /// \brief Destructor /// /// It is empty, but needs a virtual one, since we will use the derived /// classes in polymorphic way. `````` Michal 'vorner' Vaner committed Aug 09, 2011 158 `````` virtual ~DatabaseAccessor() { } `````` JINMEI Tatuya committed Aug 12, 2011 159 `````` `````` Stephen Morris committed Nov 28, 2011 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 `````` /// \brief Retrieve a zone identifier /// /// This method looks up a zone for the given name in the database. It /// should match only exact zone name (eg. name is equal to the zone's /// apex), as the DatabaseClient will loop trough the labels itself and /// find the most suitable zone. /// /// It is not specified if and what implementation of this method may throw, /// so code should expect anything. /// /// \param name The (fully qualified) domain name of the zone's apex to be /// looked up. /// \return The first part of the result indicates if a matching zone /// was found. In case it was, the second part is internal zone ID. /// This one will be passed to methods finding data in the zone. /// It is not required to keep them, in which case whatever might /// be returned - the ID is only passed back to the database as /// an opaque handle. `````` Jelte Jansen committed Aug 23, 2011 178 `````` virtual std::pair getZone(const std::string& name) const = 0; `````` Jelte Jansen committed Aug 05, 2011 179 `````` `````` Stephen Morris committed Nov 28, 2011 180 181 182 183 184 185 186 187 188 189 190 191 `````` /// \brief This holds the internal context of ZoneIterator for databases /// /// While the ZoneIterator implementation from DatabaseClient does all the /// translation from strings to DNS classes and validation, this class /// holds the pointer to where the database is at reading the data. /// /// It can either hold shared pointer to the connection which created it /// and have some kind of statement inside (in case single database /// connection can handle multiple concurrent SQL statements) or it can /// create a new connection (or, if it is more convenient, the connection /// itself can inherit both from DatabaseConnection and IteratorContext /// and just clone itself). `````` Michal 'vorner' Vaner committed Aug 05, 2011 192 193 `````` class IteratorContext : public boost::noncopyable { public: `````` Stephen Morris committed Nov 28, 2011 194 195 196 `````` /// \brief Destructor /// /// Virtual destructor, so any descendand class is destroyed correctly. `````` Michal 'vorner' Vaner committed Aug 05, 2011 197 `````` virtual ~IteratorContext() { } `````` Jelte Jansen committed Aug 15, 2011 198 `````` `````` Stephen Morris committed Nov 28, 2011 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 `````` /// \brief Function to provide next resource record /// /// This function should provide data about the next resource record /// from the data that is searched. The data is not converted yet. /// /// Depending on how the iterator was constructed, there is a difference /// in behaviour; for a 'full zone iterator', created with /// getAllRecords(), all COLUMN_COUNT elements of the array are /// overwritten. /// For a 'name iterator', created with getRecords(), the column /// NAME_COLUMN is untouched, since what would be added here is by /// definition already known to the caller (it already passes it as /// an argument to getRecords()). /// /// Once this function returns false, any subsequent call to it should /// result in false. The implementation of a derived class must ensure /// it doesn't cause any disruption due to that such as a crash or /// exception. /// /// \note The order of RRs is not strictly set, but the RRs for single /// RRset must not be interleaved with any other RRs (eg. RRsets must be /// "together"). /// /// \param columns The data will be returned through here. The order /// is specified by the RecordColumns enum, and the size must be /// COLUMN_COUNT /// \todo Do we consider databases where it is stored in binary blob /// format? /// \throw DataSourceError if there's database-related error. If the /// exception (or any other in case of derived class) is thrown, /// the iterator can't be safely used any more. /// \return true if a record was found, and the columns array was /// updated. false if there was no more data, in which case /// the columns array is untouched. `````` Jelte Jansen committed Aug 18, 2011 233 `````` virtual bool getNext(std::string (&columns)[COLUMN_COUNT]) = 0; `````` Michal 'vorner' Vaner committed Aug 05, 2011 234 `````` }; `````` Jelte Jansen committed Aug 15, 2011 235 `````` `````` Michal 'vorner' Vaner committed Aug 05, 2011 236 `````` typedef boost::shared_ptr IteratorContextPtr; `````` Jelte Jansen committed Aug 15, 2011 237 `````` `````` Stephen Morris committed Nov 28, 2011 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 `````` /// \brief Creates an iterator context for a specific name. /// /// Returns an IteratorContextPtr that contains all records of the /// given name from the given zone. /// /// The implementation of the iterator that is returned may leave the /// NAME_COLUMN column of the array passed to getNext() untouched, as that /// data is already known (it is the same as the name argument here) /// /// \exception any Since any implementation can be used, the caller should /// expect any exception to be thrown. /// /// \param name The name to search for. This should be a FQDN. /// \param id The ID of the zone, returned from getZone(). /// \param subdomains If set to true, match subdomains of name instead /// of name itself. It is used to find empty domains and match /// wildcards. /// \return Newly created iterator context. Must not be NULL. `````` Jelte Jansen committed Aug 19, 2011 256 `````` virtual IteratorContextPtr getRecords(const std::string& name, `````` Michal 'vorner' Vaner committed Aug 23, 2011 257 258 `````` int id, bool subdomains = false) const = 0; `````` Jelte Jansen committed Aug 18, 2011 259 `````` `````` Michal 'vorner' Vaner committed Mar 14, 2012 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 `````` /// \brief Creates an iterator context for the records of NSEC3 namespace /// for the given hash /// /// Returns an Iteratorcontextptr that contains all the records of the given /// hash in the NSEC3 namespace of the given zone. /// /// The implementation of the iterator that is returned may leave the /// NAME_COLUMN column of the array passed to getNext() untouched, /// as that name is easy to construct on the caller side (both the /// hash and the name of the zone is known). The SIGTYPE_COLUMN can /// be omitted as well, as it would be always empty for NSEC3 RRs or /// contained "NSEC3" in case of RRSIG RRs. /// /// The iterator will contain both the NSEC3 records and the corresponding /// RRSIGs, in arbitrary order. /// /// The iterator might be empty (containing no RRs) in case the zone is not /// signed by NSEC3. /// `````` Michal 'vorner' Vaner committed Mar 16, 2012 279 280 281 `````` /// \note In case there are multiple NSEC3 chains and they collide /// (unlikely, but it can happen), this can return multiple NSEC3 /// records. `````` Michal 'vorner' Vaner committed Mar 14, 2012 282 283 284 285 286 287 288 289 290 291 292 293 294 `````` /// \exception any Since any implementaion can be used, the caller should /// expect any exception to be thrown. /// \exception isc::NotImplemented in case the database does not support /// NSEC3 /// /// \param hash The hash part of the NSEC3 name (eg. for a name of NSEC3 /// RKBUCQT8T78GV6QBCGBHCHC019LG73SJ.example.com., we the hash would be /// RKBUCQT8T78GV6QBCGBHCHC019LG73SJ). /// \param id The id of te zone, as returned from getZone(). /// \return Newly created iterator context. Must not be NULL. virtual IteratorContextPtr getNSEC3Records(const std::string& hash, int id) const = 0; `````` Stephen Morris committed Nov 28, 2011 295 296 297 298 299 300 301 302 303 304 305 306 307 308 `````` /// \brief Creates an iterator context for the whole zone. /// /// Returns an IteratorContextPtr that contains all records of the /// zone with the given zone id. /// /// Each call to getNext() on the returned iterator should copy all /// column fields of the array that is passed, as defined in the /// RecordColumns enum. /// /// \exception any Since any implementation can be used, the caller should /// expect any exception to be thrown. /// /// \param id The ID of the zone, returned from getZone(). /// \return Newly created iterator context. Must not be NULL. `````` Jelte Jansen committed Aug 19, 2011 309 `````` virtual IteratorContextPtr getAllRecords(int id) const = 0; `````` Jelte Jansen committed Aug 10, 2011 310 `````` `````` Stephen Morris committed Nov 28, 2011 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 `````` /// \brief Creates an iterator context for a set of differences. /// /// Returns an IteratorContextPtr that contains all difference records for /// the given zone between two versions of a zone. /// /// The difference records are the set of records that would appear in an /// IXFR serving a request for the difference between two versions of a /// zone. The records are returned in the same order as they would be in /// the IXFR. This means that if the the difference between versions of a /// zone with SOA serial numbers of "start" and "end" is required, and the /// zone contains the differences between serial number "start" to serial /// number "intermediate" and from serial number "intermediate" to serial /// number "end", the returned records will be (in order): /// /// \li SOA for serial "start" /// \li Records removed from the zone between versions "start" and /// "intermediate" of the zone. The order of these is not guaranteed. /// \li SOA for serial "intermediate" /// \li Records added to the zone between versions "start" and /// "intermediate" of the zone. The order of these is not guaranteed. /// \li SOA for serial "intermediate" /// \li Records removed from the zone between versions "intermediate" and /// "end" of the zone. The order of these is not guaranteed. /// \li SOA for serial "end" /// \li Records added to the zone between versions "intermediate" and "end" /// of the zone. The order of these is not guaranteed. /// /// Note that there is no requirement that "start" be less than "end". /// Owing to serial number arithmetic, it is entirely possible that a later /// version of a zone will have a smaller SOA serial number than an earlier /// version. /// /// Each call to getNext() on the returned iterator should copy all column /// fields of the array that is passed, as defined in the RecordColumns /// enum. /// /// \exception any Since any implementation can be used, the caller should /// expect any exception to be thrown. /// /// \param id The ID of the zone, returned from getZone(). /// \param start The SOA serial number of the version of the zone from /// which the difference sequence should start. /// \param end The SOA serial number of the version of the zone at which /// the difference sequence should end. /// /// \return Newly created iterator context. Must not be NULL. `````` Stephen Morris committed Nov 04, 2011 357 358 `````` virtual IteratorContextPtr getDiffs(int id, uint32_t start, uint32_t end) const = 0; `````` Stephen Morris committed Nov 03, 2011 359 `````` `````` Stephen Morris committed Nov 28, 2011 360 `````` /// \brief Start a transaction for updating a zone. `````` JINMEI Tatuya committed Aug 19, 2011 361 362 363 364 365 366 367 368 369 370 `````` /// /// Each derived class version of this method starts a database /// transaction to make updates to the given name of zone (whose class was /// specified at the construction of the class). /// /// If \c replace is true, any existing records of the zone will be /// deleted on successful completion of updates (after /// \c commitUpdateZone()); if it's false, the existing records will be /// intact unless explicitly deleted by \c deleteRecordInZone(). /// `````` JINMEI Tatuya committed Oct 31, 2011 371 `````` /// A single \c DatabaseAccessor instance can perform at most one `````` JINMEI Tatuya committed Aug 19, 2011 372 `````` /// transaction; a duplicate call to this method before `````` JINMEI Tatuya committed Oct 31, 2011 373 374 375 376 377 378 `````` /// \c commitUpdateZone() or \c rollbackUpdateZone(), or a call to this /// method within another transaction started by \c startTransaction() /// will result in a \c DataSourceError exception. /// If multiple update attempts need to be performed concurrently (and /// if the underlying database allows such operation), separate /// \c DatabaseAccessor instance must be created. `````` JINMEI Tatuya committed Aug 19, 2011 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 `````` /// /// \note The underlying database may not allow concurrent updates to /// the same database instance even if different "connections" (or /// something similar specific to the database implementation) are used /// for different sets of updates. For example, it doesn't seem to be /// possible for SQLite3 unless different databases are used. MySQL /// allows concurrent updates to different tables of the same database, /// but a specific operation may block others. As such, this interface /// doesn't require derived classes to allow concurrent updates with /// multiple \c DatabaseAccessor instances; however, the implementation /// is encouraged to do the best for making it more likely to succeed /// as long as the underlying database system allows concurrent updates. /// /// This method returns a pair of \c bool and \c int. Its first element /// indicates whether the given name of zone is found. If it's false, /// the transaction isn't considered to be started; a subsequent call to /// this method with an existing zone name should succeed. Likewise, /// if a call to this method results in an exception, the transaction /// isn't considered to be started. Note also that if the zone is not /// found this method doesn't try to create a new one in the database. /// It must have been created by some other means beforehand. /// /// The second element is the internal zone ID used for subsequent /// updates. Depending on implementation details of the actual derived /// class method, it may be different from the one returned by /// \c getZone(); for example, a specific implementation may use a /// completely new zone ID when \c replace is true. /// `````` JINMEI Tatuya committed Oct 31, 2011 407 408 409 `````` /// \exception DataSourceError Duplicate call to this method, call to /// this method within another transaction, or some internal database /// related error. `````` JINMEI Tatuya committed Aug 19, 2011 410 411 412 413 414 415 416 417 418 `````` /// /// \param zone_name A string representation of the zone name to be updated /// \param replace Whether to replace the entire zone (see above) /// /// \return A pair of bool and int, indicating whether the specified zone /// exists and (if so) the zone ID to be used for the update, respectively. virtual std::pair startUpdateZone(const std::string& zone_name, bool replace) = 0; `````` Stephen Morris committed Nov 28, 2011 419 `````` /// \brief Add a single record to the zone to be updated. `````` JINMEI Tatuya committed Aug 19, 2011 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 `````` /// /// This method provides a simple interface to insert a new record /// (a database "row") to the zone in the update context started by /// \c startUpdateZone(). The zone to which the record to be added /// is the one specified at the time of the \c startUpdateZone() call. /// /// A successful call to \c startUpdateZone() must have preceded to /// this call; otherwise a \c DataSourceError exception will be thrown. /// /// The row is defined as a vector of strings that has exactly /// ADD_COLUMN_COUNT number of elements. See AddRecordColumns for /// the semantics of each element. /// /// Derived class methods are not required to check whether the given /// values in \c columns are valid in terms of the expected semantics; /// in general, it's the caller's responsibility. /// For example, TTLs would normally be expected to be a textual /// representation of decimal numbers, but this interface doesn't require /// the implementation to perform this level of validation. It may check /// the values, however, and in that case if it detects an error it /// should throw a \c DataSourceError exception. /// /// Likewise, derived class methods are not required to detect any /// duplicate record that is already in the zone. /// /// \note The underlying database schema may not have a trivial mapping /// from this style of definition of rows to actual database records. /// It's the implementation's responsibility to implement the mapping /// in the actual derived method. /// /// \exception DataSourceError Invalid call without starting a transaction, `````` JINMEI Tatuya committed Aug 24, 2011 451 `````` /// or other internal database error. `````` JINMEI Tatuya committed Aug 19, 2011 452 `````` /// `````` JINMEI Tatuya committed Aug 24, 2011 453 `````` /// \param columns An array of strings that defines a record to be added `````` JINMEI Tatuya committed Aug 19, 2011 454 `````` /// to the zone. `````` JINMEI Tatuya committed Aug 24, 2011 455 456 `````` virtual void addRecordToZone( const std::string (&columns)[ADD_COLUMN_COUNT]) = 0; `````` JINMEI Tatuya committed Aug 19, 2011 457 `````` `````` JINMEI Tatuya committed Apr 13, 2012 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 `````` /// \brief Add a single NSEC3-related record to the zone to be updated. /// /// This method is similar to \c addRecordToZone(), but is expected to /// be only used for NSEC3 RRs or RRSIG RRs that cover NSEC3. In terms /// of the DNS protocol, these types of RRs reside in a separate space /// of the zone. While this interface does not mandate a specific way /// of implementing the separate namespaces in the underlying database, /// it would be more convenient for the underlying implementation if the /// interfaces are separated; for example, the implementation does not /// have to examine the given data to identify the appropriate namespace. /// /// An implementation may choose to skip providing this interface if the /// zones managed by that data source are known to not support NSEC3. /// In that case the implementation should throw the /// \c isc::NotImplemented exception. /// /// Note that the \c ADD_NSEC3_HASH column of \c columns is expected to /// store only the hash label, not the entire owner name. This is similar /// to the \c hash parameter of \c getNSEC3Records(). /// /// The RRs to be added using this method are expected to be limited to /// NSEC3 or RRSIG RRs that cover NSEC3, but it's generally assumed to /// be the caller's responsibility to ensure that; the implementation /// is not required to check that condition. The result of adding /// unexpected type of RRs (and the result of subsequent lookups) is /// undefined. /// `````` JINMEI Tatuya committed Apr 16, 2012 485 `````` /// Other general notes for \c addRecordToZone() also apply to this `````` JINMEI Tatuya committed Apr 13, 2012 486 487 `````` /// method. /// `````` JINMEI Tatuya committed Apr 16, 2012 488 489 `````` /// \exception DataSourceError Invalid call without starting a transaction, /// or other internal database error. `````` JINMEI Tatuya committed Apr 13, 2012 490 491 492 493 494 `````` /// \exception isc::NotImplemented in case the database does not support /// NSEC3 /// /// \param columns An array of strings that defines a record to be added /// to the NSEC3 namespace of the zone. `````` JINMEI Tatuya committed Apr 16, 2012 495 `````` virtual void addNSEC3RecordToZone( `````` JINMEI Tatuya committed Apr 13, 2012 496 497 `````` const std::string (&columns)[ADD_NSEC3_COLUMN_COUNT]) = 0; `````` Stephen Morris committed Nov 28, 2011 498 `````` /// \brief Delete a single record from the zone to be updated. `````` JINMEI Tatuya committed Aug 19, 2011 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 `````` /// /// This method provides a simple interface to delete a record /// (a database "row") from the zone in the update context started by /// \c startUpdateZone(). The zone from which the record to be deleted /// is the one specified at the time of the \c startUpdateZone() call. /// /// A successful call to \c startUpdateZone() must have preceded to /// this call; otherwise a \c DataSourceError exception will be thrown. /// /// The record to be deleted is specified by a vector of strings that has /// exactly DEL_PARAM_COUNT number of elements. See DeleteRecordParams /// for the semantics of each element. /// /// \note In IXFR, TTL may also be specified, but we intentionally /// ignore that in this interface, because it's not guaranteed /// that all records have the same TTL (unlike the RRset /// assumption) and there can even be multiple records for the /// same name, type and rdata with different TTLs. If we only /// delete one of them, subsequent lookup will still return a /// positive answer, which would be confusing. It's a higher /// layer's responsibility to check if there is at least one /// record in the database that has the given TTL. /// /// Like \c addRecordToZone, derived class methods are not required to /// validate the semantics of the given parameters or to check if there /// is a record that matches the specified parameter; if there isn't /// it simply ignores the result. /// /// \exception DataSourceError Invalid call without starting a transaction, `````` JINMEI Tatuya committed Aug 24, 2011 528 `````` /// or other internal database error. `````` JINMEI Tatuya committed Aug 19, 2011 529 `````` /// `````` JINMEI Tatuya committed Aug 24, 2011 530 `````` /// \param params An array of strings that defines a record to be deleted `````` JINMEI Tatuya committed Aug 19, 2011 531 532 `````` /// from the zone. virtual void deleteRecordInZone( `````` JINMEI Tatuya committed Aug 24, 2011 533 `````` const std::string (¶ms)[DEL_PARAM_COUNT]) = 0; `````` JINMEI Tatuya committed Aug 19, 2011 534 `````` `````` JINMEI Tatuya committed Apr 13, 2012 535 536 537 538 539 540 `````` /// \brief Delete a single NSEC3-related record from the zone to be /// updated. /// /// This method is similar to \c deleteRecordInZone(), but is expected to /// be only used for NSEC3 RRs or RRSIG RRs that cover NSEC3. The /// relationship between these two methods is similar to that between `````` JINMEI Tatuya committed Apr 16, 2012 541 `````` /// \c addRecordToZone() and \c addNSEC3RecordToZone(), and the same `````` JINMEI Tatuya committed Apr 13, 2012 542 543 544 545 546 547 `````` /// notes apply to this method. /// /// This method uses the same set of parameters to specify the record /// to be deleted as \c deleteRecordInZone(), but the \c DEL_NAME column /// is expected to only store the hash label of the owner name. /// This is the same as \c ADD_NSEC3_HASH column for `````` JINMEI Tatuya committed Apr 16, 2012 548 `````` /// \c addNSEC3RecordToZone(). `````` JINMEI Tatuya committed Apr 13, 2012 549 `````` /// `````` JINMEI Tatuya committed Apr 16, 2012 550 551 `````` /// \exception DataSourceError Invalid call without starting a transaction, /// or other internal database error. `````` JINMEI Tatuya committed Apr 13, 2012 552 553 554 555 556 `````` /// \exception isc::NotImplemented in case the database does not support /// NSEC3 /// /// \param params An array of strings that defines a record to be deleted /// from the NSEC3 namespace of the zone. `````` JINMEI Tatuya committed Apr 16, 2012 557 `````` virtual void deleteNSEC3RecordInZone( `````` JINMEI Tatuya committed Apr 13, 2012 558 559 `````` const std::string (¶ms)[DEL_PARAM_COUNT]) = 0; `````` Stephen Morris committed Nov 28, 2011 560 `````` /// \brief Start a general transaction. `````` JINMEI Tatuya committed Oct 31, 2011 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 `````` /// /// Each derived class version of this method starts a database /// transaction in a way specific to the database details. Any subsequent /// operations on the accessor are guaranteed to be not susceptible to /// any update attempts made during the transaction. The transaction /// must be terminated by either \c commit() or \c rollback(). /// /// In practice, this transaction is intended to be used to perform /// a set of atomic reads and work as a read-only lock. So, in many /// cases \c commit() and \c rollback() will have the same effect. /// /// This transaction cannot coexist with an update transaction started /// by \c startUpdateZone(). Such an attempt will result in /// \c DataSourceError. /// /// \exception DataSourceError An attempt of nested transaction, or some /// internal database related error. virtual void startTransaction() = 0; `````` Stephen Morris committed Nov 28, 2011 580 `````` /// \brief Commit a transaction. `````` JINMEI Tatuya committed Aug 19, 2011 581 `````` /// `````` JINMEI Tatuya committed Oct 28, 2011 582 583 `````` /// This method completes a transaction started by \c startTransaction /// or \c startUpdateZone. `````` JINMEI Tatuya committed Aug 19, 2011 584 `````` /// `````` JINMEI Tatuya committed Oct 28, 2011 585 `````` /// A successful call to one of the "start" methods must have preceded to `````` JINMEI Tatuya committed Aug 19, 2011 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 `````` /// this call; otherwise a \c DataSourceError exception will be thrown. /// Once this method successfully completes, the transaction isn't /// considered to exist any more. So a new transaction can now be /// started. On the other hand, a duplicate call to this method after /// a successful completion of it is invalid and should result in /// a \c DataSourceError exception. /// /// If some internal database error happens, a \c DataSourceError /// exception must be thrown. In that case the transaction is still /// considered to be valid; the caller must explicitly rollback it /// or (if it's confident that the error is temporary) try to commit it /// again. /// /// \exception DataSourceError Call without a transaction, duplicate call /// to the method or internal database error. `````` JINMEI Tatuya committed Oct 28, 2011 601 `````` virtual void commit() = 0; `````` JINMEI Tatuya committed Aug 19, 2011 602 `````` `````` Stephen Morris committed Nov 28, 2011 603 `````` /// \brief Rollback any changes in a transaction made so far. `````` JINMEI Tatuya committed Aug 19, 2011 604 `````` /// `````` JINMEI Tatuya committed Oct 28, 2011 605 606 607 608 `````` /// This method rollbacks a transaction started by \c startTransaction or /// \c startUpdateZone. When it succeeds (it normally should, but see /// below), the underlying database should be reverted to the point /// before performing the corresponding "start" method. `````` JINMEI Tatuya committed Aug 19, 2011 609 `````` /// `````` JINMEI Tatuya committed Oct 28, 2011 610 `````` /// A successful call to one of the "start" method must have preceded to `````` JINMEI Tatuya committed Aug 19, 2011 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 `````` /// this call; otherwise a \c DataSourceError exception will be thrown. /// Once this method successfully completes, the transaction isn't /// considered to exist any more. So a new transaction can now be /// started. On the other hand, a duplicate call to this method after /// a successful completion of it is invalid and should result in /// a \c DataSourceError exception. /// /// Normally this method should not fail. But it may not always be /// possible to guarantee it depending on the characteristics of the /// underlying database system. So this interface doesn't require the /// actual implementation for the error free property. But if a specific /// implementation of this method can fail, it is encouraged to document /// when that can happen with its implication. /// /// \exception DataSourceError Call without a transaction, duplicate call /// to the method or internal database error. `````` JINMEI Tatuya committed Oct 28, 2011 627 `````` virtual void rollback() = 0; `````` JINMEI Tatuya committed Aug 19, 2011 628 `````` `````` Stephen Morris committed Nov 28, 2011 629 `````` /// \brief Install a single RR diff in difference sequences for zone update. `````` JINMEI Tatuya committed Nov 03, 2011 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 `````` /// /// This method inserts parameters of an update operation for a single RR /// (either adding or deleting one) in the underlying database. /// (These parameters would normally be a separate database table, but /// actual realization can differ in specific implementations). /// The information given via this method generally corresponds to either /// a single call to \c addRecordToZone() or \c deleteRecordInZone(), /// and this method is expected to be called immediately after (or before) /// a call to either of those methods. /// /// Note, however, that this method passes more detailed information /// than those update methods: it passes "serial", even if the diff /// is not for the SOA RR; it passes TTL for a diff that deletes an RR /// while in \c deleteRecordInZone() it's omitted. This is because /// the stored diffs are expected to be retrieved in the form that `````` JINMEI Tatuya committed Nov 14, 2011 645 `````` /// \c getDiffs() is expected to meet. This means if the caller `````` JINMEI Tatuya committed Nov 03, 2011 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 `````` /// wants to use this method with other update operations, it must /// ensure the additional information is ready when this method is called. /// /// The caller of this method must ensure that the added diffs via /// this method in a single transaction form an IXFR-style difference /// sequences: Each difference sequence is a sequence of RRs: /// an older version of SOA (to be deleted), zero or more other deleted /// RRs, the post-transaction SOA (to be added), and zero or more other /// added RRs. So, for example, the first call to this method in a /// transaction must always be deleting an SOA. Also, the \c serial /// parameter must be equal to the value of the serial field of the /// SOA that was last added or deleted (if the call is to add or delete /// an SOA RR, \c serial must be identical to the serial of that SOA). /// The underlying derived class implementation may or may not check /// this condition, but if the caller doesn't meet the condition `````` JINMEI Tatuya committed Nov 14, 2011 661 `````` /// a subsequent call to \c getDiffs() will not work as expected. `````` JINMEI Tatuya committed Nov 03, 2011 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 `````` /// /// Any call to this method must be in a transaction, and, for now, /// it must be a transaction triggered by \c startUpdateZone() (that is, /// it cannot be a transaction started by \c startTransaction()). /// All calls to this method are considered to be part of an atomic /// transaction: Until \c commit() is performed, the added diffs are /// not visible outside the transaction; if \c rollback() is performed, /// all added diffs are canceled; and the added sequences are not /// affected by any concurrent attempt of adding diffs (conflict resolution /// is up to the database implementation). /// /// Also for now, all diffs are assumed to be for the zone that is /// being updated in the context of \c startUpdateZone(). So the /// \c zone_id parameter must be identical to the zone ID returned by /// \c startUpdateZone(). /// /// In a future version we may loosen this condition so that diffs can be /// added in a generic transaction and may not even have to belong to /// a single zone. For this possible extension \c zone_id parameter is /// included even if it's redundant under the current restriction. /// `````` JINMEI Tatuya committed Nov 04, 2011 683 684 685 686 `````` /// The support for adding (or retrieving) diffs is optional; if it's /// not supported in a specific data source, this method for the /// corresponding derived class will throw an \c NotImplemented exception. /// `````` JINMEI Tatuya committed Nov 03, 2011 687 688 689 `````` /// \exception DataSourceError Invalid call without starting a transaction, /// zone ID doesn't match the zone being updated, or other internal /// database error. `````` JINMEI Tatuya committed Nov 04, 2011 690 691 `````` /// \exception NotImplemented Adding diffs is not supported in the /// data source. `````` JINMEI Tatuya committed Nov 03, 2011 692 693 694 695 696 697 698 `````` /// \exception Other The concrete derived method may throw other /// data source specific exceptions. /// /// \param zone_id The zone for the diff to be added. /// \param serial The SOA serial to which the diff belongs. /// \param operation Either \c DIFF_ADD or \c DIFF_DELETE. /// \param params An array of strings that defines a record for the diff. `````` JINMEI Tatuya committed Nov 03, 2011 699 700 701 702 `````` virtual void addRecordDiff( int zone_id, uint32_t serial, DiffOperation operation, const std::string (¶ms)[DIFF_PARAM_COUNT]) = 0; `````` Stephen Morris committed Nov 28, 2011 703 `````` /// \brief Clone the accessor with the same configuration. `````` JINMEI Tatuya committed Aug 27, 2011 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 `````` /// /// Each derived class implementation of this method will create a new /// accessor of the same derived class with the same configuration /// (such as the database server address) as that of the caller object /// and return it. /// /// Note that other internal states won't be copied to the new accessor /// even though the name of "clone" may indicate so. For example, even /// if the calling accessor is in the middle of a update transaction, /// the new accessor will not start a transaction to trace the same /// updates. /// /// The intended use case of cloning is to create a separate context /// where a specific set of database operations can be performed /// independently from the original accessor. The updater will use it /// so that multiple updaters can be created concurrently even if the /// underlying database system doesn't allow running multiple transactions /// in a single database connection. /// /// The underlying database system may not support the functionality /// that would be needed to implement this method. For example, it /// may not allow a single thread (or process) to have more than one /// database connections. In such a case the derived class implementation /// should throw a \c DataSourceError exception. /// /// \return A shared pointer to the cloned accessor. `````` JINMEI Tatuya committed Aug 25, 2011 730 `````` virtual boost::shared_ptr clone() = 0; `````` Jelte Jansen committed Aug 11, 2011 731 `````` `````` Stephen Morris committed Nov 28, 2011 732 733 734 735 736 737 738 739 740 741 `````` /// \brief Returns a string identifying this dabase backend /// /// The returned string is mainly intended to be used for /// debugging/logging purposes. /// /// Any implementation is free to choose the exact string content, /// but it is advisable to make it a name that is distinguishable /// from the others. /// /// \return the name of the database `````` Jelte Jansen committed Aug 11, 2011 742 `````` virtual const std::string& getDBName() const = 0; `````` Michal 'vorner' Vaner committed Sep 09, 2011 743 `````` `````` Stephen Morris committed Nov 28, 2011 744 745 `````` /// \brief It returns the previous name in DNSSEC order. /// `````` JINMEI Tatuya committed Jun 18, 2012 746 747 748 `````` /// Gets the previous name in the DNSSEC order. This can be used /// to find the correct NSEC records for proving nonexistence /// of domains. `````` Stephen Morris committed Nov 28, 2011 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 `````` /// /// \param rname The name to ask for previous of, in reversed form. /// We use the reversed form (see isc::dns::Name::reverse), /// because then the case insensitive order of string representation /// and the DNSSEC order correspond (eg. org.example.a is followed /// by org.example.a.b which is followed by org.example.b, etc). /// \param zone_id The zone to look through. /// \return The previous name. /// \note This function must return previous name even in case /// the queried rname does not exist in the zone. /// \note This method must skip under-the-zone-cut data (glue data). /// This might be implemented by looking for NSEC records (as glue /// data don't have them) in the zone or in some other way. /// /// \throw DataSourceError if there's a problem with the database. /// \throw NotImplemented if this database doesn't support DNSSEC /// or there's no previous name for the queried one (the NSECs /// might be missing or the queried name is less or equal the /// apex of the zone). `````` Michal 'vorner' Vaner committed Sep 09, 2011 768 `````` virtual std::string findPreviousName(int zone_id, `````` Michal 'vorner' Vaner committed Sep 09, 2011 769 `````` const std::string& rname) const = 0; `````` Michal 'vorner' Vaner committed Mar 16, 2012 770 771 772 773 774 775 `````` /// \brief It returns the previous hash in the NSEC3 chain. /// /// This is used to find previous NSEC3 hashes, to find covering NSEC3 in /// case none match exactly. /// `````` JINMEI Tatuya committed Apr 13, 2012 776 `````` /// In case a hash before the lowest or the lowest is provided, `````` Michal 'vorner' Vaner committed Mar 16, 2012 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 `````` /// this should return the largest one in the zone (NSEC3 needs a /// wrap-around semantics). /// /// \param zone_id Specifies the zone to look into, as returned by getZone. /// \param hash The hash to look before. /// \return The nearest smaller hash than the provided one, or the largest /// hash in the zone if something smaller or equal to the lowest one /// is provided. /// \note If the zone contains multiple NSEC3 chains, you should check that /// the returned result contains the NSEC3 for correct parameters. If /// not, query again and get something smaller - this will eventually /// get to the correct one. This interface and semantics might change /// in future. /// /// \throw DataSourceError if there's a problem with the database or if /// this zone is not signed with NSEC3. /// \throw NotImplemented if this database doesn't support NSEC3. /// \throw anything else, as this might be any implementation. virtual std::string findPreviousNSEC3Hash(int zone_id, const std::string& hash) const = 0; `````` Michal 'vorner' Vaner committed Aug 01, 2011 798 799 ``````}; `````` Stephen Morris committed Nov 28, 2011 800 801 802 803 804 805 806 807 808 809 810 811 ``````/// \brief Concrete data source client oriented at database backends. /// /// This class (together with corresponding versions of ZoneFinder, /// ZoneIterator, etc.) translates high-level data source queries to /// low-level calls on DatabaseAccessor. It calls multiple queries /// if necessary and validates data from the database, allowing the /// DatabaseAccessor to be just simple translation to SQL/other /// queries to database. /// /// While it is possible to subclass it for specific database in case /// of special needs, it is not expected to be needed. This should just /// work as it is with whatever DatabaseAccessor. `````` Michal 'vorner' Vaner committed Aug 01, 2011 812 813 ``````class DatabaseClient : public DataSourceClient { public: `````` Stephen Morris committed Nov 28, 2011 814 815 816 817 818 819 820 821 822 823 824 `````` /// \brief Constructor /// /// It initializes the client with a database via the given accessor. /// /// \exception isc::InvalidParameter if accessor is NULL. It might throw /// standard allocation exception as well, but doesn't throw anything else. /// /// \param rrclass The RR class of the zones that this client will handle. /// \param accessor The accessor to the database to use to get data. /// As the parameter suggests, the client takes ownership of the accessor /// and will delete it when itself deleted. `````` JINMEI Tatuya committed Aug 12, 2011 825 `````` DatabaseClient(isc::dns::RRClass rrclass, `````` JINMEI Tatuya committed Aug 27, 2011 826 `````` boost::shared_ptr accessor); `````` JINMEI Tatuya committed Aug 12, 2011 827 `````` `````` haikuo zhang committed Apr 11, 2012 828 `````` `````` Stephen Morris committed Nov 28, 2011 829 830 831 832 833 834 835 836 837 838 839 840 841 `````` /// \brief Corresponding ZoneFinder implementation /// /// The zone finder implementation for database data sources. Similarly /// to the DatabaseClient, it translates the queries to methods of the /// database. /// /// Application should not come directly in contact with this class /// (it should handle it trough generic ZoneFinder pointer), therefore /// it could be completely hidden in the .cc file. But it is provided /// to allow testing and for rare cases when a database needs slightly /// different handling, so it can be subclassed. /// /// Methods directly corresponds to the ones in ZoneFinder. `````` Michal 'vorner' Vaner committed Aug 01, 2011 842 843 `````` class Finder : public ZoneFinder { public: `````` Stephen Morris committed Nov 28, 2011 844 845 846 847 848 849 850 851 852 853 `````` /// \brief Constructor /// /// \param database The database (shared with DatabaseClient) to /// be used for queries (the one asked for ID before). /// \param zone_id The zone ID which was returned from /// DatabaseAccessor::getZone and which will be passed to further /// calls to the database. /// \param origin The name of the origin of this zone. It could query /// it from database, but as the DatabaseClient just searched for /// the zone using the name, it should have it. `````` Michal 'vorner' Vaner committed Aug 12, 2011 854 855 `````` Finder(boost::shared_ptr database, int zone_id, const isc::dns::Name& origin); `````` Stephen Morris committed Nov 28, 2011 856 `````` `````` Michal 'vorner' Vaner committed Aug 07, 2011 857 858 `````` // The following three methods are just implementations of inherited // ZoneFinder's pure virtual methods. `````` Michal 'vorner' Vaner committed Aug 01, 2011 859 860 `````` virtual isc::dns::Name getOrigin() const; virtual isc::dns::RRClass getClass() const; `````` Jelte Jansen committed Aug 05, 2011 861 `````` `````` Stephen Morris committed Nov 28, 2011 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 `````` /// \brief Find an RRset in the datasource /// /// Searches the datasource for an RRset of the given name and /// type. If there is a CNAME at the given name, the CNAME rrset /// is returned. /// (this implementation is not complete, and currently only /// does full matches, CNAMES, and the signatures for matches and /// CNAMEs) /// /// \note Maybe counter intuitively, this method is not a const member /// function. This is intentional; some of the underlying /// implementations are expected to use a database backend, and would /// internally contain some abstraction of "database connection". In /// the most strict sense any (even read only) operation might change /// the internal state of such a connection, and in that sense the /// operation cannot be considered "const". In order to avoid giving a /// false sense of safety to the caller, we indicate a call to this /// method may have a surprising side effect. That said, this view may /// be too strict and it may make sense to say the internal database /// connection doesn't affect external behavior in terms of the /// interface of this method. As we gain more experiences with various /// kinds of backends we may revisit the constness. /// /// \exception DataSourceError when there is a problem reading /// the data from the dabase backend. /// This can be a connection, code, or /// data (parse) error. /// /// \param name The name to find /// \param type The RRType to find /// \param options Options about how to search. /// See ZoneFinder::FindOptions. `````` JINMEI Tatuya committed Feb 29, 2012 894 895 896 897 `````` virtual ZoneFinderContextPtr find(const isc::dns::Name& name, const isc::dns::RRType& type, const FindOptions options = FIND_DEFAULT); `````` Michal 'vorner' Vaner committed Dec 15, 2011 898 899 900 901 902 `````` /// \brief Implementation of the ZoneFinder::findAll method. /// /// In short, it is mostly the same thing as find, but it returns all /// RRsets in the named node through the target parameter in successful /// case. It acts the same in the unsuccessful one. `````` JINMEI Tatuya committed Feb 29, 2012 903 904 905 906 `````` virtual ZoneFinderContextPtr findAll( const isc::dns::Name& name, std::vector& target, const FindOptions options = FIND_DEFAULT); `````` Jelte Jansen committed Aug 05, 2011 907 `````` `````` Michal 'vorner' Vaner committed Jan 23, 2012 908 909 910 911 `````` /// Look for NSEC3 for proving (non)existence of given name. /// /// See documentation in \c Zone. virtual FindNSEC3Result `````` JINMEI Tatuya committed Jan 20, 2012 912 `````` findNSEC3(const isc::dns::Name& name, bool recursive); `````` JINMEI Tatuya committed Jan 19, 2012 913 `````` `````` Stephen Morris committed Nov 28, 2011 914 915 916 917 918 `````` /// \brief The zone ID /// /// This function provides the stored zone ID as passed to the /// constructor. This is meant for testing purposes and normal /// applications shouldn't need it. `````` Michal 'vorner' Vaner committed Aug 01, 2011 919 `````` int zone_id() const { return (zone_id_); } `````` JINMEI Tatuya committed Aug 18, 2011 920 `````` `````` Stephen Morris committed Nov 28, 2011 921 922 923 924 925 `````` /// \brief The database accessor. /// /// This function provides the database accessor stored inside as /// passed to the constructor. This is meant for testing purposes and /// normal applications shouldn't need it. `````` JINMEI Tatuya committed Aug 18, 2011 926 927 `````` const DatabaseAccessor& getAccessor() const { return (*accessor_); `````` Michal 'vorner' Vaner committed Aug 01, 2011 928 `````` } `````` Stephen Morris committed Nov 21, 2011 929 `````` `````` Michal 'vorner' Vaner committed Aug 01, 2011 930 `````` private: `````` JINMEI Tatuya committed Aug 18, 2011 931 `````` boost::shared_ptr accessor_; `````` Michal 'vorner' Vaner committed Aug 01, 2011 932 `````` const int zone_id_; `````` Michal 'vorner' Vaner committed Aug 12, 2011 933 `````` const isc::dns::Name origin_; `````` haikuo zhang committed Apr 11, 2012 934 `````` `````` Michal 'vorner' Vaner committed Sep 09, 2011 935 936 937 938 939 `````` /// \brief Shortcut name for the result of getRRsets typedef std::pair > FoundRRsets; /// \brief Just shortcut for set of types typedef std::set WantedTypes; `````` JINMEI Tatuya committed Feb 29, 2012 940 `````` `````` Michal 'vorner' Vaner committed Dec 15, 2011 941 942 943 944 945 946 947 948 949 `````` /// \brief Internal logit of find and findAll methods. /// /// Most of their handling is in the "error" cases and delegations /// and so on. So they share the logic here and find and findAll provide /// just an interface for it. /// /// Parameters and behaviour is like of those combined together. /// Unexpected parameters, like type != ANY and having the target, are /// just that - unexpected and not checked. `````` JINMEI Tatuya committed Feb 29, 2012 950 951 952 953 954 `````` ResultContext findInternal(const isc::dns::Name& name, const isc::dns::RRType& type, std::vector* target, const FindOptions options = FIND_DEFAULT); `````` JINMEI Tatuya committed Feb 29, 2012 955 `````` `````` Michal 'vorner' Vaner committed Dec 15, 2011 956 957 958 959 960 961 962 963 964 965 `````` /// \brief Searches database for RRsets of one domain. /// /// This method scans RRs of single domain specified by name and /// extracts any RRsets found and requested by parameters. /// /// It is used internally by find(), because it is called multiple /// times (usually with different domains). /// /// \param name Which domain name should be scanned. /// \param types List of types the caller is interested in. `````` Mukund Sivaraman committed Aug 23, 2012 966 967 `````` /// \param sigs Return RRSIGs if true is passed. Otherwise, no /// associated RRSIGs are set on the returned RRsets. `````` Michal 'vorner' Vaner committed Dec 15, 2011 968 `````` /// \param construct_name If this is NULL, the resulting RRsets have `````` JINMEI Tatuya committed Jun 15, 2012 969 970 971 `````` /// their name set to name. If it is not NULL, it overrides the /// name and uses this one (this can be used for wildcard /// synthesized records). `````` Michal 'vorner' Vaner committed Dec 15, 2011 972 973 `````` /// \param any If this is true, it records all the types, not only the /// ones requested by types. It also puts a NULL pointer under the `````` JINMEI Tatuya committed Jun 15, 2012 974 975 `````` /// ANY type into the result, if it finds any RRs at all, to easy /// the identification of success. `````` Michal 'vorner' Vaner committed Apr 11, 2012 976 977 978 `````` /// \param srcContext This can be set to non-NULL value to override the /// iterator context used for obtaining the data. This can be used, /// for example, to get data from the NSEC3 namespace. `````` Michal 'vorner' Vaner committed Dec 15, 2011 979 980 981 982 983 984 985 986 `````` /// \return A pair, where the first element indicates if the domain /// contains any RRs at all (not only the requested, it may happen /// this is set to true, but the second part is empty). The second /// part is map from RRtypes to RRsets of the corresponding types. /// If the RRset is not present in DB, the RRtype is not there at /// all (so you'll not find NULL pointer in the result). /// \throw DataSourceError If there's a low-level error with the /// database or the database contains bad data. `````` Michal 'vorner' Vaner committed Sep 19, 2011 987 `````` FoundRRsets getRRsets(const std::string& name, `````` JINMEI Tatuya committed Jun 15, 2012 988 `````` const WantedTypes& types, `````` Mukund Sivaraman committed Aug 23, 2012 989 `````` bool sigs, `````` Michal 'vorner' Vaner committed Dec 13, 2011 990 `````` const std::string* construct_name = NULL, `````` Michal 'vorner' Vaner committed Apr 11, 2012 991 992 993 `````` bool any = false, DatabaseAccessor::IteratorContextPtr srcContext = DatabaseAccessor::IteratorContextPtr()); `````` Stephen Morris committed Nov 25, 2011 994 `````` `````` JINMEI Tatuya committed Apr 12, 2012 995 `````` /// \brief DNSSEC related context for ZoneFinder::findInternal. `````` JINMEI Tatuya committed Apr 12, 2012 996 `````` /// `````` JINMEI Tatuya committed Apr 12, 2012 997 998 999 1000 `````` /// This class is a helper for the ZoneFinder::findInternal method, /// encapsulating DNSSEC related information and processing logic. /// Specifically, it tells the finder whether the zone under search /// is DNSSEC signed or not, and if it is, whether it's with NSEC or ``````