BasemessagingServer (CUAE Messaging Plugin 2.5.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

cisco.uc.cuae
Class BasemessagingServer

java.lang.Object
  cisco.uc.cuae.BasemessagingServer

All Implemented Interfaces:: EtchBridge, EtchBridgeServer, messaging, messagingServer, etch.bindings.java.support.ObjSession

Direct Known Subclasses:: ImplmessagingServer

public class BasemessagingServer
extends java.lang.Object
implements messagingServer, etch.bindings.java.support.ObjSession
extends java.lang.Object
implements messagingServer, etch.bindings.java.support.ObjSession

Base implementation of messagingServer, with default method implementations which throw UnsupportedOperationException. Extend this class to provide implementations of messages from the client.

See Also:: ImplmessagingServer

Nested Class Summary

Nested classes/interfaces inherited from interface cisco.uc.cuae.messaging
messaging.AuthenticationException, messaging.InvalidArgumentException, messaging.InvalidMessageStateException, messaging.Mailbox, messaging.MailboxAlreadyOpenException, messaging.Message, messaging.MessageState, messaging.MessageType, messaging.MessagingException, messaging.NoSuchFileIdException, messaging.NoSuchFolderException, messaging.NoSuchMailboxException, messaging.NoSuchMessageException, messaging.NoSuchUserException, messaging.OperationNotPermittedException, messaging.SearchOptions, messaging.SessionExpiredException, messaging.UnderlyingProtocolException, messaging.UserType

Nested classes/interfaces inherited from interface cisco.uc.cuae.messaging

messaging.AuthenticationException, messaging.InvalidArgumentException, messaging.InvalidMessageStateException, messaging.Mailbox, messaging.MailboxAlreadyOpenException, messaging.Message, messaging.MessageState, messaging.MessageType, messaging.MessagingException, messaging.NoSuchFileIdException, messaging.NoSuchFolderException, messaging.NoSuchMailboxException, messaging.NoSuchMessageException, messaging.NoSuchUserException, messaging.OperationNotPermittedException, messaging.SearchOptions, messaging.SessionExpiredException, messaging.UnderlyingProtocolException, messaging.UserType

Nested classes/interfaces inherited from interface cisco.uc.cuae.EtchBridge
`EtchBridge.BridgeException, EtchBridge.ConfigEntry, EtchBridge.EventMessage, EtchBridge.LogLevel`

Field Summary

Fields inherited from interface cisco.uc.cuae.messaging
E_CODE_ALREADY_LOGGED_IN, E_CODE_AUTHORIZATION_FAILURE, E_CODE_COMM_FAILURE, E_CODE_INTERNAL_ERROR, E_CODE_INVALID_ARGUMENT, E_CODE_MAILBOX_ALREADY_OPEN, E_CODE_NO_PERMISSION, E_CODE_NO_SUCH_MAILBOX, E_CODE_NO_SUCH_MESSAGE, E_CODE_NOT_SUPPORTED_ERROR, E_CODE_PASSWORD_EXPIRED, E_CODE_PROTOCOL, E_CODE_SESSION_EXPIRED, E_CODE_USER_LOCKED, E_NAME_ALREADY_LOGGED_IN, E_NAME_AUTHORIZATION_FAILURE, E_NAME_COMM_FAILURE, E_NAME_INTERNAL_ERROR, E_NAME_INVALID_ARGUMENT, E_NAME_MAILBOX_ALREADY_OPEN, E_NAME_NO_PERMISSION, E_NAME_NO_SUCH_MAILBOX, E_NAME_NO_SUCH_MESSAGE, E_NAME_NOT_SUPPORTED_ERROR, E_NAME_PASSWORD_EXPIRED, E_NAME_PROTOCOL, E_NAME_SESSION_EXPIRED, E_NAME_USER_LOCKED

Fields inherited from interface cisco.uc.cuae.messaging

E_CODE_ALREADY_LOGGED_IN, E_CODE_AUTHORIZATION_FAILURE, E_CODE_COMM_FAILURE, E_CODE_INTERNAL_ERROR, E_CODE_INVALID_ARGUMENT, E_CODE_MAILBOX_ALREADY_OPEN, E_CODE_NO_PERMISSION, E_CODE_NO_SUCH_MAILBOX, E_CODE_NO_SUCH_MESSAGE, E_CODE_NOT_SUPPORTED_ERROR, E_CODE_PASSWORD_EXPIRED, E_CODE_PROTOCOL, E_CODE_SESSION_EXPIRED, E_CODE_USER_LOCKED, E_NAME_ALREADY_LOGGED_IN, E_NAME_AUTHORIZATION_FAILURE, E_NAME_COMM_FAILURE, E_NAME_INTERNAL_ERROR, E_NAME_INVALID_ARGUMENT, E_NAME_MAILBOX_ALREADY_OPEN, E_NAME_NO_PERMISSION, E_NAME_NO_SUCH_MAILBOX, E_NAME_NO_SUCH_MESSAGE, E_NAME_NOT_SUPPORTED_ERROR, E_NAME_PASSWORD_EXPIRED, E_NAME_PROTOCOL, E_NAME_SESSION_EXPIRED, E_NAME_USER_LOCKED

Constructor Summary
`BasemessagingServer()`

Method Summary
`void`	`_sessionControl(java.lang.Object control, java.lang.Object value)`
`void`	`_sessionNotify(java.lang.Object event)`
`java.lang.Object`	`_sessionQuery(java.lang.Object query)`
`java.lang.String`	`addCuaeSession(java.lang.String registrationKey)`
`void`	`closeMailbox(java.lang.String sessionId, java.lang.String username)`
`void`	`copyMessage(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId, java.lang.String destinationFolder)` Copies a message to the specified folder for a given mailbox.
`void`	`createFolder(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String folderName)` Creates a folder on the Messaging server in the specified mailbox.
`void`	`deleteFolder(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String folderName, java.lang.String destFolderName)` Deletes a folder from the Messaging server in the specified mailbox.
`void`	`deleteMessage(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId)` Deletes a message from the server message store.
`messaging.Message[]`	`findMessages(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String constraint, java.util.Map<?,?> substitutions, java.lang.Integer offset, java.lang.Integer limit, messaging.SearchOptions options)` Finds messages filtering on the specified search criteria
`java.lang.Integer`	`forwardMessage(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId, java.lang.String destinationUser, java.lang.String from)`
`EtchBridge.ConfigEntry[]`	`getConfig(java.lang.String partition)` Query application partition configuration items
`messaging.Message`	`getMessage(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId, java.lang.String[] fields)`
`java.lang.Integer`	`getMessageCount(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String constraint, java.util.Map<?,?> substitutions)`
`java.lang.Integer`	`getMessageSize(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId)`
`java.lang.String[]`	`getPartitions()` Query application partitions
`byte[]`	`getVoiceData(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId)`
`java.lang.Boolean`	`isLoggedIn(java.lang.String sessionId)`
`java.lang.Boolean`	`isLoggedInAndOpen(java.lang.String sessionId, java.lang.String mailboxId)`
`void`	`login(java.lang.String sessionId, java.lang.String name, java.lang.String password, messaging.UserType userType)` To perform any operation in the Messaging API, one must log in with either administrative or enduser credentials.
`void`	`logout(java.lang.String sessionId)`
`void`	`logWrite(EtchBridge.LogLevel level, java.lang.String msg)` CUAE Etch Bridge notify Etch application has been triggered
`void`	`moveFolder(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String srcFolderName, java.lang.String destFolderName)` Moves a folder on the Messaging server in the specified mailbox.
`void`	`moveMessage(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId, java.lang.String destinationFolder)` Moves a message to a different folder for a given mailbox.
`void`	`onNotHandled(EtchBridge.EventMessage originalEvent, java.lang.String reason)`
`messaging.Mailbox`	`openMailbox(java.lang.String sessionId, java.lang.String username)`
`java.lang.String`	`registerApplication(java.lang.String appName, java.lang.String partition, java.lang.String userName, java.lang.String password)` Register Etch application to CUAE Etch Bridge
`java.lang.String`	`registerPlugin(java.lang.String pluginName, java.lang.String nameSpace, java.lang.String uri, java.lang.String userName, java.lang.String password)` Register Etch plugin to CUAE Etch Bridge
`void`	`removeCuaeSession(java.lang.String sessionId)` Etch application notify a session instance terminated from the application logic.
`java.lang.Integer`	`sendMessage(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String destUser, java.lang.String fromUser, java.lang.String fileID)`
`void`	`undeleteMessage(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId)` Restores a previously deleted message.
`void`	`unregisterApplication(java.lang.String regKey, java.lang.String userName, java.lang.String password)` Unregister Etch application from CUAE Etch Bridge
`void`	`unregisterPlugin(java.lang.String regKey, java.lang.String userName, java.lang.String password)` Unregister Etch plugin from CUAE Etch Bridge
`void`	`updateState(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId, messaging.MessageState state)` Changes the state of the message on the Messaging server.
`void`	`updateUrgency(java.lang.String sessionId, java.lang.String mailboxId, java.lang.String messageId, java.lang.Boolean urgent)` Changes the urgency of the message of the Messaging server.
`java.lang.String`	`uploadData(java.lang.String sessionId, byte[] data, java.lang.String fileId)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

BasemessagingServer

public BasemessagingServer()

Method Detail

_sessionQuery

public java.lang.Object _sessionQuery(java.lang.Object query)
                               throws java.lang.Exception

Specified by:: _sessionQuery in interface etch.bindings.java.support.ObjSession

Throws:: java.lang.Exception

_sessionControl

public void _sessionControl(java.lang.Object control,
                            java.lang.Object value)
                     throws java.lang.Exception

Specified by:: _sessionControl in interface etch.bindings.java.support.ObjSession

Throws:: java.lang.Exception

_sessionNotify

public void _sessionNotify(java.lang.Object event)
                    throws java.lang.Exception

Specified by:: _sessionNotify in interface etch.bindings.java.support.ObjSession

Throws:: java.lang.Exception

onNotHandled

public void onNotHandled(EtchBridge.EventMessage originalEvent,
                         java.lang.String reason)

Specified by:: onNotHandled in interface messagingServer

login

public void login(java.lang.String sessionId,
                  java.lang.String name,
                  java.lang.String password,
                  messaging.UserType userType)
           throws messaging.InvalidArgumentException,
                  messaging.MessagingException,
                  messaging.AuthenticationException,
                  messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

To perform any operation in the Messaging API, one must log in with either administrative or enduser credentials.

Specified by:: login in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.AuthenticationException; messaging.UnderlyingProtocolException

logout

public void logout(java.lang.String sessionId)
            throws messaging.InvalidArgumentException,
                   messaging.MessagingException

Specified by:: logout in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException

isLoggedIn

public java.lang.Boolean isLoggedIn(java.lang.String sessionId)
                             throws messaging.InvalidArgumentException,
                                    messaging.MessagingException

Specified by:: isLoggedIn in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException

isLoggedInAndOpen

public java.lang.Boolean isLoggedInAndOpen(java.lang.String sessionId,
                                           java.lang.String mailboxId)
                                    throws messaging.InvalidArgumentException,
                                           messaging.MessagingException

Specified by:: isLoggedInAndOpen in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException

openMailbox

public messaging.Mailbox openMailbox(java.lang.String sessionId,
                                     java.lang.String username)
                              throws messaging.InvalidArgumentException,
                                     messaging.MessagingException,
                                     messaging.NoSuchMailboxException,
                                     messaging.MailboxAlreadyOpenException,
                                     messaging.OperationNotPermittedException,
                                     messaging.SessionExpiredException,
                                     messaging.UnderlyingProtocolException

Specified by:: openMailbox in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.MailboxAlreadyOpenException; messaging.OperationNotPermittedException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

closeMailbox

public void closeMailbox(java.lang.String sessionId,
                         java.lang.String username)
                  throws messaging.InvalidArgumentException,
                         messaging.MessagingException,
                         messaging.NoSuchMailboxException,
                         messaging.SessionExpiredException

Specified by:: closeMailbox in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.SessionExpiredException

getMessage

public messaging.Message getMessage(java.lang.String sessionId,
                                    java.lang.String mailboxId,
                                    java.lang.String messageId,
                                    java.lang.String[] fields)
                             throws messaging.InvalidArgumentException,
                                    messaging.MessagingException,
                                    messaging.NoSuchMessageException,
                                    messaging.NoSuchMailboxException,
                                    messaging.SessionExpiredException,
                                    messaging.UnderlyingProtocolException

Specified by:: getMessage in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMessageException; messaging.NoSuchMailboxException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

findMessages

public messaging.Message[] findMessages(java.lang.String sessionId,
                                        java.lang.String mailboxId,
                                        java.lang.String constraint,
                                        java.util.Map<?,?> substitutions,
                                        java.lang.Integer offset,
                                        java.lang.Integer limit,
                                        messaging.SearchOptions options)
                                 throws messaging.InvalidArgumentException,
                                        messaging.MessagingException,
                                        messaging.NoSuchMailboxException,
                                        messaging.SessionExpiredException,
                                        messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

Finds messages filtering on the specified search criteria

Specified by:: findMessages in interface messagingServer

constraint - the valid field names that one can search on messages is dependent on the backend (Unity or Unity Connection). For Unity, the following field names can be used to form a constraint. Note that one can only use the == and != operater between these fields and their respective values; also, one can only logically AND ('&&') multiple constraints: msgState: only NEW and READ can be specified. DELETED and FLAGGED have no meaning, and should not be specified. If not specified, both NEW and READ messages are returned messageType: only VOICE can be specified, but all messages returned are inherently voice with Unity as the backend, so specifying it is redundant currently urgent: can be set to true to only return urgent messages, and false to return only non-urgent messages. If not set, then urgent and non-urgent messages will be returned; offset - The start index of messages to return; limit - The number of messages to fetch, starting at the 'offset'. For Unity, limit must be between 0 and 100; options - Sortable options are also dependent on the backend (Unity or Unity Connection) For Unity, one can only sort on 'receivedOn'. ASC in this case means the results are sorted from oldest to newest; DESC is newest to oldest. If not specified, sorting defaults to ASC.
Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

getVoiceData

public byte[] getVoiceData(java.lang.String sessionId,
                           java.lang.String mailboxId,
                           java.lang.String messageId)
                    throws messaging.InvalidArgumentException,
                           messaging.MessagingException,
                           messaging.NoSuchMailboxException,
                           messaging.NoSuchMessageException,
                           messaging.SessionExpiredException,
                           messaging.UnderlyingProtocolException

Specified by:: getVoiceData in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

getMessageCount

public java.lang.Integer getMessageCount(java.lang.String sessionId,
                                         java.lang.String mailboxId,
                                         java.lang.String constraint,
                                         java.util.Map<?,?> substitutions)
                                  throws messaging.InvalidArgumentException,
                                         messaging.MessagingException,
                                         messaging.NoSuchMailboxException,
                                         messaging.SessionExpiredException,
                                         messaging.UnderlyingProtocolException

Specified by:: getMessageCount in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

getMessageSize

public java.lang.Integer getMessageSize(java.lang.String sessionId,
                                        java.lang.String mailboxId,
                                        java.lang.String messageId)
                                 throws messaging.InvalidArgumentException,
                                        messaging.MessagingException,
                                        messaging.NoSuchMailboxException,
                                        messaging.SessionExpiredException,
                                        messaging.UnderlyingProtocolException

Specified by:: getMessageSize in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

uploadData

public java.lang.String uploadData(java.lang.String sessionId,
                                   byte[] data,
                                   java.lang.String fileId)
                            throws messaging.InvalidArgumentException,
                                   messaging.MessagingException,
                                   messaging.NoSuchFileIdException,
                                   messaging.NoSuchMailboxException,
                                   messaging.NoSuchUserException,
                                   messaging.SessionExpiredException,
                                   messaging.UnderlyingProtocolException

Specified by:: uploadData in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchFileIdException; messaging.NoSuchMailboxException; messaging.NoSuchUserException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

sendMessage

public java.lang.Integer sendMessage(java.lang.String sessionId,
                                     java.lang.String mailboxId,
                                     java.lang.String destUser,
                                     java.lang.String fromUser,
                                     java.lang.String fileID)
                              throws messaging.InvalidArgumentException,
                                     messaging.MessagingException,
                                     messaging.NoSuchMailboxException,
                                     messaging.NoSuchFileIdException,
                                     messaging.NoSuchUserException,
                                     messaging.SessionExpiredException,
                                     messaging.UnderlyingProtocolException

Specified by:: sendMessage in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.NoSuchFileIdException; messaging.NoSuchUserException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

forwardMessage

public java.lang.Integer forwardMessage(java.lang.String sessionId,
                                        java.lang.String mailboxId,
                                        java.lang.String messageId,
                                        java.lang.String destinationUser,
                                        java.lang.String from)
                                 throws messaging.InvalidArgumentException,
                                        messaging.MessagingException,
                                        messaging.NoSuchMailboxException,
                                        messaging.NoSuchMessageException,
                                        messaging.NoSuchUserException,
                                        messaging.SessionExpiredException,
                                        messaging.UnderlyingProtocolException

Specified by:: forwardMessage in interface messagingServer

Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.NoSuchUserException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

deleteMessage

public void deleteMessage(java.lang.String sessionId,
                          java.lang.String mailboxId,
                          java.lang.String messageId)
                   throws messaging.InvalidArgumentException,
                          messaging.MessagingException,
                          messaging.NoSuchMailboxException,
                          messaging.NoSuchMessageException,
                          messaging.SessionExpiredException,
                          messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

Deletes a message from the server message store. If no exception is thrown, the application session successfully deleted the specified message. If an exception is thrown no changes will have been made on the server side.

Specified by:: deleteMessage in interface messagingServer

mailboxId - The ID for the mailbox.; messageId - The ID of a message in the mailbox.
Throws:: messaging.InvalidArgumentException; messaging.MessagingException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

undeleteMessage

public void undeleteMessage(java.lang.String sessionId,
                            java.lang.String mailboxId,
                            java.lang.String messageId)
                     throws messaging.MessagingException,
                            messaging.InvalidMessageStateException,
                            messaging.NoSuchMailboxException,
                            messaging.NoSuchMessageException,
                            messaging.SessionExpiredException,
                            messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

Restores a previously deleted message. If no exception is thrown, the message is restored and is now available for retrieval. If an exception is thrown no changes will have been made on the server side.

Specified by:: undeleteMessage in interface messagingServer

mailboxId - The ID for the mailbox.; messageId - The ID of a message in the mailbox.
Throws:: messaging.MessagingException; messaging.InvalidMessageStateException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

updateState

public void updateState(java.lang.String sessionId,
                        java.lang.String mailboxId,
                        java.lang.String messageId,
                        messaging.MessageState state)
                 throws messaging.InvalidMessageStateException,
                        messaging.NoSuchMailboxException,
                        messaging.NoSuchMessageException,
                        messaging.SessionExpiredException,
                        messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

Changes the state of the message on the Messaging server. If no exception is thrown, the application session successfully updated the state of the specified message. If an exception is thrown then no changes will be made.

Specified by:: updateState in interface messagingServer

mailboxId - The ID for the mailbox.; messageId - The ID of a message in the mailbox.; state - The new state of the message.
Throws:: messaging.InvalidMessageStateException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

updateUrgency

public void updateUrgency(java.lang.String sessionId,
                          java.lang.String mailboxId,
                          java.lang.String messageId,
                          java.lang.Boolean urgent)
                   throws messaging.InvalidMessageStateException,
                          messaging.NoSuchMailboxException,
                          messaging.NoSuchMessageException,
                          messaging.SessionExpiredException,
                          messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

Changes the urgency of the message of the Messaging server. If no exception is thrown, the application session successfully updated the urgency of the specified message. If an exception is thrown then no changes will be made.

Specified by:: updateUrgency in interface messagingServer

mailboxId - The ID for the mailbox.; urgent - The new urgency of the message.
Throws:: messaging.InvalidMessageStateException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

moveMessage

public void moveMessage(java.lang.String sessionId,
                        java.lang.String mailboxId,
                        java.lang.String messageId,
                        java.lang.String destinationFolder)
                 throws messaging.NoSuchFolderException,
                        messaging.NoSuchMailboxException,
                        messaging.NoSuchMessageException,
                        messaging.SessionExpiredException,
                        messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

Moves a message to a different folder for a given mailbox. If no exception is thrown, the application session successfully moved the specified message to the destination folder. If an exception is thrown no changes are made on the server.

Specified by:: moveMessage in interface messagingServer

mailboxId - The ID for the mailbox.; destinationFolder - A folder destined within the specified Mailbox.
Throws:: messaging.NoSuchFolderException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

copyMessage

public void copyMessage(java.lang.String sessionId,
                        java.lang.String mailboxId,
                        java.lang.String messageId,
                        java.lang.String destinationFolder)
                 throws messaging.NoSuchFolderException,
                        messaging.NoSuchMailboxException,
                        messaging.NoSuchMessageException,
                        messaging.SessionExpiredException,
                        messaging.UnderlyingProtocolException

Description copied from interface: messagingServer

Copies a message to the specified folder for a given mailbox. If no exception is thrown, the application session successfully moved the specified message to the destination folder. If an exception is thrown no changes are made on the server.

Specified by:: copyMessage in interface messagingServer

mailboxId - The ID for the mailbox.; destinationFolder - A folder defined within the specified Mailbox
Throws:: messaging.NoSuchFolderException; messaging.NoSuchMailboxException; messaging.NoSuchMessageException; messaging.SessionExpiredException; messaging.UnderlyingProtocolException

createFolder

public void createFolder(java.lang.String sessionId,
                         java.lang.String mailboxId,
                         java.lang.String folderName)
                  throws messaging.InvalidArgumentException,
                         messaging.NoSuchMailboxException,
                         messaging.SessionExpiredException

Description copied from interface: messagingServer

Creates a folder on the Messaging server in the specified mailbox. If no exception is thrown, the folder was successfully created on the server.

Specified by:: createFolder in interface messagingServer

mailboxId - The ID for the mailbox.; folderName - The fully qualified name of the new folder.
Throws:: messaging.InvalidArgumentException; messaging.NoSuchMailboxException; messaging.SessionExpiredException

moveFolder

public void moveFolder(java.lang.String sessionId,
                       java.lang.String mailboxId,
                       java.lang.String srcFolderName,
                       java.lang.String destFolderName)
                throws messaging.InvalidArgumentException,
                       messaging.NoSuchMailboxException,
                       messaging.SessionExpiredException

Description copied from interface: messagingServer

Moves a folder on the Messaging server in the specified mailbox. If no exception is thrown, the folder was successfully moved.

Specified by:: moveFolder in interface messagingServer

mailboxId - The ID for the mailbox.; srcFolderName - The fully qualified name of the existing folder.; destFolderName - The fully qualified name of the new folder location.
Throws:: messaging.InvalidArgumentException; messaging.NoSuchMailboxException; messaging.SessionExpiredException

deleteFolder

public void deleteFolder(java.lang.String sessionId,
                         java.lang.String mailboxId,
                         java.lang.String folderName,
                         java.lang.String destFolderName)
                  throws messaging.InvalidArgumentException,
                         messaging.NoSuchMailboxException,
                         messaging.SessionExpiredException

Description copied from interface: messagingServer

Deletes a folder from the Messaging server in the specified mailbox. If no exception is thrown, the folder was successfully deleted.

Specified by:: deleteFolder in interface messagingServer

mailboxId - The ID for the mailbox.; folderName - The fully qualified name of the new folder.
Throws:: messaging.InvalidArgumentException; messaging.NoSuchMailboxException; messaging.SessionExpiredException

logWrite

public void logWrite(EtchBridge.LogLevel level,
                     java.lang.String msg)

Description copied from interface: EtchBridgeServer

CUAE Etch Bridge notify Etch application has been triggered

Specified by:: logWrite in interface EtchBridgeServer

Parameters:: level - Log level of this logging statement; msg - Log message to write

registerApplication

public java.lang.String registerApplication(java.lang.String appName,
                                            java.lang.String partition,
                                            java.lang.String userName,
                                            java.lang.String password)
                                     throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Specified by:: registerApplication in interface EtchBridgeServer

Parameters:: appName - Application name; partition - Application partition name; userName - User name; password - Password
Returns:: unique registration key
Throws:: EtchBridge.BridgeException

unregisterApplication

public void unregisterApplication(java.lang.String regKey,
                                  java.lang.String userName,
                                  java.lang.String password)
                           throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Unregister Etch application from CUAE Etch Bridge

Specified by:: unregisterApplication in interface EtchBridgeServer

Parameters:: regKey - Key returned from registerApplication; userName - User name; password - Password
Throws:: EtchBridge.BridgeException

addCuaeSession

public java.lang.String addCuaeSession(java.lang.String registrationKey)
                                throws EtchBridge.BridgeException

Specified by:: addCuaeSession in interface EtchBridgeServer

Throws:: EtchBridge.BridgeException

removeCuaeSession

public void removeCuaeSession(java.lang.String sessionId)

Description copied from interface: EtchBridgeServer

Etch application notify a session instance terminated from the application logic. This is similar to the legacy EndScript action in CUAE.

Specified by:: removeCuaeSession in interface EtchBridgeServer

Parameters:: sessionId - Session identifier, similar to RoutingGuid in CUAE

getPartitions

public java.lang.String[] getPartitions()
                                 throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Query application partitions

Specified by:: getPartitions in interface EtchBridgeServer

Returns:: array of partition names of this application
Throws:: EtchBridge.BridgeException

getConfig

public EtchBridge.ConfigEntry[] getConfig(java.lang.String partition)
                                   throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Query application partition configuration items

Specified by:: getConfig in interface EtchBridgeServer

Parameters:: partition - name
Returns:: array of configuration items for this partition
Throws:: EtchBridge.BridgeException

registerPlugin

public java.lang.String registerPlugin(java.lang.String pluginName,
                                       java.lang.String nameSpace,
                                       java.lang.String uri,
                                       java.lang.String userName,
                                       java.lang.String password)
                                throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Specified by:: registerPlugin in interface EtchBridgeServer

Parameters:: pluginName - Friendly plugin name; nameSpace - The full namespace which combines module name and service name defined in Etch IDL; uri - The listener uri for client to connect to; userName - User Name; password - Password
Returns:: unique registration key
Throws:: EtchBridge.BridgeException

unregisterPlugin

public void unregisterPlugin(java.lang.String regKey,
                             java.lang.String userName,
                             java.lang.String password)
                      throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Unregister Etch plugin from CUAE Etch Bridge

Specified by:: unregisterPlugin in interface EtchBridgeServer

Parameters:: regKey - Key returned from registerPlugin; userName - User name; password - Password
Throws:: EtchBridge.BridgeException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

cisco.uc.cuae Class BasemessagingServer

BasemessagingServer

_sessionQuery

_sessionControl

_sessionNotify

onNotHandled

login

logout

isLoggedIn

isLoggedInAndOpen

openMailbox

closeMailbox

getMessage

findMessages

getVoiceData

getMessageCount

getMessageSize

uploadData

sendMessage

forwardMessage

deleteMessage

undeleteMessage

updateState

updateUrgency

moveMessage

copyMessage

createFolder

moveFolder

deleteFolder

logWrite

registerApplication

unregisterApplication

addCuaeSession

removeCuaeSession

getPartitions

getConfig

registerPlugin

unregisterPlugin

cisco.uc.cuae
Class BasemessagingServer