IFMEServerSecurityManager Class Reference

IFMEServerSecurityManager interface. More...

#include <ifmeserversecuritymanager.h>

List of all members.

Public Member Functions
virtual IFMEServerStatus *	addUserToken (const IFMEServerString &userName, const IFMEServerUserToken &userToken)=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 *	hasUserTokenExpired (const IFMEServerString &userName, FME_Boolean &expired) const =0
virtual IFMEServerStatus *	removeUserToken (const IFMEServerString &userName, FME_Boolean &existed)=0
virtual IFMEServerStatus *	updateUserToken (const IFMEServerString &userName, const IFMEServerUserToken &userToken)=0
virtual IFMEServerStatus *	userTokenExists (const IFMEServerString &userName, FME_Boolean &exists) const =0
Protected Member Functions
	IFMEServerSecurityManager ()
virtual	~IFMEServerSecurityManager ()
Private Member Functions
	IFMEServerSecurityManager (const IFMEServerSecurityManager &other)
IFMEServerSecurityManager &	operator= (const IFMEServerSecurityManager &other)

---

Detailed Description

IFMEServerSecurityManager 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

IFMEServerSecurityManager::IFMEServerSecurityManager

(

)

[inline, protected]

virtual IFMEServerSecurityManager::~IFMEServerSecurityManager

(

)

[inline, protected, virtual]

IFMEServerSecurityManager::IFMEServerSecurityManager

(

const IFMEServerSecurityManager &

other

)

[private]

---

Member Function Documentation

virtual IFMEServerStatus* IFMEServerSecurityManager::addUserToken	(	const IFMEServerString &	userName,
		const IFMEServerUserToken &	userToken
	)		[pure virtual]

Adds a new user token for the specified user.

Parameters:

userName	the user name
userToken	the user token to add

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerUserToken* IFMEServerSecurityManager::createUserToken

(

)

const [pure virtual]

Creates a new IFMEServerUserToken.

Returns:

a new IFMEServerUserToken instance

virtual IFMEServerUserToken* IFMEServerSecurityManager::createUserToken	(	const IFMEServerString &	token,
		const IFMEServerString &	clientAddress,
		FME_Int64	expirationTimeout
	)		const [pure virtual]

Creates a new IFMEServerUserToken.

Parameters:

token	the user token
clientAddress	the client address
expirationTimeout	the token expiration in seconds

Returns:

a new IFMEServerUserToken instance

virtual void IFMEServerSecurityManager::destroyUserToken

(

IFMEServerUserToken *&

userToken

)

const [pure virtual]

Frees the memory allocated for IFMEServerUserToken.

virtual IFMEServerStatus* IFMEServerSecurityManager::getUserToken	(	const IFMEServerString &	userName,
		IFMEServerUserToken &	userToken,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the token for the specified user.

Parameters:

userName	the user name
the	token for the specified user
FME_TRUE	if user token exists, otherwise FME_FALSE

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerSecurityManager::hasUserTokenExpired	(	const IFMEServerString &	userName,
		FME_Boolean &	expired
	)		const [pure virtual]

Checks if the user token for the specified user has expired.

Parameters:

userName	the user name
expired	FME_TRUE if the user token has expired, and otherwise FME_FALSE

Returns:

IFMEServerStatus if a FME Server exception occurred, or if a token does not exist for the specified user

IFMEServerSecurityManager& IFMEServerSecurityManager::operator=

(

const IFMEServerSecurityManager &

other

)

[private]

virtual IFMEServerStatus* IFMEServerSecurityManager::removeUserToken	(	const IFMEServerString &	userName,
		FME_Boolean &	existed
	)		[pure virtual]

Removes the user token for the specified user.

Parameters:

userName	the user name
existed	FME_TRUE if the user token existed prior to removed, and otherwise FME_FALSE

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerSecurityManager::updateUserToken	(	const IFMEServerString &	userName,
		const IFMEServerUserToken &	userToken
	)		[pure virtual]

Updates the user token for the specified user.

Parameters:

userName	the user name
userToken	the user token to update

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerSecurityManager::userTokenExists	(	const IFMEServerString &	userName,
		FME_Boolean &	exists
	)		const [pure virtual]

Checks if token exists for specified user.

Parameters:

userName	the user name
exists	FME_TRUE if user token exists, otherwise FME_FALSE

Returns:

IFMEServerStatus if a FME Server exception occurred

---

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

• ifmeserversecuritymanager.h