DefaultMessageProducerAdapter (Solace JMS API v10.6.2)

java.lang.Object
- com.solacesystems.jms.impl.DefaultMessageProducerAdapter

All Implemented Interfaces:

JCSMPProducerEventHandler, JCSMPStreamingPublishCorrelatingEventHandler, JCSMPStreamingPublishEventHandler, MessageProducerAdapter

Direct Known Subclasses:

FlowMessageProducerAdapter, TransactedMessageProducerAdapter, XAMessageProducerAdapter
```
public class DefaultMessageProducerAdapter
extends Object
implements MessageProducerAdapter, JCSMPStreamingPublishCorrelatingEventHandler, JCSMPProducerEventHandler
```

Constructor Summary

Constructors
Constructor and Description
`DefaultMessageProducerAdapter(SessionProperties props, boolean createSendResult)` Deprecated.
`DefaultMessageProducerAdapter(SessionProperties props, SolSessionIF session, boolean createSendResult)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel(JCSMPException e)`
`void`	`close()`
`BytesMessage`	`createBytesMessage(DeliveryMode deliveryMode)`
`BytesXMLMessage`	`createBytesXMLMessage(DeliveryMode deliveryMode)`
`MapMessage`	`createMapMessage(DeliveryMode deliveryMode)`
`StreamMessage`	`createStreamMessage(DeliveryMode deliveryMode)`
`TextMessage`	`createTextMessage(DeliveryMode deliveryMode)`
`XMLContentMessage`	`createXMLContentMessage(DeliveryMode deliveryMode)`
`void`	`handleError(String messageID, JCSMPException cause, long timestamp)` This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read.
`void`	`handleErrorEx(Object key, JCSMPException cause, long timestamp)` This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read.
`void`	`handleEvent(ProducerEventArgs event)` Called when a producer event notification is available.
`void`	`responseReceived(String messageID)` This method is invoked whenever an OK response is received.
`void`	`responseReceivedEx(Object key)` This method is invoked whenever an OK response is received.
`void`	`send(BytesXMLMessage msg, Destination destination)`
`void`	`setProducerEventListener(SolProducerEventListener eventListener)`

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

- Constructor Detail
  - DefaultMessageProducerAdapter
```
@Deprecated
public DefaultMessageProducerAdapter(SessionProperties props,
                                                 boolean createSendResult)
                                          throws JCSMPException
```
    Deprecated.
    
    Throws:
    
    JCSMPException
  - DefaultMessageProducerAdapter
```
public DefaultMessageProducerAdapter(SessionProperties props,
                                     SolSessionIF session,
                                     boolean createSendResult)
                              throws JCSMPException
```
    Throws:
    
    JCSMPException
- Method Detail
  - close
```
public void close()
```
    Specified by:
    
    close in interface MessageProducerAdapter
  - cancel
```
public void cancel(JCSMPException e)
```
    Specified by:
    
    cancel in interface MessageProducerAdapter
  - setProducerEventListener
```
public void setProducerEventListener(SolProducerEventListener eventListener)
```
    Specified by:
    
    setProducerEventListener in interface MessageProducerAdapter
  - createBytesMessage
```
public BytesMessage createBytesMessage(DeliveryMode deliveryMode)
                                throws JCSMPException
```
    Specified by:
    
    createBytesMessage in interface MessageProducerAdapter
    
    Throws:
    
    JCSMPException
  - createBytesXMLMessage
```
public BytesXMLMessage createBytesXMLMessage(DeliveryMode deliveryMode)
                                      throws JCSMPException
```
    Specified by:
    
    createBytesXMLMessage in interface MessageProducerAdapter
    
    Throws:
    
    JCSMPException
  - createMapMessage
```
public MapMessage createMapMessage(DeliveryMode deliveryMode)
                            throws JCSMPException
```
    Specified by:
    
    createMapMessage in interface MessageProducerAdapter
    
    Throws:
    
    JCSMPException
  - createStreamMessage
```
public StreamMessage createStreamMessage(DeliveryMode deliveryMode)
                                  throws JCSMPException
```
    Specified by:
    
    createStreamMessage in interface MessageProducerAdapter
    
    Throws:
    
    JCSMPException
  - createTextMessage
```
public TextMessage createTextMessage(DeliveryMode deliveryMode)
                              throws JCSMPException
```
    Specified by:
    
    createTextMessage in interface MessageProducerAdapter
    
    Throws:
    
    JCSMPException
  - createXMLContentMessage
```
public XMLContentMessage createXMLContentMessage(DeliveryMode deliveryMode)
                                          throws JCSMPException
```
    Specified by:
    
    createXMLContentMessage in interface MessageProducerAdapter
    
    Throws:
    
    JCSMPException
  - send
```
public void send(BytesXMLMessage msg,
                 Destination destination)
          throws JCSMPException
```
    Specified by:
    
    send in interface MessageProducerAdapter
    
    Throws:
    
    JCSMPException
  - handleErrorEx
```
public void handleErrorEx(Object key,
                          JCSMPException cause,
                          long timestamp)
```
    Description copied from interface: JCSMPStreamingPublishCorrelatingEventHandler
    This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read.
    Note: Handler processing should be kept to a minimum as this blocks the thread from which the error originated.
    Note: Direct messages are not buffered by the publishing API, and error responses from the appliance cannot be correlated to published Direct messages. As a result, when a Direct message is rejected by an error response, the key parameter to this callback is null.
    Error responses from the appliance
    If an error response is available, it is represented as a JCSMPErrorResponseException. The following subcodes can be present to provide further information about why the message was rejected:
    Specified by:
    
    handleErrorEx in interface JCSMPStreamingPublishCorrelatingEventHandler
    
    Parameters:
    
    key - The correlation key of the message with which the error condition is associated.
    
    cause - The error condition.
    
    timestamp - The time of the error given by System.currentTimeMillis().
    
    See Also:
    
    XMLMessage.setCorrelationKey(Object)
  - handleError
```
public void handleError(String messageID,
                        JCSMPException cause,
                        long timestamp)
```
    Description copied from interface: JCSMPStreamingPublishEventHandler
    
    This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read.
    Note: Handler processing should be kept to a minimum because it blocks the thread from which the error originated.
    Error responses from the appliance
    If an error response is available, it is represented as a JCSMPErrorResponseException. The subcodes discussed in JCSMPStreamingPublishCorrelatingEventHandler might be present to provide further information about why the message was rejected.
    
    Specified by:
    
    handleError in interface JCSMPStreamingPublishEventHandler
    
    Parameters:
    
    messageID - The message ID of the message with which the error condition is associated.
    
    cause - The error condition.
    
    timestamp - The time of the error given by System.currentTimeMillis().
  - responseReceivedEx
```
public void responseReceivedEx(Object key)
```
    Description copied from interface: JCSMPStreamingPublishCorrelatingEventHandler
    
    This method is invoked whenever an OK response is received.
    When publishing PERSISTENT and NON_PERSISTENT messages, the message's correlation key is passed as an argument to this callback when an acknowledgement is received.
    
    Note: DIRECT messages do not receive acknowledgements. Therefore, this method is not invoked for Direct messages.
    
    Specified by:
    
    responseReceivedEx in interface JCSMPStreamingPublishCorrelatingEventHandler
    
    Parameters:
    
    key - The correlation key of the message being acknowledged.
    
    See Also:
    
    XMLMessage.setCorrelationKey(Object)
  - responseReceived
```
public void responseReceived(String messageID)
```
    Description copied from interface: JCSMPStreamingPublishEventHandler
    
    This method is invoked whenever an OK response is received.
    When publishing PERSISTENT and NON_PERSISTENT messages, the messageID is passed as an argument to this callback when an acknowledgement is received.
    
    Note: This method is not invoked for DIRECT messages because they do not receive acknowledgements.
    
    Specified by:
    
    responseReceived in interface JCSMPStreamingPublishEventHandler
  - handleEvent
```
public void handleEvent(ProducerEventArgs event)
```
    Description copied from interface: JCSMPProducerEventHandler
    
    Called when a producer event notification is available.
    
    Specified by:
    
    handleEvent in interface JCSMPProducerEventHandler
    
    Parameters:
    
    event - The event to process.

Class DefaultMessageProducerAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultMessageProducerAdapter

DefaultMessageProducerAdapter

Method Detail

close

cancel

setProducerEventListener

createBytesMessage

createBytesXMLMessage

createMapMessage

createStreamMessage

createTextMessage

createXMLContentMessage

send

handleErrorEx

Error responses from the appliance

handleError

Error responses from the appliance

responseReceivedEx

responseReceived

handleEvent