|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExchangeConnectorInterface
Method Summary | |
---|---|
void |
accept(ExchangeEmailDTO email)
Accept a meeting represented by an email |
void |
addContact(ExchangeContactDTO contact)
|
void |
addEvent(ExchangeEventDTO event)
This method creates an event and send meeting requests to the |
void |
addPublicContact(ExchangeContactDTO contact)
|
void |
addTask(ExchangeTaskDTO task)
|
void |
authenticate()
check authentication (after getting a connection) |
void |
createOrUpdateEmail(ExchangeEmailDTO email)
|
void |
deleteContact(java.lang.String uniqueIdForUrl)
|
void |
deleteEmail(java.lang.String emailUniqueIdForUrl)
|
void |
deleteEvent(java.lang.String uniqueIdForUrl)
|
void |
deleteTask(java.lang.String uniqueIdForUrl)
|
java.util.ArrayList |
getContacts()
Gets all the contacts from a contact folder |
java.lang.String |
getDraftsFolderName()
getting email drafts folder name |
java.lang.String |
getEmailFolderName()
Return the Emails folder used by the connector |
java.util.ArrayList |
getEmails(java.util.Date sinceReceivedDate,
java.util.HashSet fromEmailFilter,
java.util.HashSet toEmailFilter,
int maxEmailsReturned)
|
ExchangeEventDTO |
getEventById(java.lang.String eventId)
|
int |
getEventHandlerType()
possible types: ExchangeConstants.CALENDER_HANDLER_TYPE_REGULAR (default) ExchangeConstants.CALENDER_HANDLER_TYPE_UPDATE_MEETING_REQ |
java.util.ArrayList |
getEvents(java.util.Date startDate,
java.util.Date endDate,
EventSearchCriteria eventSearchCriteria)
get an event list according to search criteria |
java.util.ArrayList |
getEvents(java.util.Date startDate,
java.util.Date endDate,
int maxRows)
get an event list |
java.util.ArrayList |
getFolders(java.lang.String folderUrl)
|
java.lang.String |
getFullTimezonStr4MeetingReq()
this should be the String format: ( example: (GMT+02.00) Israel/Jerusalem Standard Time |
java.util.ArrayList |
getPublicContacts()
|
java.util.ArrayList |
getRootFolders()
Getting all root folders for the account. |
java.util.ArrayList |
getTasks()
|
UserAvailabilityData |
getUserAvailabilityData(java.util.Date startDate,
java.util.Date endDate,
int intervalMins,
ExchangeEventAttendeeDTO attendee)
gets the users calander Availability Data between the startDate and the EndDate with the intervalMins, which determines sample rate. |
boolean |
isGetFullEmailStr()
If True Email Handler set the full email String in the ExchangeEmailDTO Depends on the number of emails returned, this can consume lots of memory. |
boolean |
isSendMeetingAcceptEmail()
Is sending meeting acceptance email |
ExchangeEmailDTO |
parseEmailDTOFromEmailMsgFile(java.lang.String fileUrl)
Parse email saved from Outlook to the file system using this method |
void |
sendEmail(ExchangeEmailDTO email)
sends an email using the information in the ExchangeEmailDTO |
void |
sendMeetingRequest(ExchangeEventDTO exchangeEventDTO)
Send a meetin request to the to person |
void |
sentEmail(java.lang.String emailURL)
|
void |
setAllDayEventTimeShifter(java.lang.String GMTTimeShift)
|
void |
setCalendarFolderName(java.lang.String calendarFolderName)
In case your calendar folder name have a different name then Calendar |
void |
setContactsFolderName(java.lang.String contactsFolderName)
In case your contacts folder name have a different name then Contacts |
void |
setDeletedFolderName(java.lang.String deletedFolderName)
In case your Deleted folder name have a different name then Deleted Items |
void |
setDomain(java.lang.String domain)
|
void |
setDraftsFolderName(java.lang.String draftsFolderName)
setting email drafts folder name, this is needed is exchange is not English |
void |
setEmailFolderName(java.lang.String inboxFolderName)
Setting email folder name, if not set using the default "inbox" |
void |
setEmailHandlerType(int emailHandlerType)
set the Email Handler Type, for advanced use. |
void |
setEventHandlerType(int eventHandlerType)
possible types: ExchangeConstants.CALENDER_HANDLER_TYPE_REGULAR (default) ExchangeConstants.CALENDER_HANDLER_TYPE_UPDATE_MEETING_REQ |
void |
setFbaPath(java.lang.String fbaPath)
set alternate fba path, the default is: /exchweb/bin/auth/owaauth.dll |
void |
setFullTimezonStr4MeetingReq(java.lang.String fullTimezonStr4MeetingReq)
this should be the String format: ( example: (GMT+02.00) Israel/Jerusalem Standard Time |
void |
setGetFullEmailStr(boolean getFullEmailStr)
Does the Email Handler set the full email String in the ExchangeEmailDTO default is false. |
void |
setGetOnlyUnreadEmails(boolean _getOnlyUnreadEmails)
setting this param to true will force the connector to bring only the unread email messages from exchange, the default is false |
void |
setPublicContactsFolderName(java.lang.String folderName)
set the Public Contacts folder name (the default is "Public Contacts") |
void |
setResponseTimeWaitSec(int responseTimeWaitSec)
|
void |
setResponseTimeWaitStepIntervalsMS(int responseTimeWaitStepIntervalsMS)
|
void |
setSendMeetingAcceptEmail(boolean sendMeetingAcceptEmail)
set false to not send meeting acceptance email. |
void |
setSendMeetingReqs(boolean sendMeetingReqs)
setting this to false will cause the CalendarHandler to not sent meeting requests to the Attendees in the ExchangeEventDTO (default is true) |
void |
setSMTPPort(int smtpPort)
Set the smtp port used for sending meeting request for example. |
void |
setTasksFolderName(java.lang.String tasksFolderName)
In case your Tasks folder name have a different name then Tasks |
void |
setUseFba(boolean useFba)
use forms-based-authentication, curretly supported only in emailHandler |
void |
setUseNTLMAuthentication(boolean useNtlm)
set to true if your exchange server supports only NTLM authentication. |
void |
setUserDefinedFields(java.util.ArrayList userDefinedFields)
|
void |
updateContact(ExchangeContactDTO contact)
|
void |
updateEvent(ExchangeEventDTO event)
|
void |
updatePublicContact(ExchangeContactDTO contact)
|
void |
updateTask(ExchangeTaskDTO task)
|
Method Detail |
---|
void addContact(ExchangeContactDTO contact) throws ExchangeGeneralException
contact
- ExchangeContactDTO
ExchangeGeneralException
void addEvent(ExchangeEventDTO event) throws ExchangeGeneralException
event
- ExchangeEventDTO
ExchangeGeneralException
void deleteContact(java.lang.String uniqueIdForUrl) throws ExchangeGeneralException
uniqueIdForUrl
- String
uniqueIdForUrl is the unique identifier of the contact resource.
ExchangeException
ExchangeGeneralException
void accept(ExchangeEmailDTO email) throws ExchangeGeneralException
email
- The email whose meeting you want to accept
ExchangeGeneralException
- elih: remove for jdk1.4 compilencevoid deleteEvent(java.lang.String uniqueIdForUrl) throws ExchangeGeneralException
uniqueIdForUrl
- String
is the unique identifier of the event resource.
ExchangeGeneralException
java.util.ArrayList getContacts() throws ExchangeGeneralException
ExchangeException
ExchangeGeneralException
java.util.ArrayList getEmails(java.util.Date sinceReceivedDate, java.util.HashSet fromEmailFilter, java.util.HashSet toEmailFilter, int maxEmailsReturned) throws ExchangeGeneralException
dateReceived
- DatefromEmailFilter
- HashSet toEmailFilter
- HashMap (the same as above)maxAtATime
- int
ExchangeGeneralException
void deleteEmail(java.lang.String emailUniqueIdForUrl) throws ExchangeGeneralException
emailUniqueIdForUrl
- String
the email message URL postfix (the Name before the .EML)
ExchangeGeneralException
java.util.ArrayList getEvents(java.util.Date startDate, java.util.Date endDate, int maxRows) throws ExchangeGeneralException
startDate
- DateendDate
- DatemaxRows
- int
ExchangeException
ExchangeGeneralException
java.util.ArrayList getEvents(java.util.Date startDate, java.util.Date endDate, EventSearchCriteria eventSearchCriteria) throws ExchangeGeneralException
startDate
- DateendDate
- DatemaxRows
- int
ExchangeException
ExchangeGeneralException
void updateContact(ExchangeContactDTO contact) throws ExchangeGeneralException
contact
- ExchangeContactDTO
ExchangeGeneralException
void updateEvent(ExchangeEventDTO event) throws ExchangeGeneralException
event
- ExchangeEventDTO
ExchangeGeneralException
void setResponseTimeWaitSec(int responseTimeWaitSec)
responseTimeWaitSec
- int
How much time to wait for exchange response (default is 20secs)void setResponseTimeWaitStepIntervalsMS(int responseTimeWaitStepIntervalsMS)
responseTimeWaitStepIntervalsMS
- int
advanced param, recommend not to change.void setCalendarFolderName(java.lang.String calendarFolderName)
calendarFolderName
- void setContactsFolderName(java.lang.String contactsFolderName)
contactsFolderName
- void setEmailFolderName(java.lang.String inboxFolderName)
emailFolderName
- void setDeletedFolderName(java.lang.String deletedFolderName)
deletedFolderName
- Stringvoid setTasksFolderName(java.lang.String tasksFolderName)
tasksFolderName
- Stringvoid authenticate() throws ExchangeGeneralException, AuthenticationException, ConnectException
ExchangeGeneralException
AuthenticationException
ConnectException
java.util.ArrayList getTasks() throws ExchangeGeneralException
ExchangeGeneralException
void updateTask(ExchangeTaskDTO task) throws ExchangeGeneralException
ExchangeGeneralException
void addTask(ExchangeTaskDTO task) throws ExchangeGeneralException
task
- ExchangeTaskDTO
ExchangeGeneralException
java.util.ArrayList getPublicContacts() throws ExchangeGeneralException
ExchangeGeneralException
void setPublicContactsFolderName(java.lang.String folderName)
folderName
- Stringvoid addPublicContact(ExchangeContactDTO contact) throws ExchangeGeneralException
contact
- ExchangeContactDTO
ExchangeGeneralException
- make sure that the account you used to create the connector instance
have permission to do this operation.
void updatePublicContact(ExchangeContactDTO contact) throws ExchangeGeneralException
contact
- ExchangeContactDTO
ExchangeGeneralException
- make sure that the account you used to create the connector instance
have permission to do this operation.
void setAllDayEventTimeShifter(java.lang.String GMTTimeShift)
ExchangeEventDTO getEventById(java.lang.String eventId) throws ExchangeGeneralException
eventId
- String
This is a URL based id.
ExchangeGeneralException
void setDomain(java.lang.String domain)
void setUseFba(boolean useFba)
useFba
- booleanvoid setFbaPath(java.lang.String fbaPath)
fbaPath
- Stringvoid setGetOnlyUnreadEmails(boolean _getOnlyUnreadEmails)
_getOnlyUnreadEmails
- booleanUserAvailabilityData getUserAvailabilityData(java.util.Date startDate, java.util.Date endDate, int intervalMins, ExchangeEventAttendeeDTO attendee) throws ExchangeGeneralException
startDate
- DateendDate
- DateintervalMins
- intattendee
- ExchangeEventAttendeeTDO
ExchangeGeneralException
void sendMeetingRequest(ExchangeEventDTO exchangeEventDTO) throws ExchangeGeneralException
exchangeEventDTO
- fill in the details of the meeting here
ExchangeGeneralException
void setSMTPPort(int smtpPort)
smtpPort
- smtp port of exchange server in order to send for example meeting request.void createOrUpdateEmail(ExchangeEmailDTO email) throws ExchangeGeneralException
email
- ExchangeEmailDTO
ExchangeGeneralException
- use the setEmailFolderName for spesifing the email foldervoid sentEmail(java.lang.String emailURL) throws ExchangeGeneralException
emailURL
- String
ExchangeGeneralException
- send an email that already exist in exchangejava.lang.String getEmailFolderName()
void sendEmail(ExchangeEmailDTO email) throws ExchangeGeneralException
email
- ExchangeEmailDTO
ExchangeGeneralException
void deleteTask(java.lang.String uniqueIdForUrl) throws ExchangeGeneralException
uniqueIdForUrl
- String
the task unique ID, this is the task name in the URL (without the EML end)
ExchangeGeneralException
int getEventHandlerType()
void setEventHandlerType(int eventHandlerType)
eventHandlerType
- intvoid setSendMeetingReqs(boolean sendMeetingReqs)
sendMeetingReqs
- booleanvoid setGetFullEmailStr(boolean getFullEmailStr)
getFullEmailStr
- booleanboolean isGetFullEmailStr()
boolean isSendMeetingAcceptEmail()
void setSendMeetingAcceptEmail(boolean sendMeetingAcceptEmail)
sendMeetingAcceptEmail
- booleanvoid setFullTimezonStr4MeetingReq(java.lang.String fullTimezonStr4MeetingReq)
fullTimezonStr4MeetingReq
- Stringjava.lang.String getFullTimezonStr4MeetingReq()
java.lang.String getDraftsFolderName()
void setDraftsFolderName(java.lang.String draftsFolderName)
draftsFolderName
- Stringjava.util.ArrayList getRootFolders() throws ExchangeGeneralException
ExchangeGeneralException
java.util.ArrayList getFolders(java.lang.String folderUrl) throws ExchangeGeneralException
folderUrl
-
ExchangeGeneralException
void setUseNTLMAuthentication(boolean useNtlm)
useNtlm
- booleanvoid setEmailHandlerType(int emailHandlerType)
emailHandlerType
- intvoid setUserDefinedFields(java.util.ArrayList userDefinedFields)
userDefinedFields
- ArrayList of user defined fields names as Strings.ExchangeEmailDTO parseEmailDTOFromEmailMsgFile(java.lang.String fileUrl) throws ExchangeGeneralException
fileUrl
- URL to the email.msg file
ExchangeGeneralException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |