Ice 3.7 Slice API Reference
Operations | List of all members
IceGrid::UserAccountMapper Interface Reference

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

defined in <IceGrid/UserAccountMapper.ice>

interface UserAccountMapper { ... }

Operations

string getUserAccount (string user) throws UserAccountNotFoundException
 Get the name of the user account for the given user. More...
 

Detailed Description

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

Operation Documentation

◆ getUserAccount()

string getUserAccount ( string  user) throws UserAccountNotFoundException

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
userThe 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.
Returns
The user account name.
Exceptions
UserAccountNotFoundExceptionRaised if no user account is found for the given user.

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