com.highdeal.pnr.tif
Interface TransactionProcessor

public interface TransactionProcessor

This interface describes the Transaction Integration Framework (TIF).
Following methods are automatically called by PnR when transaction are delivered.
At launch time, the SAP Convergent Charging 1.0 launcher will instantiate a true TransactionProcessor which implements this interface.
The user can specify the name of the transaction processor (which implements this interface) he wants by setting the TRANSAC_PROC_CLASS parameter.

Method Summary

void	check(ChargedTransactionSet ts) This method is called within clear process for each (transient) transaction set produced by PnR.
void	clear(ChargedTransactionSet ts) This method is called for each (transient) transaction set produced by PnR.
void	clear(SubsReflect sr) This method is called for each subscription reflect that is exported.
java.lang.String	getProcessorID() Returns the ID of the processor.
void	initialize(java.util.Properties props) Initializes the transaction processor.
void	reClear(ChargedTransactionSet cts) This method is called for each (transient) transaction set produced by PnR.
void	shutdown() This method is called when a server shuts down.

Method Detail

initialize

void initialize(java.util.Properties props)
                throws TransactionProcessorFailureException

Initializes the transaction processor.
This method is called at SAP Convergent Charging 1.0 launch time.

Parameters:

props - some properties which can be useful for initializing the transaction processor.

Throws:

TransactionProcessorFailureException

getProcessorID

java.lang.String getProcessorID()
                                throws TransactionProcessorFailureException

Returns the ID of the processor.
Ex : for the BnRTransactionProcessor, it returns "BNR".

Returns:

a constant ID string.

Throws:

TransactionProcessorFailureException

clear

void clear(ChargedTransactionSet ts)
           throws TransactionProcessorFailureException

This method is called for each (transient) transaction set produced by PnR.
This method is in charge of clearing/managing the transaction set. By example, a simple action could consist in saving this transaction set into a file.

Parameters:

ts - the transaction set to be cleared.

Throws:

TransactionProcessorFailureException

check

void check(ChargedTransactionSet ts)
           throws TransactionProcessorFailureException

This method is called within clear process for each (transient) transaction set produced by PnR. This method is called manually to check that BnR accounts targets exists when doing a reservation.

Parameters:

ts - the transaction set to be cleared.

Throws:

TransactionProcessorFailureException

reClear

void reClear(ChargedTransactionSet cts)
             throws TransactionProcessorFailureException

This method is called for each (transient) transaction set produced by PnR.
This method is in charge of reclearing/managing the transaction set. By example, a simple action could consist in saving this transaction set into a file. When reclearing a transaction, its transaction date may be adapted depending on the billing state of the account.

Parameters:

cts - the transaction set to be cleared.

Throws:

TransactionProcessorFailureException

clear

void clear(SubsReflect sr)
           throws TransactionProcessorFailureException

This method is called for each subscription reflect that is exported.

Parameters:

sr - the subscription reflect to be cleared.

Throws:

TransactionProcessorFailureException

shutdown

void shutdown()

This method is called when a server shuts down. It is the opportunity for the transaction processor to do some cleaning before the server shuts down.