| Sun Java System Content Delivery Server Customization Guide |    
|
| Sun Java System Content Delivery Server Customization Guide |
|
| C H A P T E R 8 |
|
Messaging API |
This chapter describes the Sun Java System Content Delivery Server Messaging API. The Messaging API provides a mechanism for carriers or application vendors to integrate their WAP, SMS, and MMS push implementations with the Content Delivery Server by creating a push adapter. The Messaging API is used to create both push sender adapters and push listener adapters.
The following figure illustrates the high-level architecture of the Messaging API and the different components that use this API.
An external push system can interact or receive push messages from the Content Delivery Server.
For information on classes or methods not described in this section, see the HTML output of the Javadoc tool for the Messaging API at $CDS_HOME/javadoc/cdsapi/index.html.
The PushMsgSender interface declares the methods needed for a push message sender implementation. This interface is called by the Content Delivery Server Messaging Service when the Content Delivery Server sends a push message.
public PushResponse pushMessage(PushMessage msg, int retryNum) throws PushMessageFailException;
Sends the message. This method is called when the Content Delivery Server sends a push message.
The PushMsgListener interface declares the methods needed for a push message listener implementation.
public boolean connect()
Returns true if the Content Delivery Server is connected to the SMSC, otherwise, returns false. This method is called by Content Delivery Server Messaging Service when the SMSC sends a push message.
public void initialize(String pushActionType) throws InitializationFailedException
Initializes SMSC parameters before making a connection to the SMSC. This is the first method called by the Content Delivery Server Messaging Service.
public void listen()
Listens for the message coming from the device. This method is called by Content Delivery Server Messaging Service after PushMsgListener is connected to the SMSC.
public void sendKeepAliveMsg()
Sends signal to keep message alive. This method is called by the Content Delivery Server Messaging Service if the SMSC requires that a "Keep Alive" signal be sent to keep the connection active.
PushMessage is the base class for all of the different types of push messages generated by the Content Delivery Server. The MMSPushMessage class used for MMS messages extends PushMessage.
All of the set methods are used by the Content Delivery Server during message construction. All of the get methods can be used by a sender's implementation of a push message.
public void addUserAgent(String ua)
Sets the user agent for the receiver's device.
public ArrayList getAllUserAgents()
Returns all user agents for the receiver's device.
public Object getAttribute(String attributeName)
Returns any message attribute.
public Object getContentBinary()
Gets the binary content included in the message.
public String getContentType()
Gets the content type of a message.
public String getDestinationAddress()
Returns the destination address, which is the phone number or email ID of the receiver.
This method is deprecated. Use getMessageId().
public String getKeyword()
Returns the keyword that is associated with the requested content.
public String getMessageId()
Returns the ID of the message.
public String getMessageText()
public String getMimeType()
public long getPushCategory()
Returns the push message category.
public long getPushDomain()
Returns the domain of the push message.
public String getPushType()
public String getShortCode()
Returns the short code to which the message is sent.
public long getSubscriberId()
public String getUniqueDeviceId()
public long getVendingContentId()
Returns the vending content ID.
public void setAllUserAgents(ArrayList list)
Sets multiple user agents for the receiver's device.
public void setAttribute(String attributeName, Object attributeVal)
public void setContentBinary(byte[] content)
Sets the content binary included in the message.
public void setContentType(String contentType)
Sets the content type of the message.
public void setDestinationAddress(String receiverId)
Sets the destination address of the receiver of the push message. The destination address can be either a phone number or email ID.
This method is deprecated. Use setMessageId().
public void setKeyword(String inputKeyword)
Sets the keyword that is associated with the requested content.
public void setMessageId(String msgId)
public void setMessageText(String text)
public void setMimeType(String mType)
public void setPushCategory(long category)
Sets the push message category.
public void setPushDomain(long domain)
Sets the domain of the push message.
public void setShortCode(String inputShortCode)
Sets the short code to which the message is sent.
public void setSubscriberId(long subId)
public void setUniqueDeviceId(String uniqueId)
Sets the unique ID of the device.
public void setVendingContentId(long contentId)
public String toString()
Displays the PushMessage object's data to the log. This method is mainly for debugging purposes.
This class is deprecated. The following methods are now part of PushMessage class:
To get and set the content name or download URL, use the getAttribute() and setAttribute() methods in PushMessage with the appropriate constant defined in PushConstants. See the output of the Javadoc tool for these classes at $CDS_HOME/javadoc/cdsapi/index.html for more information.
This class is deprecated. To get and set the download URL, use the getAttribute() and setAttribute() methods in PushMessage with the appropriate constant defined in PushConstants. See the output of the Javadoc tool for these classes at $CDS_HOME/javadoc/cdsapi/index.html for more information.
This class is deprecated. To get and set the subject or message's From address, use the getAttribute() and setAttribute() methods in PushMessage with the appropriate constant defined in PushConstants. See the output of the Javadoc tool for these classes at $CDS_HOME/javadoc/cdsapi/index.html for more information.
This class stores the binary data from the MMS push message. The binary data can have a MIME type and a unique ID associated with it. All of the set methods are used by the server during message construction. All the get methods can be used by an implementation of a push message.
public byte[] getContentData()
Returns the MMS push message's binary data.
public String getContentId()
Returns the unique ID associated with an MMS push message's binary data.
public String getContentMimeType()
Returns the MIME type of an MMS push message's binary data.
public void setContentData(byte[] contentData)
Sets the MMS push message's binary data.
public void setContentId(String contentId)
Sets the unique ID associated with an MMS push message's binary data.
public void setContentMimeType(String contentMimeType)
Sets the MIME type of an MMS push message's binary data.
This class is a wrapper for ContentSlide objects and is used to construct MMS push messages. All of the set methods are used by the Content Delivery Server during message construction. All the get methods can be used by an implementation of a push message.
public ContentSlide getAudioContent()
Returns the audio content of an MMSSlide object.
public ContentSlide getImageContent()
Returns the image content of an MMSSlide object.
public ContentSlide getTextContent()
Returns the text content of an MMSSlide object.
public ContentSlide getVideoContent()
Returns the video content of an MMSSlide object.
public void setAudioContent(String contentId, String contentMimeType, byte[] contentData)
Sets the audio content of an MMSSlide object.
public void setImageContent(String contentId, String contentMimeType, byte[] contentData)
Sets the image content of an MMSSlide object.
public void setTextContent(String contentId, String contentMimeType, byte[] contentData)
Sets the text content of an MMSSlide object.
public void setVideoContent(String contentId, String contentMimeType, byte[] contentData)
Sets the video content of an MMSSlide object.
The MMSPushMessage class extends PushMessage and represents an MMS push message. All of the set methods are used by the Content Delivery Server during message construction. All of the get methods can be used by an implementation of a push message. This class contains the From address, the To addresses, MMSC-related data, the user agent, and any Synchronized Multimedia Integration Language (SMIL) data, if available. It also encapsulates the MMSSlide object.
public void addMMSSlide(MMSSlide mmsSlide)
public void addRecipient(String to)
Sets the receiver's phone number or email ID.
public ArrayList getAllMMSSlides()
Returns all of the MMSSlide objects associated with this MMSPushMessage.
public ArrayList getAllRecipients()
Returns the phone number or email ID of all of the recipients of the message.
public boolean getDeliveryReportRequired()
Returns the value for DeliveryReportRequired attribute.
public String getFromAddress()
Returns the sender's phone number or email ID.
public String getMessageClass()
Returns the value for MessageClass attribute.
public String getMessagePriority()
Returns the value for MessagePriority attribute.
public boolean getReadReportRequired()
Returns the value for ReadReportRequired attribute.
public String getSenderVisibility()
Returns the value for SenderVisibility attribute.
public byte[] getSMILPresentation()
public void setDeliveryReportRequired(boolean deliveryReportRequired)
Sets the value for DeliveryReportRequired attribute.
public void setFromAddress(String from)
Sets the sender's phone number or email ID.
public void setMessageClass(String messageClass)
Sets the value for MessageClass attribute.
public void setMessagePriority(String messagePriority)
Sets the value for MessagePriority attribute.
public void setReadReportRequired(boolean readReportRequired)
Sets the value for the ReadReportRequired attribute.
public void setSenderVisibility(String senderVisibility)
Sets the value for SenderVisibility attribute.
public void setSMILPresentation(byte[] smil)
The MMSSender interface declares the method that sends an MMS message. This interface must be implemented for the vendor-specific MMSC during integration if you want to support MMS messages.
sendMMS(com.sun.content.server.server.messaging.message.MMSPushMessage message)
Encapsulates the functionality for sending an MMS message. This method is called by the Content Delivery Server Messaging Service when it receives an MMSPushMessage from the Content Delivery Server.
The Content Delivery Server sends an MMSPushMessage object to the Content Delivery Server Messaging Service. The Messaging Service uses the value of the mms.senderclass property in the MsgService.properties file to identify the fully qualified name of the class that provides the vendor-specific implementation of MMSSender.sendMMS. The code within the implementation of sendMMS transforms the MSSPushMessage object into a vendor-specific version of the MMS message object and sends it to the vendor-specific MMSC for processing. The following figure shows this process.
To implement a vendor-specific version of MMSSender.sendMMS, include the following items:
1. Connect to the vendor-specific MMSC.
2. Implement MMSSender.sendMMS to do the following tasks:
The PushResponse class is the base class for all of the different types of push responses generated by the external push services. All of the set methods are used by an implementation of a push message sender. All of the get methods can be used by the Content Delivery Server to log the push message in the database.
public String getMessageId()
public String getResponseDescription()
Returns the response description.
public String getResponseStatus()
The PushConstants class contains all of the constants that the push services can support. A specific push service implementation compares these constants with the values received from the PushMessage object. See the output of the Javadoc tool at $CDS_HOME/javadoc/cdsapi/index.html for information on the constants defined.
A push sender adapter must implement the PushMsgSender interface. During deployment, the implementation class needs to be registered with the Content Delivery Server. An XML file is used for registration. This XML file is located in the $CDS_HOME/deployment/deployment-name/conf directory and is named pushsenderfactory.xml.
The following example shows the structure of this file.
Four adapters are registered in this file. Specify the fully qualified class name and the protocol that the adapter supports. For example, if you have an adapter for SMS push, the protocol is sms. Make sure the adapter class and dependent classes are set in the classpath.
If you are using the default implementation of a push sender adapter for MMS, MMSPushMsgSender, you must implement the MMSSender interface. Set the mms.senderclass property in the MsgServices.properties file to the fully qualified name of your class. This class is in the $CDS_HOME/deployment/deployment-name/conf directory.
A push listener adapter implements the PushMsgListener interface. The implementation class needs to be registered with the Content Delivery Server. An XML file is used for registration. This XML file is located in the $CDS_HOME/deployment/deployment-name/conf directory and is named pushlistenerfactory.xml.
The following example shows the structure of this file.
| Sun Java System Content Delivery Server Customization Guide | 819-3213-10 |
|
Copyright © 2005, Sun Microsystems, Inc. All Rights Reserved.