com.compoze.exchange
Interface IServerProtocol

All Known Implementing Classes:

AbstractServerProtocol

public interface IServerProtocol

Classes that implement this interface provide access to Exchange via some protocol. One instance of a class that implements this interface is created for every session. Its openSession method is the first one that's called, and closeSession is called when the session is to be closed.

Method Summary

int	addAttachment(java.lang.String sMessageID, java.lang.String sFolderID, int iType, java.lang.String sName, java.lang.String sSource, int iPosition, javax.activation.DataHandler dh) Adds an attachment.
void	closeSession() Closes a session.
void	copyFolders(java.lang.String[] srcFolderIDs, java.lang.String sFolderID, java.lang.String sNewName, boolean bRecursive) Copies the folder to another folder.
void	copyMessages(java.lang.String[] messageIDs, java.lang.String sFolderID, java.lang.String sTargetFolderID) Copies messages.
java.lang.String[]	createFolder(java.lang.String sFolderID, java.lang.String sName, java.lang.String[] values, java.lang.String[] keys) Adds a folder.
java.lang.String	createMessage(java.lang.String sFolderID, java.lang.String[] messageProps, java.lang.String[] recipients, java.lang.String sRecurrencePattern, boolean bSend, boolean bSaveInSent) Creates a message.
void	createNotification(java.lang.String sSessionID, java.lang.String sFolderID, boolean bSubFolders, int iTypes) Creates a notification for for a session.
java.lang.String	createTaskRequest(java.lang.String sFolderID, java.lang.String sTaskID, java.lang.String[] messageProps, java.lang.String[] recipients, boolean bSend, boolean bSaveInSent) Creates a task request.
void	deleteAttachment(java.lang.String sMessageID, java.lang.String sFolderID, int iIndex) Deletes an attachment.
void	deleteFolders(java.lang.String[] folderIDs, boolean bDeletedItems) Deletes a folder.
void	deleteMessages(java.lang.String[] messageIDs, java.lang.String sFolderID, boolean bDeletedItems, boolean bDeleteSeries) Deletes messages.
java.lang.String	endTrace() Ends tracing calls to the server and returns a string showing all calls that were made since tracing was started.
java.lang.String[]	forwardMessage(java.lang.String sMessageID, java.lang.String sFolderID, java.lang.String[] propVals, java.lang.String[] propIDs, boolean bCopyRichText, boolean bSeries) Forwards a message.
java.lang.String[]	getAddressEntries(java.lang.String[] entryIDs, int iStartIndex, int iEndIndex, java.lang.String[] sortProps, java.lang.String[] filterProps, java.lang.String[] keys, boolean bOr, boolean bNot, java.util.TimeZone tz, java.util.Date freeBusyStart, java.util.Date freeBusyEnd, int iFreeBusyInterval) Gets address entries.
int	getAddressEntriesCount(java.lang.String[] filterProps, boolean bOr, boolean bNot) Gets address entries count.
java.lang.String[]	getAppointments(java.lang.String sFolderID, java.lang.String[] apptIDs, java.util.TimeZone tz, java.util.Date startTime, java.util.Date endTime, boolean bRecurringInstances, java.lang.String[] apptProps, boolean bHidden) Gets appointments.
javax.activation.DataHandler	getAttachment(java.lang.String sMessageID, java.lang.String sFolderID, int iEmbeddedIndex, int iAttachmentIndex) Gets an attachment.
java.lang.String[]	getAttachments(java.lang.String sMessageID, java.lang.String sFolderID, java.lang.String[] attachmentProps) Gets attachment info.
java.lang.String[]	getEmbeddedMessage(java.lang.String sMessageID, java.lang.String sFolderID, java.lang.String[] messageProps, int iIndex) Gets an embedded message.
java.lang.String	getExchangeServer() Gets the Exchange server for the session.
java.lang.String[]	getFolderProperties(java.lang.String[] folderIDs, java.lang.String[] props) Gets the properties of a number of folders.
java.lang.String[]	getFolders(java.lang.String[] folderIDs, int iDepth, java.lang.String[] props, java.lang.String[] expandedFolderIds, java.lang.String[] folderTypes) Gets folders.
java.lang.String	getID() Gets a unique ID for the session (only unique to the server the session is connected to).
java.lang.String	getMailbox() Gets the Exchange mailbox for the session.
int	getMessageCount(java.lang.String sFolderID, int iDepth, java.lang.String[] filterProps, boolean bOr, boolean bNot, boolean bHidden) Gets message count.
java.lang.String[]	getMessages(java.lang.String sFolderID, java.lang.String[] messageIDs, int iStartIndex, int iEndIndex, int iDepth, java.lang.String[] messageProps, java.lang.String[] sortProps, java.lang.String[] filterProps, boolean bOr, boolean bNot, boolean bHidden) Gets messages.
java.lang.String[]	getServerProperties(java.lang.String sSessionID, java.lang.String[] serviceProps) Gets server properties.
java.lang.String[]	getSessionOptions(java.lang.String[] optionTypes) Gets session options.
java.lang.String	getUserDomain() Gets the user domain for the session.
java.lang.String	getUserUsername() Gets the user username for the session.
void	moveFolders(java.lang.String[] srcFolderIDs, java.lang.String sFolderID) Moves the folder to another folder.
void	moveMessages(java.lang.String[] messageIDs, java.lang.String sFolderID, java.lang.String sTargetFolderID) Moves messages.
java.lang.String	openSession(java.util.Properties connectionProps) Opens a session.
void	removeNotification(java.lang.String sSessionID, java.lang.String sFolderID) Removes a notification for a session.
java.lang.String[]	replyToMessage(java.lang.String sMessageID, java.lang.String sFolderID, java.lang.String[] propVals, java.lang.String[] propIDs, boolean bReplyAll) Replies to a message.
java.lang.String[]	resolveRecipients(java.lang.String sMessageID, boolean bRemove, boolean bSeries) Resolves recipients on a message.
boolean	setLicense(java.lang.String sCompanyName, java.lang.String sDigest) Sets the service license.
void	setSessionOptions(java.lang.String[] optionValues) Sets session options.
void	startTrace(boolean bVerbose) Starts tracing calls to the server.
void	updateFolders(java.lang.String[] folderIDs, java.lang.String[] values) Updates properties in a number of folders.
void	updateMessages(java.lang.String[] messageIDs, java.lang.String sFolderID, java.lang.String[] propVals, java.lang.String[] recipients, int[] deleteRecipients, java.lang.String sRecurrencePattern, int iResponseType, boolean bSeries, boolean bSend, boolean bSaveInSent, boolean bDelete) Updates messages.
boolean	updateTaskFromRequest(java.lang.String sFolderID, java.lang.String sTaskRequestID) Updates a linked task from a task request.

Method Detail

setLicense

public boolean setLicense(java.lang.String sCompanyName,
                          java.lang.String sDigest)
                   throws ExchangeException

Sets the service license.

Parameters:

sCompanyName - the company name (licensee)

sDigest - the five fives license digest

Returns:

true if the license has been set successfully, false if it is not valid (any existing license on the service would not be updated in this case)

Throws:

ExchangeException - if a problem occurred while opening the session

openSession

public java.lang.String openSession(java.util.Properties connectionProps)
                             throws ExchangeException

Opens a session.

Parameters:

connectionProps - the connection properties

Throws:

ExchangeException - if a problem occurred while opening the session

startTrace

public void startTrace(boolean bVerbose)

Starts tracing calls to the server.

Parameters:

bVerbose - if true, trace data sent and received, otherwise just trace elapsed time and number of requests

endTrace

public java.lang.String endTrace()

Ends tracing calls to the server and returns a string showing all calls that were made since tracing was started.

Returns:

a string representing the results of the trace

getID

public java.lang.String getID()

Gets a unique ID for the session (only unique to the server the session is connected to).

Returns:

the ID

getMailbox

public java.lang.String getMailbox()

Gets the Exchange mailbox for the session.

Returns:

the mailbox

getExchangeServer

public java.lang.String getExchangeServer()

Gets the Exchange server for the session.

Returns:

the Exchange server

getUserDomain

public java.lang.String getUserDomain()

Gets the user domain for the session.

Returns:

the domain

getUserUsername

public java.lang.String getUserUsername()

Gets the user username for the session.

Returns:

the username

closeSession

public void closeSession()
                  throws ExchangeException

Closes a session.

Throws:

ExchangeException - if a problem occurred while closing the session

getFolders

public java.lang.String[] getFolders(java.lang.String[] folderIDs,
                                     int iDepth,
                                     java.lang.String[] props,
                                     java.lang.String[] expandedFolderIds,
                                     java.lang.String[] folderTypes)
                              throws ExchangeException

Gets folders.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with the Compoze Microsoft Exchange Service

createFolder

public java.lang.String[] createFolder(java.lang.String sFolderID,
                                       java.lang.String sName,
                                       java.lang.String[] values,
                                       java.lang.String[] keys)
                                throws ExchangeException

Adds a folder.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with the Compoze Microsoft Exchange Service

deleteFolders

public void deleteFolders(java.lang.String[] folderIDs,
                          boolean bDeletedItems)
                   throws ExchangeException

Deletes a folder.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with the Compoze Microsoft Exchange Service

copyFolders

public void copyFolders(java.lang.String[] srcFolderIDs,
                        java.lang.String sFolderID,
                        java.lang.String sNewName,
                        boolean bRecursive)
                 throws ExchangeException

Copies the folder to another folder.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with the Compoze Microsoft Exchange Service

moveFolders

public void moveFolders(java.lang.String[] srcFolderIDs,
                        java.lang.String sFolderID)
                 throws ExchangeException

Moves the folder to another folder.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with the Compoze Microsoft Exchange Service

updateFolders

public void updateFolders(java.lang.String[] folderIDs,
                          java.lang.String[] values)
                   throws ExchangeException

Updates properties in a number of folders.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with the Compoze Microsoft Exchange Service

getFolderProperties

public java.lang.String[] getFolderProperties(java.lang.String[] folderIDs,
                                              java.lang.String[] props)
                                       throws ExchangeException

Gets the properties of a number of folders.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with the Compoze Microsoft Exchange Service

getMessages

public java.lang.String[] getMessages(java.lang.String sFolderID,
                                      java.lang.String[] messageIDs,
                                      int iStartIndex,
                                      int iEndIndex,
                                      int iDepth,
                                      java.lang.String[] messageProps,
                                      java.lang.String[] sortProps,
                                      java.lang.String[] filterProps,
                                      boolean bOr,
                                      boolean bNot,
                                      boolean bHidden)
                               throws ExchangeException

Gets messages.

getAddressEntries

public java.lang.String[] getAddressEntries(java.lang.String[] entryIDs,
                                            int iStartIndex,
                                            int iEndIndex,
                                            java.lang.String[] sortProps,
                                            java.lang.String[] filterProps,
                                            java.lang.String[] keys,
                                            boolean bOr,
                                            boolean bNot,
                                            java.util.TimeZone tz,
                                            java.util.Date freeBusyStart,
                                            java.util.Date freeBusyEnd,
                                            int iFreeBusyInterval)
                                     throws ExchangeException

Gets address entries.

getAddressEntriesCount

public int getAddressEntriesCount(java.lang.String[] filterProps,
                                  boolean bOr,
                                  boolean bNot)
                           throws ExchangeException

Gets address entries count.

getAppointments

public java.lang.String[] getAppointments(java.lang.String sFolderID,
                                          java.lang.String[] apptIDs,
                                          java.util.TimeZone tz,
                                          java.util.Date startTime,
                                          java.util.Date endTime,
                                          boolean bRecurringInstances,
                                          java.lang.String[] apptProps,
                                          boolean bHidden)
                                   throws ExchangeException

Gets appointments.

getMessageCount

public int getMessageCount(java.lang.String sFolderID,
                           int iDepth,
                           java.lang.String[] filterProps,
                           boolean bOr,
                           boolean bNot,
                           boolean bHidden)
                    throws ExchangeException

Gets message count.

createMessage

public java.lang.String createMessage(java.lang.String sFolderID,
                                      java.lang.String[] messageProps,
                                      java.lang.String[] recipients,
                                      java.lang.String sRecurrencePattern,
                                      boolean bSend,
                                      boolean bSaveInSent)
                               throws ExchangeException

Creates a message.

createTaskRequest

public java.lang.String createTaskRequest(java.lang.String sFolderID,
                                          java.lang.String sTaskID,
                                          java.lang.String[] messageProps,
                                          java.lang.String[] recipients,
                                          boolean bSend,
                                          boolean bSaveInSent)
                                   throws ExchangeException

Creates a task request.

updateTaskFromRequest

public boolean updateTaskFromRequest(java.lang.String sFolderID,
                                     java.lang.String sTaskRequestID)
                              throws ExchangeException

Updates a linked task from a task request.

updateMessages

public void updateMessages(java.lang.String[] messageIDs,
                           java.lang.String sFolderID,
                           java.lang.String[] propVals,
                           java.lang.String[] recipients,
                           int[] deleteRecipients,
                           java.lang.String sRecurrencePattern,
                           int iResponseType,
                           boolean bSeries,
                           boolean bSend,
                           boolean bSaveInSent,
                           boolean bDelete)
                    throws ExchangeException

Updates messages.

deleteMessages

public void deleteMessages(java.lang.String[] messageIDs,
                           java.lang.String sFolderID,
                           boolean bDeletedItems,
                           boolean bDeleteSeries)
                    throws ExchangeException

Deletes messages.

forwardMessage

public java.lang.String[] forwardMessage(java.lang.String sMessageID,
                                         java.lang.String sFolderID,
                                         java.lang.String[] propVals,
                                         java.lang.String[] propIDs,
                                         boolean bCopyRichText,
                                         boolean bSeries)
                                  throws ExchangeException

Forwards a message.

replyToMessage

public java.lang.String[] replyToMessage(java.lang.String sMessageID,
                                         java.lang.String sFolderID,
                                         java.lang.String[] propVals,
                                         java.lang.String[] propIDs,
                                         boolean bReplyAll)
                                  throws ExchangeException

Replies to a message.

copyMessages

public void copyMessages(java.lang.String[] messageIDs,
                         java.lang.String sFolderID,
                         java.lang.String sTargetFolderID)
                  throws ExchangeException

Copies messages.

moveMessages

public void moveMessages(java.lang.String[] messageIDs,
                         java.lang.String sFolderID,
                         java.lang.String sTargetFolderID)
                  throws ExchangeException

Moves messages.

getEmbeddedMessage

public java.lang.String[] getEmbeddedMessage(java.lang.String sMessageID,
                                             java.lang.String sFolderID,
                                             java.lang.String[] messageProps,
                                             int iIndex)
                                      throws ExchangeException

Gets an embedded message.

getAttachments

public java.lang.String[] getAttachments(java.lang.String sMessageID,
                                         java.lang.String sFolderID,
                                         java.lang.String[] attachmentProps)
                                  throws ExchangeException

Gets attachment info.

getAttachment

public javax.activation.DataHandler getAttachment(java.lang.String sMessageID,
                                                  java.lang.String sFolderID,
                                                  int iEmbeddedIndex,
                                                  int iAttachmentIndex)
                                           throws ExchangeException

Gets an attachment.

deleteAttachment

public void deleteAttachment(java.lang.String sMessageID,
                             java.lang.String sFolderID,
                             int iIndex)
                      throws ExchangeException

Deletes an attachment.

getSessionOptions

public java.lang.String[] getSessionOptions(java.lang.String[] optionTypes)
                                     throws ExchangeException

Gets session options.

setSessionOptions

public void setSessionOptions(java.lang.String[] optionValues)
                       throws ExchangeException

Sets session options.

addAttachment

public int addAttachment(java.lang.String sMessageID,
                         java.lang.String sFolderID,
                         int iType,
                         java.lang.String sName,
                         java.lang.String sSource,
                         int iPosition,
                         javax.activation.DataHandler dh)
                  throws ExchangeException

Adds an attachment.

createNotification

public void createNotification(java.lang.String sSessionID,
                               java.lang.String sFolderID,
                               boolean bSubFolders,
                               int iTypes)
                        throws ExchangeException

Creates a notification for for a session.

Parameters:

sSessionID - the session id

removeNotification

public void removeNotification(java.lang.String sSessionID,
                               java.lang.String sFolderID)
                        throws ExchangeException

Removes a notification for a session.

Parameters:

sSessionID - the session id

getServerProperties

public java.lang.String[] getServerProperties(java.lang.String sSessionID,
                                              java.lang.String[] serviceProps)
                                       throws ExchangeException

Gets server properties.

resolveRecipients

public java.lang.String[] resolveRecipients(java.lang.String sMessageID,
                                            boolean bRemove,
                                            boolean bSeries)
                                     throws ExchangeException

Resolves recipients on a message.