org.jboss.aerogear.unifiedpush.message.util

Class JmsClient.JmsReceiver

java.lang.Object

org.jboss.aerogear.unifiedpush.message.util.JmsClient.JmsReceiver

Enclosing class:

JmsClient

public class JmsClient.JmsReceiver
extends Object

Utility that allows to specify how should be message sent and into which destination

Constructor Summary

Constructors

Constructor and Description
JmsReceiver()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
javax.jms.ObjectMessage	from(javax.jms.Destination destination) Receives message from the given destination.
JmsClient.JmsReceiver	inTransaction() Receives the message in transaction (i.e.
JmsClient.JmsReceiver	noAutoClose() Won't close the connection automatically upon completion, allowing to reuse given connection.
JmsClient.JmsReceiver	noWait() Don't block and returns the message what is in the queue, if there is none queued, then returns null immediately.
JmsClient.JmsReceiver	withAcknowledgeMode(int acknowledgeMode) Sets the message acknowledgement mode.
JmsClient.JmsReceiver	withSelector(String selector, Object... args) Specifies a selector used to query messages from a destination.
JmsClient.JmsReceiver	withTimeout(long timeout) Waits specific number of milliseconds for a message to eventually appear in the queue, or returns null if there was no message queued in given interval.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsReceiver

public JmsReceiver()

Method Detail

inTransaction

public JmsClient.JmsReceiver inTransaction()

Receives the message in transaction (i.e. use JmsXA connection factory).

Returns:

this receiver object

withSelector

public JmsClient.JmsReceiver withSelector(String selector,
                                          Object... args)

Specifies a selector used to query messages from a destination. The selector can be formatted with arguments as in String.format(String, Object...).

Parameters:

selector - specifies to query messages from a destination.

args - argument for the selector

Returns:

this receiver object

See Also:

String.format(String, Object...)

noWait

public JmsClient.JmsReceiver noWait()

Don't block and returns the message what is in the queue, if there is none queued, then returns null immediately.

Returns:

this receiver object

withTimeout

public JmsClient.JmsReceiver withTimeout(long timeout)

Waits specific number of milliseconds for a message to eventually appear in the queue, or returns null if there was no message queued in given interval.

Parameters:

timeout - wait until

Returns:

this receiver object

withAcknowledgeMode

public JmsClient.JmsReceiver withAcknowledgeMode(int acknowledgeMode)

Sets the message acknowledgement mode.

Parameters:

acknowledgeMode - JMS acknowledge mode as in Session

Returns:

this receiver object

noAutoClose

public JmsClient.JmsReceiver noAutoClose()

Won't close the connection automatically upon completion, allowing to reuse given connection.

Returns:

this receiver object

close

public void close()

Closes the connection.

from

public javax.jms.ObjectMessage from(javax.jms.Destination destination)

Receives message from the given destination.

Parameters:

destination - where to receive from

Returns:

dequeued ObjectMessage