@zeroc/ice
    Preparing search index...

    Class UserAccountMapperAbstract

    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.

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

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.

      Parameters

      Returns OutgoingResponse | PromiseLike<OutgoingResponse>

      The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

      Ice marshals any exception thrown by this method into the response.

    • 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: string

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

        The Current object for the dispatch.

      Returns string | PromiseLike<string>

      A promise like object representing the result of the dispatch, which resolves to:

      • string : The user account name.

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

    • Returns the Slice type ID of the most-derived interface supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string | PromiseLike<string>

      The Slice type ID of the most-derived interface.

    • Returns the Slice type IDs of the interfaces supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string[] | PromiseLike<string[]>

      The Slice type IDs of the interfaces supported by this object, in alphabetical order.

    • Tests whether this object supports a specific Slice interface.

      Parameters

      • typeID: string

        The type ID of the Slice interface to test against.

      • current: Current

        The Current object for the invocation.

      Returns boolean | PromiseLike<boolean>

      True if this object has the interface specified by typeID or derives from the interface specified by typeID.

    • Tests whether this object can be reached.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns void | PromiseLike<void>

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::IceGrid::UserAccountMapper".