com.solacesystems.jcsmp.transaction.xa

Interface XASession

All Known Implementing Classes:

XASessionImpl

public interface XASession

Method Summary

Modifier and Type	Method and Description
void	close() Closes the XASession.
FlowReceiver	createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps, EndpointProperties endpointProps) Creates a consumer flow within this XASession and associates it to this session.
FlowReceiver	createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps, EndpointProperties endpointProps, FlowEventHandler flowEventHandler) Creates a consumer flow within this XASession and associates it to this session.
XMLMessageProducer	createProducer(ProducerFlowProperties fprop, JCSMPStreamingPublishEventHandler callback) Creates a producer flow within this XASession and associates it to this session.
XMLMessageProducer	createProducer(ProducerFlowProperties fprop, JCSMPStreamingPublishEventHandler streamCallback, JCSMPProducerEventHandler eventCallback) Creates a producer flow within this XASession and associates it to this session.
XAResource	getXAResource() Returns the XAResource for this session.

Method Detail

getXAResource

XAResource getXAResource()
                  throws JCSMPException

Returns the XAResource for this session.

Returns:

The XAResource for this session.

Throws:

JCSMPException - If the XASession is closed.

createFlow

FlowReceiver createFlow(XMLMessageListener listener,
                        ConsumerFlowProperties flowProps,
                        EndpointProperties endpointProps)
                 throws JCSMPException

Creates a consumer flow within this XASession and associates it to this session.

The semantics and error conditions of this call are identical to JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties, EndpointProperties)

Throws:

JCSMPException

createFlow

FlowReceiver createFlow(XMLMessageListener listener,
                        ConsumerFlowProperties flowProps,
                        EndpointProperties endpointProps,
                        FlowEventHandler flowEventHandler)
                 throws JCSMPException

Creates a consumer flow within this XASession and associates it to this session.

The semantics and error conditions of this call are identical to JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties, EndpointProperties, FlowEventHandler)

Throws:

JCSMPException

createProducer

XMLMessageProducer createProducer(ProducerFlowProperties fprop,
                                  JCSMPStreamingPublishEventHandler callback)
                           throws JCSMPException

Creates a producer flow within this XASession and associates it to this session. A maximum of one (1) producer flow may be created per XASession. Only streaming producers are allowed, so callback must not be null.

Parameters:

fprop - The producer flow properties. Not used and should be null.

callback - he event handler which has to implement the at least the interface JCSMPStreamingPublishEventHandler.

Returns:

a new producer with its own producer flow

Throws:

InvalidOperationException - If the peer capabilities do not support features requested in this operation.

JCSMPException - On other errors.

createProducer

XMLMessageProducer createProducer(ProducerFlowProperties fprop,
                                  JCSMPStreamingPublishEventHandler streamCallback,
                                  JCSMPProducerEventHandler eventCallback)
                           throws JCSMPException

Creates a producer flow within this XASession and associates it to this session. A maximum of one (1) producer flow may be created per XASession. Only streaming producers are allowed, so callback must not be null.

Parameters:

fprop - The producer flow properties. Not used and should be null.

streamCallback - A stream event handler

eventCallback - A producer event handler

Returns:

a new producer with its own producer flow

Throws:

InvalidOperationException - If the peer capabilities do not support features requested in this operation.

JCSMPException - On other errors.

close

void close()
    throws JCSMPException

Closes the XASession. This call closes all subordinate guaranteed delivery flows (producers / consumers).

Throws:

JCSMPException