Package com.scalagent.joram.mom.dest.mail

Class MailAcquisition

java.lang.Object

com.scalagent.joram.mom.dest.mail.MailAcquisition

All Implemented Interfaces:

AcquisitionHandler

public class MailAcquisition
extends Object
implements AcquisitionHandler

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	DEBUG
private boolean	expunge
private Folder	folder
private static Logger	logger
(package private) boolean	persistent
private String	popPassword
private String	popServer
private String	popUser
private Store	store

Constructor Summary

Constructors

Constructor	Description
MailAcquisition()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this handler and releases any system resources associated to it.
void	closeFolder(List msgs, boolean expunge)
private String	getBody(Message message)
Message[]	popMail(String popServer, String popUser, String popPassword, boolean expunge)
void	retrieve(ReliableTransmitter transmitter)	Retrieves one or more message from an external source (e-mail, ftp, ...).
void	setProperties(Properties properties)	Configures the handler with the given properties.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

DEBUG

private static final boolean DEBUG

popServer

private String popServer

popUser

private String popUser

popPassword

private String popPassword

expunge

private boolean expunge

store

private Store store

folder

private Folder folder

persistent

boolean persistent

Constructor Detail

MailAcquisition

public MailAcquisition()

Method Detail

retrieve

public void retrieve(ReliableTransmitter transmitter)
              throws Exception

Description copied from interface: AcquisitionHandler

Retrieves one or more message from an external source (e-mail, ftp, ...). Message properties such as priority, expiration or persistence will be set afterwards by the AcquisitionModule.

If the external source is reliable, acknowledgment can be done safely after transmitting the message using the transmitter.

Specified by:

retrieve in interface AcquisitionHandler

Parameters:

transmitter - a transmitter used to transmit retrieved messages to the MOM reliably.

Throws:

Exception

popMail

public Message[] popMail(String popServer,
                         String popUser,
                         String popPassword,
                         boolean expunge)

closeFolder

public void closeFolder(List msgs,
                        boolean expunge)

setProperties

public void setProperties(Properties properties)

Description copied from interface: AcquisitionHandler

Configures the handler with the given properties. This method is called one time before the first call to retrieve and then when the acquisition destination receives a configuration message.

Specified by:

setProperties in interface AcquisitionHandler

Parameters:

properties - The new set of properties.

getBody

private String getBody(Message message)
                throws Exception,
                       MessagingException

Throws:

Exception

MessagingException

close

public void close()

Description copied from interface: AcquisitionHandler

Closes this handler and releases any system resources associated to it. There will be no subsequent call to this handler after it has been closed.

Specified by:

close in interface AcquisitionHandler