database.h 11.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// 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

#include <datasrc/client.h>

20 21
#include <exceptions/exceptions.h>

22 23 24
namespace isc {
namespace datasrc {

25
/**
26
 * \brief Abstraction of lowlevel database with DNS data
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
 *
 * 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
44 45 46
 *     database, having multiple instances of this class. If the database
 *     allows having multiple open queries at one connection, the connection
 *     class may share it.
47
 */
48
class DatabaseAccessor : boost::noncopyable {
49
public:
50 51 52 53 54 55
    /**
     * \brief Destructor
     *
     * It is empty, but needs a virtual one, since we will use the derived
     * classes in polymorphic way.
     */
56
    virtual ~DatabaseAccessor() { }
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
    /**
     * \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 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
73
     *     be returned - the ID is only passed back to the database as
74 75
     *     an opaque handle.
     */
76
    virtual std::pair<bool, int> getZone(const isc::dns::Name& name) const = 0;
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
    /**
     * \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).
     */
    class IteratorContext : public boost::noncopyable {
    public:
        /**
         * \brief Destructor
         *
         * Virtual destructor, so any descendand class is destroyed correctly.
         */
        virtual ~IteratorContext() { }
        /**
         * \brief Function to provide next resource record
         *
         * This function should provide data about the next resource record
         * from the iterated zone. The data are not converted yet.
         *
         * The order of RRs is not strictly set, but the RRs for single RRset
         * must not be interlieved with any other RRs (eg. RRsets must be
         * "together").
         *
109 110 111
         * \param data The data are to be returned by this parameter. They are
         *     (in order) the name, rrtype, TTL and the rdata.
         * \todo Unify with the interface in #1062 eventually.
112 113 114
         * \todo Do we consider databases where it is stored in binary blob
         *     format?
         */
115
        virtual bool getNext(std::string data[4]) = 0;
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
    };
    typedef boost::shared_ptr<IteratorContext> IteratorContextPtr;
    /**
     * \brief Creates an iterator context for given zone.
     *
     * This should create a new iterator context to be used by
     * DatabaseConnection's ZoneIterator. It can be created based on the name
     * or the ID (returned from getZone()), what is more comfortable for the
     * database implementation. Both are provided (and are guaranteed to match,
     * the DatabaseClient first looks up the zone ID and then calls this).
     *
     * The default implementation throws isc::NotImplemented, to allow
     * "minimal" implementations of the connection not supporting optional
     * functionality.
     *
     * \param name The name of the zone.
     * \param id The ID of the zone, returned from getZone().
     * \return Newly created iterator context. Must not be NULL.
     */
    virtual IteratorContextPtr getIteratorContext(const isc::dns::Name& name,
                                                  int id) const
    {
        /*
         * This is a compromise. We need to document the parameters in doxygen,
         * so they need a name, but then it complains about unused parameter.
         * This is a NOP that "uses" the parameters.
         */
        static_cast<void>(name);
        static_cast<void>(id);

        isc_throw(isc::NotImplemented,
                  "This database datasource can't be iterated");
    }
149 150
};

151 152 153 154 155
/**
 * \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
156
 * low-level calls on DatabaseAccessor. It calls multiple queries
157
 * if necessary and validates data from the database, allowing the
158
 * DatabaseAccessor to be just simple translation to SQL/other
159 160 161 162
 * 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
163
 * work as it is with whatever DatabaseAccessor.
164
 */
165 166
class DatabaseClient : public DataSourceClient {
public:
167 168 169
    /**
     * \brief Constructor
     *
170
     * It initializes the client with a database.
171
     *
172
     * \exception isc::InvalidParameter if database is NULL. It might throw
173 174
     * standard allocation exception as well, but doesn't throw anything else.
     *
175 176
     * \param database The database to use to get data. As the parameter
     *     suggests, the client takes ownership of the database and will
177 178
     *     delete it when itself deleted.
     */
179
    DatabaseClient(boost::shared_ptr<DatabaseAccessor> database);
180 181 182 183 184
    /**
     * \brief Corresponding ZoneFinder implementation
     *
     * The zone finder implementation for database data sources. Similarly
     * to the DatabaseClient, it translates the queries to methods of the
185
     * database.
186 187 188 189 190 191 192 193 194 195 196 197 198 199
     *
     * 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.
     */
    class Finder : public ZoneFinder {
    public:
        /**
         * \brief Constructor
         *
200
         * \param database The database (shared with DatabaseClient) to
201 202
         *     be used for queries (the one asked for ID before).
         * \param zone_id The zone ID which was returned from
203
         *     DatabaseAccessor::getZone and which will be passed to further
204
         *     calls to the database.
205
         */
206
        Finder(boost::shared_ptr<DatabaseAccessor> database, int zone_id);
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
207 208
        // The following three methods are just implementations of inherited
        // ZoneFinder's pure virtual methods.
209 210
        virtual isc::dns::Name getOrigin() const;
        virtual isc::dns::RRClass getClass() const;
211 212 213 214
        virtual FindResult find(const isc::dns::Name& name,
                                const isc::dns::RRType& type,
                                isc::dns::RRsetList* target = NULL,
                                const FindOptions options = FIND_DEFAULT)
215
            const;
216 217 218 219 220 221 222 223 224
        /**
         * \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.
         */
        int zone_id() const { return (zone_id_); }
        /**
225
         * \brief The database.
226
         *
227
         * This function provides the database stored inside as
228 229 230
         * passed to the constructor. This is meant for testing purposes and
         * normal applications shouldn't need it.
         */
231
        const DatabaseAccessor& database() const {
232
            return (*database_);
233
        }
234
    private:
235
        boost::shared_ptr<DatabaseAccessor> database_;
236 237 238 239 240
        const int zone_id_;
    };
    /**
     * \brief Find a zone in the database
     *
241
     * This queries database's getZone to find the best matching zone.
242 243 244 245
     * It will propagate whatever exceptions are thrown from that method
     * (which is not restricted in any way).
     *
     * \param name Name of the zone or data contained there.
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
246 247 248 249 250
     * \return FindResult containing the code and an instance of Finder, if
     *     anything is found. However, application should not rely on the
     *     ZoneFinder being instance of Finder (possible subclass of this class
     *     may return something else and it may change in future versions), it
     *     should use it as a ZoneFinder only.
251
     */
252
    virtual FindResult findZone(const isc::dns::Name& name) const;
253 254 255 256 257 258 259 260 261 262
    /**
     * \brief Get the zone iterator
     *
     * The iterator allows going through the whole zone content. If the
     * underlying DatabaseConnection is implemented correctly, it should
     * be possible to have multiple ZoneIterators at once and query data
     * at the same time.
     *
     * \exception DataSourceError if the zone doesn't exist.
     * \exception isc::NotImplemented if the underlying DatabaseConnection
263 264
     *     doesn't implement iteration. But in case it is not implemented
     *     and the zone doesn't exist, DataSourceError is thrown.
265 266 267 268 269 270
     * \exception Anything else the underlying DatabaseConnection might
     *     want to throw.
     * \param name The origin of the zone to iterate.
     * \return Shared pointer to the iterator (it will never be NULL)
     */
    virtual ZoneIteratorPtr getIterator(const isc::dns::Name& name) const;
271
private:
272
    /// \brief Our database.
273
    const boost::shared_ptr<DatabaseAccessor> database_;
274 275 276 277 278 279
};

}
}

#endif