FME Server C++ API 3.0

IFMEServerUserToken Class Reference

IFMEServerUserToken interface. More...

#include <ifmeserverusertoken.h>

List of all members.

Public Member Functions

virtual void getClientAddress (IFMEServerString &clientAddress) const =0
virtual FME_Int64 getExpirationTimeout () const =0
virtual void getToken (IFMEServerString &token) const =0

Protected Member Functions

 IFMEServerUserToken ()
virtual ~IFMEServerUserToken ()

Private Member Functions

 IFMEServerUserToken (const IFMEServerUserToken &other)
IFMEServerUserTokenoperator= (const IFMEServerUserToken &other)

Detailed Description

IFMEServerUserToken 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

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

Member Function Documentation

virtual void IFMEServerUserToken::getClientAddress ( IFMEServerString clientAddress) const [pure virtual]

Get the client address.

Possible client addresses could be IP address, Web Referrer URL, etc.

Parameters:
clientAddressthe client address.
virtual FME_Int64 IFMEServerUserToken::getExpirationTimeout ( ) const [pure virtual]

Gets the expiration timeout in seconds for the token. This value indicates how long a token is valid for.

Returns:
the expiration timeout in seconds for the token.
virtual void IFMEServerUserToken::getToken ( IFMEServerString token) const [pure virtual]

Gets the user token value.

Parameters:
tokenthe user token value.
IFMEServerUserToken& IFMEServerUserToken::operator= ( const IFMEServerUserToken other) [private]

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