Changeset 2598

Timestamp:

07/05/08 22:16:07 (3 months ago)

Author:

jmoore

Message:

ticket:1018 - Propagating changes to OmeroJava and OmeroCpp

Also add environment methods which have been in OmeroPy for
some time.

Location:

trunk/components

Files:

• blitz/src/omero/client.java (modified) (10 diffs)
• blitz/test/omero/itests/UsageTest.java (modified) (2 diffs)
• tools/OmeroCpp/src/omero/client.cpp (modified) (6 diffs)
• tools/OmeroCpp/src/omero/client.h (modified) (4 diffs)
• tools/OmeroCpp/test/boost_fixture.cpp (modified) (1 diff)

trunk/components/blitz/src/omero/client.java

@@ -10 +10 @@
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Properties;
 import java.util.Set;
-
+import java.util.UUID;
+
+import omero.api.IAdminPrx;
+import omero.api.ISessionPrx;
 import omero.api.ServiceFactoryPrx;
 import omero.api.ServiceFactoryPrxHelper;
@@ -57 +61 @@
     ServiceFactoryPrx sf;
 
-    boolean close_on_destroy = false;
-
     boolean closed = false;
 
@@ -106 +108 @@
             throw new ClientError("No communicator.");
         }
+        // Register Object Factory
         ObjectFactoryRegistrar.registerObjectFactory(ic,
                 ObjectFactoryRegistrar.INSTANCE);
+        // Define our unique identifer (used during close/detach)
+        ic.getImplicitContext().put(omero.constants.CLIENTUUID.value,
+                UUID.randomUUID().toString());
         CLIENTS.add(this);
     }
@@ -114 +120 @@
     // =========================================================================
 
-    public void closeOnDestroy() {
-        close_on_destroy = true;
-    }
-
+    /**
+     * Equivalent to OmeroPy's __del__ or OmeroCpp's omero::client::~client()
+     */
     public void close() {
-        if (close_on_destroy) {
-            try {
-                closeSession();
-            } catch (Exception e) {
-                // ok.
-            }
-        }
-        if (ic != null) {
-            try {
-                ic.getLogger()
-                        .trace("omero.client.destroy", "Destroying " + ic);
-                ic.destroy();
-                ic = null;
-            } catch (Exception e) {
-                // ok
-            }
+        try {
+            closeSession();
+        } catch (Exception e) {
+            System.out.println("Ignoring error in client.close()");
+            e.printStackTrace();
+        } finally {
+            closed = true;
         }
     }
@@ -143 +139 @@
 
     public ServiceFactoryPrx getServiceFactory() {
+        if (sf == null) {
+            throw new ClientError("Call createSession() to login.");
+        }
         return sf;
     }
@@ -161 +160 @@
     public ServiceFactoryPrx createSession(String username, String password)
             throws CannotCreateSessionException, PermissionDeniedException {
+
+        // Check the required properties
         if (username == null) {
             username = getProperty("omero.user");
@@ -174 +175 @@
         }
 
+        // Acquire router and get the proxy
+        // For whatever reason, we have to se the context
+        // on the router context here as well
         Glacier2.SessionPrx prx = getRouter().createSession(username, password);
         if (null == prx) {
-            throw new ClientError("No session obtained");
-        }
+            throw new ClientError("Obtained null object proxy");
+        }
+        prx = Glacier2.SessionPrxHelper.uncheckedCast(prx.ice_context(ic
+                .getImplicitContext().getContext()));
         sf = ServiceFactoryPrxHelper.checkedCast(prx);
         if (sf == null) {
-            throw new ClientError("No session obtained");
-        }
+            throw new ClientError(
+                    "Obtained object proxy is not a ServiceFactory");
+        }
+
         return this.sf;
     }
@@ -199 +207 @@
 
     public void closeSession() {
-        if (this.sf == null) {
-            return; // EARLY EXIT
-        }
-
-        try {
-            sf.close();
-            sf = null;
-        } catch (Exception e) {
-            // what can we do
+
+        ServiceFactoryPrx old = this.sf;
+        if (this.sf != null) {
+            this.sf = null;
+        }
+
+        if (ic == null && sf != null) {
+            ic = sf.ice_getCommunicator();
+        }
+
+        if (ic == null) {
+            return; // EARLY EXIT!
         }
 
@@ -216 +227 @@
         } catch (Ice.ConnectionLostException cle) {
             // ok. Exception will always be thrown
-        }
-    }
-
-    public Object getInput(String key) {
-        throw new UnsupportedOperationException();
-    }
-
-    public Object getOutput(String key) {
-        throw new UnsupportedOperationException();
-    }
-
-    public void setInput(String key, Object value) {
-        throw new UnsupportedOperationException();
-    }
-
-    public void setOutput(String key, Object value) {
-        throw new UnsupportedOperationException();
+        } finally {
+            ic = null;
+        }
+    }
+
+    // Environment methods
+    // =========================================================================
+
+    public RType getInput(String key) throws ServerError {
+        return env().getInput(sess(), key);
+    }
+
+    public RType getOutput(String key) throws ServerError {
+        return env().getOutput(sess(), key);
+    }
+
+    public void setInput(String key, RType value) throws ServerError {
+        env().setInput(sess(), key, value);
+    }
+
+    public void setOutput(String key, RType value) throws ServerError {
+        env().setOutput(sess(), key, value);
+    }
+
+    public List<String> getInputKeys() throws ServerError {
+        return env().getInputKeys(sess());
+    }
+
+    public List<String> getOutputKeys() throws ServerError {
+        return env().getOutputKeys(sess());
     }
 
@@ -249 +273 @@
     }
 
+    /**
+     * Helper method to access session environment
+     */
+    protected ISessionPrx env() throws ServerError {
+        if (sf == null) {
+            throw new ClientError("No session active");
+        }
+        ISessionPrx s = sf.getSessionService();
+        return s;
+    }
+
+    /**
+     * Helper method to access session id
+     */
+    protected String sess() throws ServerError {
+        if (sf == null) {
+            throw new ClientError("No session active");
+        }
+        IAdminPrx a = sf.getAdminService();
+        String u = a.getEventContext().sessionUuid;
+        return u;
+    }
 }

trunk/components/blitz/test/omero/itests/UsageTest.java

@@ -10 +10 @@
 
 import junit.framework.TestCase;
+import omero.RString;
 
 import org.springframework.util.ResourceUtils;
@@ -18 +19 @@
     @Test
     public void testClientClosedAutomatically() throws Exception {
-        File f1 = ResourceUtils.getFile("classpath:ice.config");
-        File f2 = ResourceUtils.getFile("classpath:local.properties");
-        omero.client client = new omero.client(f1, f2);
-        client.closeOnDestroy();
+        File f1 = ResourceUtils.getFile("classpath:local.properties");
+        omero.client client = new omero.client(f1);
+        client.createSession();
+        client.getServiceFactory().closeOnDestroy();
     }
 
     @Test
     public void testClientClosedManually() throws Exception {
-        File f1 = ResourceUtils.getFile("classpath:ice.config");
-        File f2 = ResourceUtils.getFile("classpath:local.properties");
-        omero.client client = new omero.client(f1, f2);
-        client.closeOnDestroy();
+        File f1 = ResourceUtils.getFile("classpath:local.properties");
+        omero.client client = new omero.client(f1);
+        client.createSession();
+        client.getServiceFactory().closeOnDestroy();
         client.close();
     }
+
+    @Test
+    public void testUseSharedMemory() throws Exception {
+        File f1 = ResourceUtils.getFile("classpath:local.properties");
+        omero.client client = new omero.client(f1);
+        client.createSession();
+
+        assertEquals(0, client.getInputKeys().size());
+        client.setInput("a", new omero.RString("b"));
+        assertEquals(1, client.getInputKeys().size());
+        assertTrue(client.getInputKeys().contains("a"));
+        assertEquals("b", ((RString) client.getInput("a")).val);
+
+        client.close();
+    }
+
 }

trunk/components/tools/OmeroCpp/src/omero/client.cpp

@@ -17 +17 @@
       throw omero::ClientError(__FILE__,__LINE__,"Improper initialization.");
     }
+    // Register Object Factory
     ObjectFactoryPtr of = new ObjectFactory();
     of->registerObjectFactory(ic);
+    // Define our unique identifier (used during close/detach)
+    ic->getImplicitContext()->put(omero::constants::CLIENTUUID, IceUtil::generateUUID());
   }
 
   client::client(const Ice::InitializationData& id) {
     ic = Ice::initialize(id);
-    close_on_destroy = false;
     init(ic);
   }
@@ -30 +32 @@
                  const Ice::InitializationData& id) {
     ic = Ice::initialize(argc, argv, id);
-    close_on_destroy = false;
     init(ic);
   }
 
   client::~client(){
-      if (close_on_destroy && sf) {
+      try {
           closeSession();
-      }
-      if (ic) {
-          try {
-              ic->destroy();
-          } catch (const Ice::Exception& ex) {
-              cerr << "Caught Ice exception while destroying communicator." << endl;
-              cerr << ex << endl;
-          }
-          ic = Ice::CommunicatorPtr();
+      } catch (...) {
+          std::cout << "Ignoring error in ~client"<< std::endl;
       }
   }
@@ -51 +45 @@
   omero::api::ServiceFactoryPrx client::createSession(const std::string& _username, const std::string& _password) {
 
+      // Check the required properties
     std::string username, password;
     if (_username.empty()) {
@@ -70 +65 @@
     }
 
+    // Acquire router and get the proxy
+    // For whatever reason, we have to se the context
+    // on the router context here as well.
     Ice::RouterPrx prx = ic->getDefaultRouter();
     if (!prx) {
         throw omero::ClientError(__FILE__,__LINE__,"No default router found.");
     }
+    prx = Ice::RouterPrx::uncheckedCast(prx->ice_context(ic->getImplicitContext()->getContext()));
     Glacier2::RouterPrx router = Glacier2::RouterPrx::checkedCast(prx);
     if (!router) {
@@ -81 +80 @@
     Glacier2::SessionPrx session;
     session = router->createSession(username, password);
+    if (!session) {
+        throw omero::ClientError(__FILE__,__LINE__,"Obtained null object proxy");
+    }
+
+    // Check type
     sf = omero::api::ServiceFactoryPrx::checkedCast(session);
     if (!sf) {
-      throw omero::ClientError(__FILE__,__LINE__,"No session obtained.");
+      throw omero::ClientError(__FILE__,__LINE__,"Obtained object proxy is not a ServiceFactory.");
     }
     return sf;
@@ -89 +93 @@
 
   void client::closeSession() {
-    if (sf) {
-      try {
-        sf->close();
-      } catch (const Ice::Exception& ex) {
-        // ok
+
+      omero::api::ServiceFactoryPrx old = sf;
+      sf = omero::api::ServiceFactoryPrx();
+
+      if (!ic && old) {
+          ic = old->ice_getCommunicator();
       }
-      sf = omero::api::ServiceFactoryPrx();
-    }
-    Ice::RouterPrx prx = ic->getDefaultRouter();
-    Glacier2::RouterPrx router = Glacier2::RouterPrx::checkedCast(prx);
-    try {
-        router->destroySession();
-    } catch (const Ice::ConnectionLostException& cle) {
-        // ok. Always thrown.
-    }
+
+      if (ic) {
+
+          Ice::RouterPrx prx = ic->getDefaultRouter();
+          Glacier2::RouterPrx router = Glacier2::RouterPrx::checkedCast(prx);
+          if (router) {
+              try {
+                  router->destroySession();
+              } catch (const Ice::ConnectionLostException& cle) {
+                  // ok. Always thrown.
+              } // TODO what about SNEE
+          }
+
+          try {
+              ic->destroy();
+          } catch (const Ice::Exception& ex) {
+              cerr << "Caught Ice exception while destroying communicator." << endl;
+              cerr << ex << endl;
+          }
+          ic = Ice::CommunicatorPtr();
+      }
+
   }
 
+    // Environment methods
+    // ======================================================================
+    omero::RTypePtr client::getInput(const string& key) {
+        return env()->getInput(sess(), key);
+    }
+    omero::RTypePtr client::getOutput(const string& key) {
+        return env()->getOutput(sess(), key);
+    }
+    void client::setInput(const string& key, omero::RTypePtr value) {
+        env()->setInput(sess(), key, value);
+    }
+    void client::setOutput(const string& key, omero::RTypePtr value) {
+        env()->setOutput(sess(), key, value);
+    }
+    vector<string> client::getInputKeys() {
+        env()->getInputKeys(sess());
+    }
+    vector<string> client::getOutputKeys() {
+        env()->getOutputKeys(sess());
+    }
+    omero::api::ISessionPrx client::env() {
+        return sf->getSessionService();
+    }
+    const std::string client::sess() {
+        return sf->getAdminService()->getEventContext()->sessionUuid;
+    }
 }
 

trunk/components/tools/OmeroCpp/src/omero/client.h

@@ -32 +32 @@
    * omero::api::ServiceFactoryPrx which is the blitz session facade,
    * from which all other proxies can be obtained. Once the
-   * ServiceFactoryPrx is destroyed, times out, or close() is called,
+   * ServiceFactoryPrx is destroyed or the session times out,
    * all proxies obtained from this instance are also destroyed.
    *
@@ -49 +49 @@
     // These are the central instances provided by this class.
   protected:
-    bool close_on_destroy;
     Ice::CommunicatorPtr ic;
     omero::api::ServiceFactoryPrx sf;
@@ -76 +75 @@
     /*
      * Destroys the communicator instance. To have the session destroyed,
-     * call close on the client before destruction. Otherwise, the session
-     * will be destroyed by the server on timeout.
+     * call getSession().closeOnDestroy() on the client before destruction.
+     * Otherwise, the session will be destroyed by the server on timeout.
      */
     ~client();
@@ -99 +98 @@
 
     /*
-     * Frees server-side resources. This method attempts to do everything
-     * it can without throwing an exception.
+     * Closes the Router connection created by createSession(). Due to a bug in Ice,
+     * only one connection is allowed per communicator, so we also destroy the
+     * communicator.
      */
     void closeSession();
 
     /*
-     * If called, then an existing session will be closed during
-     * destruction.
+     * Environment methods. Allows to store and retrieve
      */
-    void closeOnDestroy() {
-        close_on_destroy = true;
-    }
+    omero::RTypePtr getInput(const std::string& key);
+    omero::RTypePtr getOutput(const std::string& key);
+    void setInput(const std::string& key, omero::RTypePtr value);
+    void setOutput(const std::string& key, omero::RTypePtr value);
+    std::vector<std::string> getInputKeys();
+    std::vector<std::string> getOutputKeys();
+  protected:
+    const std::string sess();
+    omero::api::ISessionPrx env();
 
   };

trunk/components/tools/OmeroCpp/test/boost_fixture.cpp

@@ -102 +102 @@
         omero::client* client = new omero::client(argc, argv);
         client->createSession(username, password);
-        client->closeOnDestroy();
+        //  client->getSession()->closeOnDestroy(); Default.
         clients.push_back(client);
         return client;