com.eibus.soap

Interface ApplicationTransaction

public interface ApplicationTransaction

Method Summary

Modifier and Type	Method and Description
void	abort() The method abort() is called by the SOAPTransaction if one of the ApplicationTransactions has returned false during the process() method.
boolean	canProcess(java.lang.String type) Return true if the XML mapper can process methods defined of the specified type (e.g., SQL, Java, LDAP, etc.)
void	commit() The method commit() is called by the SOAPTransaction if the entire SOAPTransaction succeeded and can be committed.
boolean	process(BodyBlock request, BodyBlock response) Implement this method to process the relevant body blocks within this transaction.

Method Detail

commit

void commit()

The method commit() is called by the SOAPTransaction if the entire SOAPTransaction succeeded and can be committed. Within the implementation of the commit() method, the ApplicationTransaction is supposed to commit any internal transactions it has open (e.g., a DB transaction). In addition, only in this method the ApplicationTransaction is supposed to append the XML containing the result of the commit transaction to the response BodyBlocks that have been passed to the process() method during the lifecycle of the ApplicationTransaction.

abort

void abort()

The method abort() is called by the SOAPTransaction if one of the ApplicationTransactions has returned false during the process() method. This causes the SOAPTransaction to call the abort() method on all ApplicationTransactions which were created in it. In the implementation of this method, it must be noted that any XML nodes that have been appended to a response BodyBlock will be treated by a client program as if it was the result of an abort of the transaction, so it is important that any transactional state that was created during a call to the process() method is not appended to the response BodyBlock.

canProcess

boolean canProcess(java.lang.String type)

Return true if the XML mapper can process methods defined of the specified type (e.g., SQL, Java, LDAP, etc.)

process

boolean process(BodyBlock request,
                BodyBlock response)

Implement this method to process the relevant body blocks within this transaction. An XML Mapper can abort a transaction by throwing a SOAPFault in the process() method. The processing of the BodyBlock can be done in an asynchronous manner. To achieve this, the method response.setAsync(true); must be called. This has as effect that the SOAPTransaction within which this request is processed is not committed until the call response.continueTransaction(); is made. This could happen in another Thread. However, if one of the other BodyBlocks in the SOAPTransaction causes the transaction to abort, then this ApplicationTransaction will be aborted immediately, and a response will be sent back to the client.

Parameters:

request - The body block that contains the request method

response - The body block that should contain the response from the method

Returns:

False if the processor should abort the request containing this transaction (e.g., because an error has happened), and it should return true if the processor can continue processing.