zeroc-ice 3.6b1

data/slice/Freeze/Exception.ice

@@ -0,0 +1,100 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#pragma once
+
+[["cpp:header-ext:h"]]
+
+module Freeze
+{
+
+local interface Transaction;
+
+/**
+ *
+ * A Freeze database exception.
+ *
+ * @see Evictor
+ * @see Connection
+ *
+ **/
+["cpp:ice_print"]
+local exception DatabaseException
+{
+    /**
+     *
+     * A message describing the reason for the exception.
+     *
+     **/
+    string message;
+};
+
+/**
+ *
+ * A Freeze database exception, indicating that a database record
+ * could not be found.
+ *
+ **/
+["cpp:ice_print"]
+local exception NotFoundException extends DatabaseException
+{
+};
+
+/**
+ *
+ * A Freeze database deadlock exception. Applications can react to
+ * this exception by aborting and trying the transaction again.
+ *
+ **/
+["cpp:ice_print"]
+local exception DeadlockException extends DatabaseException
+{
+    /**
+     *
+     * The transaction in which the deadlock occurred.
+     *
+     **/
+    Transaction tx;
+};
+
+/**
+ *
+ * This Freeze Iterator is not on a valid position, for example
+ * this position has been erased.
+ *
+ **/
+local exception InvalidPositionException
+{
+};
+
+/**
+ *
+ * Exception raised when Freeze fails to locate an index.
+ *
+ **/
+["cpp:ice_print"]
+local exception IndexNotFoundException
+{
+    /**
+     *
+     * The name of the map in which the index could not be found.
+     *
+     **/
+    string mapName;
+
+    /**
+     *
+     * The name of the index.
+     *
+     **/
+    string indexName;
+};
+
+};
+

data/slice/Freeze/Transaction.ice

@@ -0,0 +1,57 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#pragma once
+
+[["cpp:header-ext:h"]]
+
+module Freeze
+{
+
+local interface Connection;
+
+
+/**
+ * 
+ * A transaction. If you want to use a transaction concurrently 
+ * in multiple threads, you need to serialize access to this
+ * transaction.
+ *
+ **/
+local interface Transaction
+{
+    /**
+     *
+     * Commit this transaction. 
+     *
+     * @throws DatabaseException Raised if a database failure occurred.
+     *
+     **/
+    void commit();
+
+    /**
+     *
+     * Roll back this transaction. 
+     *
+     * @throws DatabaseException Raised if a database failure occurred.
+     *
+     **/
+    void rollback();
+
+    /**
+     *
+     * Get the connection associated with this Transaction
+     *
+     **/
+    ["cpp:const"] Connection getConnection();
+}; 
+
+
+};
+

data/slice/Freeze/TransactionalEvictor.ice

@@ -0,0 +1,50 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#pragma once
+
+[["cpp:header-ext:h"]]
+
+#include <Freeze/Evictor.ice>
+
+module Freeze
+{
+
+local interface Transaction;
+
+/**
+ * 
+ * A transactional evictor is an evictor that performs every single read-write
+ * operation within its own transaction.
+ *
+ **/
+local interface TransactionalEvictor extends Evictor
+{
+    /**
+     *
+     * Get the transaction associated with the calling thread.
+     *
+     * @return The transaction associated with the calling thread.
+     *
+     **/
+    ["cpp:const"] Transaction getCurrentTransaction();
+
+    /**
+     *
+     * Associate a transaction with the calling thread.
+     *
+     * @param tx The transaction to associate with the calling thread.
+     *
+     **/
+    void setCurrentTransaction(Transaction tx);
+};
+
+};
+
+

data/slice/Glacier2/Metrics.ice

@@ -0,0 +1,77 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#pragma once
+
+[["cpp:header-ext:h"]]
+[["cpp:include:Glacier2/Config.h"]]
+
+#include <Ice/Metrics.ice>
+
+module IceMX
+{
+
+/**
+ *
+ * Provides information on Glacier2 sessions.
+ *
+ **/
+class SessionMetrics extends Metrics
+{
+    /**
+     *
+     * Number of client requests forwared.
+     *
+     **/
+    int forwardedClient = 0;
+
+    /**
+     *
+     * Number of server requests forwared.
+     *
+     **/
+    int forwardedServer = 0;
+ 
+    /**
+     *
+     * The size of the routing table.
+     * 
+     **/
+    int routingTableSize = 0;
+ 
+    /**
+     *
+     * Number of client requests queued.
+     *
+     **/
+    int queuedClient = 0;
+
+    /**
+     *
+     * Number of server requests queued.
+     *
+     **/
+    int queuedServer = 0;
+ 
+    /**
+     *
+     * Number of client requests overridden.
+     *
+     **/
+    int overriddenClient = 0;
+
+    /**
+     *
+     * Number of server requests overridden.
+     *
+     **/
+    int overriddenServer = 0;
+};
+
+};

data/slice/Glacier2/PermissionsVerifier.ice

@@ -0,0 +1,105 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#pragma once
+
+[["cpp:header-ext:h"]]
+[["cpp:include:Glacier2/Config.h"]]
+
+#include <Glacier2/SSLInfo.ice>
+
+module Glacier2
+{
+
+/**
+ *
+ * This exception is raised if a client is denied the ability to create
+ * a session with the router.
+ *
+ * @see Router#createSession
+ * @see Router#createSessionFromSecureConnection
+ *
+ **/
+["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;
+};
+
+};
+

data/slice/Glacier2/PermissionsVerifierF.ice

@@ -0,0 +1,21 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#pragma once
+
+[["cpp:header-ext:h"]]
+
+module Glacier2
+{
+
+interface PermissionsVerifier;
+interface SSLPermissionsVerifier;
+
+};
+

data/slice/Glacier2/Router.ice

@@ -0,0 +1,178 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#pragma once
+
+[["cpp:header-ext:h"]]
+[["cpp:include:Glacier2/Config.h"]]
+
+#include <Ice/Router.ice>
+#include <Glacier2/Session.ice>
+#include <Glacier2/PermissionsVerifier.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.
+ *
+ **/
+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 {@link Ice.Router}
+ * 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();
+};
+
+};
+