zeroc-ice 3.7.11 → 3.8.1

data/dist/ice/slice/IceGrid/Exception.ice

@@ -1,396 +1,98 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// 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"]]
-
-[["ice-prefix"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:header-dir:objc"]]
 
-[["python:pkgdir:IceGrid"]]
-
-#ifndef ICE_BUILDING_ICEGRIDDB
-[["cpp:dll-export:ICEGRID_API"]]
-
-[["objc:dll-export:ICEGRID_API"]]
-#endif
+[["cpp:include:IceGrid/Config.h"]]
 
-#include <Ice/Identity.ice>
-#include <Ice/BuiltinSequences.ice>
+[["js:module:@zeroc/ice"]]
 
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
+#include "Ice/Identity.ice"
 
-["objc:prefix:ICEGRID"]
+["java:identifier:com.zeroc.IceGrid"]
 module IceGrid
 {
-
-/**
- *
- * This exception is raised if an application does not exist.
- *
- **/
-exception ApplicationNotExistException
-{
-    /**
-     *
-     * The name of the application.
-     *
-     **/
-    string name;
-}
-
-/**
- *
- * This exception is raised if a server does not exist.
- *
- **/
-exception ServerNotExistException
-{
-    /**
-     *
-     * The identifier of the server.
-     *
-     */
-    string id;
-}
-
-/**
- *
- * This exception is raised if a server failed to start.
- *
- **/
-exception ServerStartException
-{
-    /**
-     *
-     * The identifier of the server.
-     *
-     **/
-    string id;
-
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if a server failed to stop.
- *
- **/
-exception ServerStopException
-{
-    /**
-     *
-     * The identifier of the server.
-     *
-     **/
-    string id;
-
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if an adapter does not exist.
- *
- **/
-exception AdapterNotExistException
-{
-    /**
-     *
-     * The id of the object adapter.
-     *
-     **/
-    string id;
-}
-
-/**
- *
- * This exception is raised if an object already exists.
- *
- **/
-exception ObjectExistsException
-{
-    /**
-     *
-     * The identity of the object.
-     *
-     **/
-    Ice::Identity id;
-}
-
-/**
- *
- * This exception is raised if an object is not registered.
- *
- **/
-exception ObjectNotRegisteredException
-{
-    /**
-     *
-     * The identity of the object.
-     *
-     **/
-    Ice::Identity id;
-}
-
-/**
- *
- * This exception is raised if a node does not exist.
- *
- **/
-exception NodeNotExistException
-{
-    /**
-     *
-     * The node name.
-     *
-     **/
-    string name;
-}
-
-/**
- *
- * This exception is raised if a registry does not exist.
- *
- **/
-exception RegistryNotExistException
-{
-    /**
-     *
-     * The registry name.
-     *
-     **/
-    string name;
-}
-
-/**
- *
- * An exception for deployment errors.
- *
- **/
-exception DeploymentException
-{
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if a node could not be reached.
- *
- **/
-exception NodeUnreachableException
-{
-    /**
-     *
-     * The name of the node that is not reachable.
-     *
-     **/
-    string name;
-
-    /**
-     *
-     * The reason why the node couldn't be reached.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if a server could not be reached.
- *
- **/
-exception ServerUnreachableException
-{
-    /**
-     *
-     * The id of the server that is not reachable.
-     *
-     **/
-    string name;
-
-    /**
-     *
-     * The reason why the server couldn't be reached.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if a registry could not be reached.
- *
- **/
-exception RegistryUnreachableException
-{
-    /**
-     *
-     * The name of the registry that is not reachable.
-     *
-     **/
-    string name;
-
-    /**
-     *
-     * The reason why the registry couldn't be reached.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if an unknown signal was sent to
- * to a server.
- *
- **/
-exception BadSignalException
-{
-    /**
-     *
-     * The details of the unknown signal.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if a patch failed.
- *
- **/
-exception PatchException
-{
-    /**
-     *
-     * The reasons why the patch failed.
-     *
-     **/
-    Ice::StringSeq reasons;
-}
-
-/**
- *
- * This exception is raised if a registry lock wasn't
-  * acquired or is already held by a session.
- *
- **/
-exception AccessDeniedException
-{
-    /**
-     *
-     * The id of the user holding the lock (if any).
-     *
-     **/
-    string lockUserId;
-}
-
-/**
- *
- * This exception is raised if the allocation of an object failed.
- *
- **/
-exception AllocationException
-{
-    /**
-     *
-     * The reason why the object couldn't be allocated.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if the request to allocate an object times
- * out.
- *
- **/
-exception AllocationTimeoutException extends AllocationException
-{
-}
-
-/**
- *
- * This exception is raised if a client is denied the ability to create
- * a session with IceGrid.
- *
- **/
-exception PermissionDeniedException
-{
-    /**
-     *
-     * The reason why permission was denied.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if an observer is already registered with
- * the registry.
- *
- * @see AdminSession#setObservers
- * @see AdminSession#setObserversByIdentity
- *
- **/
-exception ObserverAlreadyRegisteredException
-{
-    /**
-     *
-     * The identity of the observer.
-     *
-     **/
-    Ice::Identity id;
-}
-
-/**
- *
- * This exception is raised if a file is not available.
- *
- * @see AdminSession#openServerStdOut
- * @see AdminSession#openServerStdErr
- * @see AdminSession#openNodeStdOut
- * @see AdminSession#openNodeStdErr
- * @see AdminSession#openRegistryStdOut
- * @see AdminSession#openRegistryStdErr
- *
- **/
-exception FileNotAvailableException
-{
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
+    /// The exception that is thrown when IceGrid does not know an application with the provided name.
+    exception ApplicationNotExistException
+    {
+        /// The name of the application.
+        string name;
+    }
+
+    /// The exception that is thrown when IceGrid does not know a server with the provided server ID.
+    exception ServerNotExistException
+    {
+        /// The server ID.
+        string id;
+    }
+
+    /// The exception that is thrown when a server failed to start.
+    exception ServerStartException
+    {
+        /// The server ID.
+        string id;
+
+        /// The reason for the failure.
+        string reason;
+    }
+
+    /// The exception that is thrown when a server failed to stop.
+    exception ServerStopException
+    {
+        /// The server ID.
+        string id;
+
+        /// The reason for the failure.
+        string reason;
+    }
+
+    /// The exception that is thrown when IceGrid does not know an object adapter with the provided adapter ID.
+    exception AdapterNotExistException
+    {
+        /// The adapter ID.
+        string id;
+    }
+
+    /// The exception that is thrown when IceGrid does not know a node with the provided name.
+    exception NodeNotExistException
+    {
+        /// The node name.
+        string name;
+    }
+
+    /// The exception that is thrown when IceGrid does not know a registry with the provided name.
+    exception RegistryNotExistException
+    {
+        /// The registry name.
+        string name;
+    }
+
+    /// The exception that is thrown when the allocation of an object failed.
+    exception AllocationException
+    {
+        /// The reason why the object couldn't be allocated.
+        string reason;
+    }
+
+    /// The exception that is thrown when the request to allocate an object times out.
+    exception AllocationTimeoutException extends AllocationException
+    {
+    }
+
+    /// The exception that is thrown when a well-known object is already registered.
+    exception ObjectExistsException
+    {
+        /// The identity of the object.
+        Ice::Identity id;
+    }
+
+    /// The exception that is thrown when a well-known object is not registered.
+    exception ObjectNotRegisteredException
+    {
+        /// The identity of the object.
+        Ice::Identity id;
+    }
 }

data/dist/ice/slice/IceGrid/FileParser.ice

@@ -1,72 +1,36 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// 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"]]
-
-[["ice-prefix"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:ICEGRID_API"]]
-[["objc:header-dir:objc"]]
 
-[["python:pkgdir:IceGrid"]]
+[["cpp:include:IceGrid/Config.h"]]
 
-#include <IceGrid/Admin.ice>
+[["js:module:@zeroc/ice"]]
 
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
+#include "Admin.ice"
 
-["objc:prefix:ICEGRID"]
+["java:identifier:com.zeroc.IceGrid"]
 module IceGrid
 {
-
-/**
- *
- * This exception is raised if an error occurs during parsing.
- *
- **/
-exception ParseException
-{
-    /** The reason for the failure. */
-    string reason;
-}
-
-/**
- *
- * <code>icegridadmin</code> provides a {@link FileParser}
- * object to transform XML files into {@link ApplicationDescriptor}
- * objects.
- *
- **/
-interface FileParser
-{
-
-    /**
-     *
-     * Parse a file.
-     *
-     * @param xmlFile Full pathname to the file.
-     *
-     * @param adminProxy An Admin proxy, used only to retrieve default
-     * templates when needed. May be null.
-     *
-     * @return The application descriptor.
-     *
-     * @throws ParseException Raised if an error occurred during parsing.
-     *
-     **/
-
-    idempotent ApplicationDescriptor parse(string xmlFile, Admin* adminProxy)
-        throws ParseException;
-}
-
+    /// The exception that is thrown when an error occurs during the parsing of an IceGrid XML file.
+    exception ParseException
+    {
+        /// The reason for the failure.
+        string reason;
+    }
+
+    /// `icegridadmin` provides a `FileParser` object to transform XML files into {@link ApplicationDescriptor} objects.
+    interface FileParser
+    {
+        /// Parses a file.
+        /// @param xmlFile The full path to the file.
+        /// @param adminProxy An {@link Admin} proxy, used only to retrieve default templates when needed. May be null.
+        /// @return The application descriptor.
+        /// @throws ParseException Thrown when an error occurs during parsing.
+        idempotent ApplicationDescriptor parse(string xmlFile, Admin* adminProxy)
+            throws ParseException;
+    }
 }