org.jboss.seam.jms
Interface QueueBuilder

All Superinterfaces:

Serializable

public interface QueueBuilder
extends Serializable

QueueBuilder is a builder pattern implementation for working with JMS Queues.

Author:

johnament

Method Summary

QueueBuilder	connectionFactory(ConnectionFactory connectionFactory) Specifies the ConnectionFactory to use.
QueueBuilder	destination(Queue queue) Adds a Queue to the destinations of this QueueBuilder.
QueueBrowser	getQueueBrowser() Creates a QueueBrowser from the configured session and queue.
QueueBuilder	listen(MessageListener ml) Adds the given MessageListeners as listeners on the associated destinations.
QueueBuilder	newBuilder() Creates a QueueBuilder.
QueueBuilder	send(Message m) Sends a JMS Message to the destinations associated.
QueueBuilder	sendMap(Map m) Sends a Map as a JMS Map Message to the destinations associated.
QueueBuilder	sendObject(Serializable obj) Sends a Serializable Object as an ObjectMessage.
QueueBuilder	sendString(String s) Sends a String as a JMS TextMessage to the destinations associated.
QueueBuilder	sessionMode(int sessionMode) Sets the session mode for this Builder.
QueueBuilder	transacted() Toggles the transacted state (default is false) for this builder.

Method Detail

transacted

QueueBuilder transacted()

Toggles the transacted state (default is false) for this builder.

Returns:

this Builder.

sessionMode

QueueBuilder sessionMode(int sessionMode)

Sets the session mode for this Builder. Default is Session.AUTO_ACKNOWLEDGE

Parameters:

sessionMode - SessionMode flag, see javax.jms.Session's list of valid values.

Returns:

this Builder.

connectionFactory

QueueBuilder connectionFactory(ConnectionFactory connectionFactory)

Specifies the ConnectionFactory to use.

Parameters:

ConnectionFactory - to use.

Returns:

this QueueBuilder.

destination

QueueBuilder destination(Queue queue)

Adds a Queue to the destinations of this QueueBuilder.

Parameters:

queue - The queue to add.

Returns:

this QueueBuilder

send

QueueBuilder send(Message m)

Sends a JMS Message to the destinations associated.

Parameters:

m - The message to send.

Returns:

this QueueBuilder.

sendMap

QueueBuilder sendMap(Map m)

Sends a Map as a JMS Map Message to the destinations associated.

Parameters:

m - the Map to send.

Returns:

this QueueBuilder

sendString

QueueBuilder sendString(String s)

Sends a String as a JMS TextMessage to the destinations associated.

Parameters:

s - The String to send.

Returns:

this QueueBuilder.

sendObject

QueueBuilder sendObject(Serializable obj)

Sends a Serializable Object as an ObjectMessage.

Parameters:

obj - The Serializable object to send.

Returns:

this QueueBuilder

listen

QueueBuilder listen(MessageListener ml)

Adds the given MessageListeners as listeners on the associated destinations.

Parameters:

ml - MessageListener instances to connect to these destinations.

Returns:

this QueueBuilder

newBuilder

QueueBuilder newBuilder()

Creates a QueueBuilder. It will be associated with any active Session.

Returns:

a new QueueBuilder instance.

getQueueBrowser

QueueBrowser getQueueBrowser()

Creates a QueueBrowser from the configured session and queue.

Returns:

a QueueBrowser on top of the configured queue and session.