com.funambol.email.items.dao
Class EntityDAO

java.lang.Object
  com.funambol.email.items.dao.EntityDAO

Direct Known Subclasses:

ImapEntityDAO, PopEntityDAO

public class EntityDAO
extends java.lang.Object

This class implements methods to access data in Mail Server datastore.

Field Summary

protected java.lang.String	jndiDataSourceName
protected com.funambol.framework.logging.FunambolLogger	log
protected java.lang.String	serverType

Constructor Summary

EntityDAO()

EntityDAO(java.lang.String jndiDataSourceName, java.lang.String serverType)

Method Summary

void	addCustomFolderInDB(com.sun.mail.imap.IMAPFolder folder, java.lang.String defFullpath, com.funambol.server.tools.id.DBIDGenerator idFolderSpace, java.lang.String source_uri, long principalId) insert a custom folder
void	addDefaultFolderInDB(java.lang.String GUID, java.lang.String parentId, java.lang.String fullPath, java.lang.String source_uri, long principalId) This method inserts one of the default folders if needed
void	addDefaultFolderInMailServer(CommonMailServerWrapper cmsw, java.lang.String folderName) This method inserts the folder in the MailServer
void	addEmailInDB(SyncItemInfo syncItemInfo, java.lang.String username, java.lang.String protocol) add the item in the local fnbl_email_inbox
void	addItemInServerItems(SyncItemInfo syncItemInfo, java.util.LinkedHashMap serverItems) add the item in the server items map
void	checkMessageIDforDrafts(com.sun.mail.imap.IMAPFolder f, CommonMailServerWrapper cmsw)
java.util.LinkedHashMap	getAllEmailsInbox(java.lang.String username, java.lang.String protocol)
javax.mail.Folder	getDefaultFolder(IMailServerWrapper msw, java.lang.String fullpath) check if the Folder is in the mail server
ItemFolder	getFolderFromUID(java.lang.String GUID, java.lang.String source_uri, long principalId) serch a folder using the GUID in the local DB
java.lang.String	getFullPathFromFID(java.lang.String FID, java.lang.String source_uri, long principalId) gets the folder fullpath from the local DB In the local db the GUID is composed by: parentId + separator + objectId This method look up the item with the GUID = '%/FID'
java.lang.String	getFullPathFromGUID(java.lang.String GUID, java.lang.String source_uri, long principalId) gets the folder fullpath from the local DB
java.lang.String	getGUIDFromFullPath(java.lang.String fullpath, java.lang.String source_uri, long principalId) gets the Folder id from the local DB
java.lang.String	insertFolder(java.lang.String fullPath, java.lang.String parentId, com.funambol.server.tools.id.DBIDGenerator idFolderSpace, java.lang.String source_uri, long principalId)
void	insertInvalidItemInCache(java.lang.String GUID, java.lang.String messageId, java.util.Date headerDate, java.util.Date received, java.lang.String subject, java.lang.String sender, java.lang.String isEmail, java.lang.String source_uri, long principalId) This method inserts one of the default folders if needed
void	insertInvalidItemInCache(java.lang.String GUID, java.lang.String source_uri, long principalId) This method inserts one of the default folders if needed
void	removeEmailInDB(java.lang.String username, java.lang.String protocol, java.lang.String GUID) remove the item in the local fnbl_email_inbox
void	removeFolderInDB(java.lang.String GUID, java.lang.String source_uri, long principalId) remove folder in the local fnbl_email_folder
void	removeItemInServerItems(java.lang.String GUID, java.util.LinkedHashMap serverItems) remove the item in the server items map
void	setDeletedEmailInInbox(java.lang.String username, java.lang.String protocol, java.lang.String GUID)
void	updateCRCInDB(long crc, java.lang.String username, java.lang.String protocol, java.lang.String GUID) This method update the CRC for an email in the fnbl_email_inbox
void	updateCRCInServerItems(long crc, java.lang.String GUID, java.util.LinkedHashMap serverItems) update the item in the server items map
void	updateItemInServerItems(SyncItemInfo syncItemInfo, java.lang.String GUID, java.util.LinkedHashMap serverItems) update the item in the server items map

Methods inherited from class java.lang.Object

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

Field Detail

log

protected com.funambol.framework.logging.FunambolLogger log

jndiDataSourceName

protected java.lang.String jndiDataSourceName

serverType

protected java.lang.String serverType

Constructor Detail

EntityDAO

public EntityDAO()

EntityDAO

public EntityDAO(java.lang.String jndiDataSourceName,
                 java.lang.String serverType)

Parameters:

jndiDataSourceName - String

Method Detail

addCustomFolderInDB

public void addCustomFolderInDB(com.sun.mail.imap.IMAPFolder folder,
                                java.lang.String defFullpath,
                                com.funambol.server.tools.id.DBIDGenerator idFolderSpace,
                                java.lang.String source_uri,
                                long principalId)
                         throws EntityException

insert a custom folder

Parameters:

folder - IMAPFolder

defFullpath - String

idFolderSpace - IdSpaceGenerator

source_uri - String

principalId - long

Throws:

EntityException

getFullPathFromGUID

public java.lang.String getFullPathFromGUID(java.lang.String GUID,
                                            java.lang.String source_uri,
                                            long principalId)
                                     throws EntityException

gets the folder fullpath from the local DB

Parameters:

GUID - folder id

source_uri - String

principalId - long

Returns:

String

Throws:

EntityException

getFullPathFromFID

public java.lang.String getFullPathFromFID(java.lang.String FID,
                                           java.lang.String source_uri,
                                           long principalId)
                                    throws EntityException

gets the folder fullpath from the local DB In the local db the GUID is composed by: parentId + separator + objectId This method look up the item with the GUID = '%/FID'

Parameters:

FID - folder id

source_uri - String

principalId - long

Returns:

String

Throws:

EntityException

getGUIDFromFullPath

public java.lang.String getGUIDFromFullPath(java.lang.String fullpath,
                                            java.lang.String source_uri,
                                            long principalId)
                                     throws EntityException

gets the Folder id from the local DB

Parameters:

fullpath - folder full path

source_uri - String

principalId - long

Returns:

String

Throws:

EntityException

addDefaultFolderInMailServer

public void addDefaultFolderInMailServer(CommonMailServerWrapper cmsw,
                                         java.lang.String folderName)
                                  throws EntityException

This method inserts the folder in the MailServer

Parameters:

cmsw - CommonMailServerWrapper

folderName - String

Throws:

EntityException

getFolderFromUID

public ItemFolder getFolderFromUID(java.lang.String GUID,
                                   java.lang.String source_uri,
                                   long principalId)
                            throws EntityException

serch a folder using the GUID in the local DB

Parameters:

GUID - folder id

source_uri - String

principalId - long

Returns:

ItemFolder

Throws:

EntityException

checkMessageIDforDrafts

public void checkMessageIDforDrafts(com.sun.mail.imap.IMAPFolder f,
                                    CommonMailServerWrapper cmsw)
                             throws EntityException

Parameters:

f - IMAPFolder

cmsw - CommonMailServerWrapper

Throws:

EntityException

insertFolder

public java.lang.String insertFolder(java.lang.String fullPath,
                                     java.lang.String parentId,
                                     com.funambol.server.tools.id.DBIDGenerator idFolderSpace,
                                     java.lang.String source_uri,
                                     long principalId)
                              throws EntityException

Parameters:

fullPath - folder full path

parentId - parent folder id

idFolderSpace - IdSpaceGenerator

source_uri - String

principalId - long

Returns:

String

Throws:

EntityException

getDefaultFolder

public javax.mail.Folder getDefaultFolder(IMailServerWrapper msw,
                                          java.lang.String fullpath)
                                   throws EntityException

check if the Folder is in the mail server

Parameters:

msw - - IMailServerWrapper .

fullpath - - String .

Returns:

true if the folder is in the Mail Server - boolean.

Throws:

EntityException

removeFolderInDB

public void removeFolderInDB(java.lang.String GUID,
                             java.lang.String source_uri,
                             long principalId)
                      throws EntityException

remove folder in the local fnbl_email_folder

Parameters:

GUID - String

source_uri - String

principalId - long

Throws:

EntityException

getAllEmailsInbox

public java.util.LinkedHashMap getAllEmailsInbox(java.lang.String username,
                                                 java.lang.String protocol)
                                          throws EntityException

Parameters:

username - String

Returns:

The Items Collection with all info

Throws:

EntityException

removeEmailInDB

public void removeEmailInDB(java.lang.String username,
                            java.lang.String protocol,
                            java.lang.String GUID)
                     throws EntityException

remove the item in the local fnbl_email_inbox

Parameters:

username - String

protocol - String

GUID - String

Throws:

EntityException

addEmailInDB

public void addEmailInDB(SyncItemInfo syncItemInfo,
                         java.lang.String username,
                         java.lang.String protocol)
                  throws EntityException

add the item in the local fnbl_email_inbox

Parameters:

username - String

protocol - String

GUID - String

Throws:

EntityException

setDeletedEmailInInbox

public void setDeletedEmailInInbox(java.lang.String username,
                                   java.lang.String protocol,
                                   java.lang.String GUID)
                            throws EntityException

Parameters:

username - String

protocol - String

GUID - String

Throws:

EntityException

removeItemInServerItems

public void removeItemInServerItems(java.lang.String GUID,
                                    java.util.LinkedHashMap serverItems)
                             throws EntityException

remove the item in the server items map

Parameters:

GUID - String

serverItems - all info in CrcSyncItemInfo

Throws:

EntityException

updateItemInServerItems

public void updateItemInServerItems(SyncItemInfo syncItemInfo,
                                    java.lang.String GUID,
                                    java.util.LinkedHashMap serverItems)
                             throws EntityException

update the item in the server items map

Parameters:

GUID - String

serverItems - all info in CrcSyncItemInfo

Throws:

EntityException

updateCRCInServerItems

public void updateCRCInServerItems(long crc,
                                   java.lang.String GUID,
                                   java.util.LinkedHashMap serverItems)
                            throws EntityException

update the item in the server items map

Parameters:

GUID - String

serverItems - all info in CrcSyncItemInfo

Throws:

EntityException

addItemInServerItems

public void addItemInServerItems(SyncItemInfo syncItemInfo,
                                 java.util.LinkedHashMap serverItems)
                          throws EntityException

add the item in the server items map

Parameters:

syncItemInfo - SyncItemInfo

serverItems - all info in the mail server

Throws:

EntityException

addDefaultFolderInDB

public void addDefaultFolderInDB(java.lang.String GUID,
                                 java.lang.String parentId,
                                 java.lang.String fullPath,
                                 java.lang.String source_uri,
                                 long principalId)
                          throws EntityException

This method inserts one of the default folders if needed

Parameters:

GUID - String

parentId - String

fullPath - String

source_uri - String

principalId - long

Throws:

EntityException

updateCRCInDB

public void updateCRCInDB(long crc,
                          java.lang.String username,
                          java.lang.String protocol,
                          java.lang.String GUID)
                   throws EntityException

This method update the CRC for an email in the fnbl_email_inbox

Parameters:

new - crc long

username - String

protocol - String

guid - String

Throws:

EntityException

insertInvalidItemInCache

public void insertInvalidItemInCache(java.lang.String GUID,
                                     java.lang.String messageId,
                                     java.util.Date headerDate,
                                     java.util.Date received,
                                     java.lang.String subject,
                                     java.lang.String sender,
                                     java.lang.String isEmail,
                                     java.lang.String source_uri,
                                     long principalId)
                              throws EntityException

This method inserts one of the default folders if needed

Parameters:

GUID - String

source_uri - String

principalId - long

Throws:

EntityException

insertInvalidItemInCache

public void insertInvalidItemInCache(java.lang.String GUID,
                                     java.lang.String source_uri,
                                     long principalId)
                              throws EntityException

This method inserts one of the default folders if needed

Parameters:

GUID - String

source_uri - String

principalId - long

Throws:

EntityException