org.osid.messaging

Interface MessagingProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MessagingProfile, OsidProfile, OsidProxyManager, Sourceable

public interface MessagingProxyManager
extends OsidProxyManager, MessagingProfile

The message manager provides access to message lookup and creation session and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information from a server environment. The sessions included in this manager are:

• MessagingSession: a session to send messages
• MessageLookupSession: a session to retrieve messages
• MessageQuerySession: a session to query for messages
• MessageSearchSession: a session to search for messages
• MessageAdminSession: a session to create and delete messages
• MessageNotificationSession: a session to receive notifications pertaining to message changes
• MessageMailboxSession: a session to look up message to mailbox mappings
• MessageMailboxAssignmentSession: a session to manage message to mailbox mappings
• MessageSmartMailboxSession: a session to manage dynamic mailboxes of messages

• ReceiptLookupSession: a session to retrieve message receipts
• ReceiptAdminSession: a session to update message receipts
• ReceiptNotificationSession: a session to receive notifications pertaining to changes in message receipts

• MailboxLookupSession: a session to retrieve mailboxes
• MailboxQuerySession: a session to query mailboxes
• MailboxSearchSession: a session to search for mailboxes
• MailboxAdminSession: a session to create, update and delete mailboxes
• MailboxNotificationSession: a session to receive notifications pertaining to changes in mailboxes
• MailboxHierarchySession: a session to traverse mailbox hierarchies
• MailboxHierarchyDesignSession: a session to manage mailbox hierarchies

Method Summary

Methods

Modifier and Type	Method and Description
MailboxAdminSession	getMailboxAdminSession(Proxy proxy) Gets the mailbox administrative session for creating, updating and deleteing mailboxes.
MailboxHierarchyDesignSession	getMailboxHierarchyDesignSession(Proxy proxy) Gets the mailbox hierarchy design session.
MailboxHierarchySession	getMailboxHierarchySession(Proxy proxy) Gets the mailbox hierarchy traversal session.
MailboxLookupSession	getMailboxLookupSession(Proxy proxy) Gets the mailbox lookup session.
MailboxNotificationSession	getMailboxNotificationSession(MailboxReceiver mailboxReceiver, Proxy proxy) Gets the notification session for subscribing to changes to a mailbox.
MailboxQuerySession	getMailboxQuerySession(Proxy proxy) Gets the mailbox query session.
MailboxSearchSession	getMailboxSearchSession(Proxy proxy) Gets the mailbox search session.
MessageAdminSession	getMessageAdminSession(Proxy proxy) Gets a message administration session for creating, updating and deleting messages.
MessageAdminSession	getMessageAdminSessionForMailbox(Id mailboxId, Proxy proxy) Gets a message administration session for the given mailbox.
MessageLookupSession	getMessageLookupSession(Proxy proxy) Gets the OsidSession associated with the message lookup service.
MessageLookupSession	getMessageLookupSessionForMailbox(Id mailboxId, Proxy proxy) Gets the OsidSession associated with the message lookup service for the given mailbox.
MessageMailboxAssignmentSession	getMessageMailboxAssignmentSession(Proxy proxy) Gets the session for assigning message to mailbox mappings.
MessageMailboxSession	getMessageMailboxSession(Proxy proxy) Gets the session for retrieving message to mailbox mappings.
MessageNotificationSession	getMessageNotificationSession(MessageReceiver messageReceiver, Proxy proxy) Gets the message notification session for the given mailbox.
MessageNotificationSession	getMessageNotificationSessionForMailbox(MessageReceiver messageReceiver, Id mailboxId, Proxy proxy) Gets the message notification session for the given mailbox.
MessageQuerySession	getMessageQuerySession(Proxy proxy) Gets the OsidSession associated with the message query service.
MessageQuerySession	getMessageQuerySessionForMailbox(Id mailboxId, Proxy proxy) Gets the OsidSession associated with the message query service for the given mailbox.
MessageSearchSession	getMessageSearchSession(Proxy proxy) Gets a message search session.
MessageSearchSession	getMessageSearchSessionForMailbox(Id mailboxId, Proxy proxy) Gets a message search session for the given mailbox.
MessageSmartMailboxSession	getMessageSmartMailboxSession(Id mailboxId, Proxy proxy) Gets the OsidSession to manage message smart mailboxes.
MessagingBatchProxyManager	getMessagingBatchProxyManager() Gets a MessagingBatchProxyManager.
MessagingSession	getMessagingSession(Proxy proxy) Gets the OsidSession associated with the message sending service.
ReceiptAdminSession	getReceiptAdminSession(Proxy proxy) Gets the OsidSession associated with the receipt administrative service.
ReceiptAdminSession	getReceiptAdminSessionForMailbox(Id mailboxId, Proxy proxy) Gets the OsidSession associated with the receipt administrative service for the given mailbox.
ReceiptLookupSession	getReceiptLookupSession(Proxy proxy) Gets the OsidSession associated with the receipt lookup service.
ReceiptLookupSession	getReceiptLookupSessionForMailbox(Id mailboxId, Proxy proxy) Gets the OsidSession associated with the receipt lookup service for the given mailbox.
ReceiptNotificationSession	getReceiptNotificationSession(ReceiptReceiver receiptReceiver, Proxy proxy) Gets the notification session for notifications pertaining to receipt changes.
ReceiptNotificationSession	getReceiptNotificationSessionForMailbox(ReceiptReceiver receiptReceiver, Id mailboxId, Proxy proxy) Gets the receipt notification session for the given mailbox.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.messaging.MessagingProfile

getMailboxRecordTypes, getMailboxSearchRecordTypes, getMessageRecordTypes, getMessageSearchRecordTypes, getReceiptRecordTypes, supportsMailboxAdmin, supportsMailboxHierarchy, supportsMailboxHierarchyDesign, supportsMailboxLookup, supportsMailboxNotification, supportsMailboxRecordType, supportsMailboxSearch, supportsMailboxSearchRecordType, supportsMessageAdmin, supportsMessageLookup, supportsMessageMailbox, supportsMessageMailboxAssignment, supportsMessageNotification, supportsMessageQuery, supportsMessageRecordType, supportsMessageSearch, supportsMessageSearchRecordType, supportsMessageSmartMailbox, supportsMessaging, supportsMessagingBatch, supportsReceiptAdmin, supportsReceiptLookup, supportsReceiptNotification, supportsReceiptRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getMessagingSession

MessagingSession getMessagingSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the message sending service.

Parameters:

proxy - a proxy

Returns:

a MessagingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessaging() is false

Compliance:

optional - This method must be implemented if supportsMessaging() is true.

getMessageLookupSession

MessageLookupSession getMessageLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the message lookup service.

Parameters:

proxy - a proxy

Returns:

a MessageLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageLookup() is false

Compliance:

optional - This method must be implemented if supportsMessageLookup() is true.

getMessageLookupSessionForMailbox

MessageLookupSession getMessageLookupSessionForMailbox(Id mailboxId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the message lookup service for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a MessageLookupSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMessageLookup() and supportsVisibleFederation() are true.

getMessageQuerySession

MessageQuerySession getMessageQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the message query service.

Parameters:

proxy - a proxy

Returns:

a MessageQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageQuery() is false

Compliance:

optional - This method must be implemented if supportsMessageQuery() is true.

getMessageQuerySessionForMailbox

MessageQuerySession getMessageQuerySessionForMailbox(Id mailboxId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the message query service for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a MessageQuerySession

Throws:

NotFoundException - no Mailbox found by the given Id

NullArgumentException - mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMessageQuery() and supportsVisibleFederation() are true

getMessageSearchSession

MessageSearchSession getMessageSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets a message search session.

Parameters:

proxy - a proxy

Returns:

a MessageSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageSearch() is false

Compliance:

optional - This method must be implemented if supportsMessageSearch() is true.

getMessageSearchSessionForMailbox

MessageSearchSession getMessageSearchSessionForMailbox(Id mailboxId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets a message search session for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a MessageSearchSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMessageSearch() and supportsVisibleFederation() are true.

getMessageAdminSession

MessageAdminSession getMessageAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets a message administration session for creating, updating and deleting messages.

Parameters:

proxy - a proxy

Returns:

a MessageAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageAdmin() is false

Compliance:

optional - This method must be implemented if supportsMessageAdmin() is true.

getMessageAdminSessionForMailbox

MessageAdminSession getMessageAdminSessionForMailbox(Id mailboxId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets a message administration session for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a MessageAdminSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMessageAdmin() and supportsVisibleFederation() are true.

getMessageNotificationSession

MessageNotificationSession getMessageNotificationSession(MessageReceiver messageReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the message notification session for the given mailbox.

Parameters:

messageReceiver - notification callback

proxy - a proxy

Returns:

a MessageNotificationSession

Throws:

NullArgumentException - messageReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageNotification() is false

Compliance:

optional - This method must be implemented if supportsMessageNotification() is true.

getMessageNotificationSessionForMailbox

MessageNotificationSession getMessageNotificationSessionForMailbox(MessageReceiver messageReceiver,
                                                                 Id mailboxId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the message notification session for the given mailbox.

Parameters:

messageReceiver - notification callback

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a MessageNotificationSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - messageReceiver, mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMessageNotfication() and supportsVisibleFederation() are true.

getMessageMailboxSession

MessageMailboxSession getMessageMailboxSession(Proxy proxy)
                                               throws OperationFailedException

Gets the session for retrieving message to mailbox mappings.

Parameters:

proxy - a proxy

Returns:

a MessageMailboxSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageMailbox() is false

Compliance:

optional - This method must be implemented if supportsMessageMailbox() is true.

getMessageMailboxAssignmentSession

MessageMailboxAssignmentSession getMessageMailboxAssignmentSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the session for assigning message to mailbox mappings.

Parameters:

proxy - a proxy

Returns:

a MessageMailboxAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageMailboxAssignment() is false

Compliance:

optional - This method must be implemented if supportsMessageMailboxAssignment() is true.

getMessageSmartMailboxSession

MessageSmartMailboxSession getMessageSmartMailboxSession(Id mailboxId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession to manage message smart mailboxes.

Parameters:

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a MessageSmartMailboxesession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMessageSmartMailbox() is false

Compliance:

optional - This method must be implemented if supportsMessageSmartMailbox() is true.

getReceiptLookupSession

ReceiptLookupSession getReceiptLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the receipt lookup service.

Parameters:

proxy - a proxy

Returns:

a ReceiptLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptLookup() is false

Compliance:

optional - This method must be implemented if supportsReceiptLookup() is true.

getReceiptLookupSessionForMailbox

ReceiptLookupSession getReceiptLookupSessionForMailbox(Id mailboxId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the receipt lookup service for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a ReceiptLookupSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReceiptLookup() and supportsVisibleFederation() are true.

getReceiptAdminSession

ReceiptAdminSession getReceiptAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the receipt administrative service.

Parameters:

proxy - a proxy

Returns:

a ReceiptAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptAdmin() is false

Compliance:

optional - This method must be implemented if supportsReceiptAdmin() is true.

getReceiptAdminSessionForMailbox

ReceiptAdminSession getReceiptAdminSessionForMailbox(Id mailboxId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the receipt administrative service for the given mailbox.

Parameters:

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a ReceiptAdminSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReceiptAdmin() and supportsVisibleFederation() are true.

getReceiptNotificationSession

ReceiptNotificationSession getReceiptNotificationSession(ReceiptReceiver receiptReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the notification session for notifications pertaining to receipt changes.

Parameters:

receiptReceiver - the notification callback

proxy - a proxy

Returns:

a ReceiptNotificationSession

Throws:

NullArgumentException - receiptReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptNotification() is false

Compliance:

optional - This method must be implemented if supportsreceiptNotification() is true.

getReceiptNotificationSessionForMailbox

ReceiptNotificationSession getReceiptNotificationSessionForMailbox(ReceiptReceiver receiptReceiver,
                                                                 Id mailboxId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the receipt notification session for the given mailbox.

Parameters:

receiptReceiver - the notification callback

mailboxId - the Id of the mailbox

proxy - a proxy

Returns:

a ReceiptNotificationSession

Throws:

NotFoundException - mailboxId not found

NullArgumentException - receiptReceiver, mailboxId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReceiptNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReceiptNotfication() and supportsVisibleFederation() are true.

getMailboxLookupSession

MailboxLookupSession getMailboxLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the mailbox lookup session.

Parameters:

proxy - a proxy

Returns:

a MailboxLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxLookup() is false

Compliance:

optional - This method must be implemented if supportsMailboxLookup() is true.

getMailboxQuerySession

MailboxQuerySession getMailboxQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the mailbox query session.

Parameters:

proxy - a proxy

Returns:

a MailboxQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxQuery() is false

Compliance:

optional - This method must be implemented if supportsMailboxQuery() is true.

getMailboxSearchSession

MailboxSearchSession getMailboxSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the mailbox search session.

Parameters:

proxy - a proxy

Returns:

a MailboxSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxSearch() is false

Compliance:

optional - This method must be implemented if supportsMailboxSearch() is true.

getMailboxAdminSession

MailboxAdminSession getMailboxAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the mailbox administrative session for creating, updating and deleteing mailboxes.

Parameters:

proxy - a proxy

Returns:

a MailboxAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxAdmin() is false

Compliance:

optional - This method must be implemented if supportsMailboxAdmin() is true.

getMailboxNotificationSession

MailboxNotificationSession getMailboxNotificationSession(MailboxReceiver mailboxReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the notification session for subscribing to changes to a mailbox.

Parameters:

mailboxReceiver - notification callback

proxy - a proxy

Returns:

a MailboxNotificationSession

Throws:

NullArgumentException - mailboxReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxNotification() is false

Compliance:

optional - This method must be implemented if supportsMailboxNotification() is true.

getMailboxHierarchySession

MailboxHierarchySession getMailboxHierarchySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the mailbox hierarchy traversal session.

Parameters:

proxy - a proxy

Returns:

a MailboxHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxHierarchy() is false

Compliance:

optional - This method must be implemented if supportsMailboxHierarchy() is true.

getMailboxHierarchyDesignSession

MailboxHierarchyDesignSession getMailboxHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the mailbox hierarchy design session.

Parameters:

proxy - a proxy

Returns:

a MailboxHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMailboxHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsMailboxHierarchyDesign() is true.

getMessagingBatchProxyManager

MessagingBatchProxyManager getMessagingBatchProxyManager()
                                                         throws OperationFailedException

Gets a MessagingBatchProxyManager.

Returns:

a MessagingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMessagingBatch() is false

Compliance:

optional - This method must be implemented if supportsMessagingBatch() is true.