narya/src/java/com/threerings/presents/server/InvocationManager.java

//
// $Id: InvocationManager.java,v 1.16 2003/10/26 02:33:43 eric Exp $

package com.threerings.presents.server;

import java.util.ArrayList;

import com.samskivert.util.HashIntMap;
import com.samskivert.util.LRUHashMap;
import com.samskivert.util.StringUtil;

import com.threerings.io.Streamable;
import com.threerings.util.StreamableArrayList;

import com.threerings.presents.Log;
import com.threerings.presents.data.ClientObject;
import com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller;
import com.threerings.presents.data.InvocationMarshaller;
import com.threerings.presents.data.InvocationObject;

import com.threerings.presents.dobj.DEvent;
import com.threerings.presents.dobj.DObject;
import com.threerings.presents.dobj.EventListener;
import com.threerings.presents.dobj.InvocationRequestEvent;
import com.threerings.presents.dobj.MessageEvent;
import com.threerings.presents.dobj.ObjectAccessException;
import com.threerings.presents.dobj.RootDObjectManager;
import com.threerings.presents.dobj.Subscriber;
import com.threerings.presents.dobj.Subscriber;

/**
 * The invocation services provide client to server invocations (service
 * requests) and server to client invocations (responses and
 * notifications). Via this mechanism, the client can make requests of the
 * server, be notified of its response and the server can asynchronously
 * invoke code on the client.
 *
 * <p> Invocations are like remote procedure calls in that they are named
 * and take arguments. All arguments must be {@link Streamable} objects,
 * primitive types, or String objects. All arguments are passed by value
 * (by serializing and unserializing the arguments); there is no special
 * facility provided for referencing non-local objects (it is assumed that
 * the distributed object facility will already be in use for any objects
 * that should be shared).
 *
 * <p> The server invocation manager listens for invocation requests from
 * the client and passes them on to the invocation provider registered for
 * the requested invocation module. It also provides a mechanism by which
 * responses and asynchronous notification invocations can be delivered to
 * the client.
 */
public class InvocationManager
    implements Subscriber, EventListener
{
    /** The list of services that are to be provided to clients at boot
     * time. Don't mess with this list! */
    public StreamableArrayList bootlist = new StreamableArrayList();

    /**
     * Constructs an invocation manager which will use the supplied
     * distributed object manager to operate its invocation
     * services. Generally only one invocation manager should be
     * operational in a particular system.
     */
    public InvocationManager (RootDObjectManager omgr)
    {
        _omgr = omgr;

        // create the object on which we'll listen for invocation requests
        omgr.createObject(DObject.class, this);
    }

    public int getOid ()
    {
        return _invoid;
    }

    /**
     * Registers the supplied invocation dispatcher, returning a
     * marshaller that can be used to send requests to the provider for
     * whom the dispatcher is proxying.
     *
     * @param dispatcher the dispatcher to be registered.
     * @param bootstrap if true, the service instance will be added to the
     * list of invocation service objects provided to the client in the
     * bootstrap data.
     */
    public InvocationMarshaller registerDispatcher (
        InvocationDispatcher dispatcher, boolean bootstrap)
    {
        // get the next invocation code
        int invCode = nextInvCode();

        // create the marshaller and initialize it
        InvocationMarshaller marsh = dispatcher.createMarshaller();
        marsh.init(_invoid, invCode);

        // if we haven't yet finished our own initialization, we need to
        // throw this dispatcher on a queue so that we can fill in its
        // invocation oid when we know what it should be
        if (_invoid == -1) {
            _lateInitQueue.add(marsh);
        }

        // register the dispatcher
        _dispatchers.put(invCode, dispatcher);

        // if it's a bootstrap service, slap it in the list
        if (bootstrap) {
            bootlist.add(marsh);
        }

        _recentRegServices.put(new Integer(invCode), marsh);

//        Log.info("Registered service [marsh=" + marsh + "].");
        return marsh;
    }

    /**
     * Clears out a dispatcher registration. This should be called to free
     * up resources when an invocation service is no longer going to be
     * used.
     */
    public void clearDispatcher (InvocationMarshaller marsh)
    {
        if (_dispatchers.remove(marsh.getInvocationCode()) == null) {
            Log.warning("Requested to remove unregistered marshaller? " +
                        "[marsh=" + marsh + "].");
        }
    }

    public void objectAvailable (DObject object)
    {
        // this must be our invocation object
        _invoid = object.getOid();

        // add ourselves as a message listener
        object.addListener(this);

        // let any early registered marshallers know about our invoid
        while (_lateInitQueue.size() > 0) {
            InvocationMarshaller marsh = (InvocationMarshaller)
                _lateInitQueue.remove(0);
            marsh.setInvocationOid(_invoid);
        }

//         Log.info("Created invocation service object [oid=" + _invoid + "].");
    }

    public void requestFailed (int oid, ObjectAccessException cause)
    {
        // if for some reason we were unable to create our invocation
        // object, we'll end up here
        Log.warning("Unable to create invocation object " +
                    "[reason=" + cause + "].");
        _invoid = -1;
    }

    // documentation inherited from interface
    public void eventReceived (DEvent event)
    {
//         Log.info("Event received " + event + ".");

        if (event instanceof InvocationRequestEvent) {
            InvocationRequestEvent ire = (InvocationRequestEvent)event;
            dispatchRequest(ire.getSourceOid(), ire.getInvCode(),
                            ire.getMethodId(), ire.getArgs());
        }
    }

    /**
     * Called when we receive an invocation request message. Dispatches
     * the request to the appropriate invocation provider via the
     * registered invocation dispatcher.
     */
    protected void dispatchRequest (
        int clientOid, int invCode, int methodId, Object[] args)
    {
        // make sure the client is still around
        ClientObject source = (ClientObject)_omgr.getObject(clientOid);
        if (source == null) {
            Log.warning("Client no longer around for invocation " +
                        "request [clientOid=" + clientOid +
                        ", code=" + invCode + ", methId=" + methodId +
                        ", args=" + StringUtil.toString(args) + "].");
            return;
        }

        // look up the dispatcher
        InvocationDispatcher disp = (InvocationDispatcher)
            _dispatchers.get(invCode);
        if (disp == null) {
            Log.warning("Received invocation request for which we have " +
                        "no registered dispatcher [code=" + invCode +
                        ", methId=" + methodId +
                        ", args=" + StringUtil.toString(args) + "].");
            Log.warning("Marsheller for unregistered dispatcher [march=" +
                        _recentRegServices.get(new Integer(invCode)) + "].");
            return;
        }

        // scan the args, initializing any listeners and keeping track of
        // the "primary" listener
        ListenerMarshaller rlist = null;
        int acount = args.length;
        for (int ii = 0; ii < acount; ii++) {
            Object arg = args[ii];
            if (arg instanceof ListenerMarshaller) {
                ListenerMarshaller list = (ListenerMarshaller)arg;
                list.omgr = _omgr;
                // keep track of the listener we'll inform if anything
                // goes horribly awry
                if (rlist == null) {
                    rlist = list;
                }
            }
        }

//         Log.debug("Dispatching invreq [caller=" + source.who() +
//                   ", disp=" + disp + ", methId=" + methodId +
//                   ", args=" + StringUtil.toString(args) + "].");

        // dispatch the request
        try {
            disp.dispatchRequest(source, methodId, args);

        } catch (InvocationException ie) {
            if (rlist != null) {
                rlist.requestFailed(ie.getMessage());

            } else {
                Log.warning("Service request failed but we've got no " +
                            "listener to inform of the failure " +
                            "[caller=" + source.who() + ", code=" + invCode +
                            ", dispatcher=" + disp + ", methodId=" + methodId +
                            ", args=" + StringUtil.toString(args) +
                            ", error=" + ie + "].");
            }

        } catch (Throwable t) {
            Log.warning("Dispatcher choked [disp=" + disp +
                        ", caller=" + source.who() + ", methId=" + methodId +
                        ", args=" + StringUtil.toString(args) + "].");
            Log.logStackTrace(t);
        }
    }

    /**
     * Used to generate monotonically increasing provider ids.
     */
    protected synchronized int nextInvCode ()
    {
        return _invCode++;
    }

    // debugging action...
    protected static final LRUHashMap _recentRegServices =
        new LRUHashMap(10000);

    /** The distributed object manager with which we're working. */
    protected RootDObjectManager _omgr;

    /** The object id of the object on which we receive invocation service
     * requests. */
    protected int _invoid = -1;

    /** Used to generate monotonically increasing provider ids. */
    protected int _invCode;

    /** A table of invocation dispatchers each mapped by a unique code. */
    protected HashIntMap _dispatchers = new HashIntMap();

    /** Used to keep track of marshallers registered before we had our
     * invocation object so that we can fill their invocation id in
     * belatedly. */
    protected ArrayList _lateInitQueue = new ArrayList();

    /** The text that is appended to the procedure name when automatically
     * generating a failure response. */
    protected static final String FAILED_SUFFIX = "Failed";
}