//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2007 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/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.presents.util;

import com.samskivert.io.PersistenceException;
import com.samskivert.util.Invoker;

import com.threerings.presents.Log;
import com.threerings.presents.client.InvocationService;
import com.threerings.presents.data.InvocationCodes;

/**
 * Simplifies a common pattern which is to post an {@link Invoker} unit which does some database
 * operation and then calls back to an {@link InvocationService.InvocationListener} of some
 * sort. If the database operation fails, the error will be logged and the result listener will be
 * replied to with {@link InvocationCodes#INTERNAL_ERROR}.
 */
public abstract class PersistingUnit extends Invoker.Unit
{
    public PersistingUnit (InvocationService.InvocationListener listener)
    {
        this("UnknownPersistingUnit", listener);
    }

    public PersistingUnit (String name, InvocationService.InvocationListener listener)
    {
        super(name);
        _listener = listener;
    }

    /**
     * This method is where the unit performs its persistent actions. Any persistence exception
     * will be caught and logged along with the output from {@link #getFailureMessage}, if any.
     */
    public abstract void invokePersistent ()
        throws PersistenceException;

    /**
     * Handles the success case, which by default is to do nothing.
     */
    public void handleSuccess ()
    {
    }

    /**
     * Handles the failure case by logging the error and reporting an internal error to the
     * listener.
     */
    public void handleFailure (PersistenceException error)
    {
        Log.warning(getFailureMessage());
        Log.logStackTrace(error);
        _listener.requestFailed(InvocationCodes.INTERNAL_ERROR);
    }

    @Override // from Invoker.Unit
    public boolean invoke ()
    {
        try {
            invokePersistent();
        } catch (PersistenceException pe) {
            _error = pe;
        }
        return true;
    }

    @Override // from Invoker.Unit
    public void handleResult ()
    {
        if (_error != null) {
            handleFailure(_error);
        } else {
            handleSuccess();
        }
    }

    /**
     * Provides a custom failure message in the event that the persistent action fails. This will
     * be logged along with the exception.
     */
    protected String getFailureMessage ()
    {
        return this + " failed.";
    }

    protected InvocationService.InvocationListener _listener;
    protected PersistenceException _error;
}

@@ -965,47 +965,33 @@
 ort 
-com.samskivert.io.PersistenceException;
+java.util.logging.Level;%0A
 %0Aimp
@@ -1028,44 +1028,8 @@
 r;%0A%0A
-import com.threerings.presents.Log;%0A
 impo
@@ -1133,16 +1133,123 @@
 onCodes;
+%0Aimport com.threerings.presents.server.InvocationException;%0A%0Aimport static com.threerings.presents.Log.log;
 %0A%0A/**%0A *
@@ -2212,27 +2212,16 @@
  throws 
-Persistence
 Exceptio
@@ -2510,27 +2510,16 @@
 ailure (
-Persistence
 Exceptio
@@ -2545,76 +2545,190 @@
     
-Log.warning(getFailureMessage());%0A        Log.logStackTrace(
+if (error instanceof InvocationException) %7B%0A            _listener.requestFailed(error.getMessage());%0A        %7D else %7B%0A            log.log(Level.WARNING, getFailureMessage(), 
 error);%0A
     
@@ -2715,32 +2715,36 @@
 sage(), error);%0A
+    
         _listene
@@ -2792,16 +2792,26 @@
 ERROR);%0A
+        %7D%0A
     %7D%0A%0A 
@@ -2942,27 +2942,16 @@
  catch (
-Persistence
 Exceptio
@@ -3548,19 +3548,8 @@
 ted 
-Persistence
 Exce

Allow the unit to throw InvocationException and do the right thing with it.