com.neurosys.messenger.processors.readers

Class IMAPMailBoxReader

java.lang.Object

com.neurosys.messenger.processors.readers.IMAPMailBoxReader

All Implemented Interfaces:

RealTimeLineReader<javax.mail.Message>, ResourceAwareRealTimeLineReader<javax.mail.Message>

public class IMAPMailBoxReader
extends Object
implements ResourceAwareRealTimeLineReader<javax.mail.Message>

Reads a Mail Box using IMAP protocol

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected String	folderName
protected javax.mail.Folder	mailbox

Constructor Summary

Constructors

Constructor and Description
IMAPMailBoxReader()

Method Summary

Modifier and Type	Method and Description
void	close() Any cleanup
void	dispose() Un-initialize reader, so that it maybe re consumed Except for the main Resource & configuration set by Spring context all other instance variables used will be re-set/disposed/cleared.
protected List<MessagePart<String,String>>	getContentAsString(String type, Object content) Marshal content from an Email (IMAP) to a MessagePart
List<MessagePart<String,String>>	getContentFromMail(javax.mail.Message mail)
Long	getCurrentIndex() Depending on the resource the ResourceAwareRealTimeLineReader.size() may factor in redundant rows also that maybe filtered by the reader if it uses some sort of filter.
String	getFolderName()
String	getHost()
int	getIndex()
Properties	getJavaMailProperties()
javax.mail.Folder	getMailbox()
String	getPassword()
int	getSize()
String	getSourceLocation()
String	getUsername()
boolean	hasNext() True if there is another record that can be read by the parser, false implies end of parse/read
void	init() Allow lazy initialization of Reader in cases where the resource may not be known @ PostConstruct time
boolean	isInitialized() Allow the calling API to determine if the reader has been initialized via RealTimeLineReader.init() or PostConstruct phase If not RealTimeLineReader.init() should be called upon the instance.
javax.mail.Message	next() Read line from Source, on Record construction complete return the Record.
void	setFolderName(String folderName)
void	setHost(String host)
void	setIndex(int index)
void	setJavaMailProperties(Properties javaMailProperties)
void	setMailbox(javax.mail.Folder mailbox)
void	setPassword(String password)
void	setUsername(String username)
Long	size() Get number of tuples/records in resource

Methods inherited from class java.lang.Object

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

Field Detail

folderName

protected String folderName

Default value:

value is inbox

mailbox

protected transient javax.mail.Folder mailbox

Constructor Detail

IMAPMailBoxReader

public IMAPMailBoxReader()

Method Detail

getContentAsString

protected List<MessagePart<String,String>> getContentAsString(String type,
                                                              Object content)
                                                       throws javax.mail.MessagingException,
                                                              IOException

Marshal content from an Email (IMAP) to a MessagePart

Parameters:

type - as String (part details)

content - as String (raw content)

Returns:

MessagePart

Throws:

javax.mail.MessagingException

IOException

getContentFromMail

public List<MessagePart<String,String>> getContentFromMail(javax.mail.Message mail)
                                                    throws javax.mail.MessagingException,
                                                           IOException

Throws:

javax.mail.MessagingException

IOException

next

public javax.mail.Message next()
                        throws javax.mail.MessagingException

Description copied from interface: RealTimeLineReader

Read line from Source, on Record construction complete return the Record.

Specified by:

next in interface RealTimeLineReader<javax.mail.Message>

Returns:

Record

Throws:

javax.mail.MessagingException

hasNext

public boolean hasNext()

Description copied from interface: RealTimeLineReader

True if there is another record that can be read by the parser, false implies end of parse/read

Specified by:

hasNext in interface RealTimeLineReader<javax.mail.Message>

Returns:

boolean

close

public void close()
           throws Exception

Description copied from interface: RealTimeLineReader

Any cleanup

Specified by:

close in interface RealTimeLineReader<javax.mail.Message>

Throws:

Exception

getSourceLocation

public String getSourceLocation()

Specified by:

getSourceLocation in interface RealTimeLineReader<javax.mail.Message>

init

public void init()
          throws Exception

Description copied from interface: RealTimeLineReader

Allow lazy initialization of Reader in cases where the resource may not be known @ PostConstruct time

Specified by:

init in interface RealTimeLineReader<javax.mail.Message>

Throws:

Exception

isInitialized

public boolean isInitialized()
                      throws Exception

Description copied from interface: RealTimeLineReader

Allow the calling API to determine if the reader has been initialized via RealTimeLineReader.init() or PostConstruct phase
If not RealTimeLineReader.init() should be called upon the instance.

Specified by:

isInitialized in interface RealTimeLineReader<javax.mail.Message>

Throws:

Exception

dispose

public void dispose()
             throws Exception

Description copied from interface: RealTimeLineReader

Un-initialize reader, so that it maybe re consumed
Except for the main Resource & configuration set by Spring context all other instance variables used will be re-set/disposed/cleared.

Specified by:

dispose in interface RealTimeLineReader<javax.mail.Message>

Throws:

Exception

size

public Long size()

Description copied from interface: ResourceAwareRealTimeLineReader

Get number of tuples/records in resource

Specified by:

size in interface ResourceAwareRealTimeLineReader<javax.mail.Message>

Returns:

Long

getCurrentIndex

public Long getCurrentIndex()

Description copied from interface: ResourceAwareRealTimeLineReader

Depending on the resource the ResourceAwareRealTimeLineReader.size() may factor in redundant rows also that maybe filtered by the reader if it uses some sort of filter.
This method allows to keep track of the real position, since the calling API may/will not be notified of skipped rows. Numbering starts from 0.

Size and getCurrentIndex reflect on valid rows being processed. But there maybe noise and extra un-processable rows due to which getCurrentIndex() on the last record maybe < what size() gives.
Hence @ the end of your process normalize to 100% when we are sure its done without errors/abort.

Specified by:

getCurrentIndex in interface ResourceAwareRealTimeLineReader<javax.mail.Message>

Returns:

getHost

public String getHost()

setHost

public void setHost(String host)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getFolderName

public String getFolderName()

setFolderName

public void setFolderName(String folderName)

getMailbox

public javax.mail.Folder getMailbox()

setMailbox

public void setMailbox(javax.mail.Folder mailbox)

getIndex

public int getIndex()

setIndex

public void setIndex(int index)

getSize

public int getSize()

getJavaMailProperties

public Properties getJavaMailProperties()

setJavaMailProperties

public void setJavaMailProperties(Properties javaMailProperties)