org.masukomi.aspirin.core.store.queue

Interface QueueStore

All Known Implementing Classes:

SimpleQueueStore

public interface QueueStore

Experimental interface to set up Quality of Service features. It could be changed in the next versions.

Author:

Laszlo Solova

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String mailid, long expire, Collection<javax.mail.internet.InternetAddress> recipients)
List<String>	clean() This method is called to clean QueueStore.
QueueInfo	createQueueInfo()
long	getNextAttempt(String mailid, String recipient)
boolean	hasBeenRecipientHandled(String mailid, String recipient)
void	init()
boolean	isCompleted(String mailid)
QueueInfo	next() It gives back the next sendable QueueInfo object.
void	remove(String mailid)
void	removeRecipient(String recipient)
void	setSendingResult(QueueInfo qi)
int	size()

Method Detail

add

void add(String mailid,
       long expire,
       Collection<javax.mail.internet.InternetAddress> recipients)
         throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

clean

List<String> clean()

This method is called to clean QueueStore. In cleaning process the QueueStore have to remove all completed mailid, and after finishing it gives back list of unfinished mailids.

Returns:

List of used mailids.

createQueueInfo

QueueInfo createQueueInfo()

getNextAttempt

long getNextAttempt(String mailid,
                  String recipient)

hasBeenRecipientHandled

boolean hasBeenRecipientHandled(String mailid,
                              String recipient)

init

void init()

isCompleted

boolean isCompleted(String mailid)

next

QueueInfo next()

It gives back the next sendable QueueInfo object. QueueInfo has - the next valid attempt time (attempt before current time and attemptcount is under limit) - valid expiry (expiry is unset or is after current time) - QUEUED status

Returns:

next sendable QueueInfo or null

remove

void remove(String mailid)

removeRecipient

void removeRecipient(String recipient)

setSendingResult

void setSendingResult(QueueInfo qi)

size

int size()