/**
 *    Copyright (C) 2012 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This program 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 Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <string>

#include "mongo/base/disallow_copying.h"
#include "mongo/base/string_data.h"
#include "mongo/db/jsobj.h"

namespace mongo {

    /**
     * This class represents the layout and contents of documents contained in the
     * config.lockpings collection. All manipulation of documents coming from that
     * collection should be done with this class.
     *
     * Usage Example:
     *
     *     // Contact the config. 'conn' has been obtained before.
     *     DBClientBase* conn;
     *     BSONObj query = QUERY(LockpingsType::exampleField("exampleFieldName"));
     *     exampleDoc = conn->findOne(LockpingsType::ConfigNS, query);
     *
     *     // Process the response.
     *     LockpingsType exampleType;
     *     string errMsg;
     *     if (!exampleType.parseBSON(exampleDoc, &errMsg) || !exampleType.isValid(&errMsg)) {
     *         // Can't use 'exampleType'. Take action.
     *     }
     *     // use 'exampleType'
     *
     */
    class LockpingsType {
        MONGO_DISALLOW_COPYING(LockpingsType);
    public:

        //
        // schema declarations
        //

        // Name of the lockpings collection in the config server.
        static const std::string ConfigNS;

        // Field names and types in the lockpings collection type.
        static const BSONField<std::string> process;
        static const BSONField<Date_t> ping;

        //
        // lockpings type methods
        //

        LockpingsType();
        ~LockpingsType();

        /**
         * Returns true if all the mandatory fields are present and have valid
         * representations. Otherwise returns false and fills in the optional 'errMsg' string.
         */
        bool isValid(std::string* errMsg) const;

        /**
         * Returns the BSON representation of the entry.
         */
        BSONObj toBSON() const;

        /**
         * Clears and populates the internal state using the 'source' BSON object if the
         * latter contains valid values. Otherwise sets errMsg and returns false.
         */
        bool parseBSON(const BSONObj& source, std::string* errMsg);

        /**
         * Clears the internal state.
         */
        void clear();

        /**
         * Copies all the fields present in 'this' to 'other'.
         */
        void cloneTo(LockpingsType* other) const;

        /**
         * Returns a string representation of the current internal state.
         */
        std::string toString() const;

        //
        // individual field accessors
        //

        // Mandatory Fields
        void setProcess(const StringData& process) {
            _process = process.toString();
            _isProcessSet = true;
        }

        void unsetProcess() { _isProcessSet = false; }

        bool isProcessSet() const { return _isProcessSet; }

        // Calling get*() methods when the member is not set results in undefined behavior
        const std::string& getProcess() const {
            dassert(_isProcessSet);
            return _process;
        }

        void setPing(const Date_t ping) {
            _ping = ping;
            _isPingSet = true;
        }

        void unsetPing() { _isPingSet = false; }

        bool isPingSet() const { return _isPingSet; }

        // Calling get*() methods when the member is not set results in undefined behavior
        const Date_t getPing() const {
            dassert(_isPingSet);
            return _ping;
        }

        // Optional Fields

    private:
        // Convention: (M)andatory, (O)ptional, (S)pecial rule.
        std::string _process;     // (M)  string describing the process holding the lock
        bool _isProcessSet;
        Date_t _ping;     // (M)  last time the holding process updated this document
        bool _isPingSet;
    };

} // namespace mongo
