zeroc-ice 3.7.10.1__cp312-cp312-win_amd64.whl → 3.8.0.post1__cp312-cp312-win_amd64.whl

slice/IceGrid/UserAccountMapper.ice

@@ -1,69 +1,34 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#pragma once
-
-[["cpp:dll-export:ICEGRID_API"]]
-[["cpp:doxygen:include:IceGrid/IceGrid.h"]]
-[["cpp:header-ext:h"]]
-[["cpp:include:IceGrid/Config.h"]]
-
-[["ice-prefix"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:ICEGRID_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:IceGrid"]]
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:ICEGRID"]
-module IceGrid
-{
-
-/**
- *
- * This exception is raised if a user account for a given session
- * identifier can't be found.
- *
- **/
-exception UserAccountNotFoundException
-{
-}
-
-/**
- *
- * A user account mapper object is used by IceGrid nodes to map
- * session identifiers to user accounts.
- *
- **/
-interface UserAccountMapper
-{
-    /**
-     *
-     * 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 <code>user</code>
-     * attribute. If this attribute is not defined, and the server's
-     * activation mode is <code>session</code>, the default value of
-     * <code>user</code> is the session identifier.
-     *
-     * @return The user account name.
-     *
-     * @throws UserAccountNotFoundException Raised if no user account
-     * is found for the given user.
-     *
-     **/
-    string getUserAccount(string user)
-        throws UserAccountNotFoundException;
-}
-
-}
+// Copyright (c) ZeroC, Inc.
+
+#pragma once
+
+[["cpp:dll-export:ICEGRID_API"]]
+[["cpp:doxygen:include:IceGrid/IceGrid.h"]]
+[["cpp:header-ext:h"]]
+
+[["cpp:include:IceGrid/Config.h"]]
+
+[["js:module:@zeroc/ice"]]
+
+["java:identifier:com.zeroc.IceGrid"]
+module IceGrid
+{
+    /// The exception that is thrown when a user account for a given session identifier can't be found.
+    exception UserAccountNotFoundException
+    {
+    }
+
+    /// 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`.
+    interface UserAccountMapper
+    {
+        /// 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.
+        /// @param user 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.
+        /// @return The user account name.
+        /// @throws UserAccountNotFoundException Thrown when no user account is found for the given user.
+        string getUserAccount(string user)
+            throws UserAccountNotFoundException;
+    }
+}