Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addListener(MailQueueListener) - Method in class rs.mail.queue.MailQueue
-
Adds a listener to this queue.
C
- capacity(boolean) - Method in class rs.mail.queue.MailQueue
-
Returns the total capacity of the normal or prioritized queue.
D
- DEFAULT_MAX_PRIORITY_SIZE - Static variable in class rs.mail.queue.MailQueue
-
Default size of the mail queue for priority emails
- DEFAULT_MAX_RETRIES - Static variable in class rs.mail.queue.MailQueue
-
Default number of retries before giving up when sending fails
- DEFAULT_MAX_SIZE - Static variable in class rs.mail.queue.MailQueue
-
Default size of the mail queue for non-priority emails
- DEFAULT_QUEUING_TIMEOUT_SECONDS - Static variable in class rs.mail.queue.MailQueue
-
The default period of time a queuing operation shall wait before giving up.
- DEFAULT_RETRY_PERIOD - Static variable in class rs.mail.queue.MailQueue
-
Default period of time after a failed message will be tried again
F
- failedAttempts - Variable in class rs.mail.queue.MailQueue.MessageEntry
-
Number of failed attempts
G
- getBucketToken() - Method in class rs.mail.queue.MailQueue
-
Tries to consume a token from a bucket.
- getLog() - Method in class rs.mail.queue.MailQueueAdapter
-
Returns the log.
- getMailer() - Method in class rs.mail.queue.SimpleJavaMailSender
-
Returns the mailer.
- getMaxRetries() - Method in class rs.mail.queue.MailQueue
-
Returns the number of retries before giving up when sending fails.
- getNext() - Method in class rs.mail.queue.MailQueue
-
Picks the next message for sending if available.
- getNext(boolean) - Method in class rs.mail.queue.MailQueue
-
Picks the next message from the given queue.
- getRetryPeriod() - Method in class rs.mail.queue.MailQueue
-
Returns the period in milliseconds that has to pass before a failed message will be tried again.
- getSession() - Method in class rs.mail.queue.MessageMailSender
-
Returns the mail session.
- getTokenBucket() - Method in class rs.mail.queue.MailQueue
-
Returns the token bucket.
I
- isPriority - Variable in class rs.mail.queue.MailQueue.MessageEntry
-
Whether it is priority
M
- mailFailed(MailQueue.MessageEntry<T>, String) - Method in class rs.mail.queue.MailQueue
-
Informs listeners that a message failed.
- MailQueue<T> - Class in rs.mail.queue
-
Abstract implementation of the queue that leaves the underlying mailing implemebtation open.
- MailQueue(MailSender<T>) - Constructor for class rs.mail.queue.MailQueue
-
Constructor.
- MailQueue(MailSender<T>, int) - Constructor for class rs.mail.queue.MailQueue
-
Constructor.
- MailQueue(MailSender<T>, int, int) - Constructor for class rs.mail.queue.MailQueue
-
Constructor.
- MailQueue.MessageEntry<X> - Class in rs.mail.queue
-
Helper class to store messages in the queue.
- MailQueueAdapter - Class in rs.mail.queue
-
Default implementation of the
MailQueueListenerinterface. - MailQueueAdapter() - Constructor for class rs.mail.queue.MailQueueAdapter
-
Constructor.
- MailQueueAdapter(Logger) - Constructor for class rs.mail.queue.MailQueueAdapter
-
Constructor.
- mailQueued(MailQueue.MessageEntry<T>) - Method in class rs.mail.queue.MailQueue
-
Informs listeners that a message was queued.
- MailQueueListener - Interface in rs.mail.queue
-
A listener that gets informed about events in a mail queue.
- MailSender<T> - Interface in rs.mail.queue
-
A helper interface that actually will send e-mails.
- mailSending(MailQueue.MessageEntry<T>) - Method in class rs.mail.queue.MailQueue
-
Informs listeners that a message is being sent.
- mailSent(MailQueue.MessageEntry<T>) - Method in class rs.mail.queue.MailQueue
-
Informs listeners that a message was sent successfully.
- message - Variable in class rs.mail.queue.MailQueue.MessageEntry
-
The message itself
- MessageEntry(String, X, boolean) - Constructor for class rs.mail.queue.MailQueue.MessageEntry
-
Constructor.
- MessageMailSender - Class in rs.mail.queue
-
Sends messages for
Messageobjects. - MessageMailSender() - Constructor for class rs.mail.queue.MessageMailSender
-
Constructor from system properties.
- MessageMailSender(Properties) - Constructor for class rs.mail.queue.MessageMailSender
-
Constructor.
- MessageMailSender(Properties, Authenticator) - Constructor for class rs.mail.queue.MessageMailSender
-
Constructor.
- MessageMailSender(Session) - Constructor for class rs.mail.queue.MessageMailSender
-
Constructor.
N
- notBeforeTimeInMillis - Variable in class rs.mail.queue.MailQueue.MessageEntry
-
A timestamp to hold the message
O
- onFailed(String, int, String) - Method in class rs.mail.queue.MailQueueAdapter
-
Informs that a message could not be sent.
- onFailed(String, int, String) - Method in interface rs.mail.queue.MailQueueListener
-
Informs that a message could not be sent.
- onQueued(String) - Method in class rs.mail.queue.MailQueueAdapter
-
Informs that a message was added to the queue.
- onQueued(String) - Method in interface rs.mail.queue.MailQueueListener
-
Informs that a message was added to the queue.
- onSending(String) - Method in class rs.mail.queue.MailQueueAdapter
-
Informs that the message is now being sent.
- onSending(String) - Method in interface rs.mail.queue.MailQueueListener
-
Informs that the message is now being sent.
- onSent(String) - Method in class rs.mail.queue.MailQueueAdapter
-
Informs that a message was sent successfully.
- onSent(String) - Method in interface rs.mail.queue.MailQueueListener
-
Informs that a message was sent successfully.
Q
- queue(MailQueue.MessageEntry<T>, LinkedBlockingDeque<MailQueue.MessageEntry<T>>, long) - Method in class rs.mail.queue.MailQueue
-
Internal queuing implementation - queues the entry in th egiven queue using the given maximum waiting time.
- queue(T, String) - Method in class rs.mail.queue.MailQueue
-
Add the message to the queue for sending with normal priority.
- queue(T, String, boolean) - Method in class rs.mail.queue.MailQueue
-
Add the message to the queue for sending.
- queue(T, String, boolean, int) - Method in class rs.mail.queue.MailQueue
-
Add the message to the queue for sending.
- queue(T, String, boolean, int, long) - Method in class rs.mail.queue.MailQueue
-
Add the message to the queue for sending.
- queue(T, String, boolean, long) - Method in class rs.mail.queue.MailQueue
-
Add the message to the queue for sending.
- queue(T, String, long) - Method in class rs.mail.queue.MailQueue
-
Add the message to the queue for sending with normal priority.
R
- referenceId - Variable in class rs.mail.queue.MailQueue.MessageEntry
-
Reference ID of the message
- remainingCapacity(boolean) - Method in class rs.mail.queue.MailQueue
-
Returns the remaining capacity of the normal or prioritized queue.
- remove(MailQueue.MessageEntry<T>) - Method in class rs.mail.queue.MailQueue
-
Removes the message from the queue
- removeListener(MailQueueListener) - Method in class rs.mail.queue.MailQueue
-
Removes a listener from this queue.
- rs.mail.queue - package rs.mail.queue
-
Implements the mailing queue.
- run() - Method in class rs.mail.queue.MailQueue
-
Process the queue once.
S
- sendMessage(Message, String) - Method in class rs.mail.queue.MessageMailSender
-
Sends the message object.
- sendMessage(Email, String) - Method in class rs.mail.queue.SimpleJavaMailSender
-
Sends the message object.
- sendMessage(T, String) - Method in interface rs.mail.queue.MailSender
-
Sends the message object.
- setMailer(Mailer) - Method in class rs.mail.queue.SimpleJavaMailSender
-
Sets the mailer.
- setMaxRetries(int) - Method in class rs.mail.queue.MailQueue
-
Sets the number of retries before giving up when sending fails.
- setRetryPeriod(long) - Method in class rs.mail.queue.MailQueue
-
Sets the period in milliseconds that has to pass before a failed message will be tried again.
- setTokenBucket(Bucket) - Method in class rs.mail.queue.MailQueue
-
Sets the token bucket.
- SimpleJavaMailSender - Class in rs.mail.queue
-
Sends messages for SimpleJavaMail
Emailobjects. - SimpleJavaMailSender() - Constructor for class rs.mail.queue.SimpleJavaMailSender
-
Constructor.
- SimpleJavaMailSender(Mailer) - Constructor for class rs.mail.queue.SimpleJavaMailSender
-
Constructor.
- size() - Method in class rs.mail.queue.MailQueue
-
Returns the current size of the queue.
- size(boolean) - Method in class rs.mail.queue.MailQueue
-
Returns the current size of the queue for normal or prioritized messages only.
All Classes and Interfaces|All Packages|Constant Field Values