user.h

Go to the documentation of this file.

// Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef USER_H
#define USER_H
 
#include <boost/shared_ptr.hpp>
 
#include <map>
#include <stdint.h>
#include <vector>
 
namespace user_chk {
 
 
class UserId {
public:
    // Use explicit values to ensure consistent numeric ordering for key
    // comparisons.
    enum UserIdType {
        HW_ADDRESS = 0,
        DUID = 1
    };
 
    static const char* HW_ADDRESS_STR;
    static const char* DUID_STR;
 
    UserId(UserIdType id_type, const std::vector<uint8_t>& id);
 
    UserId(UserIdType id_type, const std::string& id_str);
 
    ~UserId();
 
    const std::vector<uint8_t>& getId() const;
 
    UserIdType getType() const;
 
    std::string toText(char delim_char=0x0) const;
 
    bool operator ==(const UserId & other) const;
 
    bool operator !=(const UserId & other) const;
 
    bool operator <(const UserId & other) const;
 
    static std::string lookupTypeStr(UserIdType type);
 
    static UserIdType lookupType(const std::string& type_str);
 
private:
    UserIdType id_type_;
 
    std::vector<uint8_t> id_;
 
};
 
std::ostream&
operator<<(std::ostream& os, const UserId& user_id);
 
typedef boost::shared_ptr<UserId> UserIdPtr;
 
typedef std::map<std::string, std::string> PropertyMap;
 
class User {
public:
    User(const UserId & user_id);
 
    User(UserId::UserIdType id_type, const std::vector<uint8_t>& id);
 
    User(UserId::UserIdType id_type, const std::string& id_str);
 
    ~User();
 
    const PropertyMap& getProperties() const;
 
    void setProperties(const PropertyMap& properties);
 
    void setProperty(const std::string& name, const std::string& value);
 
    std::string getProperty(const std::string& name) const;
 
    void delProperty(const std::string& name);
 
    const UserId& getUserId() const;
 
private:
    UserId user_id_;
 
    PropertyMap properties_;
};
 
typedef boost::shared_ptr<User> UserPtr;
 
} // namespace user_chk
 
#endif