org.mobicents.csapi.jr.slee.gms
Interface IpMessagingManagerConnection

All Superinterfaces:

IpServiceConnection

public interface IpMessagingManagerConnection
extends IpServiceConnection

This interface is the 'service manager' interface for the Generic Messaging Service. The generic messaging manager interface provides the management functions to the generic messaging service. The application programmer can use this interface to open mailbox objects and also to enable or disable event notifications.

Method Summary

void	disableMessagingNotification(int assignmentID) This method is used by the application to disable call notifications.
int	enableMessagingNotification(TpMessagingEventCriteria eventCriteria) This method is used to enable messaging notifications so that events can be sent to the application.
IpMailboxConnection	getIpMailboxConnection(TpMailboxIdentifier mailboxIdentifier) Obtains Access To a IpMailboxConnection interface
TpMailboxIdentifier	openMailbox(TpAddress mailboxID, java.lang.String authenticationInfo) This method opens a mailbox for the application.

Methods inherited from interface org.mobicents.csapi.jr.slee.IpServiceConnection

closeConnection

Method Detail

getIpMailboxConnection

IpMailboxConnection getIpMailboxConnection(TpMailboxIdentifier mailboxIdentifier)
                                           throws javax.slee.resource.ResourceException

Obtains Access To a IpMailboxConnection interface

Returns:

A IpMailboxConnection interface

Throws:

ResourceException - If it is not possible to create the connection

openMailbox

TpMailboxIdentifier openMailbox(TpAddress mailboxID,
                                java.lang.String authenticationInfo)
                                throws TpCommonExceptions,
                                       P_GMS_INVALID_MAILBOX,
                                       P_GMS_INVALID_AUTHENTICATION_INFORMATION,
                                       javax.slee.resource.ResourceException

This method opens a mailbox for the application. The session ID for use by the application is returned. Authentication information may be needed to open the mailbox. The application can open more than one mailbox at the same time. The application is not allowed to open the same mailbox more than once at the same time.

Parameters:

mailboxID - Specifies the identity of the mailbox. If the mailbox chosen is invalid, the error code P_GMS_INVALID_MAILBOX is returned.

authenticationInfo - Authentication information needed for the application to open a mailbox in the messaging system, such as a key or password. If the authentication process is considered strong enough for the application to gain access to the mailbox, then the authentication information will be an empty string. If the authentication information is not valid, the error code P_GMS_INVALID_AUTHENTICATION_INFORMATION is returned.

Returns:

mailboxReference Specifies the reference to the opened mailbox.

Throws:

TpCommonExceptions

P_GMS_INVALID_MAILBOX

P_GMS_INVALID_AUTHENTICATION_INFORMATION

javax.slee.resource.ResourceException

enableMessagingNotification

int enableMessagingNotification(TpMessagingEventCriteria eventCriteria)
                                throws TpCommonExceptions,
                                       P_INVALID_CRITERIA,
                                       javax.slee.resource.ResourceException

This method is used to enable messaging notifications so that events can be sent to the application.

Parameters:

eventCriteria - Specifies the event specific criteria used by the application to define the event required.

Returns:

assignmentID Specifies the ID assigned by the generic messaging manager interface for this newly-enabled event notification.

Throws:

TpCommonExceptions

P_INVALID_CRITERIA

javax.slee.resource.ResourceException

disableMessagingNotification

void disableMessagingNotification(int assignmentID)
                                  throws TpCommonExceptions,
                                         P_INVALID_ASSIGNMENT_ID,
                                         javax.slee.resource.ResourceException

This method is used by the application to disable call notifications.

Parameters:

assignmentID - Specifies the assignment ID given by the generic messaging manager interface when the previous enableNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the framework will return the error code P_INVALID_ASSIGNMENTID.

Throws:

TpCommonExceptions

P_INVALID_ASSIGNMENT_ID

javax.slee.resource.ResourceException