IceGrid.UserAccountMapper

class IceGrid.UserAccountMapper

Bases: Object, ABC

Maps user strings in server descriptors to actual user account names. You can configure the user account mapper of an IceGrid node with the property IceGrid.Node.UserAccountMapper.

Notes

The Slice compiler generated this skeleton class from Slice interface ::IceGrid::UserAccountMapper.

abstractmethod getUserAccount(user: str, current: Current) → str | Awaitable[str]

Gets 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 (str) – The value of the server descriptor’s user attribute. When this attribute is not defined, and the server’s activation mode is session, the default value for user is the session identifier.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

The user account name.

Return type:

str | Awaitable[str]

Raises:

UserAccountNotFoundException – Thrown when no user account is found for the given user.

static ice_staticId() → str

Obtain the type ID of the Slice interface.

Returns:

The type ID.

Return type:

str