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 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.
|
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
MessagingSession getMessagingSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the message
sending service.proxy
- a proxy a MessagingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessaging()
is false
optional
- This method must be implemented if
supportsMessaging()
is true.
MessageLookupSession getMessageLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the message lookup
service.proxy
- a proxy a MessageLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageLookup()
is false
optional
- This method must be implemented if
supportsMessageLookup()
is true.
MessageLookupSession getMessageLookupSessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the message lookup
service for the given mailbox.mailboxId
- the Id
of the mailboxproxy
- a proxy a MessageLookupSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsMessageLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageLookup()
and
supportsVisibleFederation()
are true.
MessageQuerySession getMessageQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the message query
service.proxy
- a proxy MessageQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageQuery()
is false
optional
- This method must be implemented if
supportsMessageQuery()
is true.
MessageQuerySession getMessageQuerySessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the message query
service for the given mailbox.mailboxId
- the Id
of the mailboxproxy
- a proxy MessageQuerySession
NotFoundException
- no Mailbox
found by
the given Id
NullArgumentException
- mailboxId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageQuery()
and
supportsVisibleFederation()
are true
MessageSearchSession getMessageSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a MessageSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageSearch()
is false
optional
- This method must be implemented if
supportsMessageSearch()
is true.
MessageSearchSession getMessageSearchSessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
mailboxId
- the Id
of the mailboxproxy
- a proxy a MessageSearchSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsMessageSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageSearch()
and
supportsVisibleFederation()
are true.
MessageAdminSession getMessageAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a MessageAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageAdmin()
is false
optional
- This method must be implemented if
supportsMessageAdmin()
is true.
MessageAdminSession getMessageAdminSessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
mailboxId
- the Id
of the mailboxproxy
- a proxy a MessageAdminSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMessageAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMessageAdmin()
and
supportsVisibleFederation()
are true.
MessageNotificationSession getMessageNotificationSession(MessageReceiver messageReceiver, Proxy proxy) throws OperationFailedException
messageReceiver
- notification callbackproxy
- a proxy a MessageNotificationSession
NullArgumentException
- messageReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageNotification()
is false
optional
- This method must be implemented if
supportsMessageNotification()
is true.
MessageNotificationSession getMessageNotificationSessionForMailbox(MessageReceiver messageReceiver, Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
messageReceiver
- notification callbackmailboxId
- the Id
of the mailboxproxy
- a proxy a MessageNotificationSession
NotFoundException
- mailboxId
not foundNullArgumentException
- messageReceiver,
mailboxId
or proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsMessageNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsMessageNotfication()
and
supportsVisibleFederation()
are true.
MessageMailboxSession getMessageMailboxSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy MessageMailboxSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageMailbox()
is false
optional
- This method must be implemented if
supportsMessageMailbox()
is true.
MessageMailboxAssignmentSession getMessageMailboxAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy MessageMailboxAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageMailboxAssignment()
is false
optional
- This method must be implemented if
supportsMessageMailboxAssignment()
is true.
MessageSmartMailboxSession getMessageSmartMailboxSession(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage message smart mailboxes.mailboxId
- the Id
of the mailboxproxy
- a proxy MessageSmartMailboxesession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessageSmartMailbox()
is false
optional
- This method must be implemented if
supportsMessageSmartMailbox()
is true.
ReceiptLookupSession getReceiptLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the receipt lookup
service.proxy
- a proxy a ReceiptLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReceiptLookup()
is false
optional
- This method must be implemented if
supportsReceiptLookup()
is true.
ReceiptLookupSession getReceiptLookupSessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the receipt lookup
service for the given mailbox.mailboxId
- the Id
of the mailboxproxy
- a proxy a ReceiptLookupSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsReceiptLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsReceiptLookup()
and
supportsVisibleFederation()
are true.
ReceiptAdminSession getReceiptAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the receipt
administrative service.proxy
- a proxy a ReceiptAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReceiptAdmin()
is false
optional
- This method must be implemented if
supportsReceiptAdmin()
is true.
ReceiptAdminSession getReceiptAdminSessionForMailbox(Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the receipt
administrative service for the given mailbox.mailboxId
- the Id
of the mailboxproxy
- a proxy a ReceiptAdminSession
NotFoundException
- mailboxId
not foundNullArgumentException
- mailboxId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsReceiptAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsReceiptAdmin()
and
supportsVisibleFederation()
are true.
ReceiptNotificationSession getReceiptNotificationSession(ReceiptReceiver receiptReceiver, Proxy proxy) throws OperationFailedException
receiptReceiver
- the notification callbackproxy
- a proxy a ReceiptNotificationSession
NullArgumentException
- receiptReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReceiptNotification()
is false
optional
- This method must be implemented if
supportsreceiptNotification()
is true.
ReceiptNotificationSession getReceiptNotificationSessionForMailbox(ReceiptReceiver receiptReceiver, Id mailboxId, Proxy proxy) throws NotFoundException, OperationFailedException
receiptReceiver
- the notification callbackmailboxId
- the Id
of the mailboxproxy
- a proxy a ReceiptNotificationSession
NotFoundException
- mailboxId
not foundNullArgumentException
- receiptReceiver,
mailboxId
or proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsReceiptNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsReceiptNotfication()
and
supportsVisibleFederation()
are true.
MailboxLookupSession getMailboxLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy MailboxLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxLookup()
is false
optional
- This method must be implemented if
supportsMailboxLookup()
is true.
MailboxQuerySession getMailboxQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy MailboxQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxQuery()
is false
optional
- This method must be implemented if
supportsMailboxQuery()
is true.
MailboxSearchSession getMailboxSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy MailboxSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxSearch()
is false
optional
- This method must be implemented if
supportsMailboxSearch()
is true.
MailboxAdminSession getMailboxAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy MailboxAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMailboxAdmin()
is false
optional
- This method must be implemented if
supportsMailboxAdmin()
is true.
MailboxNotificationSession getMailboxNotificationSession(MailboxReceiver mailboxReceiver, Proxy proxy) throws OperationFailedException
mailboxReceiver
- notification callbackproxy
- a proxy MailboxNotificationSession
NullArgumentException
- mailboxReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMailboxNotification()
is false
optional
- This method must be implemented if
supportsMailboxNotification()
is true.
MailboxHierarchySession getMailboxHierarchySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy a MailboxHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMailboxHierarchy()
is false
optional
- This method must be implemented if
supportsMailboxHierarchy()
is true.
MailboxHierarchyDesignSession getMailboxHierarchyDesignSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy MailboxHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMailboxHierarchyDesign()
is false
optional
- This method must be implemented if
supportsMailboxHierarchyDesign()
is true.
MessagingBatchProxyManager getMessagingBatchProxyManager() throws OperationFailedException
MessagingBatchProxyManager.
MessagingBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMessagingBatch()
is false
optional
- This method must be implemented if
supportsMessagingBatch()
is true.