com.solacesystems.jcsmp.impl

Class JCSMPXMLMessageConsumer

java.lang.Object

com.solacesystems.jcsmp.impl.JCSMPXMLMessageConsumer

All Implemented Interfaces:

Consumer, XMLMessageConsumer

public class JCSMPXMLMessageConsumer
extends Object
implements XMLMessageConsumer

JCSMPXMLMessageConsumer

Constructor Summary

Constructors

Constructor and Description
JCSMPXMLMessageConsumer(FlowHandleImpl classicFlowHandle, JCSMPBasicSession session)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the message consumer, rendering it unusable.
void	closeSync()
void	closeSync(boolean linger)
FlowHandleImpl	getFlowHandle()
LiveMessageController	getLiveMessageController()
XMLMessageListener	getMessageListener() Gets the message consumer's message listener.
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	setMessageListener(XMLMessageListener listener) Sets the message consumer's message listener.
void	start() Enables receiving messages from an appliance.
void	startSync()
void	stop() Disables receiving messages from an appliance.
void	stopSync()
boolean	stopSyncStart()
void	stopSyncWait()

Methods inherited from class java.lang.Object

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

Constructor Detail

JCSMPXMLMessageConsumer

public JCSMPXMLMessageConsumer(FlowHandleImpl classicFlowHandle,
                               JCSMPBasicSession session)

Method Detail

getFlowHandle

public FlowHandleImpl getFlowHandle()

getLiveMessageController

public LiveMessageController getLiveMessageController()

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.

See Also:

Consumer.start()

startSync

public void startSync()
               throws JCSMPException

Specified by:

startSync in interface Consumer

Throws:

JCSMPException - on error

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

See Also:

Consumer.stop()

stopSync

public void stopSync()
              throws JCSMPInterruptedException

Specified by:

stopSync in interface Consumer

Throws:

JCSMPInterruptedException

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

See Also:

Consumer.close()

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

getMessageListener

public XMLMessageListener getMessageListener()

Description copied from interface: XMLMessageConsumer

Gets the message consumer's message listener.

Specified by:

getMessageListener in interface XMLMessageConsumer

Returns:

The message listener if set, null otherwise.

See Also:

XMLMessageConsumer.getMessageListener()

setMessageListener

public void setMessageListener(XMLMessageListener listener)

Description copied from interface: XMLMessageConsumer

Sets the message consumer's message listener. By setting a message listener, the message consumer works in asynchronous mode.

The following calling patterns are not allowed and will result in an exception:

setting the message listener twice to different listeners (or the second time to null). setting the message listener after doing a receive(). doing a receive() after setting the message listener. setting the message listener after the connection is started with JCSMPProperties.MESSAGE_CALLBACK_ON_REACTOR set.

Specified by:

setMessageListener in interface XMLMessageConsumer

Parameters:

listener - The listener to which the messages are to be delivered.

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

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

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

stopSyncStart

public boolean stopSyncStart()

Specified by:

stopSyncStart in interface Consumer

stopSyncWait

public void stopSyncWait()
                  throws JCSMPInterruptedException

Specified by:

stopSyncWait in interface Consumer

Throws:

JCSMPInterruptedException