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::UserAccountMapperPrx:

Collaboration diagram for IceGrid::UserAccountMapperPrx:

Public Member Functions
::std::string	getUserAccount (const ::std::string &user, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the name of the user account for the given user. More...

::std::function< void()>	getUserAccountAsync (const ::std::string &user, ::std::function< void(::std::string)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the name of the user account for the given user. More...

template<template< typename > class P = ::std::promise>
auto	getUserAccountAsync (const ::std::string &user, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::string >>().get_future())
	Get the name of the user account for the given user. More...

Public Member Functions inherited from Ice::Proxy< UserAccountMapperPrx, ::Ice::ObjectPrx >
::std::shared_ptr< UserAccountMapperPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...

::std::shared_ptr< UserAccountMapperPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface. More...

Detailed Description

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

Member Function Documentation

◆ getUserAccount()

::std::string IceGrid::UserAccountMapperPrx::getUserAccount	(	const ::std::string &	user,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
context	The Context map to send with the invocation.

Returns: The user account name.

Exceptions

IceGrid::UserAccountNotFoundException Raised if no user account is found for the given user.

◆ getUserAccountAsync() [1/2]

::std::function<void()> IceGrid::UserAccountMapperPrx::getUserAccountAsync	(	const ::std::string &	user,
		::std::function< void(::std::string)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ getUserAccountAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceGrid::UserAccountMapperPrx::getUserAccountAsync	(	const ::std::string &	user,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::std::string>>().get_future())

inline

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.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

static const ::std::string& IceGrid::UserAccountMapperPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getUserAccount()

◆ getUserAccountAsync() [1/2]

◆ getUserAccountAsync() [2/2]

◆ ice_staticId()