IceGrid.UserAccountMapperPrx

class IceGrid.UserAccountMapperPrx

Bases: ObjectPrx

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 proxy class from Slice interface ::IceGrid::UserAccountMapper.

getUserAccount(user: str, context: dict[str, str] | None = None) → 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The user account name.

Return type:

str

Raises:

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

getUserAccountAsync(user: str, context: dict[str, str] | None = None) → 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The user account name.

Return type:

Awaitable[str]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → UserAccountMapperPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[UserAccountMapperPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → UserAccountMapperPrx
static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

Returns:

A new proxy with the requested facet, or None if the source proxy is None.

Return type:

ObjectPrx | None

static ice_staticId() → str

Returns the Slice type ID associated with this type.

Returns:

The Slice type ID.

Return type:

str