Producer (Solace Messaging API for Java v10.28.2)

All Known Subinterfaces:

XMLMessageProducer
```
@ProviderType
public interface Producer
```
Producer is the super class of XMLMessageProducer.
NOTE: Applications must cache this instance and close it only when it is no longer required.

Acquiring message instances
The Producer interface offers the following methods to acquire message instances:
When using these methods, you must consider the following points:
1. An application must acquire a single message instance at a time, and must send the message after acquiring it. Multi-threaded applications using a producer must ensure synchronisation is enforced so that a thread cannot acquire a new message before an existing message in another thread is sent.

2. An application must not attempt to send a message object multiple times. A new message instance should be acquired for this purpose. If an attempt is made to send a message twice, an InvalidOperationException is thrown.

NOTE: Producer is primarily maintained for backwards compatibility with existing applications that use the Messaging API for Java. It is recommended that new Java applications use the session-independent messages. Applications that require more control over message creation and pooling should use session-independent messages. There is no performance penalty for using the session-independent message ownership model if messages are preallocated and reused. See JCSMPFactory.createMessage(Class).

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the message producer.
`BytesMessage`	`createBytesMessage()` Applications use this method to create a `BytesMessage`.
`BytesXMLMessage`	`createBytesXMLMessage()` Applications use this method to create a `BytesXMLMessage`.
`BytesXMLMessage`	`createBytesXMLMessage(byte[] value)` Applications use this method to create a `BytesXMLMessage`.
`SDTMap`	`createMap()` Create maps for use as user `properties` or as structured `payload`.
`MapMessage`	`createMapMessage()` Applications use this method to create a `MapMessage`.
`SDTStream`	`createStream()` Create streams for use as structured `payload`.
`StreamMessage`	`createStreamMessage()` Applications use this method to create a `StreamMessage`.
`StreamXMLMessage`	`createStreamXMLMessage()` Deprecated.
`StreamXMLMessage`	`createStreamXMLMessage(InputStream stream)` Deprecated.
`TextMessage`	`createTextMessage()` Applications use this method to create a `TextMessage`.
`TextXMLMessage`	`createTextXMLMessage()` Deprecated.
`TextXMLMessage`	`createTextXMLMessage(String text)` Deprecated.
`XMLContentMessage`	`createXMLContentMessage()` Applications use this method to create a `XMLContentMessage`.
`JCSMPStreamingPublishEventHandler`	`getStreamingCallbackHandler()` Deprecated.
`boolean`	`isClosed()` Checks if message producer is closed

- Method Detail
  - getStreamingCallbackHandler
```
JCSMPStreamingPublishEventHandler getStreamingCallbackHandler()
                                                       throws JCSMPException
```
    Deprecated.
    
    Returns:
    
    The message producer callback handler if set; null, otherwise.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
  - createTextXMLMessage
```
TextXMLMessage createTextXMLMessage()
                             throws JCSMPException
```
    Deprecated.
    
    Applications use this method to create a TextXMLMessage.
    NOTE: Applications shall not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of TextXMLMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createTextXMLMessage
```
TextXMLMessage createTextXMLMessage(String text)
                             throws JCSMPException
```
    Deprecated.
    
    Applications use this method to create a TextXMLMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Parameters:
    
    text - The message content.
    
    Returns:
    
    An instance of TextXMLMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createBytesXMLMessage
```
BytesXMLMessage createBytesXMLMessage()
                               throws JCSMPException
```
    Applications use this method to create a BytesXMLMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of BytesXMLMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createBytesXMLMessage
```
BytesXMLMessage createBytesXMLMessage(byte[] value)
                               throws JCSMPException
```
    Applications use this method to create a BytesXMLMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Parameters:
    
    value - The message content.
    
    Returns:
    
    An instance of BytesXMLMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createStreamXMLMessage
```
StreamXMLMessage createStreamXMLMessage()
                                 throws JCSMPException
```
    Deprecated.
    
    Applications use this method to create a StreamXMLMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of StreamXMLMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createStreamXMLMessage
```
StreamXMLMessage createStreamXMLMessage(InputStream stream)
                                 throws IOException,
                                        JCSMPException
```
    Deprecated.
    
    Applications use this method to create a StreamXMLMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Parameters:
    
    stream - The InputStream from which to read message content.
    
    Returns:
    
    An instance of StreamXMLMessage.
    
    Throws:
    
    IOException - If error reading from stream.
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createMap
```
SDTMap createMap()
```
    Create maps for use as user properties or as structured payload. There is nothing tying the returned map to the producer that created it. The map can be used by any producer in any message.
    
    Returns:
    
    A new instance of SDTMap.
  - createStream
```
SDTStream createStream()
```
    Create streams for use as structured payload. There is nothing tying the returned stream to the producer that created it. The stream can be used by any producer in any message.
    
    Returns:
    
    A new instance of SDTStream.
  - createBytesMessage
```
BytesMessage createBytesMessage()
                         throws JCSMPException
```
    Applications use this method to create a BytesMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of BytesMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createXMLContentMessage
```
XMLContentMessage createXMLContentMessage()
                                   throws JCSMPException
```
    Applications use this method to create a XMLContentMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of XMLContentMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createMapMessage
```
MapMessage createMapMessage()
                     throws JCSMPException
```
    Applications use this method to create a MapMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of MapMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createStreamMessage
```
StreamMessage createStreamMessage()
                           throws JCSMPException
```
    Applications use this method to create a StreamMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of StreamMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - createTextMessage
```
TextMessage createTextMessage()
                       throws JCSMPException
```
    Applications use this method to create a TextMessage.
    NOTE: Applications must not cache the created object based on the assumption that the method returns a new object each time. The JCSMP implementation can reuse the same object by resetting its content.
    
    Returns:
    
    An instance of TextMessage.
    
    Throws:
    
    InvalidOperationException - when called on a closed producer.
    
    JCSMPException
    
    See Also:
    
    Acquiring message instances
  - close
```
void close()
```
    Closes the message producer.
  - isClosed
```
boolean isClosed()
```
    Checks if message producer is closed
    
    Returns:
    
    true if message producer is closed, false otherwise

Interface Producer

Acquiring message instances

Method Summary

Method Detail

getStreamingCallbackHandler

createTextXMLMessage

createTextXMLMessage

createBytesXMLMessage

createBytesXMLMessage

createStreamXMLMessage

createStreamXMLMessage

createMap

createStream

createBytesMessage

createXMLContentMessage

createMapMessage

createStreamMessage

createTextMessage

close

isClosed