FME Server C++ API 3.0

IFMEServerIdentity Class Reference

IFMEServerIdentity interface. More...

#include <ifmeserveridentity.h>

List of all members.

Public Member Functions

virtual void getID (IFMEServerString &id) const =0
virtual FME_Boolean getIsAuthenticated () const =0
virtual void getRoles (IFMEServerStringArray &roles) const =0

Protected Member Functions

 IFMEServerIdentity ()
virtual ~IFMEServerIdentity ()

Private Member Functions

 IFMEServerIdentity (const IFMEServerIdentity &other)
IFMEServerIdentityoperator= (const IFMEServerIdentity &other)

Detailed Description

IFMEServerIdentity interface.

Package Overview:

This file defines the interface that subclasses of this class MUST follow.

Developers MUST NOT implement their own subclasses of this, instead, the FME will ALWAYS provide them with the subclass instance they should be using.


Constructor & Destructor Documentation

IFMEServerIdentity::IFMEServerIdentity ( ) [inline, protected]
virtual IFMEServerIdentity::~IFMEServerIdentity ( ) [inline, protected, virtual]
IFMEServerIdentity::IFMEServerIdentity ( const IFMEServerIdentity other) [private]

Member Function Documentation

virtual void IFMEServerIdentity::getID ( IFMEServerString id) const [pure virtual]

Gets the user ID.

Parameters:
namethe user ID
virtual FME_Boolean IFMEServerIdentity::getIsAuthenticated ( ) const [pure virtual]

Checks if the user is authenticated.

Returns:
FME_TRUE if the user is authenticated, otherwise FME_FALSE
virtual void IFMEServerIdentity::getRoles ( IFMEServerStringArray roles) const [pure virtual]

Gets a list of the user's roles.

Parameters:
rolesa list of the user's roles
IFMEServerIdentity& IFMEServerIdentity::operator= ( const IFMEServerIdentity other) [private]

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines