Package com.github.ddth.queue.impl

Class RabbitMqQueue<ID,DATA>

java.lang.Object

com.github.ddth.queue.impl.AbstractQueue<ID,DATA>

com.github.ddth.queue.impl.RabbitMqQueue<ID,DATA>

All Implemented Interfaces:

IQueue<ID,DATA>, AutoCloseable

Direct Known Subclasses:

BaseUniversalRabbitMqQueue

public abstract class RabbitMqQueue<ID,DATA>
extends AbstractQueue<ID,DATA>

(Experimental) RabbitMQ implementation of IQueue.

• Queue-size support: no
• Ephemeral storage support: no

Since:

0.6.1

Author:

Thanh Ba Nguyen

Nested Class Summary

Nested classes/interfaces inherited from class com.github.ddth.queue.impl.AbstractQueue

AbstractQueue.PutToQueueCase

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_QUEUE_NAME
static String	DEFAULT_URI

Fields inherited from interface com.github.ddth.queue.IQueue

SIZE_NOT_SUPPORTED

Constructor Summary

Constructors

Constructor	Description
RabbitMqQueue()

Method Summary

Modifier and Type	Method	Description
protected com.rabbitmq.client.ConnectionFactory	buildConnectionFactory()
protected void	closeQuietly(com.rabbitmq.client.Channel channel)
protected void	closeQuietly(com.rabbitmq.client.Connection connection)
protected com.rabbitmq.client.Channel	createChannel()
void	destroy()	Destroy method.
protected boolean	doPutToQueue(IQueueMessage<ID,DATA> msg, AbstractQueue.PutToQueueCase queueCase)	Put a message to the queue storage.
int	ephemeralSize()	Get number of items currently in ephemeral storage.
void	finish(IQueueMessage<ID,DATA> msg)	Called when finish processing the message to cleanup ephemeral storage.
protected com.rabbitmq.client.Connection	getConnection()
protected com.rabbitmq.client.ConnectionFactory	getConnectionFactory()	Getter for connectionFactory.
protected com.rabbitmq.client.Channel	getConsumerChannel()	Get the Channel dedicated for consuming messages.
Collection<IQueueMessage<ID,DATA>>	getOrphanMessages(long thresholdTimestampMs)	Get all orphan messages (messages that were left in ephemeral storage for a long time).
protected com.rabbitmq.client.Channel	getProducerChannel()	Get the Channel dedicated for sending messages.
String	getQueueName()	Name of RabbitMQ queue to send/receive messages.
String	getUri()	RabbitMQ's connection URI (format amqp://username:password@host:port/virtualHost).
RabbitMqQueue<ID,DATA>	init()	Init method.
int	queueSize()	Get number of items currently in queue storage.
RabbitMqQueue<ID,DATA>	setConnectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory)	Setter for connectionFactory.
protected RabbitMqQueue<ID,DATA>	setConnectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory, boolean setMyOwnConnectionFactory)	Setter for connectionFactory.
RabbitMqQueue<ID,DATA>	setQueueName(String queueName)	Name of RabbitMQ queue to send/receive messages.
RabbitMqQueue<ID,DATA>	setUri(String uri)	RabbitMQ's connection URI (format amqp://username:password@host:port/virtualHost).
IQueueMessage<ID,DATA>	take()	Take a message out of queue.

Methods inherited from class com.github.ddth.queue.impl.AbstractQueue

close, createMessage, createMessage, createMessage, deserialize, deserialize, getMessageFactory, getSerDeser, queue, requeue, requeueSilent, serialize, setMessageFactory, setSerDeser

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_URI

public static final String DEFAULT_URI

See Also:

Constant Field Values

DEFAULT_QUEUE_NAME

public static final String DEFAULT_QUEUE_NAME

See Also:

Constant Field Values

Constructor Detail

RabbitMqQueue

public RabbitMqQueue()

Method Detail

getUri

public String getUri()

RabbitMQ's connection URI (format amqp://username:password@host:port/virtualHost).

Returns:

setUri

public RabbitMqQueue<ID,DATA> setUri(String uri)

RabbitMQ's connection URI (format amqp://username:password@host:port/virtualHost).

Parameters:

uri -

Returns:

getQueueName

public String getQueueName()

Name of RabbitMQ queue to send/receive messages.

Overrides:

getQueueName in class AbstractQueue<ID,DATA>

Returns:

setQueueName

public RabbitMqQueue<ID,DATA> setQueueName(String queueName)

Name of RabbitMQ queue to send/receive messages.

Overrides:

setQueueName in class AbstractQueue<ID,DATA>

Parameters:

queueName -

Returns:

getConnectionFactory

protected com.rabbitmq.client.ConnectionFactory getConnectionFactory()

Getter for connectionFactory.

Returns:

setConnectionFactory

protected RabbitMqQueue<ID,DATA> setConnectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory,
                                                            boolean setMyOwnConnectionFactory)

Setter for connectionFactory.

Parameters:

connectionFactory -

setMyOwnConnectionFactory -

Returns:

Since:

0.7.1

setConnectionFactory

public RabbitMqQueue<ID,DATA> setConnectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory)

Setter for connectionFactory.

Parameters:

connectionFactory -

Returns:

getConnection

protected com.rabbitmq.client.Connection getConnection()
                                                throws IOException,
                                                       TimeoutException

Throws:

IOException

TimeoutException

createChannel

protected com.rabbitmq.client.Channel createChannel()
                                             throws IOException,
                                                    TimeoutException

Throws:

IOException

TimeoutException

getProducerChannel

protected com.rabbitmq.client.Channel getProducerChannel()
                                                  throws IOException,
                                                         TimeoutException

Get the Channel dedicated for sending messages.

Returns:

Throws:

IOException

TimeoutException

getConsumerChannel

protected com.rabbitmq.client.Channel getConsumerChannel()
                                                  throws IOException,
                                                         TimeoutException

Get the Channel dedicated for consuming messages.

Returns:

Throws:

IOException

TimeoutException

buildConnectionFactory

protected com.rabbitmq.client.ConnectionFactory buildConnectionFactory()
                                                                throws KeyManagementException,
                                                                       NoSuchAlgorithmException,
                                                                       URISyntaxException

Returns:

Throws:

URISyntaxException

NoSuchAlgorithmException

KeyManagementException

Since:

0.6.2.6

init

public RabbitMqQueue<ID,DATA> init()
                                  throws Exception

Init method.

Overrides:

init in class AbstractQueue<ID,DATA>

Returns:

Throws:

Exception

destroy

public void destroy()

Destroy method.

Overrides:

destroy in class AbstractQueue<ID,DATA>

closeQuietly

protected void closeQuietly(com.rabbitmq.client.Connection connection)

closeQuietly

protected void closeQuietly(com.rabbitmq.client.Channel channel)

finish

public void finish(IQueueMessage<ID,DATA> msg)

Called when finish processing the message to cleanup ephemeral storage.

Implementation flow:

• Remove message from ephemeral storage.

Note: ephemeral storage implementation is optional, depends on implementation.

doPutToQueue

protected boolean doPutToQueue(IQueueMessage<ID,DATA> msg,
                               AbstractQueue.PutToQueueCase queueCase)

Put a message to the queue storage.

Sub-class implements this method.

queueCase is ignore as we always add new message to RabbitMQ.

Specified by:

doPutToQueue in class AbstractQueue<ID,DATA>

Returns:

take

public IQueueMessage<ID,DATA> take()
                                  throws QueueException.EphemeralIsFull

Take a message out of queue.

Implementation flow:

• Read message from head of queue storage.
• Write message to ephemeral storage.
• Remove message from queue storage.

Note: ephemeral storage implementation is optional, depends on implementation.

Returns:

Throws:

QueueException.EphemeralIsFull - if the ephemeral storage is full

getOrphanMessages

public Collection<IQueueMessage<ID,DATA>> getOrphanMessages(long thresholdTimestampMs)

Get all orphan messages (messages that were left in ephemeral storage for a long time).

Parameters:

thresholdTimestampMs - message is orphan if message's timestampMillis + thresholdTimestampMs < now . Which means getOrphanMessages(10000) will return orphan messages that have stayed in ephemeral storage for more than 10000 milliseconds.

Returns:

null or empty collection if there is no orphan message

queueSize

public int queueSize()

Get number of items currently in queue storage.

Returns:

negative number if queue size can not be queried

ephemeralSize

public int ephemeralSize()

Get number of items currently in ephemeral storage.

Note: ephemeral storage implementation is optional, depends on implementation.

Returns:

negative number if ephemeral size can not be queried