com.eibus.soap

Class SOAPTransaction

java.lang.Object

com.eibus.soap.SOAPTransaction

public final class SOAPTransaction
extends java.lang.Object

A SOAPTransaction is created by a SOAP Processor for each incoming SOAP Envelope. The protocol in Cordys Integrator is that each SOAP Envelope should be treated as one single transaction. That means, e.g., that multiple database updates on different records (even from different tables) that appear in the same message must be committed in one database transaction. To achieve this, whenever a SOAPTransaction is created, the SOAP Processor will ask all the ApplicationConnectors to internally create an ApplicationTransaction. If the SOAPTransaction is completely handled, then it will call the commit (or abort) method of all internal ApplicationTransactions. After this, the reply SOAP Envelope will be sent back to the client.

See Also:

Processor, ApplicationConnector, ApplicationTransaction, BodyBlock

Constructor Summary

Constructors

Constructor and Description
SOAPTransaction(int requestEnvelope, Processor processor) Creates a new request around the specified message and sets the creation-timestamp.
SOAPTransaction(Message message, Processor processor) Creates a new request around the specified message and sets the creation-timestamp.

Method Summary

Modifier and Type	Method and Description
void	cancelReply(boolean cancelReply) Cancels the reply for this request.
protected void	finalize() Cleanup the request and response XML structures when the transaction is finalized.
BodyBlock	getCurrentBodyBlock() Returns the current body block in case of a multicall request
static SOAPTransaction	getCurrentSOAPTransaction() This method returns the SOAP Transaction that belongs to the current thread.
Identity	getIdentity() Returns the user as UserIdentity
java.util.Locale	getLocale() Returns the locale associated with this SOAP transaction.
java.lang.String	getOrganizationalContextDN() Returns the organizational context DN associated with this SOAP transaction.
int	getRequestEnvelope() Returns the xml node that was received from the client.
int	getResponseEnvelope() Returns the xml node that will be sent back to the client.
static SOAPTransaction	getSOAPTransaction(java.lang.Thread thread) This method returns the SOAP Transaction that belongs to the specified thread.
long	getTimestamp() Returns the moment at which the request object was created.
AccessControlObject	getUserCredentials() Deprecated. use link SOAPTransaction.getIdentity().getUserOrganization(); use link SOAPTransaction.getIdentity().getOrgUserDN();
boolean	isCancelled() Returns true if a call to cancelReply() has been made, false otherwise.
void	set_Locale(java.util.Locale locale) Internal method to set the locale associated with this SOAP transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPTransaction

public SOAPTransaction(Message message,
                       Processor processor)

Creates a new request around the specified message and sets the creation-timestamp.

SOAPTransaction

public SOAPTransaction(int requestEnvelope,
                       Processor processor)

Creates a new request around the specified message and sets the creation-timestamp.

Method Detail

getUserCredentials

@Deprecated
public AccessControlObject getUserCredentials()

Deprecated. use link SOAPTransaction.getIdentity().getUserOrganization(); use link SOAPTransaction.getIdentity().getOrgUserDN();

Returns the access control information of the user that sent this request.

getIdentity

public Identity getIdentity()

Returns the user as UserIdentity

getRequestEnvelope

public int getRequestEnvelope()

Returns the xml node that was received from the client.

Returns:

A soap envelope.

getResponseEnvelope

public int getResponseEnvelope()

Returns the xml node that will be sent back to the client.

Returns:

A soap envelope.

cancelReply

public void cancelReply(boolean cancelReply)

Cancels the reply for this request. The Processor handling this request will not send a reply for the request to the client.

isCancelled

public boolean isCancelled()

Returns true if a call to cancelReply() has been made, false otherwise. If the reply has been cancelled, the Processor handling this request will not send a reply for it.

getTimestamp

public long getTimestamp()

Returns the moment at which the request object was created.

Returns:

The moment of creation of the request object

getCurrentSOAPTransaction

public static SOAPTransaction getCurrentSOAPTransaction()

This method returns the SOAP Transaction that belongs to the current thread. It calls the getSOAPTransaction() method with Thread.currentThread().

Returns:

The SOAPTransaction currently associated with the current thread.

getSOAPTransaction

public static SOAPTransaction getSOAPTransaction(java.lang.Thread thread)

This method returns the SOAP Transaction that belongs to the specified thread.

Returns:

The SOAPTransaction currently associated with the specified thread.

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleanup the request and response XML structures when the transaction is finalized.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

See Also:

Object.finalize()

set_Locale

public void set_Locale(java.util.Locale locale)

Internal method to set the locale associated with this SOAP transaction.

Parameters:

locale - the locale to associate with this SOAP transaction.

Since:

C3

getOrganizationalContextDN

public java.lang.String getOrganizationalContextDN()

Returns the organizational context DN associated with this SOAP transaction.

Returns:

the organizational context DN associated with this SOAP transaction.

getLocale

public java.util.Locale getLocale()

Returns the locale associated with this SOAP transaction.

Returns:

the locale associated with this SOAP transaction.

Since:

C3

getCurrentBodyBlock

public BodyBlock getCurrentBodyBlock()

Returns the current body block in case of a multicall request