IceGrid::UserAccountMapper Class Reference

A user account mapper object is used by IceGrid nodes to map session identifiers to user accounts. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::UserAccountMapper:

Collaboration diagram for IceGrid::UserAccountMapper:

Public Types
using	ProxyType = UserAccountMapperPrx

Public Member Functions
virtual::std::string	getUserAccount (::std::string user, const ::Ice::Current &current)=0
	Get the name of the user account for the given user.
virtual::std::string	ice_id (const ::Ice::Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector<::std::string >	ice_ids (const ::Ice::Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool	ice_isA (::std::string id, const ::Ice::Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID.
Public Member Functions inherited from Ice::Object
virtual bool	ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
	Dispatches an invocation to a servant.
virtual std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object.
virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface.
virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached.
virtual	~Object ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type.

Detailed Description

A user account mapper object is used by IceGrid nodes to map session identifiers to user accounts.

Member Typedef Documentation

ProxyType

using IceGrid::UserAccountMapper::ProxyType = UserAccountMapperPrx

Member Function Documentation

getUserAccount()

virtual::std::string IceGrid::UserAccountMapper::getUserAccount ( ::std::string user, const ::Ice::Current & current )

pure virtual

Get the name of the user account for the given user.

This is used by IceGrid nodes to figure out the user account to use to run servers.

Parameters

user	The value of the server descriptor's user attribute. If this attribute is not defined, and the server's activation mode is session, the default value of user is the session identifier.
current	The Current object for the invocation.

Returns

The user account name.

Exceptions

IceGrid::UserAccountNotFoundException

Raised if no user account is found for the given user.

ice_id()

virtual::std::string IceGrid::UserAccountMapper::ice_id ( const ::Ice::Current & current ) const

override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current

The Current object for the invocation.

Returns

A fully-scoped type ID.

ice_ids()

virtual ::std::vector<::std::string > IceGrid::UserAccountMapper::ice_ids ( const ::Ice::Current & current ) const

override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current

The Current object for the invocation.

Returns

A list of fully-scoped type IDs.

ice_isA()

virtual bool IceGrid::UserAccountMapper::ice_isA ( ::std::string id, const ::Ice::Current & current ) const

overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns

True if this object supports the interface, false, otherwise.

ice_staticId()

const ::std::string & IceGrid::UserAccountMapper::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns

A fully-scoped type ID.

---

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

• generated/cpp11/x64/Release/IceGrid/UserAccountMapper.h