org.jpos.transaction.participant

Class JSParticipant

java.lang.Object

org.jpos.util.Log

org.jpos.transaction.participant.JSParticipant

All Implemented Interfaces:

XmlConfigurable, AbortParticipant, TransactionConstants, TransactionParticipant, LogSource

public class JSParticipant
extends Log
implements TransactionParticipant, AbortParticipant, XmlConfigurable

A TransactionParticipant whose prepare, commit and abort methods can be specified through JS scripts.
To indicate what code to execute for any of the methods just add an element named 'prepare', 'commit' or 'abort' contained in that of the participant.
The value to return in the prepare method should be stored in the script variable named "result". None of these tags are mandatory.
Usage:

     Add a transaction participant like this:
     <participant class="org.jpos.transaction.participant.JSParticipant" logger="Q2" realm="js"
     src='deploy/test.js' />

     test.js may look like this (all functions are optional)

     var K = Java.type("org.jpos.transaction.TransactionConstants");
     var prepare = function(id, ctx) {
       var map = ctx.getMap();
       ctx.log ("Prepare has been called");
       ctx.log (map.TIMESTAMP);
       map.NEWPROPERTY='ABC';
       return K.PREPARED;
     }

     var prepareForAbort = function(id, ctx) {
       ctx.put ("Test", "Test from JS transaction $id");
       ctx.log ("prepareForAbort has been called");
       return K.PREPARED;
     }
     var commit = function(id, ctx) {
       ctx.log ("Commit has been called");
     }

     var abort = function(id, ctx) {
       ctx.log ("Abort has been called");
     }
 

Field Summary

Fields inherited from class org.jpos.util.Log

DEBUG, ERROR, FATAL, INFO, logger, realm, TRACE, WARN

Fields inherited from interface org.jpos.transaction.TransactionConstants

ABORTED, FAIL, NO_JOIN, PAUSE, PREPARED, READONLY, RETRY

Constructor Summary

Constructors

Constructor and Description
JSParticipant()

Method Summary

Modifier and Type	Method and Description
void	abort(long id, java.io.Serializable context) Called by TransactionManager upon transaction commit.
void	commit(long id, java.io.Serializable context) Called by TransactionManager upon transaction commit.
int	prepare(long id, java.io.Serializable context) Called by TransactionManager in preparation for a transaction
int	prepareForAbort(long id, java.io.Serializable context) Called by TransactionManager in preparation for a transaction that is known to abort.
void	setConfiguration(org.jdom2.Element e)

Methods inherited from class org.jpos.util.Log

createDebug, createDebug, createError, createError, createFatal, createFatal, createInfo, createInfo, createLogEvent, createLogEvent, createTrace, createTrace, createWarn, createWarn, debug, debug, error, error, fatal, fatal, getLog, getLogger, getRealm, info, info, setLogger, setLogger, setRealm, trace, trace, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSParticipant

public JSParticipant()

Method Detail

prepare

public int prepare(long id,
                   java.io.Serializable context)

Description copied from interface: TransactionParticipant

Called by TransactionManager in preparation for a transaction

Specified by:

prepare in interface TransactionParticipant

Parameters:

id - the Transaction identifier

context - transaction context

Returns:

PREPARED or ABORTED (| NO_JOIN | READONLY)

prepareForAbort

public int prepareForAbort(long id,
                           java.io.Serializable context)

Description copied from interface: AbortParticipant

Called by TransactionManager in preparation for a transaction that is known to abort.

Specified by:

prepareForAbort in interface AbortParticipant

Parameters:

id - the Transaction identifier

context - transaction context

Returns:

0 [| NO_JOIN | READONLY)

commit

public void commit(long id,
                   java.io.Serializable context)

Description copied from interface: TransactionParticipant

Called by TransactionManager upon transaction commit. Warning: implementation should be able to handle multiple calls with the same transaction id (rare crash recovery)

Specified by:

commit in interface TransactionParticipant

Parameters:

id - the Transaction identifier

context - transaction context

abort

public void abort(long id,
                  java.io.Serializable context)

Description copied from interface: TransactionParticipant

Called by TransactionManager upon transaction commit. Warning: implementation should be able to handle multiple calls with the same transaction id (rare crash recovery)

Specified by:

abort in interface TransactionParticipant

Parameters:

id - the Transaction identifier

context - transaction context

setConfiguration

public void setConfiguration(org.jdom2.Element e)
                      throws ConfigurationException

Specified by:

setConfiguration in interface XmlConfigurable

Parameters:

e - Configuration element

Throws:

ConfigurationException - on error