FlowHandleImpl (Solace JMS API v10.8.1)

java.lang.Object
- com.solacesystems.jcsmp.impl.flow.FlowHandleImpl

All Implemented Interfaces:

Consumer, FlowReceiver, Closeable, FlowHandle, LiveMessageController, XMLMessageListener

Direct Known Subclasses:

DirectFlowHandleImpl
```
public class FlowHandleImpl
extends Object
implements FlowReceiver, FlowHandle, LiveMessageController, Closeable, XMLMessageListener
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FlowHandleImpl.ResourceBoundState

static class FlowHandleImpl.StartState
- Nested classes/interfaces inherited from interface com.solacesystems.jcsmp.impl.flow.FlowHandle
  FlowHandle.FlowType

Nested Classes
Modifier and Type	Class and Description
`static class`	`FlowHandleImpl.ResourceBoundState`
`static class`	`FlowHandleImpl.StartState`

Field Summary

Fields
Modifier and Type Field and Description

boolean deliverAsyncOnReactor

static org.apache.commons.logging.Log Trace

Fields
Modifier and Type	Field and Description
`boolean`	`deliverAsyncOnReactor`
`static org.apache.commons.logging.Log`	`Trace`

Constructor Summary

Constructors
Constructor and Description
`FlowHandleImpl(Endpoint boundTo, Topic newTopic, XMLMessageListener listener, CSMPSubscriberChannel channel, JCSMPSession session, boolean ad_enabled, AssuredCtrlEnums.QueueAccessType q_access_type, AssuredCtrlEnums.FlowType boundFlowType, Long gr_permissions, EndpointProperties endpointProperties, String selector, ConsumerFlowProperties cfp, BaseTransactedSessionImpl old_ts, FlowEventHandler flowEventHandler)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`ackMessage(JCSMPXMLMessage msg)`
`void`	`addLiveResponseListener(String correlationId, LiveResponseListener listener)`
`void`	`addLiveTopicAction(CacheLiveDataAction action, Topic topic, LiveTopicListener listener)`
`void`	`checkLocalQueueEmptyAcks()`
`void`	`close()` Closes the message consumer, rendering it unusable.
`void`	`close(boolean linger)` [SolReserved] Close a flow, optionally signaling a non-durable Endpoint should linger on the appliance.
`void`	`closeChannelDied()`
`void`	`closeImpl(boolean allowAcks, boolean linger, TcpChannel.WriteBlockPolicy wpol)`
`void`	`closeImpl(boolean allowAcks, boolean linger, TcpChannel.WriteBlockPolicy wpol, JCSMPException cause)`
`void`	`closeSegmentFlows(boolean linger, boolean rollback)`
`void`	`closeSync()`
`void`	`closeSync(boolean linger)`
`void`	`closeSyncImpl(boolean allowAcks, boolean linger, TcpChannel.WriteBlockPolicy wpol)` Internal-only method used to specify that we may be closing without wanting to send ACKS, such as when closing to handle an exception in this Flow Handle.
`void`	`closeWindow()`
`static BytesXMLMessage`	`createStructuredType(JCSMPXMLMessage msg)`
`Object`	`getAckCreateSendLock()`
`long`	`getAckLastSerialNumber()`
`int`	`getAckThreshold()`
`Endpoint`	`getBoundResource()`
`BrowserImpl`	`getBrowserFlow()`
`String`	`getCachedSelector()`
`Topic`	`getCachedTopic()`
`ConsumerNotificationDispatcher`	`getConsumerNotifDsp()`
`CSMPSubscriberChannel`	`getCSMPSubscriberChannel()`
`AbstractUnackedMessageList.UnackedMessageListInfo`	`getCurrentUnackedMessageListInfo()`
`Destination`	`getDestination()` Returns the `Destination` to which messages should be published to get routed to this flow's bound `Endpoint`.
`Endpoint`	`getEndpoint()` Returns the appliance Endpoint this flow is bound to.
`Long`	`getEndpointErrorId()`
`long`	`getEndpointId()`
`EndpointProperties`	`getEndpointProperties()`
`FlowEventHandler`	`getFlowEventHandler()`
`long`	`getFlowId()`
`String`	`getFlowName()`
`AssuredCtrlEnums.FlowType`	`getFlowType()`
`Long`	`getGrantedPermissions()`
`long`	`getLastInOrderTpMsg()`
`long`	`getLastMsgIdAcked()`
`LiveMessageController`	`getLiveMessageController()`
`HashMap<String,LiveTopicListener>`	`getLiveTopicMap()`
`ReentrantLock`	`getLock()`
`String`	`getLogFlowInfoString()`
`XMLMessageListener`	`getMessageListener()`
`int`	`getMessageQueueSize()`
`int`	`getNumUnackedTpMsgs()`
`int`	`getOriginalAckThreshold()`
`int`	`getReconnectRetryIntervalInMsecs()`
`JCSMPBasicSession`	`getSession()`
`SubscriberQueueHooks`	`getSubQueueHooks()`
`Subscription`	`getSubscription()` Returns the subscription associated to the Endpoint when bound to a `TopicEndpoint`.
`int`	`getSubWindowSize()`
`BaseTransactedSessionImpl`	`getTransactedSession()`
`int`	`getWindowSize()`
`void`	`handleControllerException(JCSMPException e)`
`void`	`handleException(JCSMPException e)`
`void`	`handleLargeMsgNotification(ConsumerLargeMessageNotification notif)`
`void`	`handleMessageSegmentReconstructionTimeout(MsgSegmentReconstructionTimedTask task)`
`void`	`handleQueueException(JCSMPException e)`
`void`	`handleSegmentFlowCreationTimeout(SegmentFlowCreationTimedTask task)`
`void`	`handleUnackedMsgSegments()`
`void`	`injectCacheEvent(CacheEventMessage msg)`
`void`	`injectMessage(XMLMessage msg)`
`void`	`injectNotification(Notification notif)`
`Boolean`	`isAutoRebindEnabled()`
`Boolean`	`isAutoRebindTriggered()`
`boolean`	`isBoundToResource()`
`boolean`	`isMsgSegmentFlow()`
`boolean`	`isNoLocal()`
`boolean`	`isOpened()`
`void`	`logFlowInfo(JCSMPLogLevel level)` Outputs a log containing the flow state information for the flow at a specified log level.
`boolean`	`notifyAdMessage(JCSMPXMLMessage msg)`
`void`	`notifyFlowEventHandler(FlowEventArgs eventArgs)`
`void`	`notifyPostReconnect()`
`void`	`notifyReconnected()`
`void`	`onException(JCSMPException exception)` On error, this method is invoked.
`void`	`onLiveMessage(JCSMPXMLMessage msg)`
`void`	`onReceive(BytesXMLMessage message)` The callback method to handle messages received by the `XMLMessageConsumer`.
`void`	`openWindow()`
`boolean`	`processMessage(JCSMPXMLMessage msg)`
`BytesXMLMessage`	`receive()` Receives the next available message, waiting until one is available.
`BytesXMLMessage`	`receive(int timeoutInMillis)` Receives the next available message.
`BytesXMLMessage`	`receiveNoWait()` Receives the next available message.
`void`	`removeLiveResponseListener(String correlationId)`
`void`	`removeLiveTopicAction(CacheLiveDataAction action, Topic topic)`
`void`	`resetAdState()`
`void`	`rollback()` ROLLBACK a flow: discards all locally-buffered messages and resets the expected next "LastMsgId" field to 0.
`void`	`sendSingleAck(long msgId, boolean allowReactorComplete)`
`void`	`setAckLastSerialNumber(long ackLastSerialNumber)`
`void`	`setAckThreshold(int threshold)`
`void`	`setBoundToResourceState(FlowHandleImpl.ResourceBoundState s)`
`void`	`setBrowserFlow(BrowserImpl flow)`
`void`	`setCachedSelector(String cachedSelector)`
`void`	`setEndpointErrorId(Long id)`
`void`	`setEndpointId(long endpointId)`
`void`	`setFlowId(long flowId)`
`void`	`setFlowName(String flowName)`
`void`	`setLastReportedWinSz(int winSz)`
`void`	`setMessageListener(XMLMessageListener listener)`
`void`	`setNumUnackedTpMsgs(int num)`
`void`	`setSubQueueHooks(SubscriberQueueHooks subQueueHooks)`
`void`	`setSubscription(Topic s)`
`void`	`start()` Enables receiving messages from an appliance.
`void`	`startAckTimer()`
`void`	`startMsgSegmentTimer(boolean restart)`
`void`	`startSegmentFlowCreationTimer()`
`void`	`startSync()`
`void`	`stop()` Disables receiving messages from an appliance.
`void`	`stopAckTimer()`
`void`	`stopMsgSegmentTimer()`
`void`	`stopSegmentFlowCreationTimer()`
`void`	`stopSync()`
`boolean`	`stopSyncStart()`
`void`	`stopSyncWait()`
`void`	`throwClosedException(String message)`
`WireMessage`	`tpCreateAck()`
`WireMessage`	`tpCreateStopAck()`
`void`	`tpSendAck(WireMessage ackMsg, boolean allowOnStateSub, boolean allowReactorComplete)`
`void`	`transportInit()` called during init and when AD resets due to switch to a different HOST
`Object`	`triggerAsyncDelivery()`
`void`	`triggerDequeueFromConstructionQueue(ConsumerLargeMessageNotification timeoutNotification)`
`Boolean`	`tryToStartAutoRebind()`
`void`	`tryToTriggerAutoRebind(Boolean enabled)`

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

- Field Detail
  - deliverAsyncOnReactor
```
public final boolean deliverAsyncOnReactor
```
  - Trace
```
public static final org.apache.commons.logging.Log Trace
```
- Constructor Detail
  - FlowHandleImpl
```
public FlowHandleImpl(Endpoint boundTo,
                      Topic newTopic,
                      XMLMessageListener listener,
                      CSMPSubscriberChannel channel,
                      JCSMPSession session,
                      boolean ad_enabled,
                      AssuredCtrlEnums.QueueAccessType q_access_type,
                      AssuredCtrlEnums.FlowType boundFlowType,
                      Long gr_permissions,
                      EndpointProperties endpointProperties,
                      String selector,
                      ConsumerFlowProperties cfp,
                      BaseTransactedSessionImpl old_ts,
                      FlowEventHandler flowEventHandler)
```
- Method Detail
  - getLock
```
public ReentrantLock getLock()
```
  - getSession
```
public JCSMPBasicSession getSession()
```
  - getGrantedPermissions
```
public Long getGrantedPermissions()
```
  - getAckCreateSendLock
```
public Object getAckCreateSendLock()
```
    Specified by:
    
    getAckCreateSendLock in interface FlowHandle
  - getEndpointProperties
```
public EndpointProperties getEndpointProperties()
```
  - getCSMPSubscriberChannel
```
public CSMPSubscriberChannel getCSMPSubscriberChannel()
```
  - getLiveMessageController
```
public LiveMessageController getLiveMessageController()
```
  - getLastMsgIdAcked
```
public long getLastMsgIdAcked()
```
  - tryToStartAutoRebind
```
public Boolean tryToStartAutoRebind()
```
  - isAutoRebindEnabled
```
public Boolean isAutoRebindEnabled()
```
  - isAutoRebindTriggered
```
public Boolean isAutoRebindTriggered()
```
  - tryToTriggerAutoRebind
```
public void tryToTriggerAutoRebind(Boolean enabled)
```
  - getReconnectRetryIntervalInMsecs
```
public int getReconnectRetryIntervalInMsecs()
```
  - transportInit
```
public final void transportInit()
```
    called during init and when AD resets due to switch to a different HOST
  - getFlowId
```
public long getFlowId()
```
    Specified by:
    
    getFlowId in interface FlowHandle
  - getMessageListener
```
public XMLMessageListener getMessageListener()
```
  - getBrowserFlow
```
public BrowserImpl getBrowserFlow()
```
  - setBrowserFlow
```
public void setBrowserFlow(BrowserImpl flow)
```
  - setMessageListener
```
public final void setMessageListener(XMLMessageListener listener)
```
    Specified by:
    
    setMessageListener in interface FlowReceiver
  - setLastReportedWinSz
```
public void setLastReportedWinSz(int winSz)
```
  - setFlowId
```
public void setFlowId(long flowId)
```
  - getEndpointId
```
public long getEndpointId()
```
  - setEndpointId
```
public void setEndpointId(long endpointId)
```
  - getFlowName
```
public String getFlowName()
```
  - setFlowName
```
public void setFlowName(String flowName)
```
  - getBoundResource
```
public Endpoint getBoundResource()
```
  - getCachedTopic
```
public Topic getCachedTopic()
```
  - getCachedSelector
```
public String getCachedSelector()
```
  - setCachedSelector
```
public void setCachedSelector(String cachedSelector)
```
  - closeChannelDied
```
public void closeChannelDied()
```
  - close
```
public void close()
```
    Description copied from interface: Consumer
    
    Closes the message consumer, rendering it unusable.
    Once closed, an application acquires a new instance in order to continue to receive messages.
    New messages will not be processed and delivered after a call to close() returns, although it is possible for a single asynchronous message delivery to occur if it has already begun when close() is called.
    
    Specified by:
    
    close in interface Consumer
    
    Specified by:
    
    close in interface Closeable
  - close
```
public void close(boolean linger)
```
    Description copied from interface: FlowReceiver
    
    [SolReserved] Close a flow, optionally signaling a non-durable Endpoint should linger on the appliance. When linger is set, the Endpoint will not be destroyed immediately, but rather only after a appliance-defined timeout. Unacknowledged messages on the Endpoint will be preserved during this time.
    
    Specified by:
    
    close in interface FlowReceiver
    
    Parameters:
    
    linger - If true, and this flow is bound to a non-durable Endpoint, signals to the appliance the Endpoint should not be immediately destroyed.
  - closeSegmentFlows
```
public void closeSegmentFlows(boolean linger,
                              boolean rollback)
```
  - setBoundToResourceState
```
public void setBoundToResourceState(FlowHandleImpl.ResourceBoundState s)
```
  - setAckThreshold
```
public void setAckThreshold(int threshold)
```
  - getAckThreshold
```
public int getAckThreshold()
```
  - getOriginalAckThreshold
```
public int getOriginalAckThreshold()
```
  - getSubWindowSize
```
public int getSubWindowSize()
```
  - isBoundToResource
```
public boolean isBoundToResource()
```
  - closeImpl
```
public void closeImpl(boolean allowAcks,
                      boolean linger,
                      TcpChannel.WriteBlockPolicy wpol,
                      JCSMPException cause)
```
  - closeImpl
```
public void closeImpl(boolean allowAcks,
                      boolean linger,
                      TcpChannel.WriteBlockPolicy wpol)
```
  - closeSync
```
public void closeSync()
               throws JCSMPException
```
    Specified by:
    
    closeSync in interface Consumer
    
    Throws:
    
    JCSMPException
  - closeSync
```
public void closeSync(boolean linger)
               throws JCSMPException
```
    Specified by:
    
    closeSync in interface Consumer
    
    Throws:
    
    JCSMPException
  - closeSyncImpl
```
public void closeSyncImpl(boolean allowAcks,
                          boolean linger,
                          TcpChannel.WriteBlockPolicy wpol)
                   throws JCSMPInterruptedException
```
    Internal-only method used to specify that we may be closing without wanting to send ACKS, such as when closing to handle an exception in this Flow Handle.
    
    Parameters:
    
    allowAcks - parameter
    
    Throws:
    
    JCSMPInterruptedException
  - resetAdState
```
public void resetAdState()
```
  - receive
```
public BytesXMLMessage receive()
                        throws JCSMPException
```
    Description copied from interface: Consumer
    
    Receives the next available message, waiting until one is available.
    
    Specified by:
    
    receive in interface Consumer
    
    Returns:
    
    The next available message, or null if it is interrupted.
    
    Throws:
    
    InvalidOperationException - If the consumer is not started, or a message listener is set.
    
    JCSMPTransportException - If the consumer was closed after the function was called, but before any message was received.
    
    JCSMPException
  - isOpened
```
public boolean isOpened()
```
  - receive
```
public BytesXMLMessage receive(int timeoutInMillis)
                        throws JCSMPException
```
    Description copied from interface: Consumer
    
    Receives the next available message. If no message is available, this method blocks until timeoutInMillis is reached. A timeout of zero never expires, and the call blocks indefinitely.
    
    Specified by:
    
    receive in interface Consumer
    
    Parameters:
    
    timeoutInMillis - The timeout in milliseconds.
    
    Returns:
    
    The next available message, or null if the timeout expires.
    
    Throws:
    
    InvalidOperationException - If the consumer is not started, or a message listener is set.
    
    JCSMPTransportException - If the consumer was closed after the method was called, but before any message was received.
    
    JCSMPException
  - receiveNoWait
```
public BytesXMLMessage receiveNoWait()
                              throws JCSMPException
```
    Description copied from interface: Consumer
    
    Receives the next available message. If no message is available, this method returns null immediately.
    
    Specified by:
    
    receiveNoWait in interface Consumer
    
    Returns:
    
    The next available message, or null if one is not available.
    
    Throws:
    
    InvalidOperationException - If the consumer is not started, or a message listener is set.
    
    JCSMPTransportException - If the consumer was closed after the function was called but before any message was received.
    
    JCSMPException
  - start
```
public void start()
           throws JCSMPException
```
    Description copied from interface: Consumer
    
    Enables receiving messages from an appliance.
    
    Specified by:
    
    start in interface Consumer
    
    Throws:
    
    JCSMPException - upon error
    
    InvalidOperationException - when called on a closed consumer.
  - stop
```
public void stop()
```
    Description copied from interface: Consumer
    
    Disables receiving messages from an appliance.
    Note that there is no guarantee the effect of calling stop() will be instantaneous: messages already in-flight or being processed by the API may still be delivered after the call to stop() returns.
    
    Specified by:
    
    stop in interface Consumer
  - startSync
```
public void startSync()
               throws JCSMPException
```
    Specified by:
    
    startSync in interface Consumer
    
    Throws:
    
    JCSMPException - on error
  - stopSync
```
public void stopSync()
              throws JCSMPInterruptedException
```
    Specified by:
    
    stopSync in interface Consumer
    
    Throws:
    
    JCSMPInterruptedException
  - stopSyncStart
```
public boolean stopSyncStart()
```
    Specified by:
    
    stopSyncStart in interface Consumer
  - stopSyncWait
```
public void stopSyncWait()
                  throws JCSMPInterruptedException
```
    Specified by:
    
    stopSyncWait in interface Consumer
    
    Throws:
    
    JCSMPInterruptedException
  - notifyPostReconnect
```
public void notifyPostReconnect()
```
  - notifyReconnected
```
public void notifyReconnected()
```
  - handleException
```
public void handleException(JCSMPException e)
```
  - handleControllerException
```
public void handleControllerException(JCSMPException e)
```
  - notifyAdMessage
```
public boolean notifyAdMessage(JCSMPXMLMessage msg)
```
  - processMessage
```
public boolean processMessage(JCSMPXMLMessage msg)
```
  - handleQueueException
```
public void handleQueueException(JCSMPException e)
```
  - getConsumerNotifDsp
```
public ConsumerNotificationDispatcher getConsumerNotifDsp()
```
  - checkLocalQueueEmptyAcks
```
public void checkLocalQueueEmptyAcks()
```
  - openWindow
```
public void openWindow()
```
  - closeWindow
```
public void closeWindow()
```
  - triggerAsyncDelivery
```
public Object triggerAsyncDelivery()
```
    Specified by:
    
    triggerAsyncDelivery in interface FlowHandle
  - getLastInOrderTpMsg
```
public long getLastInOrderTpMsg()
```
    Specified by:
    
    getLastInOrderTpMsg in interface FlowHandle
  - getWindowSize
```
public int getWindowSize()
```
    Specified by:
    
    getWindowSize in interface FlowHandle
  - getCurrentUnackedMessageListInfo
```
public AbstractUnackedMessageList.UnackedMessageListInfo getCurrentUnackedMessageListInfo()
```
  - setNumUnackedTpMsgs
```
public void setNumUnackedTpMsgs(int num)
```
    Specified by:
    
    setNumUnackedTpMsgs in interface FlowHandle
  - getNumUnackedTpMsgs
```
public int getNumUnackedTpMsgs()
```
  - getLogFlowInfoString
```
public String getLogFlowInfoString()
```
  - logFlowInfo
```
public void logFlowInfo(JCSMPLogLevel level)
```
    Description copied from interface: FlowReceiver
    
    Outputs a log containing the flow state information for the flow at a specified log level.
    
    Specified by:
    
    logFlowInfo in interface FlowReceiver
    
    Parameters:
    
    level - The level (corresponding to org.apache.commons.logging levels) at which to output the log.
  - startAckTimer
```
public void startAckTimer()
```
    Specified by:
    
    startAckTimer in interface FlowHandle
  - stopAckTimer
```
public void stopAckTimer()
```
    Specified by:
    
    stopAckTimer in interface FlowHandle
  - startMsgSegmentTimer
```
public void startMsgSegmentTimer(boolean restart)
```
  - stopMsgSegmentTimer
```
public void stopMsgSegmentTimer()
```
  - startSegmentFlowCreationTimer
```
public void startSegmentFlowCreationTimer()
```
  - stopSegmentFlowCreationTimer
```
public void stopSegmentFlowCreationTimer()
```
  - isNoLocal
```
public boolean isNoLocal()
```
  - throwClosedException
```
public void throwClosedException(String message)
                          throws InvalidOperationException
```
    Throws:
    
    InvalidOperationException
  - ackMessage
```
public void ackMessage(JCSMPXMLMessage msg)
```
  - sendSingleAck
```
public void sendSingleAck(long msgId,
                          boolean allowReactorComplete)
```
    Specified by:
    
    sendSingleAck in interface FlowHandle
  - tpCreateAck
```
public WireMessage tpCreateAck()
```
    Specified by:
    
    tpCreateAck in interface FlowHandle
  - tpCreateStopAck
```
public WireMessage tpCreateStopAck()
```
    Specified by:
    
    tpCreateStopAck in interface FlowHandle
  - tpSendAck
```
public void tpSendAck(WireMessage ackMsg,
                      boolean allowOnStateSub,
                      boolean allowReactorComplete)
```
    Specified by:
    
    tpSendAck in interface FlowHandle
  - getSubQueueHooks
```
public SubscriberQueueHooks getSubQueueHooks()
```
  - setSubQueueHooks
```
public void setSubQueueHooks(SubscriberQueueHooks subQueueHooks)
```
  - getMessageQueueSize
```
public int getMessageQueueSize()
```
  - addLiveTopicAction
```
public void addLiveTopicAction(CacheLiveDataAction action,
                               Topic topic,
                               LiveTopicListener listener)
                        throws InvalidOperationException
```
    Specified by:
    
    addLiveTopicAction in interface LiveMessageController
    
    Throws:
    
    InvalidOperationException
  - removeLiveTopicAction
```
public void removeLiveTopicAction(CacheLiveDataAction action,
                                  Topic topic)
```
    Specified by:
    
    removeLiveTopicAction in interface LiveMessageController
  - addLiveResponseListener
```
public void addLiveResponseListener(String correlationId,
                                    LiveResponseListener listener)
```
    Specified by:
    
    addLiveResponseListener in interface LiveMessageController
  - injectMessage
```
public void injectMessage(XMLMessage msg)
```
    Specified by:
    
    injectMessage in interface LiveMessageController
  - handleLargeMsgNotification
```
public void handleLargeMsgNotification(ConsumerLargeMessageNotification notif)
```
  - handleMessageSegmentReconstructionTimeout
```
public void handleMessageSegmentReconstructionTimeout(MsgSegmentReconstructionTimedTask task)
```
  - handleSegmentFlowCreationTimeout
```
public void handleSegmentFlowCreationTimeout(SegmentFlowCreationTimedTask task)
```
  - handleUnackedMsgSegments
```
public void handleUnackedMsgSegments()
```
  - injectNotification
```
public void injectNotification(Notification notif)
```
    Specified by:
    
    injectNotification in interface LiveMessageController
  - injectCacheEvent
```
public void injectCacheEvent(CacheEventMessage msg)
```
    Specified by:
    
    injectCacheEvent in interface LiveMessageController
  - onLiveMessage
```
public void onLiveMessage(JCSMPXMLMessage msg)
```
  - getLiveTopicMap
```
public HashMap<String,LiveTopicListener> getLiveTopicMap()
```
    Specified by:
    
    getLiveTopicMap in interface LiveMessageController
  - removeLiveResponseListener
```
public void removeLiveResponseListener(String correlationId)
```
    Specified by:
    
    removeLiveResponseListener in interface LiveMessageController
  - createStructuredType
```
public static BytesXMLMessage createStructuredType(JCSMPXMLMessage msg)
```
  - getEndpoint
```
public Endpoint getEndpoint()
```
    Description copied from interface: FlowReceiver
    
    Returns the appliance Endpoint this flow is bound to.
    
    Specified by:
    
    getEndpoint in interface FlowReceiver
    
    Returns:
    
    The bound appliance Endpoint.
  - getSubscription
```
public Subscription getSubscription()
```
    Description copied from interface: FlowReceiver
    
    Returns the subscription associated to the Endpoint when bound to a TopicEndpoint.
    
    Specified by:
    
    getSubscription in interface FlowReceiver
    
    Returns:
    
    The Topic subscription associated to the TopicEndpoint this flow is bound to, null if not bound to a TopicEndpoint.
  - getDestination
```
public Destination getDestination()
```
    Description copied from interface: FlowReceiver
    Returns the Destination to which messages should be published to get routed to this flow's bound Endpoint.
    - If bound to a TopicEndpoint, the Destination will be of type Topic.
    - If bound to a Queue, the Destination will be of type Queue.
    - If bound to a SubscriberEndpoint, this method returns null.
    Specified by:
    
    getDestination in interface FlowReceiver
    
    Returns:
    
    The Destination to which messages should be published to get routed to this flow's bound Endpoint.
  - setSubscription
```
public void setSubscription(Topic s)
```
  - getFlowType
```
public AssuredCtrlEnums.FlowType getFlowType()
```
  - rollback
```
public void rollback()
```
    ROLLBACK a flow: discards all locally-buffered messages and resets the expected next "LastMsgId" field to 0.
  - getTransactedSession
```
public BaseTransactedSessionImpl getTransactedSession()
```
  - setAckLastSerialNumber
```
public void setAckLastSerialNumber(long ackLastSerialNumber)
```
  - getAckLastSerialNumber
```
public long getAckLastSerialNumber()
```
  - getFlowEventHandler
```
public FlowEventHandler getFlowEventHandler()
```
  - notifyFlowEventHandler
```
public void notifyFlowEventHandler(FlowEventArgs eventArgs)
```
  - triggerDequeueFromConstructionQueue
```
public void triggerDequeueFromConstructionQueue(ConsumerLargeMessageNotification timeoutNotification)
```
  - onReceive
```
public void onReceive(BytesXMLMessage message)
```
    Description copied from interface: XMLMessageListener
    
    The callback method to handle messages received by the XMLMessageConsumer.
    
    Specified by:
    
    onReceive in interface XMLMessageListener
    
    Parameters:
    
    message - The BytesXMLMessage received.
  - onException
```
public void onException(JCSMPException exception)
```
    Description copied from interface: XMLMessageListener
    
    On error, this method is invoked. In general, the error is unrecoverable.
    
    Specified by:
    
    onException in interface XMLMessageListener
    
    Parameters:
    
    exception - The exception associated with the error condition.
  - isMsgSegmentFlow
```
public boolean isMsgSegmentFlow()
```
  - getEndpointErrorId
```
public Long getEndpointErrorId()
```
  - setEndpointErrorId
```
public void setEndpointErrorId(Long id)
```

Class FlowHandleImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.solacesystems.jcsmp.impl.flow.FlowHandle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

deliverAsyncOnReactor

Trace

Constructor Detail

FlowHandleImpl

Method Detail

getLock

getSession

getGrantedPermissions

getAckCreateSendLock

getEndpointProperties

getCSMPSubscriberChannel

getLiveMessageController

getLastMsgIdAcked

tryToStartAutoRebind

isAutoRebindEnabled

isAutoRebindTriggered

tryToTriggerAutoRebind

getReconnectRetryIntervalInMsecs

transportInit

getFlowId

getMessageListener

getBrowserFlow

setBrowserFlow

setMessageListener

setLastReportedWinSz

setFlowId

getEndpointId

setEndpointId

getFlowName

setFlowName

getBoundResource

getCachedTopic

getCachedSelector

setCachedSelector

closeChannelDied

close

close

closeSegmentFlows

setBoundToResourceState

setAckThreshold

getAckThreshold

getOriginalAckThreshold

getSubWindowSize

isBoundToResource

closeImpl

closeImpl

closeSync

closeSync

closeSyncImpl

resetAdState

receive

isOpened

receive

receiveNoWait

start

stop

startSync

stopSync

stopSyncStart

stopSyncWait

notifyPostReconnect

notifyReconnected

handleException

handleControllerException

notifyAdMessage

processMessage

handleQueueException

getConsumerNotifDsp

checkLocalQueueEmptyAcks

openWindow

closeWindow

triggerAsyncDelivery