waruserauthdata.h

ftpserver very good sample

/** 
  Container for implementation dependent login/session
  data. Typically used to store uid/gid or SID's.
  
*/

#ifndef WAR_USER_AUTH_DATA_H
#define WAR_USER_AUTH_DATA_H

/* SYSTEM INCLUDES */


/* PROJECT INCLUDES */

#ifndef WAR_SMART_POINTER_H
#   include "WarSmartPointer.h"
#endif

#ifndef WAR_PTR_WRAPPER_H
#   include "WarPtrWrapper.h"
#endif

#ifndef WAR_OPTION_LIST_H
#   include "WarOptionList.h"
#endif

/* LOCAL INCLUDES */


/* FORWARD REFERENCES */

class WarSvrProperties;

#ifdef __cplusplus
extern "C" 
{
#endif
/****************** BEGIN OLD STYLE C spesific ********/


/****************** END OLD STYLE C spesific **********/
#ifdef __cplusplus 
}
#endif

/****************** BEGIN C++ spesific ****************/

#ifdef __cplusplus

class WarUserAuthData : public WarSmartPointer
{
public:
    // LIFECYCLE
    
    /**
    * Default constructor.
    */
    WarUserAuthData(void)
    {}
 
    /**
    * Destructor.
    */
    ~WarUserAuthData(void)
    {}
    
    // OPERATORS 

    bool operator == (const WarUserAuthData& from) const
    {
        return mUserName == from.mUserName;
    }

    bool operator < (const WarUserAuthData& from) const 
    {
        return mUserName < from.mUserName;
    }

    virtual void BeginImpersonate() 
        throw(WarException) = 0;

    virtual void EndImpersonate() 
        throw(WarException) = 0;

    // OPERATIONS  
    
    void SetUserName(war_ccstr_t userName)
    {
        mUserName = userName ? userName : "";
    }

    
    /* Merge the current effective properties, so that the
     * properties specified for the user takes precidence.
     */
    virtual void 
    MergeProperties(WarSvrProperties& effectiveProperties)
        throw(WarException)
    {
        WarThrow(WarError(WAR_ERR_NOT_IMPLEMENTED), NULL);
    }

    // ACCESS
    // INQUIRY

    virtual bool IsAnonymous() const
    {
        return false;
    }

    virtual bool IsPwdEmail() const
    {
        return false;
    }

    virtual const std::string& GetUserName() const
    {
        return mUserName;
    }

    virtual bool IsEnabled() const
    {
        return true;
    }

    virtual int GetIntOption(war_ccstr_t name) const 
        throw(WarException)
    {
        return mOptions.GetIntOption(name);
    }

    virtual std::string GetOption(war_ccstr_t name) const
        throw(WarException)
    {
        return mOptions.GetOption(name);
    }
    
protected:
    std::string mUserName;
    WarOptionList mOptions;

#ifdef WIN32
    friend class WarUserAuthWin32Nt;
    friend class WarIfUser;
    WarWin32Registry mRegRoot; // Users root-key in the registry
#endif

private:
};

/* INLINE METHODS */

/* EXTERNAL REFERENCES */

typedef WarPtrWrapper<WarUserAuthData> war_authdata_ptr_t;

#endif /* __cplusplus */

/****************** END C++ spesific ******************/

#endif  /* WAR_USER_AUTH_DATA_H_ */