XASessionImpl (Solace JMS API v10.6.3)

java.lang.Object
- com.solacesystems.jcsmp.impl.transaction.BaseTransactedSessionImpl
- - com.solacesystems.jcsmp.impl.transaction.xa.XASessionImpl

All Implemented Interfaces:: XASession

public class XASessionImpl
extends BaseTransactedSessionImpl
implements XASession

Nested Class Summary
- Nested classes/interfaces inherited from class com.solacesystems.jcsmp.impl.transaction.BaseTransactedSessionImpl
  BaseTransactedSessionImpl.AllowedOperation

Constructor Summary

Constructors
Constructor and Description

XASessionImpl(XASessionManager mgr, JCSMPChannelProperties channelProperties)

Constructors
Constructor and Description
`XASessionImpl(XASessionManager mgr, JCSMPChannelProperties channelProperties)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`beforeEnqueue(FlowHandleImpl fh, XMLMessage deliver)` Hook called right before a message is enqueued in the
`void`	`checkClosed()`
`void`	`checkClosedXA()`
`void`	`checkContext()`
`void`	`close()` Closes the `XASession`.
`void`	`close(JCSMPException e)`
`void`	`closeFlow(Closeable flow)`
`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 callback, JCSMPProducerEventHandler eventCallback)` Creates a producer flow within this `XASession` and associates it to this session.
`void`	`doCloseXASession(JCSMPException ex)`
`long`	`doOpenXASession(boolean onReconnect)`
`long`	`doResumeXASession()`
`boolean`	`getExpectsAcks()`
`JCSMPXMLMessageProducer`	`getMessageProducer()`
`String`	`getNetworkInfoString()`
`XASessionImpl`	`getParent()`
`int`	`getResponseTimeout()`
`XAResource`	`getXAResource()` Returns the XAResource for this session.
`XASessionManager`	`getXASessionManager()`
`void`	`handleUnrecoverableException(JCSMPException e)`
`boolean`	`hasUnboundSubFlows()`
`boolean`	`isReady()`
`boolean`	`isXA()`
`void`	`messageIdRenumbering(PubADManager adMgr)`
`void`	`notifyFlowRebindFinished()`
`void`	`notifyPostReconnect(FlowHandleImpl fh)` Called by `SubFlowManagerImpl.notifyPostReconnect(com.solacesystems.jcsmp.JCSMPException, com.solacesystems.common.HostInfo)`
`void`	`notifyUnknownName()`
`void`	`notifyVridChange()`
`void`	`processOpenXASessionResponse(AssuredCtrlHeaderBean adctrl)`
`void`	`processResumeXASessionResponse(AssuredCtrlHeaderBean adctrl)`
`void`	`resetTransactionSteps()`
`void`	`setIsReady(boolean isReady)`
`void`	`setParent(XASessionImpl parent)`
`String`	`toString()`
`void`	`trackMessage(BytesXMLMessage message)`
`void`	`triggerRequestRetransmit()`

Methods inherited from class com.solacesystems.jcsmp.impl.transaction.BaseTransactedSessionImpl
addInputStep, addOutputStep, allowOperation, getName, getTransactedSessionId, getTransactionSteps, setName

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - XASessionImpl
```
public XASessionImpl(XASessionManager mgr,
                     JCSMPChannelProperties channelProperties)
```
- Method Detail
  - getMessageProducer
```
public JCSMPXMLMessageProducer getMessageProducer()
```
  - setParent
```
public void setParent(XASessionImpl parent)
```
  - hasUnboundSubFlows
```
public boolean hasUnboundSubFlows()
```
  - messageIdRenumbering
```
public void messageIdRenumbering(PubADManager adMgr)
```
  - getParent
```
public XASessionImpl getParent()
```
  - isReady
```
public boolean isReady()
```
  - setIsReady
```
public void setIsReady(boolean isReady)
```
  - checkClosed
```
public void checkClosed()
                 throws ClosedFacilityException
```
    Throws:
    
    ClosedFacilityException
  - checkClosedXA
```
public void checkClosedXA()
                   throws XAException
```
    Throws:
    
    XAException
  - checkContext
```
public void checkContext()
                  throws XAException
```
    Throws:
    
    XAException
  - getXAResource
```
public XAResource getXAResource()
                         throws JCSMPException
```
    Description copied from interface: XASession
    
    Returns the XAResource for this session.
    
    Specified by:
    
    getXAResource in interface XASession
    
    Returns:
    
    The XAResource for this session.
    
    Throws:
    
    JCSMPException - If the XASession is closed.
  - getXASessionManager
```
public XASessionManager getXASessionManager()
```
  - getResponseTimeout
```
public int getResponseTimeout()
```
  - beforeEnqueue
```
public boolean beforeEnqueue(FlowHandleImpl fh,
                             XMLMessage deliver)
```
    Description copied from class: BaseTransactedSessionImpl
    
    Hook called right before a message is enqueued in the
    
    Overrides:
    
    beforeEnqueue in class BaseTransactedSessionImpl
    
    Parameters:
    
    fh - parameter
    
    deliver - parameter
    
    Returns:
    
    True to continue delivery, or false to silently drop the message
  - notifyPostReconnect
```
public void notifyPostReconnect(FlowHandleImpl fh)
```
    Description copied from class: BaseTransactedSessionImpl
    
    Called by SubFlowManagerImpl.notifyPostReconnect(com.solacesystems.jcsmp.JCSMPException, com.solacesystems.common.HostInfo)
    
    Overrides:
    
    notifyPostReconnect in class BaseTransactedSessionImpl
    
    Parameters:
    
    fh - parameter
  - trackMessage
```
public void trackMessage(BytesXMLMessage message)
                  throws JCSMPException
```
    Throws:
    
    JCSMPException
  - createFlow
```
public FlowReceiver createFlow(XMLMessageListener listener,
                               ConsumerFlowProperties flowProps,
                               EndpointProperties endpointProps)
                        throws JCSMPException
```
    Description copied from interface: XASession
    
    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)
    
    Specified by:
    
    createFlow in interface XASession
    
    Throws:
    
    JCSMPException
  - createFlow
```
public FlowReceiver createFlow(XMLMessageListener listener,
                               ConsumerFlowProperties flowProps,
                               EndpointProperties endpointProps,
                               FlowEventHandler flowEventHandler)
                        throws JCSMPException
```
    Description copied from interface: XASession
    
    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)
    
    Specified by:
    
    createFlow in interface XASession
    
    Throws:
    
    JCSMPException
  - closeFlow
```
public void closeFlow(Closeable flow)
```
    Specified by:
    
    closeFlow in class BaseTransactedSessionImpl
  - getExpectsAcks
```
public boolean getExpectsAcks()
```
    Specified by:
    
    getExpectsAcks in class BaseTransactedSessionImpl
  - createProducer
```
public XMLMessageProducer createProducer(ProducerFlowProperties fprop,
                                         JCSMPStreamingPublishEventHandler callback)
                                  throws JCSMPException
```
    Description copied from interface: XASession
    
    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.
    
    Specified by:
    
    createProducer in interface XASession
    
    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
```
public XMLMessageProducer createProducer(ProducerFlowProperties fprop,
                                         JCSMPStreamingPublishEventHandler callback,
                                         JCSMPProducerEventHandler eventCallback)
                                  throws JCSMPException
```
    Description copied from interface: XASession
    
    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.
    
    Specified by:
    
    createProducer in interface XASession
    
    Parameters:
    
    fprop - The producer flow properties. Not used and should be null.
    
    callback - 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
```
public void close()
```
    Description copied from interface: XASession
    
    Closes the XASession. This call closes all subordinate guaranteed delivery flows (producers / consumers).
    
    Specified by:
    
    close in interface XASession
  - close
```
public void close(JCSMPException e)
```
  - resetTransactionSteps
```
public void resetTransactionSteps()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - notifyVridChange
```
public void notifyVridChange()
```
    Specified by:
    
    notifyVridChange in class BaseTransactedSessionImpl
  - notifyUnknownName
```
public void notifyUnknownName()
```
    Specified by:
    
    notifyUnknownName in class BaseTransactedSessionImpl
  - handleUnrecoverableException
```
public void handleUnrecoverableException(JCSMPException e)
```
  - notifyFlowRebindFinished
```
public void notifyFlowRebindFinished()
                              throws JCSMPException
```
    Throws:
    
    JCSMPException
  - triggerRequestRetransmit
```
public void triggerRequestRetransmit()
                              throws JCSMPException
```
    Throws:
    
    JCSMPException
  - doOpenXASession
```
public long doOpenXASession(boolean onReconnect)
                     throws JCSMPException
```
    Parameters:
    
    onReconnect - - indicates if this has been called as part of reconnect. Note: If not on reconnect then the XA session will be ready after receiving an open response. For reconnect it will be started later.
    
    Returns:
    
    TransactedSessionId
    
    Throws:
    
    JCSMPException
  - processOpenXASessionResponse
```
public void processOpenXASessionResponse(AssuredCtrlHeaderBean adctrl)
                                  throws JCSMPException
```
    Throws:
    
    JCSMPException
  - doResumeXASession
```
public long doResumeXASession()
                       throws JCSMPException
```
    Throws:
    
    JCSMPException
  - processResumeXASessionResponse
```
public void processResumeXASessionResponse(AssuredCtrlHeaderBean adctrl)
                                    throws JCSMPException
```
    Throws:
    
    JCSMPException
  - doCloseXASession
```
public void doCloseXASession(JCSMPException ex)
                      throws JCSMPException
```
    Throws:
    
    JCSMPException
  - getNetworkInfoString
```
public String getNetworkInfoString()
```
  - isXA
```
public boolean isXA()
```
    Specified by:
    
    isXA in class BaseTransactedSessionImpl

Class XASessionImpl

Nested Class Summary

Nested classes/interfaces inherited from class com.solacesystems.jcsmp.impl.transaction.BaseTransactedSessionImpl

Constructor Summary

Method Summary

Methods inherited from class com.solacesystems.jcsmp.impl.transaction.BaseTransactedSessionImpl

Methods inherited from class java.lang.Object

Constructor Detail

XASessionImpl

Method Detail

getMessageProducer

setParent

hasUnboundSubFlows

messageIdRenumbering

getParent

isReady

setIsReady

checkClosed

checkClosedXA

checkContext

getXAResource

getXASessionManager

getResponseTimeout

beforeEnqueue

notifyPostReconnect

trackMessage

createFlow

createFlow

closeFlow

getExpectsAcks

createProducer

createProducer

close

close

resetTransactionSteps

toString

notifyVridChange

notifyUnknownName

handleUnrecoverableException

notifyFlowRebindFinished

triggerRequestRetransmit

doOpenXASession

processOpenXASessionResponse

doResumeXASession

processResumeXASessionResponse

doCloseXASession

getNetworkInfoString

isXA