zeroc-ice 3.7.11__cp314-cp314-macosx_10_15_universal2.whl → 3.8.0.post1__cp314-cp314-macosx_10_15_universal2.whl

slice/Glacier2/PermissionsVerifier.ice

@@ -1,111 +1,55 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
 [["cpp:dll-export:GLACIER2_API"]]
 [["cpp:doxygen:include:Glacier2/Glacier2.h"]]
 [["cpp:header-ext:h"]]
-[["cpp:include:Glacier2/Config.h"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
 
-[["objc:dll-export:GLACIER2_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:Glacier2"]]
+[["cpp:include:Glacier2/Config.h"]]
 
-#include <Glacier2/SSLInfo.ice>
+[["js:module:@zeroc/ice"]]
 
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
+#include "SSLInfo.ice"
 
-["objc:prefix:GLACIER2"]
+["java:identifier:com.zeroc.Glacier2"]
 module Glacier2
 {
-
-/**
- *
- * This exception is raised if a client is denied the ability to create
- * a session with the router.
- *
- **/
-["preserve-slice"]
-exception PermissionDeniedException
-{
-    /**
-     *
-     * The reason why permission was denied.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * The Glacier2 permissions verifier. This is called through the
- * process of establishing a session.
- *
- * @see Router
- *
- **/
-interface PermissionsVerifier
-{
-    /**
-     *
-     * Check whether a user has permission to access the router.
-     *
-     * @param userId The user id for which to check permission.
-     *
-     * @param password The user's password.
-     *
-     * @param reason The reason why access was denied.
-     *
-     * @return True if access is granted, or false otherwise.
-     *
-     * @throws PermissionDeniedException Raised if the user access is
-     * denied. This can be raised in place of returning false with a
-     * reason set in the reason out parameter.
-     *
-     **/
-    ["nonmutating", "cpp:const", "format:sliced"]
-    idempotent bool checkPermissions(string userId, string password, out string reason)
-        throws PermissionDeniedException;
-}
-
-/**
- *
- * The SSL Glacier2 permissions verifier. This is called through the
- * process of establishing a session.
- *
- * @see Router
- *
- **/
-interface SSLPermissionsVerifier
-{
-    /**
-     *
-     * Check whether a user has permission to access the router.
-     *
-     * @param info The SSL information.
-     *
-     * @param reason The reason why access was denied.
-     *
-     * @return True if access is granted, or false otherwise.
-     *
-     * @throws PermissionDeniedException Raised if the user access is
-     * denied. This can be raised in place of returning false with a
-     * reason set in the reason out parameter.
-     *
-     * @see SSLInfo
-     *
-     **/
-    ["nonmutating", "cpp:const", "format:sliced"]
-    idempotent bool authorize(SSLInfo info, out string reason)
-        throws PermissionDeniedException;
-}
-
+    /// The exception that is thrown when a client is not allowed to create a session.
+    exception PermissionDeniedException
+    {
+        /// The reason why permission was denied.
+        string reason;
+    }
+
+    /// Represents an object that checks user permissions. The Glacier2 router and other services use a
+    /// {@link PermissionsVerifier} proxy when the user is authenticated using a user ID and password.
+    interface PermissionsVerifier
+    {
+        /// Checks if a user is authorized to establish a session.
+        /// @param userId The user ID.
+        /// @param password The user's password.
+        /// @param reason The reason why access was denied.
+        /// @return `true` if access is granted, `false` otherwise.
+        /// @throws PermissionDeniedException Thrown when the user's access is denied. This exception can be thrown
+        /// instead of returning `false` with a reason set in the reason out parameter.
+        ["cpp:const"]
+        idempotent bool checkPermissions(string userId, string password, out string reason)
+            throws PermissionDeniedException;
+    }
+
+    /// Represents an object that checks user permissions. The Glacier2 router and other services use an
+    /// {@link SSLPermissionsVerifier} proxy when the user is authenticated through an SSL certificate.
+    interface SSLPermissionsVerifier
+    {
+        /// Checks if a user is authorized to establish a session.
+        /// @param info The SSL information.
+        /// @param reason The reason why access was denied.
+        /// @return `true` if access is granted, `false` otherwise.
+        /// @throws PermissionDeniedException Thrown when the user's access is denied. This exception can be thrown
+        /// instead of returning `false` with a reason set in the reason out parameter.
+        ["cpp:const"]
+        idempotent bool authorize(SSLInfo info, out string reason)
+            throws PermissionDeniedException;
+    }
 }

slice/Glacier2/Router.ice

@@ -1,186 +1,93 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
 [["cpp:dll-export:GLACIER2_API"]]
 [["cpp:doxygen:include:Glacier2/Glacier2.h"]]
 [["cpp:header-ext:h"]]
-[["cpp:include:Glacier2/Config.h"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:GLACIER2_API"]]
-[["objc:header-dir:objc"]]
 
-[["python:pkgdir:Glacier2"]]
+[["cpp:include:Glacier2/Config.h"]]
 
-#include <Ice/Router.ice>
-#include <Glacier2/Session.ice>
-#include <Glacier2/PermissionsVerifier.ice>
+[["js:module:@zeroc/ice"]]
 
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
+#include "Ice/Router.ice"
+#include "PermissionsVerifier.ice"
+#include "Session.ice"
 
-/**
- *
- * Glacier2 is a firewall solution for Ice. Glacier2 authenticates
- * and filters client requests and allows callbacks to the client in a
- * secure fashion. In combination with IceSSL, Glacier2 provides a
- * security solution that is both non-intrusive and easy to configure.
- *
- **/
-["objc:prefix:GLACIER2"]
+/// Communicate through firewalls and across NATs.
+["java:identifier:com.zeroc.Glacier2"]
 module Glacier2
 {
-
-/**
- *
- * This exception is raised if a client tries to destroy a session
- * with a router, but no session exists for the client.
- *
- * @see Router#destroySession
- *
- **/
-exception SessionNotExistException
-{
-}
-
-/**
- *
- * The Glacier2 specialization of the <code>Ice::Router</code> interface.
- *
- **/
-interface Router extends Ice::Router
-{
-    /**
-     *
-     * This category must be used in the identities of all of the client's
-     * callback objects. This is necessary in order for the router to
-     * forward callback requests to the intended client. If the Glacier2
-     * server endpoints are not set, the returned category is an empty
-     * string.
-     *
-     * @return The category.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent string getCategoryForClient();
-
-    /**
-     *
-     * Create a per-client session with the router. If a
-     * {@link SessionManager} has been installed, a proxy to a {@link Session}
-     * object is returned to the client. Otherwise, null is returned
-     * and only an internal session (i.e., not visible to the client)
-     * is created.
-     *
-     * If a session proxy is returned, it must be configured to route
-     * through the router that created it. This will happen automatically
-     * if the router is configured as the client's default router at the
-     * time the session proxy is created in the client process, otherwise
-     * the client must configure the session proxy explicitly.
-     *
-     * @see Session
-     * @see SessionManager
-     * @see PermissionsVerifier
-     *
-     * @return A proxy for the newly created session, or null if no
-     * {@link SessionManager} has been installed.
-     *
-     * @param userId The user id for which to check the password.
-     *
-     * @param password The password for the given user id.
-     *
-     * @throws PermissionDeniedException Raised if the password for
-     * the given user id is not correct, or if the user is not allowed
-     * access.
-     *
-     * @throws CannotCreateSessionException Raised if the session
-     * cannot be created.
-     *
-     **/
-    ["amd", "format:sliced"] Session* createSession(string userId, string password)
-        throws PermissionDeniedException, CannotCreateSessionException;
-
-    /**
-     *
-     * Create a per-client session with the router. The user is
-     * authenticated through the SSL certificates that have been
-     * associated with the connection. If a {@link SessionManager} has been
-     * installed, a proxy to a {@link Session} object is returned to the
-     * client. Otherwise, null is returned and only an internal
-     * session (i.e., not visible to the client) is created.
-     *
-     * If a session proxy is returned, it must be configured to route
-     * through the router that created it. This will happen automatically
-     * if the router is configured as the client's default router at the
-     * time the session proxy is created in the client process, otherwise
-     * the client must configure the session proxy explicitly.
-     *
-     * @see Session
-     * @see SessionManager
-     * @see PermissionsVerifier
-     *
-     * @return A proxy for the newly created session, or null if no
-     * {@link SessionManager} has been installed.
-     *
-     * @throws PermissionDeniedException Raised if the user cannot be
-     * authenticated or if the user is not allowed access.
-     *
-     * @throws CannotCreateSessionException Raised if the session
-     * cannot be created.
-     *
-     **/
-    ["amd", "format:sliced"] Session* createSessionFromSecureConnection()
-        throws PermissionDeniedException, CannotCreateSessionException;
-
-    /**
-     *
-     * Keep the calling client's session with this router alive.
-     *
-     * @throws SessionNotExistException Raised if no session exists
-     * for the calling client.
-     *
-     **/
-    ["amd"] void refreshSession()
-        throws SessionNotExistException;
-
-    /**
-     *
-     * Destroy the calling client's session with this router.
-     *
-     * @throws SessionNotExistException Raised if no session exists
-     * for the calling client.
-     *
-     **/
-    void destroySession()
-        throws SessionNotExistException;
-
-    /**
-     *
-     * Get the value of the session timeout. Sessions are destroyed
-     * if they see no activity for this period of time.
-     *
-     * @return The timeout (in seconds).
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent long getSessionTimeout();
-
-    /**
-     *
-     * Get the value of the ACM timeout. Clients supporting connection
-     * heartbeats can enable them instead of explicitly sending keep
-     * alives requests.
-     *
-     * NOTE: This method is only available since Ice 3.6.
-     *
-     * @return The timeout (in seconds).
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent int getACMTimeout();
-}
-
+    /// The exception that is thrown when a client tries to destroy a session with a router, but no session exists for
+    /// this client.
+    /// @see Router#destroySession
+    exception SessionNotExistException
+    {
+    }
+
+    /// The Glacier2 specialization of the {@link Ice::Router} interface.
+    interface Router extends Ice::Router
+    {
+        /// Gets a unique category that identifies the client (caller) in the router. This category must be used in the
+        /// identities of all the client's callback objects.
+        /// @return The category. It's an empty string when `Glacier2.Server.Endpoints` is not configured.
+        ["cpp:const"]
+        idempotent string getCategoryForClient();
+
+        /// Creates a session for the client (caller) with the router. If a {@link SessionManager} is configured,
+        /// a proxy to a {@link Session} object is returned to the client. Otherwise, null is returned and only an
+        /// internal session (i.e., not visible to the client) is created.
+        /// If a non-null session proxy is returned, it must be configured to route through the router that created it.
+        /// This occurs automatically when the router is configured as the client's default router at the time the
+        /// session proxy is created in the client application; otherwise, the client must configure the session proxy
+        /// explicitly.
+        /// @param userId The user ID.
+        /// @param password The password.
+        /// @return A proxy for the newly created session, or null if no {@link SessionManager} is configured.
+        /// @throws PermissionDeniedException Thrown when an authentication or authorization failure occurs.
+        /// @throws CannotCreateSessionException Thrown when the session cannot be created.
+        /// @see Session
+        /// @see SessionManager
+        /// @see PermissionsVerifier
+        Session* createSession(string userId, string password)
+            throws PermissionDeniedException, CannotCreateSessionException;
+
+        /// Creates a per-client session with the router. The user is authenticated through the SSL certificate(s)
+        /// associated with the connection. If an {@link SSLSessionManager} is configured, a proxy to a {@link Session}
+        /// object is returned to the client. Otherwise, null is returned and only an internal session (i.e., not
+        /// visible to the client) is created.
+        /// If a non-null session proxy is returned, it must be configured to route through the router that created it.
+        /// This occurs automatically when the router is configured as the client's default router at the time the
+        /// session proxy is created in the client application; otherwise, the client must configure the session proxy
+        /// explicitly.
+        /// @return A proxy for the newly created session, or null if no {@link SSLSessionManager} is configured.
+        /// @throws PermissionDeniedException Thrown when an authentication or authorization failure occurs.
+        /// @throws CannotCreateSessionException Thrown when the session cannot be created.
+        /// @see Session
+        /// @see SessionManager
+        /// @see PermissionsVerifier
+        Session* createSessionFromSecureConnection()
+            throws PermissionDeniedException, CannotCreateSessionException;
+
+        /// Keeps the session with this router alive.
+        /// @throws SessionNotExistException Thrown when no session exists for the caller (client).
+        ["deprecated:As of Ice 3.8, this operation does nothing."]
+        void refreshSession()
+            throws SessionNotExistException;
+
+        /// Destroys the session of the caller with this router.
+        /// @throws SessionNotExistException Thrown when no session exists for the caller (client).
+        void destroySession()
+            throws SessionNotExistException;
+
+        /// Gets the idle timeout used by the server-side of the connection.
+        /// @return The idle timeout (in seconds).
+        ["cpp:const"]
+        idempotent long getSessionTimeout();
+
+        /// Gets the idle timeout used by the server-side of the connection.
+        /// @return The idle timeout (in seconds).
+        ["cpp:const"]
+        idempotent int getACMTimeout();
+    }
 }

slice/Glacier2/SSLInfo.ice

@@ -1,59 +1,42 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
 [["cpp:dll-export:GLACIER2_API"]]
 [["cpp:doxygen:include:Glacier2/Glacier2.h"]]
 [["cpp:header-ext:h"]]
-[["cpp:include:Glacier2/Config.h"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
 
-[["objc:dll-export:GLACIER2_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:Glacier2"]]
+[["cpp:include:Glacier2/Config.h"]]
 
-#include <Ice/BuiltinSequences.ice>
+[["js:module:@zeroc/ice"]]
 
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
+#include "Ice/BuiltinSequences.ice"
 
-["objc:prefix:GLACIER2"]
+["java:identifier:com.zeroc.Glacier2"]
 module Glacier2
 {
+    interface SSLPermissionsVerifier; // So that doc-comments can link to `SSLPermissionsVerifier`.
 
-/**
- *
- * Information taken from an SSL connection used for permissions
- * verification.
- *
- * @see PermissionsVerifier
- *
- */
-struct SSLInfo
-{
-    /** The remote host. */
-    string remoteHost;
-
-    /** The remote port. */
-    int remotePort;
+    /// Represents information gathered from an incoming SSL connection and used for authentication and authorization.
+    /// @see SSLPermissionsVerifier
+    struct SSLInfo
+    {
+        /// The remote host.
+        string remoteHost;
 
-    /** The router's host. */
-    string localHost;
+        /// The remote port.
+        int remotePort;
 
-    /** The router's port. */
-    int localPort;
+        /// The router's host.
+        string localHost;
 
-    /** The negotiated cipher suite. */
-    string cipher;
+        /// The router's port.
+        int localPort;
 
-    /** The certificate chain. */
-    Ice::StringSeq certs;
-}
+        /// The negotiated cipher suite.
+        string cipher;
 
+        /// The certificate chain.
+        Ice::StringSeq certs;
+    }
 }