IFMEServerSingleSignOnIdentity Class Reference

IFMEServerSingleSignOnIdentity interface. More...

#include <ifmeserversinglesignonidentity.h>

List of all members.

Public Types
enum	AuthenticationState { Succeeded = 0, InProgress = 1, Failed = 2 }
Public Member Functions
virtual AuthenticationState	getAuthenticationState () const =0
virtual void	takeAuthData (IFMEServerString &authData)=0
Protected Member Functions
	IFMEServerSingleSignOnIdentity ()
virtual	~IFMEServerSingleSignOnIdentity ()
Private Member Functions
	IFMEServerSingleSignOnIdentity (const IFMEServerSingleSignOnIdentity &other)
IFMEServerSingleSignOnIdentity &	operator= (const IFMEServerSingleSignOnIdentity &other)

---

Detailed Description

IFMEServerSingleSignOnIdentity 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.

---

Member Enumeration Documentation

enum IFMEServerSingleSignOnIdentity::AuthenticationState

The possible authentication states for the single sign-on identity.

Enumerator:

Succeeded
InProgress
Failed

---

Constructor & Destructor Documentation

IFMEServerSingleSignOnIdentity::IFMEServerSingleSignOnIdentity

(

)

[inline, protected]

virtual IFMEServerSingleSignOnIdentity::~IFMEServerSingleSignOnIdentity

(

)

[inline, protected, virtual]

IFMEServerSingleSignOnIdentity::IFMEServerSingleSignOnIdentity

(

const IFMEServerSingleSignOnIdentity &

other

)

[private]

---

Member Function Documentation

virtual AuthenticationState IFMEServerSingleSignOnIdentity::getAuthenticationState

(

)

const [pure virtual]

Returns the authentication state.

Returns:

the authentication state

IFMEServerSingleSignOnIdentity& IFMEServerSingleSignOnIdentity::operator=

(

const IFMEServerSingleSignOnIdentity &

other

)

[private]

virtual void IFMEServerSingleSignOnIdentity::takeAuthData

(

IFMEServerString &

authData

)

[pure virtual]

Gets the authentication data returned from the server. If the server returned no such data, an empty string is returned.

The data may only be retrieved once; subsequent calls to takeAuthData() will return an empty string.

Parameters:

authData

the authentication data returned from the server, or an empty string if the server returned no data

---

The documentation for this class was generated from the following file:

• ifmeserversinglesignonidentity.h