This class is a container for the attributes necessary to create a Nirvana transaction. More...

Public Member Functions
nAbstractChannel	getChannel ()
	Gets the nirvana channel that will be associated with transactions created from this object. More...

nMessageSigner	getSigner ()
	Retrieves the message signer implementation used to sign messages. More...

long	getTimeout ()
	Retrieves the timeout value. More...

long	getTTL ()
	Gets the TTL value that transactions created from this object will have. More...

	nTransactionAttributes ()
	Default Constructor.

	nTransactionAttributes (nAbstractChannel aChannel) throws nTransactionException
	Constructs an nTransactionAttributes object associated with the channel specified. More...

	nTransactionAttributes (nAbstractChannel aChannel, long aTimeToLive) throws nTransactionException
	Constructs an nTransactionAttributes object associated with the channel specified. More...

	nTransactionAttributes (nAbstractChannel aChannel, long aTimeToLive, nMessageSigner signer) throws nTransactionException
	Constructs an nTransactionAttributes object associated with the channel specified. More...

	nTransactionAttributes (nAbstractChannel aChannel, long aTimeToLive, nMessageSigner signer, long timeout) throws nTransactionException
	Constructs an nTransactionAttributes object associated with the channel specified. More...

void	setChannel (nChannel aChannel)
	Sets the nirvana channel that will be associated with transactions created from this object. More...

void	setTimeout (long timeout)
	Sets the timeout value, as milliseconds, to use. More...

void	setTTL (long aTimeToLive)
	Sets the TTL value that transactions created from this object will have. More...

Detailed Description

This class is a container for the attributes necessary to create a Nirvana transaction.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nTransactionAttributes.nTransactionAttributes ( nAbstractChannel aChannel ) throws nTransactionException

Constructs an nTransactionAttributes object associated with the channel specified.

Parameters

aChannel The nirvana channel associated with this transaction

Exceptions

nTransactionException If there is an error during the construction, check the message for more information. One way this can occur is if the underlying store that the transaction was working with is deleted

com.pcbsys.nirvana.client.nTransactionAttributes.nTransactionAttributes	(	nAbstractChannel	aChannel,
		long	aTimeToLive
	)		throws nTransactionException

Constructs an nTransactionAttributes object associated with the channel specified.

Transactions created with this object will have the Time To Live (TTL) specified.

Parameters

aChannel	The nirvana channel associated with the transaction
aTimeToLive	The Time To Live (TTL) value that the transaction will have

Exceptions

nTransactionException If there is an error during the construction, check the message for more information. One way this can occur is if the underlying store that the transaction was working with is deleted

com.pcbsys.nirvana.client.nTransactionAttributes.nTransactionAttributes	(	nAbstractChannel	aChannel,
		long	aTimeToLive,
		nMessageSigner	signer
	)		throws nTransactionException

Constructs an nTransactionAttributes object associated with the channel specified.

Transactions created with this object will have the Time To Live (TTL) specified and all messages will be signed by the specified message signer implementation.

Parameters

aChannel	The nirvana channel associated with the transaction
aTimeToLive	The Time To Live (TTL) value that the transaction will have
signer	message signer implementation to be used to sign all events

Exceptions

nTransactionException If there is an error during the construction, check the message for more information. One way this can occur is if the underlying store that the transaction was working with is deleted

com.pcbsys.nirvana.client.nTransactionAttributes.nTransactionAttributes	(	nAbstractChannel	aChannel,
		long	aTimeToLive,
		nMessageSigner	signer,
		long	timeout
	)		throws nTransactionException

Constructs an nTransactionAttributes object associated with the channel specified.

Transactions created with this object will have the Time To Live (TTL) specified and all messages will be signed by the specified message signer implementation.

Parameters

aChannel	The nirvana channel associated with the transaction
aTimeToLive	The Time To Live (TTL) value that the transaction will have
signer	message signer implementation to be used to sign all events
timeout	in milliseconds to retry the commit / abort if there are recoverable exceptions, <0 represents infinite, 0 represents no retry and >0 represents actual retry timeframe

Exceptions

nTransactionException If there is an error during the construction, check the message for more information. One way this can occur is if the underlying store that the transaction was working with is deleted

Member Function Documentation

nAbstractChannel com.pcbsys.nirvana.client.nTransactionAttributes.getChannel ( )

Gets the nirvana channel that will be associated with transactions created from this object.

Returns: the nChannel object that will be associated with the transactions created from this object

nMessageSigner com.pcbsys.nirvana.client.nTransactionAttributes.getSigner ( )

Retrieves the message signer implementation used to sign messages.

Returns: a nMessageSigner compliant implementation of a message signer, if one is specified.

long com.pcbsys.nirvana.client.nTransactionAttributes.getTimeout ( )

Retrieves the timeout value.

Returns: a long millisecond value

long com.pcbsys.nirvana.client.nTransactionAttributes.getTTL ( )

Gets the TTL value that transactions created from this object will have.

Returns: a long value specifying the TTL value that transactions created from this object will have

void com.pcbsys.nirvana.client.nTransactionAttributes.setChannel ( nChannel aChannel )

Sets the nirvana channel that will be associated with transactions created from this object.

Parameters

aChannel the nChannel object that will be associated with the transactions created from this object

void com.pcbsys.nirvana.client.nTransactionAttributes.setTimeout ( long timeout )

Sets the timeout value, as milliseconds, to use.

This value controls if the code will retry the commit or abort on recoverable exceptions and only return once the operation has been completed.

Parameters

timeout in milliseconds to retry the commit / abort if there are recoverable exceptions, <0 represents infinite, 0 represents no retry and >0 represents actual retry timeframe

void com.pcbsys.nirvana.client.nTransactionAttributes.setTTL ( long aTimeToLive )

Sets the TTL value that transactions created from this object will have.

Parameters

aTimeToLive a long value specifying the TTL value that transactions created from this object will have

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation