oracle.panama.messaging.xms
Class XMSServer

java.lang.Object
  |
  +--oracle.panama.messaging.xms.DeviceAddressDataSelectorBase
        |
        +--oracle.panama.messaging.xms.XMSServer

All Implemented Interfaces:

DeviceAddressDataSelector, oracle.panama.messaging.push.server.FailoverAddressProcessor, oracle.panama.sysmgmt.server.ManagedServer, java.lang.Runnable, XMSMessageTransformer

public class XMSServer

extends DeviceAddressDataSelectorBase

implements oracle.panama.messaging.push.server.FailoverAddressProcessor, oracle.panama.sysmgmt.server.ManagedServer, XMSMessageTransformer

Field Summary

Fields inherited from interface oracle.panama.messaging.xms.XMSMessageTransformer

MULTIPART_ALTERNATIVE, MULTIPART_MIXED, MULTIPART_RELATED

Method Summary

Message	createNotificationMessage(long id, DeliveryType deliveryType)
oracle.panama.messaging.push.Packet	createNotificationPacket(long id, boolean isTransformed)
oracle.panama.messaging.push.Packet	createPacket(TransformationContext context, Message message) Create a packet for this message
oracle.panama.messaging.push.Packet	createTransformedPacket(TransformationContext context)
void	delete(long id)
boolean	destroy() free the resources allocated by the ManagedServer
oracle.panama.messaging.push.DeviceAddressData[]	getFailoverChain(oracle.panama.messaging.push.AddressData recipient, oracle.panama.messaging.push.Packet packet)
static XMSServer	getInstance()
Message	getMessage(long id) Get the original (non-transformed) content
oracle.panama.messaging.xms.store.XMSMessageStoreBase	getMessageStore()
oracle.panama.messaging.push.Packet	getPacket(long id)
oracle.panama.messaging.push.DeviceAddressData[]	getRecipients(long id, DeliveryType dt)
oracle.panama.messaging.push.DeviceAddressData[]	getRecipients(oracle.panama.messaging.push.Packet packet, DeliveryType dt)
java.lang.String	getSubject(long id)
Message	getTransformedMessage(long id, DeliveryType deliveryType)
Message	getTransformedMessage(TransformationContext context) Get a transformed Message given a transformation context
oracle.panama.messaging.push.Packet[]	getTransformedPackets(long id, DeliveryType deliveryType, oracle.panama.messaging.push.AddressData[] allRecipients) Get a transformed Packet given an id, deliveryType and array of deliveryAddresses Note that 0 or more Packets will be returned.
oracle.panama.messaging.push.Packet[]	getTransformedPackets(long id, DeliveryType deliveryType, oracle.panama.messaging.push.DeviceAddressData[] recipients)
boolean	init(oracle.panama.sysmgmt.server.ServerContext context) The ManagedServer should return false indicating the method failed, otherwise true is returned.
oracle.panama.sysmgmt.server.ServerStatus	isAlive() Return a simple runtime status, running or dead
boolean	isMMSPacket(oracle.panama.messaging.push.Packet packet)
boolean	isXMSPacket(oracle.panama.messaging.push.Packet packet)
void	refreshCache(oracle.panama.sysmgmt.server.SMRequestEvent refreshCacheEvent) Handle the Cache Refresh Event which is sent when Panama Object data has been changed and commited at DB level
void	run() When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.
boolean	stop() SMAgent will call this method to stop the ManagedServer instance
long	storePacket(oracle.panama.messaging.push.Packet packet) Store the packet with the original content

Methods inherited from class oracle.panama.messaging.xms.DeviceAddressDataSelectorBase

getSuccessor, getUser, isRichContent, isRichContent, setSuccessor, sortDeviceAddresses

Methods inherited from class java.lang.Object

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

Method Detail

getTransformedMessage

public Message getTransformedMessage(long id,
DeliveryType deliveryType)
                              throws XMSException

Parameters:

id -

deliveryType -

Returns:

Throws:

XMSException

getTransformedMessage

public Message getTransformedMessage(TransformationContext context)
                              throws XMSException

Get a transformed Message given a transformation context

Parameters:

context -

Returns:

Throws:

XMSException

createNotificationPacket

public oracle.panama.messaging.push.Packet createNotificationPacket(long id,
                                                                    boolean isTransformed)
                                                             throws XMSException

XMSException

createNotificationMessage

public Message createNotificationMessage(long id,
DeliveryType deliveryType)

getRecipients

public oracle.panama.messaging.push.DeviceAddressData[] getRecipients(long id,
DeliveryType dt)
                                                               throws XMSException

XMSException

getRecipients

public oracle.panama.messaging.push.DeviceAddressData[] getRecipients(oracle.panama.messaging.push.Packet packet,
DeliveryType dt)
                                                               throws XMSException

XMSException

getFailoverChain

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

Specified by:

getFailoverChain in interface oracle.panama.messaging.push.server.FailoverAddressProcessor

getInstance

public static XMSServer getInstance()

storePacket

public long storePacket(oracle.panama.messaging.push.Packet packet)
                 throws XMSException

Store the packet with the original content

Specified by:

storePacket in interface XMSMessageTransformer

XMSException

getPacket

public oracle.panama.messaging.push.Packet getPacket(long id)
                                              throws XMSException

XMSException

getMessage

public Message getMessage(long id)
                   throws XMSException

Get the original (non-transformed) content

XMSException

getTransformedPackets

public oracle.panama.messaging.push.Packet[] getTransformedPackets(long id,
DeliveryType deliveryType,
                                                                   oracle.panama.messaging.push.AddressData[] allRecipients)
                                                            throws XMSException

Get a transformed Packet given an id, deliveryType and array of deliveryAddresses Note that 0 or more Packets will be returned. If none of the recipients can receive content for this delivery type, no (0) packets are returned. If the same packet is valid for all users passed in, only one packet is returned. If the content needs to be customized on a per-user basis (as when we are processing content for RevAsk, an array of Packets will be returned, one per user. In general, the user of this API need not be concerned about the difference, since a for loop will handle all cases.

Specified by:

getTransformedPackets in interface XMSMessageTransformer

XMSException

getTransformedPackets

public oracle.panama.messaging.push.Packet[] getTransformedPackets(long id,
DeliveryType deliveryType,
                                                                   oracle.panama.messaging.push.DeviceAddressData[] recipients)
                                                            throws XMSException

Parameters:

id -

deliveryType -

recipients -

Returns:

Throws:

XMSException

createTransformedPacket

public oracle.panama.messaging.push.Packet createTransformedPacket(TransformationContext context)
                                                            throws XMSException

XMSException

delete

public void delete(long id)
            throws XMSException

XMSException

createPacket

public final oracle.panama.messaging.push.Packet createPacket(TransformationContext context,
Message message)
                                                       throws XMSException

Create a packet for this message

Parameters:

context -

message -

Returns:

Throws:

XMSException

getSubject

public final java.lang.String getSubject(long id)
                                  throws XMSException

XMSException

getMessageStore

public oracle.panama.messaging.xms.store.XMSMessageStoreBase getMessageStore()

isXMSPacket

public boolean isXMSPacket(oracle.panama.messaging.push.Packet packet)
                    throws XMSException

Specified by:

isXMSPacket in interface XMSMessageTransformer

XMSException

isMMSPacket

public boolean isMMSPacket(oracle.panama.messaging.push.Packet packet)
                    throws XMSException

XMSException

init

public boolean init(oracle.panama.sysmgmt.server.ServerContext context)

The ManagedServer should return false indicating the method failed, otherwise true is returned.

Specified by:

init in interface oracle.panama.sysmgmt.server.ManagedServer

stop

public boolean stop()

SMAgent will call this method to stop the ManagedServer instance

Specified by:

stop in interface oracle.panama.sysmgmt.server.ManagedServer

destroy

public boolean destroy()

free the resources allocated by the ManagedServer

Specified by:

destroy in interface oracle.panama.sysmgmt.server.ManagedServer

isAlive

public oracle.panama.sysmgmt.server.ServerStatus isAlive()

Return a simple runtime status, running or dead

Specified by:

isAlive in interface oracle.panama.sysmgmt.server.ManagedServer

refreshCache

public void refreshCache(oracle.panama.sysmgmt.server.SMRequestEvent refreshCacheEvent)

Handle the Cache Refresh Event which is sent when Panama Object data has been changed and commited at DB level

Specified by:

refreshCache in interface oracle.panama.sysmgmt.server.ManagedServer

run

public void run()

When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.

The general contract of the method run is that it may take any action whatsoever.

Specified by:

run in interface java.lang.Runnable

See Also:

Thread.run()