org.apache.james.queue.activemq

Class ActiveMQMailQueue

java.lang.Object

org.apache.james.queue.jms.JMSMailQueue

org.apache.james.queue.activemq.ActiveMQMailQueue

All Implemented Interfaces:

ActiveMQSupport, MailPrioritySupport, MailQueue, ManageableMailQueue, JMSSupport

public class ActiveMQMailQueue
extends JMSMailQueue
implements ActiveMQSupport

MailQueue implementation which use an ActiveMQ Queue.

This implementation require at ActiveMQ 5.4.0+.

When a Mail attribute is found and is not one of the supported primitives, then the toString() method is called on the attribute value to convert it

The implementation use BlobMessage or ObjectMessage, depending on the constructor which was used

See http://activemq.apache .org/blob-messages.html for more details

Some other supported feature is handling of priorities. See:
http://activemq.apache.org/how-can-i-support-priority-queues.html

For this just add a Mail attribute with name MailPrioritySupport.MAIL_PRIORITY to it. It should use one of the following value MailPrioritySupport.LOW_PRIORITY, MailPrioritySupport.NORMAL_PRIORITY, MailPrioritySupport.HIGH_PRIORITY

To have a good throughput you should use a caching connection factory.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.queue.api.ManageableMailQueue

ManageableMailQueue.MailQueueItemView, ManageableMailQueue.MailQueueIterator, ManageableMailQueue.Type

Nested classes/interfaces inherited from interface org.apache.james.queue.api.MailQueue

MailQueue.MailQueueException, MailQueue.MailQueueItem

Field Summary

Fields inherited from class org.apache.james.queue.jms.JMSMailQueue

connectionFactory, FORCE_DELIVERY, logger, queuename

Fields inherited from interface org.apache.james.queue.activemq.ActiveMQSupport

JAMES_BLOB_URL, JAMES_QUEUE_NAME, JAMES_REUSE_BLOB_URL

Fields inherited from interface org.apache.james.queue.jms.JMSSupport

JAMES_MAIL_ATTRIBUTE_NAMES, JAMES_MAIL_ERROR_MESSAGE, JAMES_MAIL_LAST_UPDATED, JAMES_MAIL_MESSAGE_SIZE, JAMES_MAIL_NAME, JAMES_MAIL_RECIPIENTS, JAMES_MAIL_REMOTEADDR, JAMES_MAIL_REMOTEHOST, JAMES_MAIL_SENDER, JAMES_MAIL_SEPARATOR, JAMES_MAIL_STATE, JAMES_NEXT_DELIVERY

Fields inherited from interface org.apache.james.queue.api.MailQueue

NO_DELAY

Fields inherited from interface org.apache.james.queue.api.MailPrioritySupport

HIGH_PRIORITY, LOW_PRIORITY, MAIL_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ActiveMQMailQueue(javax.jms.ConnectionFactory connectionFactory, String queuename, boolean useBlob, org.slf4j.Logger logger) Construct a new ActiveMQ based MailQueue.
ActiveMQMailQueue(javax.jms.ConnectionFactory connectionFactory, String queuename, org.slf4j.Logger logger) Construct a ActiveMQMailQueue which only use BlobMessage

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.jms.Message	copy(javax.jms.Session session, javax.jms.Message m) Create a copy of the given Message.
protected MailQueue.MailQueueItem	createMailQueueItem(javax.jms.Connection connection, javax.jms.Session session, javax.jms.MessageConsumer consumer, javax.jms.Message message) Create a MailQueue.MailQueueItem for the given parameters
protected org.apache.activemq.ActiveMQSession	getAMQSession(javax.jms.Session session) Cast the given Session to an ActiveMQSession
long	getSize() Try to use ActiveMQ StatisticsPlugin to get size and if that fails fallback to JMSMailQueue.getSize()
protected void	populateMailMimeMessage(javax.jms.Message message, org.apache.mailet.Mail mail) Populat the given Mail instance with a MimeMessage.
protected void	produceMail(javax.jms.Session session, Map<String,Object> props, int msgPrio, org.apache.mailet.Mail mail) Produce the mail to the JMS Queue
List<javax.jms.Message>	removeWithSelector(String selector) Remove messages with the given selector

Methods inherited from class org.apache.james.queue.jms.JMSMailQueue

browse, clear, convertAttributeValue, count, createMail, deQueue, enQueue, enQueue, flush, getJMSProperties, getMessageSelector, populateMail, remove, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveMQMailQueue

public ActiveMQMailQueue(javax.jms.ConnectionFactory connectionFactory,
                 String queuename,
                 org.slf4j.Logger logger)

Construct a ActiveMQMailQueue which only use BlobMessage

Throws:

NotCompliantMBeanException

See Also:

ActiveMQMailQueue(ConnectionFactory, String, boolean, Logger)

ActiveMQMailQueue

public ActiveMQMailQueue(javax.jms.ConnectionFactory connectionFactory,
                 String queuename,
                 boolean useBlob,
                 org.slf4j.Logger logger)

Construct a new ActiveMQ based MailQueue.

Parameters:

connectionFactory -

queuename -

useBlob -

logger -

Throws:

NotCompliantMBeanException

Method Detail

populateMailMimeMessage

protected void populateMailMimeMessage(javax.jms.Message message,
                           org.apache.mailet.Mail mail)
                                throws javax.mail.MessagingException,
                                       javax.jms.JMSException

Description copied from class: JMSMailQueue

Populat the given Mail instance with a MimeMessage. The MimeMessage is read from the JMS Message. This implementation use a BytesMessage

Overrides:

populateMailMimeMessage in class JMSMailQueue

Throws:

javax.mail.MessagingException

javax.jms.JMSException

See Also:

JMSMailQueue.populateMailMimeMessage(javax.jms.Message, org.apache.mailet.Mail)

produceMail

protected void produceMail(javax.jms.Session session,
               Map<String,Object> props,
               int msgPrio,
               org.apache.mailet.Mail mail)
                    throws javax.jms.JMSException,
                           javax.mail.MessagingException,
                           IOException

Produce the mail to the JMS Queue

Overrides:

produceMail in class JMSMailQueue

Throws:

javax.jms.JMSException

javax.mail.MessagingException

IOException

getAMQSession

protected org.apache.activemq.ActiveMQSession getAMQSession(javax.jms.Session session)
                                                     throws javax.jms.JMSException

Cast the given Session to an ActiveMQSession

Parameters:

session -

Returns:

amqSession

Throws:

javax.jms.JMSException

createMailQueueItem

protected MailQueue.MailQueueItem createMailQueueItem(javax.jms.Connection connection,
                                          javax.jms.Session session,
                                          javax.jms.MessageConsumer consumer,
                                          javax.jms.Message message)
                                               throws javax.jms.JMSException,
                                                      javax.mail.MessagingException

Description copied from class: JMSMailQueue

Create a MailQueue.MailQueueItem for the given parameters

Overrides:

createMailQueueItem in class JMSMailQueue

Returns:

item

Throws:

javax.jms.JMSException

javax.mail.MessagingException

removeWithSelector

public List<javax.jms.Message> removeWithSelector(String selector)
                                           throws MailQueue.MailQueueException

Description copied from class: JMSMailQueue

Remove messages with the given selector

Overrides:

removeWithSelector in class JMSMailQueue

Returns:

messages

Throws:

MailQueue.MailQueueException

copy

protected javax.jms.Message copy(javax.jms.Session session,
                     javax.jms.Message m)
                          throws javax.jms.JMSException

Description copied from class: JMSMailQueue

Create a copy of the given Message. This includes the properties and the payload

Overrides:

copy in class JMSMailQueue

Returns:

copy

Throws:

javax.jms.JMSException

getSize

public long getSize()
             throws MailQueue.MailQueueException

Try to use ActiveMQ StatisticsPlugin to get size and if that fails fallback to JMSMailQueue.getSize()

Specified by:

getSize in interface ManageableMailQueue

Overrides:

getSize in class JMSMailQueue

Returns:

size

Throws:

MailQueue.MailQueueException

See Also:

ManageableMailQueue.getSize()