ifmeserversecuritymanager.h

Go to the documentation of this file.

#ifndef _IFMESERVERSECURITYMANAGER_H
#define _IFMESERVERSECURITYMANAGER_H

#include <fmeservertypes.h>

class IFMEServerStatus;
class IFMEServerString;
class IFMEServerUserToken;

//===========================================================================
// Abstract Interface Class -- all methods are virtual and it has no data
class IFMEServerSecurityManager
{
public:
   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* userTokenExists(const IFMEServerString& userName,
                                             FME_Boolean& exists) const = 0;
   
   // -----------------------------------------------------------------------
   virtual IFMEServerUserToken* createUserToken() const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerUserToken* createUserToken(const IFMEServerString& token,
                                        const IFMEServerString& clientAddress,
                                        FME_Int64 expirationTimeout) const = 0;

   // -----------------------------------------------------------------------
   virtual void destroyUserToken(IFMEServerUserToken*& userToken) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* getUserToken(const IFMEServerString& userName,
                                          IFMEServerUserToken& userToken,
                                          FME_Boolean& exists) const = 0;
   
   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* addUserToken(const IFMEServerString& userName,
                                          const IFMEServerUserToken& userToken) = 0;
   
   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* updateUserToken(const IFMEServerString& userName,
                                             const IFMEServerUserToken& userToken) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* removeUserToken(const IFMEServerString& userName,
                                             FME_Boolean& existed) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* hasUserTokenExpired(const IFMEServerString& userName,
                                                 FME_Boolean& expired) const = 0;
      
protected:

   // -----------------------------------------------------------------------
   // No one should be creating an instance of this directly, so we
   // make the constructor protected.
   IFMEServerSecurityManager() {}

   // -----------------------------------------------------------------------
   // No one should be destroying an instance of this directly, so we
   // make the destructor protected.
   virtual ~IFMEServerSecurityManager() {}

private:

   // -----------------------------------------------------------------------
   // The copy constructor is not implemented.
   IFMEServerSecurityManager(const IFMEServerSecurityManager &other);

   // -----------------------------------------------------------------------
   // The assignment operator is not implemented. 
   IFMEServerSecurityManager &operator=(const IFMEServerSecurityManager &other);

};

#endif