From 732a6512c5c54d834ec61cd77116bbcfba233078 Mon Sep 17 00:00:00 2001
From: Elizabeth Fong <elizabeth@threerings.net>
Date: Thu, 23 Jun 2005 01:33:43 +0000
Subject: [PATCH] refactored method for client to subscribe to runtime configs
 from yoweb into narya, since it uses no yohoho-specific code

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3618 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 .../admin/client/ConfigObjectManager.java     | 139 ++++++++++++++++++
 1 file changed, 139 insertions(+)
 create mode 100644 src/java/com/threerings/admin/client/ConfigObjectManager.java

diff --git a/src/java/com/threerings/admin/client/ConfigObjectManager.java b/src/java/com/threerings/admin/client/ConfigObjectManager.java
new file mode 100644
index 000000000..9d7c9c687
--- /dev/null
+++ b/src/java/com/threerings/admin/client/ConfigObjectManager.java
@@ -0,0 +1,139 @@
+package com.threerings.admin.client;
+
+import java.util.HashMap;
+
+import com.samskivert.util.StringUtil;
+
+import com.threerings.admin.Log;
+import com.threerings.admin.data.ConfigObject;
+
+import com.threerings.presents.client.Client;
+import com.threerings.presents.client.SessionObserver;
+import com.threerings.presents.dobj.DObject;
+import com.threerings.presents.dobj.DObjectManager;
+import com.threerings.presents.dobj.ObjectAccessException;
+import com.threerings.presents.dobj.Subscriber;
+
+public class ConfigObjectManager implements AdminService.ConfigInfoListener
+{
+    public ConfigObjectManager(Client client) {
+        _serverconfig = new HashMap();
+        _client = client;
+        _client.addClientObserver(new SessionObserver() {
+            // documentation inherited from interface SessionObserver
+            public void clientDidLogon (Client client) {
+                // Initialize the dobjmgr
+                _dobjmgr = _client.getDObjectManager();
+                // Now that we're logged on, let's grab the server configs
+                _service = (AdminService)
+                    client.requireService(AdminService.class);
+                getConfigInfo();
+            }
+
+            // documentation inherited from interface SessionObserver
+            public void clientDidLogoff (Client client) {
+                // Clean up our subscription to the server's configuration
+                for (int ii = 0; ii < _csubscribers.length; ii++) {
+                    _csubscribers[ii].cleanup();
+                }
+            }
+
+            // documentation inherited from interface SessionObserver
+            public void clientObjectDidChange (Client client) {}
+        });
+    }
+    
+    /**
+     * Convenience: generate a getConfigInfo request to the AdminService
+     * from the external class, instead from within the anonymous inner class
+     */
+    protected void getConfigInfo() {
+        _service.getConfigInfo(_client, this);
+    }
+
+    // documentation inherited from interface AdminService.ConfigInfoListener
+    public void gotConfigInfo (String[] keys, int[] oids)
+    {
+        _csubscribers = new ConfigObjectSubscriber[keys.length];
+        for (int ii = 0; ii < keys.length; ii++) {
+            _csubscribers[ii] = new ConfigObjectSubscriber();
+            _csubscribers[ii].subscribeConfig(keys[ii], oids[ii]);
+        }
+    }
+    
+    // documentation inherited from interface AdminService.ConfigInfoListener
+    public void requestFailed (String reason) {
+        Log.warning("Oh bugger, we didn't get the config data because " + reason);
+    }
+    
+    /**
+     * Returns the ConfigObject identified by the given key
+     */
+    public ConfigObject getServerConfig (String key) {
+        return (ConfigObject)_serverconfig.get(key);
+    }
+    
+    /**
+     * This class takes care of the details of subscribing to and placing
+     * an individual ConfigObject that the server knows about into a HashMap
+     */
+    protected class ConfigObjectSubscriber implements Subscriber
+    {
+        /**
+         * This method requests that we place a subscription to the
+         * ConfigObject with the given oid, identified by the key; when the
+         * object becomes available, it's added to our serverconfig map.
+         */
+        public void subscribeConfig (String key, int oid) {
+            _key = key;
+            _oid = oid;
+            _dobjmgr.subscribeToObject(_oid, this);
+        }
+
+        // documentation inherited from interface Subscriber
+        public void objectAvailable (DObject object) {
+            _cobj = (ConfigObject)object;
+            _serverconfig.put(_key, _cobj);
+        }
+        
+        // documentation inherited from interface Subscriber
+        public void requestFailed (int oid, ObjectAccessException cause) {
+            Log.warning("Unable to subscribe to config object " + _key);
+        }
+        
+        /**
+         * Signals that we should stop subscribing to our ConfigObject,
+         * and flush out the entry from the serverconfig map.
+         */
+        public void cleanup () {
+            // clear out our subscription
+            _dobjmgr.unsubscribeFromObject(_oid, this);
+            _cobj = null;
+            _serverconfig.remove(_key);
+        }
+
+        /** The object that we are tracking */
+        protected ConfigObject _cobj;
+        
+        /** The name of the config object that we are subscribing to */
+        protected String _key;
+        
+        /** The oid of the object that we're tracking */
+        protected int _oid;
+    }
+    
+    /** An array of handlers that each subscribe to a single ConfigObject */
+    protected ConfigObjectSubscriber[] _csubscribers;
+    
+    /** Our local copy of the server-side runtime configuration */
+    protected HashMap _serverconfig;
+    
+    /** Our distributed object manager */
+    protected DObjectManager _dobjmgr;
+    
+    /** Our admin service that we're using to fetch data */
+    protected AdminService _service;
+    
+    /** Our client object */
+    protected Client _client;
+}