Convert Narya (most of the way) over to a Maven Ant task based build. The

ActionScript bits remain belligerent, but the Java stuff is mostly shipshape.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@6222 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/main/java/com/threerings/bureau/client/Agent.java

@@ -0,0 +1,53 @@
+//
+// $Id$
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
+// http://code.google.com/p/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.bureau.client;
+
+import com.threerings.bureau.data.AgentObject;
+
+/**
+ * Represents an agent running within a bureau client.
+ */
+public abstract class Agent
+{
+    /**
+     * Initializes the Agent with the distributed agent object.
+     */
+    public void init (AgentObject agentObj)
+    {
+        _agentObj = agentObj;
+    }
+
+    /**
+     * Starts the code running in the agent.
+     */
+    public abstract void start ();
+
+    /**
+     * Stops the code running in the agent.
+     */
+    public abstract void stop ();
+
+    /**
+     * The shared agent object.
+     */
+    protected AgentObject _agentObj;
+}

src/main/java/com/threerings/bureau/client/BureauClient.java

@@ -0,0 +1,78 @@
+//
+// $Id$
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
+// http://code.google.com/p/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.bureau.client;
+
+import com.samskivert.util.Config;
+import com.samskivert.util.RunQueue;
+
+import com.threerings.presents.client.Client;
+import com.threerings.presents.dobj.DObjectManager;
+
+import com.threerings.bureau.data.BureauCredentials;
+import com.threerings.bureau.util.BureauContext;
+
+/**
+ * Represents a client embedded in a bureau.
+ */
+public abstract class BureauClient extends Client
+{
+    /**
+     * Creates a new client.
+     * @param runQueue the place to post tasks required by clients
+     */
+    public BureauClient (String bureauId, String sharedSecret, RunQueue runQueue)
+    {
+        super(null, runQueue);
+        _bureauId = bureauId;
+        _creds = new BureauCredentials(_bureauId, sharedSecret);
+        _ctx = createContext();
+        _director = createDirector();
+    }
+
+    protected abstract BureauDirector createDirector ();
+
+    protected BureauContext createContext ()
+    {
+        return new BureauContext() {
+            public BureauDirector getBureauDirector () {
+                return _director;
+            }
+            public DObjectManager getDObjectManager () {
+                return _omgr;
+            }
+            public Client getClient () {
+                return BureauClient.this;
+            }
+            public Config getConfig () {
+                return _config;
+            }
+            public String getBureauId () {
+                return _bureauId;
+            }
+        };
+    }
+
+    protected BureauContext _ctx;
+    protected String _bureauId;
+    protected BureauDirector _director;
+    protected Config _config = new Config("bureau");
+}

src/main/java/com/threerings/bureau/client/BureauDecoder.java

@@ -0,0 +1,78 @@
+//
+// $Id$
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
+// http://code.google.com/p/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.bureau.client;
+
+import com.threerings.presents.client.InvocationDecoder;
+
+/**
+ * Dispatches calls to a {@link BureauReceiver} instance.
+ */
+public class BureauDecoder extends InvocationDecoder
+{
+    /** The generated hash code used to identify this receiver class. */
+    public static final String RECEIVER_CODE = "3e98f7a30deb5a8e25e05c71c6081bf4";
+
+    /** The method id used to dispatch {@link BureauReceiver#createAgent}
+     * notifications. */
+    public static final int CREATE_AGENT = 1;
+
+    /** The method id used to dispatch {@link BureauReceiver#destroyAgent}
+     * notifications. */
+    public static final int DESTROY_AGENT = 2;
+
+    /**
+     * Creates a decoder that may be registered to dispatch invocation
+     * service notifications to the specified receiver.
+     */
+    public BureauDecoder (BureauReceiver receiver)
+    {
+        this.receiver = receiver;
+    }
+
+    @Override
+    public String getReceiverCode ()
+    {
+        return RECEIVER_CODE;
+    }
+
+    @Override
+    public void dispatchNotification (int methodId, Object[] args)
+    {
+        switch (methodId) {
+        case CREATE_AGENT:
+            ((BureauReceiver)receiver).createAgent(
+                ((Integer)args[0]).intValue()
+            );
+            return;
+
+        case DESTROY_AGENT:
+            ((BureauReceiver)receiver).destroyAgent(
+                ((Integer)args[0]).intValue()
+            );
+            return;
+
+        default:
+            super.dispatchNotification(methodId, args);
+            return;
+        }
+    }
+}

src/main/java/com/threerings/bureau/client/BureauDirector.java

@@ -0,0 +1,187 @@
+//
+// $Id$
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
+// http://code.google.com/p/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.bureau.client;
+
+import com.samskivert.util.IntMap;
+import com.samskivert.util.IntMaps;
+
+import com.threerings.presents.client.BasicDirector;
+import com.threerings.presents.client.Client;
+import com.threerings.presents.dobj.ObjectAccessException;
+import com.threerings.presents.dobj.Subscriber;
+import com.threerings.presents.util.SafeSubscriber;
+
+import com.threerings.bureau.data.AgentObject;
+import com.threerings.bureau.data.BureauCodes;
+import com.threerings.bureau.server.BureauRegistry;
+import com.threerings.bureau.util.BureauContext;
+
+import static com.threerings.bureau.Log.log;
+
+/**
+ * Allows the server to create and destroy agents on a client.
+ * @see BureauRegistry
+ */
+public abstract class BureauDirector extends BasicDirector
+{
+    /**
+     * Creates a new BureauDirector.
+     */
+    public BureauDirector (BureauContext ctx)
+    {
+        super(ctx);
+        _ctx = ctx;
+    }
+
+    @Override // from BasicDirector
+    public void clientDidLogon (Client client)
+    {
+        super.clientDidLogon(client);
+        _bureauService.bureauInitialized(_ctx.getClient(), _ctx.getBureauId());
+    }
+
+    /**
+     * Creates a new agent when the server requests it.
+     */
+    protected synchronized void createAgent (int agentId)
+    {
+        Subscriber<AgentObject> delegator = new Subscriber<AgentObject>() {
+            public void objectAvailable (AgentObject agentObject) {
+                BureauDirector.this.objectAvailable(agentObject);
+            }
+            public void requestFailed (int oid, ObjectAccessException cause) {
+                BureauDirector.this.requestFailed(oid, cause);
+            }
+        };
+
+        log.info("Subscribing to object " + agentId);
+
+        SafeSubscriber<AgentObject> subscriber =
+            new SafeSubscriber<AgentObject>(agentId, delegator);
+        _subscribers.put(agentId, subscriber);
+        subscriber.subscribe(_ctx.getDObjectManager());
+    }
+
+    /**
+     * Destroys an agent at the server's request.
+     */
+    protected synchronized void destroyAgent (int agentId)
+    {
+        Agent agent = null;
+        agent = _agents.remove(agentId);
+
+        if (agent == null) {
+            log.warning("Lost an agent, id " + agentId);
+        } else {
+            try {
+                agent.stop();
+            } catch (Throwable t) {
+                log.warning("Stopping an agent caused an exception", t);
+            }
+            SafeSubscriber<AgentObject> subscriber = _subscribers.remove(agentId);
+            if (subscriber == null) {
+                log.warning("Lost a subscriber for agent " + agent);
+            } else {
+                subscriber.unsubscribe(_ctx.getDObjectManager());
+            }
+            _bureauService.agentDestroyed(_ctx.getClient(), agentId);
+        }
+    }
+
+    /**
+     * Callback for when the a request to subscribe to an object finishes and the object is
+     * available.
+     */
+    protected synchronized void objectAvailable (AgentObject agentObject)
+    {
+        int oid = agentObject.getOid();
+
+        log.info("Object " + oid + " now available");
+
+        Agent agent;
+        try {
+            agent = createAgent(agentObject);
+            agent.init(agentObject);
+            agent.start();
+        } catch (Throwable t) {
+            log.warning("Could not create agent", "obj", agentObject, t);
+            _bureauService.agentCreationFailed(_ctx.getClient(), oid);
+            return;
+        }
+
+        _agents.put(oid, agent);
+        _bureauService.agentCreated(_ctx.getClient(), oid);
+    }
+
+    /**
+     * Callback for when the a request to subscribe to an object fails.
+     */
+    protected synchronized void requestFailed (int oid, ObjectAccessException cause)
+    {
+        log.warning("Could not subscribe to agent", "oid", oid, cause);
+    }
+
+    @Override // from BasicDirector
+    protected void registerServices (Client client)
+    {
+        super.registerServices(client);
+
+        // Require the bureau services
+        client.addServiceGroup(BureauCodes.BUREAU_GROUP);
+
+        // Set up our decoder so we can receive method calls from the server
+        BureauReceiver receiver = new BureauReceiver() {
+            public void createAgent (int agentId) {
+                BureauDirector.this.createAgent(agentId);
+            }
+            public void destroyAgent (int agentId) {
+                BureauDirector.this.destroyAgent(agentId);
+            }
+        };
+
+        client.getInvocationDirector().
+            registerReceiver(new BureauDecoder(receiver));
+    }
+
+    @Override // from BasicDirector
+    protected void fetchServices (Client client)
+    {
+        super.fetchServices(client);
+
+        _bureauService = client.getService(BureauService.class);
+    }
+
+    /**
+     * Called when it is time to create an Agent. Subclasses should read the
+     * <code>agentObject</code>'s type and/or properties to determine what kind of Agent to
+     * create.
+     * @param agentObj the distributed and object
+     * @return a new Agent that will govern the distributed object
+     */
+    protected abstract Agent createAgent (AgentObject agentObj);
+
+    protected BureauContext _ctx;
+    protected BureauService _bureauService;
+    protected IntMap<Agent> _agents = IntMaps.newHashIntMap();
+    protected IntMap<SafeSubscriber<AgentObject>> _subscribers =
+        IntMaps.newHashIntMap();
+}

src/main/java/com/threerings/bureau/client/BureauReceiver.java

@@ -0,0 +1,49 @@
+//
+// $Id$
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
+// http://code.google.com/p/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.bureau.client;
+
+import com.threerings.presents.client.InvocationReceiver;
+
+import com.threerings.bureau.data.AgentObject;
+
+/**
+ * Hooks for controlling a previously launched bureau client.
+ */
+public interface BureauReceiver extends InvocationReceiver
+{
+    /**
+     * Creates a new agent. Implementors should create a new {@link Agent} and give it access to
+     * the {@link AgentObject} referred to by the <code>agentId</code> parameter and must notify
+     * the service that the agent has been created using {@link BureauService#agentCreated}.
+     * @param agentId the id of the <code>AgentObject</code> that needs an <code>Agent</code>
+     */
+    void createAgent (int agentId);
+
+    /**
+     * Destroys a previously created agent. Implementors should destroy the agent that was created
+     * by the call to <code>createAgent</code> with the same agent id and must notify
+     * the service that the agent has been created using {@link BureauService#agentDestroyed}.
+     * @param agentId the id of the <code>AgentObject</code> whose <code>Agent</code>
+     * should be destroyed
+     */
+    void destroyAgent (int agentId);
+}

src/main/java/com/threerings/bureau/client/BureauService.java

@@ -0,0 +1,64 @@
+//
+// $Id$
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
+// http://code.google.com/p/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.bureau.client;
+
+import com.threerings.presents.client.Client;
+import com.threerings.presents.client.InvocationService;
+
+/**
+ * Interface for the bureau to communicate with the server.
+ */
+public interface BureauService extends InvocationService
+{
+    /**
+     * Notifies the server that the bureau is up and running and ready to receive
+     * requests via the <code>BureauReceiver</code>.
+     * @see BureauReceiver
+     */
+    void bureauInitialized (Client client, String bureauId);
+
+    /**
+     * Notifies the server that this bureau has encountered a critical error and needs to be shut
+     * down.
+     */
+    void bureauError (Client client, String message);
+
+    /**
+     * Notify the server that a previosuly requested agent is now created and ready to use.
+     * @see BureauReceiver#createAgent
+     */
+    void agentCreated (Client client, int agentId);
+
+    /**
+     * Notify the server that a previosuly requested agent could not be created.
+     * @see BureauReceiver#createAgent
+     */
+    void agentCreationFailed (Client client, int agentId);
+
+    /**
+     * Notify the server that an agent is no longer running. Normally called in response
+     * to a call to <code>destroyAgent</code>
+     * @see BureauReceiver#destroyAgent
+     */
+    void agentDestroyed (Client client, int agentId);
+}
+