IceGrid._UserAccountMapperOperations Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of icegrid-compat Show documentation

Locate, deploy, and manage Ice servers

There is a newer version: 3.7.10

//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
//
// Ice version 3.7.3
//
// 
//
// Generated from file `UserAccountMapper.ice'
//
// Warning: do not edit this file.
//
// 
//

package IceGrid;

/**
 * A user account mapper object is used by IceGrid nodes to map
 * session identifiers to user accounts.
 *
 **/
public interface _UserAccountMapperOperations
{
    /**
     * 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.
     *
     * @param 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.
     *
     * @param current The Current object for the invocation.
     * @return The user account name.
     *
     * @throws UserAccountNotFoundException Raised if no user account
     * is found for the given user.
     *
     **/
    String getUserAccount(String user, Ice.Current current)
        throws UserAccountNotFoundException;
}