oracle.panama.messaging.xms
Class ConversationManager

java.lang.Object
  |
  +--oracle.panama.messaging.xms.ConversationManager

public class ConversationManager

extends java.lang.Object

Provides tools to manage conversations between two entities - register conversation between two entities - determine the other end of a conversation given one entity - get the failover chain of devices for an entity based on presence

Author:

kalpak.kothari

Method Summary

oracle.panama.messaging.push.AddressData	getConversationOtherEnd(oracle.panama.messaging.push.AddressData addr) Get the other entity that addr is conversing with.
oracle.panama.messaging.push.DeviceAddressData[]	getFailoverChain(oracle.panama.messaging.push.AddressData addr, oracle.panama.messaging.push.Packet packet) Get failover chain of devices for user, and filter out offline devices.
static ConversationManager	getInstance()
java.lang.String	getKey(oracle.panama.messaging.push.AddressData addr) Generates a key for use in HashMap.
boolean	isPresenceOffline(oracle.panama.messaging.push.AddressData address) Is user Offline
boolean	isValidEndPoint(oracle.panama.messaging.push.AddressData to)
oracle.panama.messaging.push.AddressData	registerConversation(oracle.panama.messaging.push.AddressData from, oracle.panama.messaging.push.AddressData to, DeliveryType toDT) Register a conversation between two entities (from and to), by using a free end point.
boolean	setPresenceOffline(oracle.panama.messaging.push.AddressData address) Set Presence of user to Offline
boolean	setPresenceOnline(oracle.panama.messaging.push.AddressData address) Set Presence of user to Online

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ConversationManager getInstance()

registerConversation

public oracle.panama.messaging.push.AddressData registerConversation(oracle.panama.messaging.push.AddressData from,
                                                                     oracle.panama.messaging.push.AddressData to,
DeliveryType toDT)
                                                              throws java.lang.Exception

Register a conversation between two entities (from and to), by using a free end point.

Returns:

a valid end point for this conversation

java.lang.Exception

getConversationOtherEnd

public oracle.panama.messaging.push.AddressData getConversationOtherEnd(oracle.panama.messaging.push.AddressData addr)

Get the other entity that addr is conversing with.

Parameters:

addr - an entity in a conversation

Returns:

the other entity in the conversation

isValidEndPoint

public boolean isValidEndPoint(oracle.panama.messaging.push.AddressData to)

Returns:

true, if end point being used in conversation.

getKey

public java.lang.String getKey(oracle.panama.messaging.push.AddressData addr)

Generates a key for use in HashMap. Reason for not using AddressData directly: it does not implement .equals().

getFailoverChain

public oracle.panama.messaging.push.DeviceAddressData[] getFailoverChain(oracle.panama.messaging.push.AddressData addr,
                                                                         oracle.panama.messaging.push.Packet packet)

Get failover chain of devices for user, and filter out offline devices.

Parameters:

addr - UserAddressData (Panama User) or DeviceAddressData.

packet - packet to send to user, used to order the failover chain.

setPresenceOnline

public boolean setPresenceOnline(oracle.panama.messaging.push.AddressData address)

Set Presence of user to Online

Returns:

true if user removed from offline list, false otherwise

setPresenceOffline

public boolean setPresenceOffline(oracle.panama.messaging.push.AddressData address)

Set Presence of user to Offline

Returns:

true if user added to offline list, false otherwise

isPresenceOffline

public boolean isPresenceOffline(oracle.panama.messaging.push.AddressData address)

Is user Offline

Returns:

true if user is offline, false otherwise