com.threerings.presents.util

Class PersistingUnit

java.lang.Object

com.samskivert.util.Invoker.Unit

com.threerings.presents.util.PersistingUnit

All Implemented Interfaces:

Runnable

public abstract class PersistingUnit
extends Invoker.Unit

Simplifies a common pattern which is to post an Invoker unit which does some database operation and then calls back to an InvocationService.InvocationListener of some sort. If the database operation fails, the error will be logged and the result listener will be replied to with InvocationCodes.INTERNAL_ERROR.

Field Summary

Fields inherited from class com.samskivert.util.Invoker.Unit

queueStamp

Constructor Summary

Constructors

Constructor and Description
PersistingUnit(InvocationService.InvocationListener listener)
PersistingUnit(String name, InvocationService.InvocationListener listener)
PersistingUnit(String name, InvocationService.InvocationListener listener, Object... args) Creates a persisting unit with the supplied name and listener and a set of key/value pairs that will be included in the failure message if this unit fails.

Method Summary

Modifier and Type	Method and Description
void	handleFailure(Exception error) Handles the failure case by logging the error and reporting an internal error to the listener.
void	handleResult()
void	handleSuccess() Handles the success case, which by default posts a response to a ConfirmListener.
boolean	invoke()
abstract void	invokePersistent() This method is where the unit performs its persistent actions.

Methods inherited from class com.samskivert.util.Invoker.Unit

getDetail, getLongThreshold, run, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PersistingUnit

public PersistingUnit(InvocationService.InvocationListener listener)

PersistingUnit

public PersistingUnit(String name,
                      InvocationService.InvocationListener listener)

PersistingUnit

public PersistingUnit(String name,
                      InvocationService.InvocationListener listener,
                      Object... args)

Creates a persisting unit with the supplied name and listener and a set of key/value pairs that will be included in the failure message if this unit fails.

Method Detail

invokePersistent

public abstract void invokePersistent()
                               throws Exception

This method is where the unit performs its persistent actions. Any persistence exception will be caught and logged along with the output from getFailureMessage(), if any.

Throws:

Exception

handleSuccess

public void handleSuccess()

Handles the success case, which by default posts a response to a ConfirmListener. If you need something else, or to repond to a ResultListener, you'll need to override this.

handleFailure

public void handleFailure(Exception error)

Handles the failure case by logging the error and reporting an internal error to the listener.

invoke

public boolean invoke()

Specified by:

invoke in class Invoker.Unit

handleResult

public void handleResult()

Overrides:

handleResult in class Invoker.Unit