com.solacesystems.jcsmp.impl

Class JCSMPXMLMessageProducer

java.lang.Object

com.solacesystems.jcsmp.impl.JCSMPXMLMessageProducer

All Implemented Interfaces:

Closeable, JCSMPStreamingPublishCorrelatingEventHandler, JCSMPStreamingPublishEventHandler, Producer, CSMPPublisherChannelObserver, XMLMessageProducer

public class JCSMPXMLMessageProducer
extends Object
implements XMLMessageProducer, CSMPPublisherChannelObserver, Closeable, JCSMPStreamingPublishCorrelatingEventHandler

JCSMPXMLMessageProducer

Field Summary

Fields

Modifier and Type	Field and Description
CSMPPublisherChannel	channel

Fields inherited from interface com.solacesystems.jcsmp.protocol.CSMPPublisherChannelObserver

NULL_FLOWID, NULL_PUBLISHERID

Constructor Summary

Constructors

Constructor and Description
JCSMPXMLMessageProducer(JCSMPBasicSession session, CSMPPublisherChannel channel, JCSMPStreamingPublishEventHandler callback, JCSMPProducerEventHandler eventHandler, PubFlowManager pubFlowMgr, ProducerFlowProperties fprop, JCSMPBasicSession.InternalBindProperties internalBindProp)

Method Summary

Modifier and Type	Method and Description
void	buildDispatchProducerList(List<JCSMPXMLMessageProducer> toNotify)
void	close() Closes the message producer.
void	closeImpl(boolean reconn)
BytesMessage	createBytesMessage() Applications use this method to create a BytesMessage.
BytesXMLMessage	createBytesXMLMessage() reuse the message object
BytesXMLMessage	createBytesXMLMessage(byte[] value) reuse the message object
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() reuse the message object
StreamXMLMessage	createStreamXMLMessage(InputStream stream) reuse the message object
TextMessage	createTextMessage() Applications use this method to create a TextMessage.
TextXMLMessage	createTextXMLMessage() reuse the message object
TextXMLMessage	createTextXMLMessage(String text) reuse the message object
XMLContentMessage	createXMLContentMessage() Applications use this method to create a XMLContentMessage.
String	getDbgFlowName()
ReentrantLock	getLock()
int	getPriority()
JCSMPProducerEventHandler	getProducerEventHandler()
PubADManager	getPubADManager()
JCSMPSessionStats	getSessionStats()
JCSMPStreamingPublishEventHandler	getStreamEventHandler()
JCSMPStreamingPublishEventHandler	getStreamingCallbackHandler()
JCSMPStreamingPublishEventHandler	getStreamingCallbackHandlerInternal()
BaseTransactedSessionImpl	getTransactedSession()
boolean	handleAckAD(long msgID, JCSMPErrorResponseException err)
void	handleAsyncCloseFlow(WireMessage message)
boolean	handleCommitResponse(long msgID, JCSMPErrorResponseException err)
void	handleError(String messageID, JCSMPException cause, long timestamp)
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	handleException(MsgIdInfo msgInfo, JCSMPException e, long producerId, boolean forceNotifyIfClosed) This method is called when exception happened during read and write operation.
void	handleException(MsgIdInfo msgId, JCSMPException e, long producerId, boolean forceNotifyIfClosed, List<JCSMPXMLMessageProducer> toNotify)
void	handlePubMsgResponse(WireMessage resp)
void	handlePubMsgSent(JCSMPXMLMessage xmlMsg, JCSMPXMLMessageProducer prod)
void	handleRetransmitADMsgs(Runnable callbackOnComplete, boolean forceAllowEnqueue)
boolean	isDirectPermitted()
boolean	isOpenInternal()
boolean	isTransacted()
void	notifyReconnected()
void	open()
void	responseReceived(String messageID)
void	responseReceivedEx(Object key) This method is invoked whenever an OK response is received.
void	resume(int tickets) There can be several tasks to run on reconnect / transaction resyncs, etc.
void	send(XMLMessage message) Sends a message.
void	send(XMLMessage message, Destination destination) Sends a message to a destination, such as a Queue or Topic.
void	sendImpl(JCSMPXMLMessage[] messages, int offset, int length, com.solacesystems.jcsmp.impl.JCSMPXMLMessageProducer.PubMsgInfo[] pubMsgInfos)
void	sendMsgOnce(JCSMPXMLMessage[] messages, int offset, int length, boolean newMsgIdRequired, boolean newMsg, boolean notify, boolean allowBlock, Integer expectedChannelTag, boolean dropOnWouldBlock, boolean allowStateSub, com.solacesystems.jcsmp.impl.JCSMPXMLMessageProducer.PubMsgInfo[] pubMsgInfos)
int	sendMultiple(JCSMPSendMultipleEntry[] entries, int offset, int length, int sendFlags) Sends a batch of messages.
void	sendReply(XMLMessage requestMessage, XMLMessage replyMessage) Convenience function for sending a reply message.
void	setDirectPermitted(boolean directPermitted)
void	setPriority(int prior)
void	setStreamingCallbackHandler(JCSMPStreamingPublishEventHandler callback) By setting a callback handler, any send returns immediately without confirming the successful delivery of the message.
void	suspend() There can be several tasks to run on reconnect / transaction resyncs, etc.
void	waitOnSpinlockSendBlocked()
void	waitOnSpinlockSendBlockedWithThrow()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

channel

public CSMPPublisherChannel channel

Constructor Detail

JCSMPXMLMessageProducer

public JCSMPXMLMessageProducer(JCSMPBasicSession session,
                               CSMPPublisherChannel channel,
                               JCSMPStreamingPublishEventHandler callback,
                               JCSMPProducerEventHandler eventHandler,
                               PubFlowManager pubFlowMgr,
                               ProducerFlowProperties fprop,
                               JCSMPBasicSession.InternalBindProperties internalBindProp)

Method Detail

getLock

public ReentrantLock getLock()

getPubADManager

public PubADManager getPubADManager()

getStreamEventHandler

public JCSMPStreamingPublishEventHandler getStreamEventHandler()

getProducerEventHandler

public JCSMPProducerEventHandler getProducerEventHandler()

isOpenInternal

public boolean isOpenInternal()

open

public void open()
          throws JCSMPException

Throws:

JCSMPException

close

public void close()

Description copied from interface: Producer

Closes the message producer.

Specified by:

close in interface Closeable

Specified by:

close in interface Producer

See Also:

Producer.close()

closeImpl

public void closeImpl(boolean reconn)

send

public void send(XMLMessage message,
                 Destination destination)
          throws JCSMPException

Description copied from interface: XMLMessageProducer

Sends a message to a destination, such as a Queue or Topic. Once send returns, message.getMessageId() gives the message id assigned to the message.

Specified by:

send in interface XMLMessageProducer

Parameters:

message - Message to send.

destination - The destination to publish to.

Throws:

JCSMPException - on failure.

sendMultiple

public int sendMultiple(JCSMPSendMultipleEntry[] entries,
                        int offset,
                        int length,
                        int sendFlags)
                 throws JCSMPException

Description copied from interface: XMLMessageProducer

Sends a batch of messages. Each JCSMPSendMultipleEntry element in entries is a {XMLMessage, Destination} tuple, allowing this method to send messages to individual destinations. JCSMP attempts to write all messages to the network at once, returning once the write is complete. Guaranteed messages can be published with this method; they are published serially as space becomes available in the acknowledgement window. This method returns the number of messages written, but current implementations can choose to block until all messages have been published.

Restrictions:

• All messages published must have the same DeliveryMode set.
• All messages published must be session-independent messages (acquired from JCSMPFactory).
• This XMLMessageProducer must be operating in streaming publish mode (a streaming callback handler must be specified).
• No message instance can appear twice in entries.
• The maximum array length is 50.

Specified by:

sendMultiple in interface XMLMessageProducer

Parameters:

entries - An array of elements to publish.

offset - The offset into entries.

length - The number of entries, starting at offset, to attempt to publish.

sendFlags - Flags controlling the send operation, present for extensibility, must be 0 in this release.

Returns:

The number of messages written to the network.

Throws:

JCSMPException - When sending a message to the network failed unrecoverably.

See Also:

JCSMPFactory.createMessage(Class)

sendReply

public void sendReply(XMLMessage requestMessage,
                      XMLMessage replyMessage)
               throws JCSMPException

Description copied from interface: XMLMessageProducer

Convenience function for sending a reply message.

Automatically copies requestMessage's CorrelationId to replyMessage and sets the reply attribute on the latter. replyMessage is sent to the Destination returned by requestMessage.getReplyTo().

Specified by:

sendReply in interface XMLMessageProducer

Parameters:

requestMessage - The request message that is being replied to.

replyMessage - The reply message to publish.

Throws:

JCSMPException - When sending a message to the network failed unrecoverably.

See Also:

send() for error response subcodes.

send

public void send(XMLMessage message)
          throws JCSMPException

Description copied from interface: XMLMessageProducer

Sends a message.

A new message ID is assigned to the message by JCSMP automatically every time this method is called.

If using producer-acquired messages, the message becomes read-only and cannot be modified or resent by the application.

Specified by:

send in interface XMLMessageProducer

Parameters:

message - The message to be sent.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException - upon failure.

See Also:

XMLMessageProducer.send(com.solacesystems.jcsmp.XMLMessage)

sendImpl

public void sendImpl(JCSMPXMLMessage[] messages,
                     int offset,
                     int length,
                     com.solacesystems.jcsmp.impl.JCSMPXMLMessageProducer.PubMsgInfo[] pubMsgInfos)
              throws JCSMPException

Throws:

JCSMPException

sendMsgOnce

public void sendMsgOnce(JCSMPXMLMessage[] messages,
                        int offset,
                        int length,
                        boolean newMsgIdRequired,
                        boolean newMsg,
                        boolean notify,
                        boolean allowBlock,
                        Integer expectedChannelTag,
                        boolean dropOnWouldBlock,
                        boolean allowStateSub,
                        com.solacesystems.jcsmp.impl.JCSMPXMLMessageProducer.PubMsgInfo[] pubMsgInfos)
                 throws JCSMPException

Throws:

JCSMPException

handleAckAD

public boolean handleAckAD(long msgID,
                           JCSMPErrorResponseException err)
                    throws JCSMPException

Throws:

JCSMPException

handleCommitResponse

public boolean handleCommitResponse(long msgID,
                                    JCSMPErrorResponseException err)
                             throws JCSMPException

Throws:

JCSMPException

suspend

public void suspend()

There can be several tasks to run on reconnect / transaction resyncs, etc. Tasks that suspend the producer thread increment the ticket count.

resume

public void resume(int tickets)

There can be several tasks to run on reconnect / transaction resyncs, etc. Tasks that want to resume the producer thread decrement the ticket count and if we hit zero we tick the resume flag.

waitOnSpinlockSendBlockedWithThrow

public void waitOnSpinlockSendBlockedWithThrow()
                                        throws JCSMPInterruptedException

Throws:

JCSMPInterruptedException

waitOnSpinlockSendBlocked

public void waitOnSpinlockSendBlocked()

handleRetransmitADMsgs

public void handleRetransmitADMsgs(Runnable callbackOnComplete,
                                   boolean forceAllowEnqueue)

getStreamingCallbackHandler

public JCSMPStreamingPublishEventHandler getStreamingCallbackHandler()
                                                              throws JCSMPException

Specified by:

getStreamingCallbackHandler in interface Producer

Returns:

The message producer callback handler if set; null, otherwise.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

getStreamingCallbackHandlerInternal

public JCSMPStreamingPublishEventHandler getStreamingCallbackHandlerInternal()

getTransactedSession

public BaseTransactedSessionImpl getTransactedSession()

isTransacted

public boolean isTransacted()

setStreamingCallbackHandler

public void setStreamingCallbackHandler(JCSMPStreamingPublishEventHandler callback)
                                 throws JCSMPException

Description copied from interface: XMLMessageProducer

By setting a callback handler, any send returns immediately without confirming the successful delivery of the message. Applications receive the response of the send asynchronously through the callback.

Specified by:

setStreamingCallbackHandler in interface XMLMessageProducer

Parameters:

callback - The callback handler to be set.

Throws:

InvalidOperationException - When called on a closed producer.

JCSMPException

getSessionStats

public JCSMPSessionStats getSessionStats()

createTextXMLMessage

public TextXMLMessage createTextXMLMessage()
                                    throws JCSMPException

reuse the message object

Specified by:

createTextXMLMessage in interface Producer

Returns:

An instance of TextXMLMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

createTextXMLMessage

public TextXMLMessage createTextXMLMessage(String text)
                                    throws JCSMPException

reuse the message object

Specified by:

createTextXMLMessage in interface Producer

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

public BytesXMLMessage createBytesXMLMessage()
                                      throws JCSMPException

reuse the message object

Specified by:

createBytesXMLMessage in interface Producer

Returns:

An instance of BytesXMLMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

createBytesXMLMessage

public BytesXMLMessage createBytesXMLMessage(byte[] value)
                                      throws JCSMPException

reuse the message object

Specified by:

createBytesXMLMessage in interface Producer

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

public StreamXMLMessage createStreamXMLMessage()
                                        throws JCSMPException

reuse the message object

Specified by:

createStreamXMLMessage in interface Producer

Returns:

An instance of StreamXMLMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

createStreamXMLMessage

public StreamXMLMessage createStreamXMLMessage(InputStream stream)
                                        throws IOException,
                                               JCSMPException

reuse the message object

Specified by:

createStreamXMLMessage in interface Producer

Parameters:

stream - The InputStream from which to read message content.

Returns:

An instance of StreamXMLMessage.

Throws:

JCSMPException - on error

IOException - If error reading from stream.

See Also:

Acquiring message instances

createMap

public SDTMap createMap()

Description copied from interface: Producer

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.

Specified by:

createMap in interface Producer

Returns:

A new instance of SDTMap.

createStream

public SDTStream createStream()

Description copied from interface: Producer

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.

Specified by:

createStream in interface Producer

Returns:

A new instance of SDTStream.

createBytesMessage

public BytesMessage createBytesMessage()
                                throws JCSMPException

Description copied from interface: Producer

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.

Specified by:

createBytesMessage in interface Producer

Returns:

An instance of BytesMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

createXMLContentMessage

public XMLContentMessage createXMLContentMessage()
                                          throws JCSMPException

Description copied from interface: Producer

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.

Specified by:

createXMLContentMessage in interface Producer

Returns:

An instance of XMLContentMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

createMapMessage

public MapMessage createMapMessage()
                            throws JCSMPException

Description copied from interface: Producer

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.

Specified by:

createMapMessage in interface Producer

Returns:

An instance of MapMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

createStreamMessage

public StreamMessage createStreamMessage()
                                  throws JCSMPException

Description copied from interface: Producer

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.

Specified by:

createStreamMessage in interface Producer

Returns:

An instance of StreamMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

createTextMessage

public TextMessage createTextMessage()
                              throws JCSMPException

Description copied from interface: Producer

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.

Specified by:

createTextMessage in interface Producer

Returns:

An instance of TextMessage.

Throws:

InvalidOperationException - when called on a closed producer.

JCSMPException

See Also:

Acquiring message instances

buildDispatchProducerList

public void buildDispatchProducerList(List<JCSMPXMLMessageProducer> toNotify)

Specified by:

buildDispatchProducerList in interface CSMPPublisherChannelObserver

handleException

public void handleException(MsgIdInfo msgId,
                            JCSMPException e,
                            long producerId,
                            boolean forceNotifyIfClosed,
                            List<JCSMPXMLMessageProducer> toNotify)

Specified by:

handleException in interface CSMPPublisherChannelObserver

handleException

public void handleException(MsgIdInfo msgInfo,
                            JCSMPException e,
                            long producerId,
                            boolean forceNotifyIfClosed)

This method is called when exception happened during read and write operation.

handlePubMsgResponse

public void handlePubMsgResponse(WireMessage resp)

Specified by:

handlePubMsgResponse in interface CSMPPublisherChannelObserver

handleAsyncCloseFlow

public void handleAsyncCloseFlow(WireMessage message)

Specified by:

handleAsyncCloseFlow in interface CSMPPublisherChannelObserver

notifyReconnected

public void notifyReconnected()

Specified by:

notifyReconnected in interface CSMPPublisherChannelObserver

handlePubMsgSent

public void handlePubMsgSent(JCSMPXMLMessage xmlMsg,
                             JCSMPXMLMessageProducer prod)

Specified by:

handlePubMsgSent in interface CSMPPublisherChannelObserver

isDirectPermitted

public boolean isDirectPermitted()

setDirectPermitted

public void setDirectPermitted(boolean directPermitted)

getDbgFlowName

public String getDbgFlowName()

handleError

public void handleError(String messageID,
                        JCSMPException cause,
                        long timestamp)

Specified by:

handleError in interface JCSMPStreamingPublishCorrelatingEventHandler

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().

responseReceived

public void responseReceived(String messageID)

Specified by:

responseReceived in interface JCSMPStreamingPublishCorrelatingEventHandler

Specified by:

responseReceived in interface JCSMPStreamingPublishEventHandler

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)

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:

• JCSMPErrorResponseSubcodeEx.MESSAGE_TOO_LARGE
• JCSMPErrorResponseSubcodeEx.QUEUE_NOT_FOUND
• JCSMPErrorResponseSubcodeEx.INVALID_TOPIC_SYNTAX
• JCSMPErrorResponseSubcodeEx.XML_PARSE_ERROR
• JCSMPErrorResponseSubcodeEx.PUBLISH_ACL_DENIED
• JCSMPErrorResponseSubcodeEx.PUBLISH_NO_VALID_CLOSED_USER_GROUP
• JCSMPErrorResponseSubcodeEx.MAX_MESSAGE_USAGE_EXCEEDED
• JCSMPErrorResponseSubcodeEx.SPOOL_OVER_QUOTA

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)

getPriority

public int getPriority()

setPriority

public void setPriority(int prior)