Home

Sun Java System Content Delivery Server Integration Guide

1. Copyright lt SUN PROPRIE lt Use is subj lt view gt lt title gt lt jsp gt lt CDAT lt title gt lt jsp gt lt CDATA lt text type er lt jsp gt lt CDAT lt text gt lt jsp gt lt CDATA lt jsp gt lt CDATA lt jsp gt lt CDATA lt form gt lt action gt 0 lt c 2003 Sun Microsystems Inc All rights reserved gt TARV CONFIDENTIAL lt ect to license terms gt A lt bean encodedmessage key device login title gt gt lt jsp gt lt logic messagesPresent gt gt lt jsp gt ror gt A lt html encodederrors gt gt lt jsp gt lt logic messagesPresent gt gt lt jsp gt lt logic messagesNotPresent gt gt lt jsp gt lt logic messagesNotPresent gt gt lt jsp gt 7 6 Integration Guide 20004 CODE EXAMPLE 7 1 Sample Page with Form Continued lt jsp gt Web getWeb getActionURL SubscriberConstants ACTION DEVICE LOGIN null response lt jsp gt lt action gt lt field gt lt name gt username lt name gt lt type gt text lt type gt lt size gt 10 lt size gt lt maxlength gt 40 lt maxlength gt lt label gt lt jsp gt lt CDATA lt bean encodedmessage key device login username gt gt lt jsp gt lt label gt lt field gt lt field gt lt name gt password lt name gt lt type gt password lt type gt lt size gt 10 lt size gt lt maxlength gt 40 lt maxlength gt lt label gt
2. deployment name markup_generation page defs directory The use of these files is described in Section 7 1 3 Processes and Page Usage on page 7 9 TABLE 7 1 XML Files for Subscriber Portal Pages File Name Description _campaign xml Shows the details for an individual campaign _catalog_menu xml Shows lists of links and is used to show the lists of categories content promotions search results My Downloads and My Wish List _confirm_unsubscribe xml Prompts the subscriber to confirm the request to unsubscribe from an item of content _detail xml Shows the details for an item of content _device_error_msg xml Shows an error message device unsupported xml Notifies the subscriber that the device being used is not supported _download xml Prompts the subscriber to download an item of content _enter_coupon xml Prompts the subscriber to provide the information needed to redeem a coupon 7 2 Integration Guide 4 TABLE 7 1 XML Files for Subscriber Portal Pages Continued File Name Description _gift_cancel_confirm xml _gift_cancel_success xml _gift_details xml _locale_selection xml _login xml _login_disabled xml _main_menu xml _MmManage_category xml _my_gifts_menu xml _purchase_confirm xml _search xml _share_content xml _share_content_confirm xml _share_content_receive xml _share_content_success xml _sms_sent xml _unsub_success xml _user_admin_menu
3. lt jsp gt lt CDATA lt bean encodedmessage key device login password gt gt lt jsp gt lt label gt lt field gt lt button gt lt name gt lt jsp gt lt CDATA lt SubscriberConstants BUTTON_SUBMIT gt gt lt jsp gt lt name gt lt label gt lt jsp gt lt CDATA lt bean encodedmessage key device login loginLink gt gt lt jsp gt lt label gt lt button gt lt form gt lt view gt The following code example shows a page that contains links to other pages CODE EXAMPLE 7 2 Sample Page with Links lt xml version 1 0 gt lt Copyright c 2003 Sun Microsystems Inc All rights reserved gt lt SUN PROPRIETARY CONFIDENTIAL gt lt Use is subject to license terms gt lt view gt lt title gt lt jsp gt lt CDATA lt bean encodedmessage key device menu main title gt gt lt jsp gt lt title gt lt list gt lt jsp gt lt CDATA lt logic iterate id element name lt SubscriberConstants ATTR_MENU_LIST gt Chapter 7 Device Specific User Interface Framework 7 CODE EXAMPLE 7 2 Sample Page with Links Continued tvpe com sun content server server webapps common ListItem indexId index gt gt lt jsp gt lt item gt lt link gt lt name gt lt jsp gt lt CDATA lt bean encodedwrite name element property name gt gt lt jsp gt lt name gt lt url gt lt jsp gt
4. Framework The Subscriber Portal component of the Content Delivery Server is a browser based application that can be accessed on a PC or on the subscriber s device Because the browsers used bv different devices have different capabilities the Content Deliverv Server provides a framework for generating Subscriber Portal pages that are tailored to the capabilities of the different devices This framework applies only to the version of the Subscriber Portal that runs on a subscriber s device not to the version that runs on a PC The Content Deliverv Server provides Subscriber Portal pages for devices that use browsers based on WML and XHTML The pages provided are suitable for manv devices However if you are supporting a device that does not correctly show the pages of the Subscriber Portal or you want to take advantage of a device s special capabilities you can create a version of the Subscriber Portal pages specificallv for that device Section 7 1 Overview of the Framework on page 7 1 describes the framework for device specific user interfaces Section 7 2 Generating Pages for a Specific Device on page 7 17 describes how to generate Subscriber Portal pages tailored to the capabilities of a device Section 7 3 Modifying Pages for All Devices on page 7 18 describes how to modifv a page and propagate the change to all device specific versions of the page 7 1 Overview of the Framework The Subscriber Portal consis
5. Les produits qui font l objet de ce manuel d entretien et les informations qu il contient sont regis par la legislation americaine en matiere de controle des exportations et peuvent etre soumis au droit d autres pays dans le domaine des exportations et importations Les utilisations finales ou utilisateurs finaux pour des armes nucleaires des missiles des armes biologiques et chimiques ou du nucleaire maritime directement ou indirectement sont strictement interdites Les exportations ou reexportations vers des pays sous eee des Etats Unis ou vers des entites figurant sur les listes d exclusion d exportation americaines y compris mais de maniere non exclusive la liste de personnes qui font objet d un ordre de ne pas participer d une facon directe ou indirecte aux exportations des produits ou des services qui sont regi par la legislation americaine en matiere de controle des exportations et la liste de ressortissants specifiquement designes sont rigoureusement interdites LA DOCUMENTATION EST FOURNIE EN L ETAT ET TOUTES AUTRES CONDITIONS DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE YCOMPRIS NOTAMMENT TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE A L APTITUDE A UNE UTILISATION PARTICULIERE OU A L ABSENCE DE CONTREFACON Contents Preface xi Introduction 1 1 Billing Integration 2 1 2 1 Billing Adapter Provided 2 1 22 Working with the Postpaid Service
6. TABLE 2 1 Billing Event Parameters Parameters Description billing ticket Billing ticket for this transaction campaign_coupon Coupon code for a campaign campaign_id String that identifies the campaign catalog res id String that identifies the content edition 2 2 Integration Guide 4 TABLE 2 1 Parameters Billing Event Parameters Continued Description content binarv mimetvpe content class id content description content drm tvpe id content short description content id content name current status date destination address developer content id developer id developer name download confirm download count download current count download expiration download period download price download purchase download recurring event log event msg MIME type of the content String that identifies the content item Long description of the content String that identifies the DRM method used to protect the content Short description of the content String that identifies the content that was purchased This value is the same as catalog res id Name of the content Current status of this transaction Date on which the transaction occurred Address to which content is sent for example the MSISDN of the subscriber who requested content Unique identifier used by the developer to identify the content String that identifies the developer of the content Name of
7. color schemes 7 8 Integration Guide 4 7129 7 1 3 1 XHTML AU xs1 Extends the XHTML Color style sheet to support the AU Svstem browser XHIML IAppli xsl Extends the XHTML Color style sheet to support an iAppli browser XHIML NokiaSeries40 xsl Extends the XHTML Color style sheet to support the browser on Nokia Series 40 devices m XHTML SE xs1 Extends the XHTML Color style sheet to support the browser on newer Sony Ericsson devices m XHIML Alternate xsl Extends the XHTML Basic style sheet to support the browser on older devices or devices with less features m XHTML Symbian xs1 Extends the XHTML Color style sheet to support the Svmbian browser and larger images XHTML UP xs1 Extends the XHTML Color style sheet to support the Openwave UP browser a XHIML Motorola xsl Extends the XHTML Color style sheet to support the Mobile Internet Browser MIB 2 2 or later on newer Motorola devices These stvle sheets are suitable for manv devices However if the pages of the Subscriber Portal do not display well on a device a new style sheet can be created to define a different rendering of the elements Onlv those elements that do not displav well need to be included in the new style sheet For example if a device uses the XHTML Alternate xsi style sheet and only links and fields render poorly create a style sheet that imports XHTML ALternate xs1 and includes definitions for only links and fi
8. follow these steps 1 Edit an existing XML file in the CDS_HOME deployment deployment name markup_generation page defs directory or create a new file and add it to the directory See Section 7 1 1 Page Definitions on page 7 2 for a description of the elements that can be included in a file 2 Run the command bin cdsi genmarkup ss all This command processes all of the XML files in the CDS_HOME deployment deployment name markup_generation page defs directory against all of the style sheets in the CDS_HOME deployment deployment name markup_generation stylesheets directory and generates a new set of JSP pages for each style sheet Each set of pages is placed in the CDS_HOME deployment deployment name markup_generation jsps stylesheet directory where stylesheet is the name of the style sheet used to generate the pages 3 Move the directories that contain the generated JSP pages to the Subscriber Portal application directory on each application server where you deployed a Subscriber Portal For Sun Java System Application Server CDS_HOME deployment deployment name sun domains server domain server name applications j2ee modules CDSSubscriberPortal_1 device m For WebLogic Server CDS_HOME deployment deployment name weblogic domains server domain applications subscriberportal device 7 18 Integration Guide 4 7 4 Adding a Custom Page The version of the Subscriber Portal that runs on
9. 4 CODE EXAMPLE 3 1 Sample Mapping File for LDAP Data Continued lt ldap gt kinitial context _factory gt com sun jndi ldap LdapCtxFactory lt initial_ context _factory gt lt provider_url gt ldap t1 389 ou Users o LDAPUserManager lt provider_url gt lt prefix gt uid lt prefix gt lt username gt cn directory manager lt username gt lt password gt 1ldappwd lt password gt lt master_username gt cn directory manager lt master_username gt lt master_password gt ldappwd lt master_password gt lt 1dap gt lt object gt lt obj0 gt top lt obj0 gt lt obj1 gt person lt obj1 gt lt obj 2 gt organizationalPerson lt obj1 gt lt object gt lt mapping isDeletable true isAddable true gt lt loginId isRequired true gt SSN lt loginId gt lt password isRequired true isEncoded false gt pwd lt password gt kunigueDeviceld isRequired true isModifiable true isMultiple true gt lt value0 gt handsetID lt value0 gt lt valuel gt mobileID lt valuel gt lt uniqueDeviceld gt lt firstName isRequired true gt givenName lt firstName gt lt lastName isRequired true gt familyName lt lastName gt lt streetl gt street lt street1 gt lt city gt city lt city gt lt postalcode gt zipcode lt postalcode gt lt email isRequired true gt email lt email gt lt enabled isRequired true gt status lt enabled gt lt msisdn isRequired true isModifiable true gt msisdn lt
10. Enter Enter Information Information Confirm Purchase The Purchase Content page provides the following options m Trial Subscribers can try out an item before purchasing it by clicking Trial The Download page generated from download xml is shown The trial option is available only if the administrator set up a trial for the item Chapter 7 Device Specific User Interface Framework 7 15 7 16 m Purchase Subscribers can purchase content for themselves by clicking Purchase The Confirm Purchase page generated from purchase confirm xml is shown If the subscriber confirms the purchase the Download page generated from _download xm1 is shown If the subscriber downloads content that is delivered in an SMS message a confirmation page generated from _sms_sent xml is shown If the subscriber already purchased the item the purchase option is not available An option to unsubscribe is available if the subscriber has a subscription for the item When the subscriber unsubscribes a confirmation page generated from _confirm_unsubscribe xml is shown When the subscription is successfully cancelled a notification page generated from _unsub_success xm1 is shown I Have a Coupon If subscribers have a coupon code they can purchase content at a discount by clicking I Have a Coupon The Enter Coupon Code page generated from _enter_coupon xm1 is shown After a coupon code is entered the Confirm Purchase page and Download page are sh
11. Service 2 1 Messaging 6 1 User Profile 3 1 WAP Gateway 5 1 APIFilterAdapter adapter 8 2 B billing adapter defined 2 1 Billing API 2 1 billing information 2 2 billing integration 2 1 binary content push 6 3 browser config 7 17 C CIMD2 SMS push listener 6 3 SMS push sender 6 2 conf xml file 3 2 content validation adapter 8 1 Index 1 content validation workflow 8 1 conventions tvpographical xii CopvrightAdapter adapter 8 2 criteria for workflow 8 4 csv_record xsl 2 2 D default record xsl 2 2 device specific pages generating 7 17 modifving 7 18 page elements 7 4 device specific user interface framework 7 1 DRM Mobile 9 1 DRMAdapter adapter 8 2 E Event Service API 2 1 F framework user interface 7 1 G genmarkup command 7 17 7 18 7 20 IAppliValidationAdapter adapter 8 2 L LDAP mapping file for 3 2 sample mapping file 3 6 tuning 3 7 LDAP subscriber adapter 3 1 M mapping file LDAP 3 2 3 6 Messaging API 6 1 MethodRedirectionAdapter adapter 8 2 MIDletPermissionsAdapter adapter 8 2 MIDletSigningAdapter adapter 8 2 MIDletValidationAdapter adapter 8 2 My Downloads 7 13 My Gifts 7 14 My Wish List 7 14 Index 2 Integration Guide 4 N Nokia Activ Server 2 0 1 5 2 Nokia Atrus WAP gateway 5 2 0 Openwave WAP gatewav 5 3 organization of this guide xi P page elements 7 4 pages Subscriber Portal 7 2 Postpaid Service 2 2 Postpa
12. element getUrl lt jsp gt lt url gt lt accesskey gt lt jsp gt lt CDATA lt index intValue 1 gt gt lt jsp gt lt accesskey gt lt link gt lt item gt lt jsp gt lt CDATA lt logic iterate gt gt lt jsp gt lt list gt lt view gt 141 2 Style Sheets Style sheets provide templates that describe how to render each element used to define a JSP page These elements are described in TABLE 7 2 Style sheets interpret the XML page definitions and create the JSP pages for a given device or class of devices Set up style sheets to render markup according to the capabilities of the device used For example when an XML definition specifies a link the style sheet for one type of browser might render the link in color where the style sheet for a different type of browser might render the link with an underline The Content Delivery Server provides the following style sheets with the product These style sheets are in the CDS_HOME deployment deployment name markup_generation stylesheets directory m WML 1 1 xsl Provides basic functionality for devices that support WML 1 1 m WML 1 2 xsl Extends the style sheet for WML 1 1 to support WML 1 2 fuctionality including access keys XHTML Basic xsl Provides basic functionality for devices that support XHTML XHIML Color xsl Extends the style sheet for XHTML to include support for header and footer images and Cascading Style Sheet CSS
13. is used For information on enabling DRM methods see Section 4 7 1 Set the DRM Methods Supported in the Sun Java System Content Delivery Server Installation Guide Chapter 9 DRM Server Integration 3 9 4 Integration Guide 9 2005Q4 Index Svmbols _campaign xml file 7 2 7 13 _catalog_menu xml file 7 2 7 11 7 12 7 13 7 14 _confirm_unsubscribe xml file 7 2 7 16 _detail xml file 7 2 7 11 7 13 7 14 device_error_msg xml file 7 2 _device_unsupported xml file 7 2 _download xml file 7 2 7 14 7 15 _enter_coupon xml file 7 2 7 16 _gift_cancel_confirm xml file 7 3 7 14 _gift_cancel_success xml file 7 3 7 14 _gift_details xml file 7 3 7 14 _locale_selection xml file 7 3 7 13 _login xml file 7 3 7 10 _login_disabled xml file 7 3 7 10 _main_menu xml file 7 3 7 10 _manage_category xml file 7 3 7 13 _my_gifts_menu xml file 7 3 7 14 _purchase_confirm xml file 7 3 7 16 _search xml file 7 3 7 12 _share_content xml file 7 3 7 16 _share_content_confirm xml file 7 3 7 16 _share_content_receive xml file 7 3 7 16 _share_content_success xml file 7 3 7 16 _sms_sent xml file 7 3 7 16 _unsub_success xml file 7 3 7 16 _user_admin_menu xml file 7 3 7 13 A adapter push listener 6 3 push sender 6 2 subscriber LDAP 3 1 WAP gateway default 5 2 Nokia Activ Server 2 0 1 5 2 Nokia Artus WAP gateway 5 2 Openwave WAP gateway 5 3 AddDerivedEditionAdapter adapter 8 2 8 4 API Event
14. mobile devices was created using Apache Struts see http jakarta apache org struts for information on this framework If you have a good understanding of Java technology XML and Struts you can add a page to the Subscriber Portal to customize the page flow As an example of customizing the page flow this section describes the process for adding a Terms and Conditions page before the main menu is shown To add the page follow these steps 1 Create the XML file that defines the page that you want to add Save the file in the CDS HOME deplovment deplovment name markup generation page defs directorv See Section 7 1 1 Page Definitions on page 7 2 for information on the page elements that vou can use The Terms and Conditions page for this example could be defined as shown in the following code example CODE EXAMPLE 7 3 Terms and Conditions Page Definition lt xml version 1 0 gt lt Copyright c 2003 Sun Microsystems Inc All rights reserved gt lt SUN PROPRIETARY CONFIDENTIAL gt lt Use is subject to license terms gt lt view gt lt title gt lt jsp gt lt CDATA lt bean encodedmessage key device newPage title gt gt lt jsp gt lt title gt lt text gt lt jsp gt lt CDATA lt bean encodedmessage key device newPage instructions gt gt lt jsp gt lt text gt lt navbar orientation horizontal gt lt link gt lt name gt lt jsp gt lt CDATA l
15. reserved F7 package com sun content server cdsexample import javax servlet http HttpServletRequest import javax servlet http HttpServletResponse import org apache struts action ActionForm import org apache struts action ActionForward import org apache struts action ActionMapping import com sun content server subscriberapi IApiContext Title Sun Java TM System Content Delivery Server Description Show a new page but only if some External Service determines that the user needs to see this page author SUN Microsystems Inc version 1 0 ake public class CheckNewPageHandler extends BaseDeviceHandler public ActionForward doExecute ActionMapping mapping ActionForm form HttpServletRequest request HttpServletResponse response throws Exception TApiContext apiContext getApiContext request ExternalService class needs to be implemented boolean showPage ExternalService showPage apiContext getMobileld if showPage return mapping findForward show page else return mapping findForward do not show page Chapter 7 Device Specific User Interface Framework 7 21 5 Edit the struts config xml file to indicate how to handle the page in the page flow This file is in one of the following locations For Sun Java System Application Server 505 HOME deplovment deployment name sun domains server domain server name applications j2ee modules CDSSubsc
16. using in Vour enterprise Before Xou Read This Document This guide is for svstem administrators who are responsible for integrating the Content Deliverv Server with their current infrastructure It assumes some knowledge of networking database and wireless technologies You must have successfullv deploved the Content Deliverv Server as described in the Sun Java System Content Delivery Server Installation Guide before using the information in this guide Note Sun is not responsible for the availabilitv of third partv web sites mentioned in this document and does not endorse and is not responsible or liable for anv content advertising products or other materials available through such sites How this Document is Organized This guide is divided into the following chapters Chapter 1 provides an overview of adapters that are provided to assist you in integrating the Content Deliverv Server with vour existing infrastructure xi Chapter 2 describes the billing adapters that are available for integrating the Content Deliverv Server with vour billing svstem Chapter 3 describes the subscriber adapters that are available for integrating the Content Delivery Server with your user data Chapter 4 describes how the Content Delivery Server supports single sign on m Chapter 5 describes the WAP gateway adapters that are available for configuring the Content Delivery Server to support the WAP gateway that yo
17. vou do business to accommodate a proprietarv solution You can configure the Content Deliverv Server to work within vour existing infrastructure Adapters are used in the following areas to integrate the Content Deliverv Server with vour setup Billing Billing adapters convert the information provided by the Content Delivery Server to the format needed by your billing system Subscriber data Subscriber adapters map external subscriber data to the data required by the Content Delivery Server when processing subscriber related functions WAP gateway Wireless application protocol WAP gateway adapters parse the HTTP header from a WAP gateway to retrieve the MSISDN number device profile and other attributes needed by the Content Delivery Server Push delivery Push adapters serve as the interface between the Content Delivery Server and your push implementation Content validation Content validation adapters perform any preprocessing of submitted content that is required before the content is accepted by the Content Delivery Server You can also write customized adapters using the Content Delivery Server APIs if none of the adapters provided meets your needs The APIs are described in the Sun Java System Content Delivery Server Customization Guide In addition to the adapters used to integrate the Content Delivery Server with existing external systems the following features enable you to integrate the Content Delive
18. you deployed a Subscriber Portal For Sun Java System Application Server CDS_HOME deployment deployment name sun domains server domain server name applications j2ee modules CDSSubscriberPortal_1 device m For WebLogic Server CDS_HOME deployment deployment name weblogic domains server domain applications subscriberportal device Add the name of the style sheet to the CDS_HOME deployment deployment name conf browser config file This file maintains the list of supported browser types from which the Catalog Manager administrator chooses when adding a device For example if you created a style sheet named XHTML newBrowser xsl to support a new browser type add the following statement to the file device markup browser option XHTML newBrowser Chapter 7 Device Specific User Interface Framework 7 7 3 Modifying Pages for All Devices If you want to make changes to the version of the Subscriber Portal that is run on mobile devices you can change the page definitions and regenerate the JSP pages The changes that you make are only seen when the Subscriber Portal is accessed from a mobile device Changes made to the XML page definitions do not affect the version of the Subscriber Portal that runs on a PC Make the changes on a test system to avoid disrupting the production system When you are sure that the generated pages are correct move the files created to your production system To change a page
19. you would add the following statements lt uniqueDeviceID isMultiple true gt lt value0 gt handsetID lt value0 gt lt valuel gt mobileID lt valuel gt lt uniqueDeviceID gt The password element can also have the attribute isEncoded Set this attribute to true if the password is stored as an encoded string Set to false if the password is stored without encoding The default is false See Section 3 3 1 2 Sample Mapping File on page 3 6 for an example Chapter 3 Subscriber Integration 3 5 3 3 1 2 CODE EXAMPLE 3 1 Sample Mapping File TABLE 3 4 describes sample data that is mapped in the sample mapping file that follows Fields identified as having no mapping do not appear in the sample TABLE 3 4 Data for Sample LDAP File Content Delivery Server Field LDAP Field loginld SSN password pwd uniqueDeviceId handsetID mobileID firstName givenName middleName no mapping lastName familvName gender no mapping streetl street street2 no mapping city city state no mapping postalcode zipcode country no mapping email email phone no mapping activatedate no mapping deactivatedate no mapping salutation no mapping enabled status msisdn msisdn Sample Mapping File for LDAP Data lt ldapusermanager gt lt config gt lt search_scope gt 1 lt search_scope gt lt max_search_wait_time gt 1000 lt max_search_wait_time gt lt config gt 3 6 Integration Guide
20. 2 2 Subscriber Integration 3 1 3 1 Subscriber Adapter Provided 3 1 3 2 Using a Subscriber Adapter 3 2 3 3 Working with LDAP 3 2 3 3 1 Creating the Mapping File for LDAP 3 2 3 3 1 1 Subscriber Data for the Content Delivery Server 3 3 3 3 1 2 Sample Mapping File 3 6 3 3 2 Tuning LDAP 3 7 Single Sign on Support 4 1 41 Using the MSISDN Number Through the WAP Gateway 4 1 WAP Gateway Configuration 5 1 5 1 WAP Gateway Adapters Provided 5 1 iv 5 1 1 Default WAP Gateway Adapter 5 2 5 1 2 Nokia Activ Server 2 0 1 2 5 1 3 Nokia Artus WAP Gateway 5 2 5 14 Openwave WAP Gateway 5 3 5 2 Using a WAP Gateway Adapter 5 3 6 Push Delivery 6 1 6 1 Push Adapters Provided 6 1 6 1 1 Push Sender Adapters 6 2 6 1 1 1 SMS Push for Messages 6 2 6 1 1 2 WAP Push for Messages 6 3 6 1 1 3 SMTP Push for Messages 6 3 6 1 14 SMS Push for Binary Content 3 6 1 2 Push Listener Adapter 6 3 6 2 Using a Push Adapter 4 6 3 Sample Registration File 6 5 6 3 1 Sample pushsenderfactory xml 6 5 6 3 2 Sample pushlistenerfactory xml 6 5 7 Device Specific User Interface Framework 1 7 1 Overview of the Framework 7 1 7 1 1 Page Definitions 2 7 1 2 Style Sheets 7 8 7 1 3 Processes and Page Usage 7 9 7 1 3 1 Log In Process 7 9 7 1 3 2 View Content Process 7 11 7 1 3 3 Search for Content Process 7 12 7 1 3 4 Set Preferences Process 7 12 7 1 3 5 View Promotions Process 7 13 Integration Guide 4 7 1 3 6 View the My Downloads List Process 7 13 7 1 3 7 View My W
21. E deployment deployment name conf directory for example module gateway id com sun content server service gateway nokia NokiaActivServerWAPGateway Include only the names of the adapters that you want to use Remove adapters that you are not using Chapter 5 WAP Gateway Configuration 5 3 5 4 Integration Guide 9 2005Q4 CHAPTER 6 Push Deliverv Push technology makes it possible for subscribers to receive the link to content without first having to request it from their device Push technology can also be used to push content directly to a device The Sun Java System Content Delivery Server supports WAP Wireless Access Protocol push SMS Short Message Service and SMTP Simple Mail Transfer Protocol push formats for messages and SMS and MMS push for content A push adapter serves as the interface between the Content Delivery Server and your push implementation Configure the Content Delivery Server to use the push adapters that you need The push adapters provided with the Content Delivery Server are described in the following sections If these adapters do not provide the functionality that you need you can create your own push adapter using the Messaging API See the Sun Java System Content Delivery Server Customization Guide for information on this API 6 1 Push Adapters Provided The Content Delivery Server provides both push sender and push listener adapters Push sender adapters are used by the Content Deli
22. Integration Guide View content see Section 7 1 3 2 View Content Process on page 7 11 Search for content see Section 7 1 3 3 Search for Content Process on page 7 12 Set preferences see Section 7 1 3 4 Set Preferences Process on page 7 12 View promotions if available see Section 7 1 3 5 View Promotions Process on page 7 13 View My Downloads if available see Section 7 1 3 6 View the My Downloads List Process on page 7 13 View My Wish List if available see Section 7 1 3 7 View My Wish List Process on page 7 14 e 2005Q4 7 1 3 2 a View My Gifts if available see Section 7 1 3 8 View the My Gifts List Process on page 7 14 View Content Process The following figure shows the process of viewing available content Get Content Select Category Select Content Purchase Content FIGURE 7 2 View Content Process 1 When the subscriber clicks Get Content on the Main Menu the Select Category page generated from _catalog_menu xm1 is shown This page shows the list of categories that are available to the subscriber 2 When the subscriber clicks a category name in the list of categories the Select Content page generated from _catalog_menu xml is shown This page shows the list of content and content bundles that are available to the subscriber 3 When the subscriber clicks an item of content in the content list the Purchase Content page generated from _detail
23. ate your own subscriber adapter using the User Profile API See the Sun Java System Content Delivery Server Customization Guide for information on this API 3 1 Subscriber Adapter Provided Currently the subscriber adapter provided with the Content Delivery Server supports the Lightweight Directory Access Protocol LDAP format The LDAP subscriber adapter uses an XML file to map data between the Content Delivery Server and your LDAP directory 3 1 3 2 Using a Subscriber Adapter To specify the subscriber adapter that you want to use you must set the module security subscriber usermanager property to the fully qualified class name of the subscriber adapter This property is in the security conf file found in the CDS_HOME deployment deployment name conf directory Use one of the values shown in the following table Adapter Value for the module security subscriber usermanager property Oracle com sun content server server securitv user SubscriberImpl Use this value to use the Content Delivery Server database to store all subscriber data This is the default setting LDAP com sun content server server securitv user ldap ldapusermanager LDAPUser Manager Use this value to use an external LDAP directory for subscriber data To use the subscriber adapter for LDAP vou must also provide an XML file that describes the mapping to be used This file is described in Section 3 3 1 Creating the Mapping File fo
24. ated pages are correct move the files created to your production system To generate a version of the Subscriber Portal that is tailored to a specific device or set of devices follow these steps Create an XSL style sheet in the CDS_HOME deployment deployment name markup_generation stylesheets directory Give the new style sheet a name that identifies the device or device category for which the generated pages will be used Import a parent style sheet based on the browser category that the device uses For example if the browser category is XHTML include the statement lt xsl import href XHTML Basic xsl oin the style sheet Follow the structure of the parent style sheet Templates are needed only for those elements that do not render correctly or to take advantage of advanced capabilities that are offered on a device Run the command bin cdsi genmarkup ss stylesheet where stylesheet is the name of the style sheet that you created in Step 1 and does not include the xs1 extension This command processes all of the XML files in the CDS_HOME deployment deployment name markup_generation page defs directory against the new style sheet and generates a set of JSP pages The results are placed in the CDS_HOME deployment deployment name markup_generation jsps stylesheet directory Move the directory that contains the generated JSP pages to the Subscriber Portal application directory on each application server where
25. content validation adapter to be run for that step The following table describes the adapters provided with the Content Deliverv Server TABLE 8 1 Content Validation Adapters Adapter Description APIFilterAdapter Verifies that only APIs allowed by the developer plan assigned to the developer who submitted the content are used It also determines which devices support the APIs that the content uses MIDletValidationAdapter Validates that the byte stream is a MIDlet application archive file CopyrightAdapter Ensures that copyrighted content is not stored locally IAppliValidationAdapter Validates that the byte stream is an iAppli application archive file AddDerivedEditionAdapter Stores the edition that is published stocked and downloaded MIDletSigningAdapter Signs the MIDlet MIDletPermissionsAdapter Adds permissions to the MIDlet Permissions and MIDlet Permissions Opt attributes that are needed to run MIDlets that are instrumented with connected DRM agents DRMAdapter Instruments a MIDlet with the DRM agent MethodRedirectionAdapter Redirects certain method calls to methods that provide the special processing required by MIDlets instrumented with DRM agents If none of the adapters provided meets your needs you can create your own adapter using the Content Validation API See the Sun Java System Content Delivery Server Customization Guide for information on the Content Validation API If the adapter that you writ
26. d Copyrighted Content lt workflow id 4 name Copyrighted External Content Workflow activation manual gt lt desc gt This workflow is used to ensure copyrighted external content is not stored lt desc gt lt step list gt lt step id 1 name AddingDerivedEdition adapter AddDerivedEditionAdapter gt lt desc gt This step adds a downloadable edition derived from the original lt desc gt lt argument list gt lt argument name AddDerivedEdition EditionNameSuffix kind indirect value editionnamesuffix gt lt argument name AddDerivedEdition StoreOriginalBytes kind direct value true gt lt argument list gt lt step gt lt step id 2 name PreventingCopies adapter CopyrightAdapter gt lt desc gt This step removes any locally stored copies of the content Chapter 8 Content Validation Workflows 8 3 CODE EXAMPLE 8 1 Workflow for Externally Hosted Copyrighted Content Continued lt desc gt lt step gt lt step list gt lt workflow gt Each workflow that you define requires the following items A unique workflow ID A list of steps Within the list each step must have a unique ID and name and specify the name of the adapter to be executed A step that executes AddDerivedEditionAdapter This step stores the version of the content that a subscriber downloads There must be at least one step in every workflow that executes this adapter If your workflow mo
27. difies the content to create the edition that is downloaded AddDerivedEditionAdapter must be executed after the steps that perform the modifications and the argument AddDerivedEdition StoreOriginalBytes must be set to false Otherwise the modifications are lost If your workflow creates more than one edition the edition delivered to the subscriber depends on the capabilities of the device If more than one edition matches the device the last edition created that matches is the one delivered For example if steps 2 5 and 7 in your workflow create unique editions of the content and the device is capable of running the editions created in steps 2 and 7 the edition created in step 7 is delivered a An argument list If the adapter used in a step requires arguments the step must include an argument list 8 3 Defining Criteria for the Workflow The workflow that is executed is determined by the criteria defined for the workflow See the section Specifying Workflow Criteria in the Sun Java System Content Delivery Server Installation Guide for information on setting up the criteria for the workflow that you created 8 4 Integration Guide 4 CHAPTER 9 DRM Server Integration One of the options provided with the Content Deliverv Server for protecting content requires an application that implements the Open Mobile Alliance OMA Digital Rights Management DRM 1 0 guidelines for managing digital rights To use this opt
28. e Elements Continued Element Description option Describe the list of items included in a field of tvpe select and optionlist appear under the field element Use option when the list of items text is known Use optionlist when the list is dynamically generated An option contains the following elements name Name of the item e value Value assigned to the item Provides the text for the page and appears under either the view element or a list element The text element generally contains a lt jsp gt tag that contains a lt bean message gt or lt bean write gt tag This element can have the following attributes e alignment Valid values are left right and center e type Valid values are error and bold title Provides the title used for the page and appears under the view view element The title element generally contains a lt jsp gt tag that contains a lt bean message gt or lt bean write gt tag Describes the page and is the top most element All other elements are contained within it For a WML based browser the view represents a card For an HTML based browser the view represents the body This element can have the attribute main Set this attribute to true to include header and footer images on a page Set to false to not include header and footer images The f ollowing code example shows a page that contains a form CODE EXAMPLE 7 1 Sample Page with Form lt xml version 1 lt
29. e Subscriber Portal Note This field is required and must be mapped password Password for the login ID provided Note This field is required and must be mapped uniqueDeviceld Unique ID that identifies the subscriber by the device being used Typically this is the same as the MSISDN Note This field is required and must be mapped firstName First name of the subscriber Note This field is required and must be mapped middleName Middle initial of the subscriber lastName Last name of the subscriber Note This field is required and must be mapped gender Gender of the subscriber streetl Street address for the subscriber street2 Any additional address information required for the subscriber city City information for the subscriber state State information for the subscriber postalcode Postal code for the subscriber country Country where the subscriber resides email Email address for the subscriber used when sending password reminders or campaign notifications Note This field is required and must be mapped phone Phone number for the subscriber activatedate Date on which the subscriber account was activated deactivatedate Date on which the subscriber account was deactivated Integration Guide 2005Q4 TABLE 3 3 Subscriber Data Continued Content Deliverv Server Field Description salutation Salutation by which the subscriber prefers to be addressed enabled Status of the subscriber If no value is provided the default
30. e needs values that cannot be known at the time the adapter is written create a property file for the adapter For example if the adapter needs to know the location of a utility that it uses create a property file that contains a property for the location Set the location property to point to the directory that contains the utility on the system on which the adapter runs Write the adapter to Integration Guide 4 reference the location propertv when the location of the utilitv is needed The property file that you create must be placed in the CDS_HOME deployment deplovment name conf directory If you create your own adapter you must register the adapter by adding a statement in the CDS_HOME deployment deplovment name cont SubmissionVerifierAdapters xml file If the adapter requires values in a property file specify the name of the file in the property file attribute For example if you create an adapter named MyValidationAdapter that requires a property file named Validation properties add the following statement to the file lt adapter id MyValidationAdapter name sample package MvValidationAdapter propertyfile Validation properties gt 8 2 Creating a Workflow A workflow describes the steps taken to validate and protect content submitted to the Content Delivery Server The following code example shows the workflow for externally hosted copyrighted content CODE EXAMPLE 8 1 Workflow for Externally Hoste
31. ean write gt tag e size Size of the field maxlength Maximum length of the data a user can enter e value Default value displayed for the field option or optionlist List of items for a field that is of type select See the description for option optionlist in this table Describes a form for the page and appears under the view element A view can have only one form A form contains the following elements action Action that is executed when the form is submitted button Button on the form A form can contain multiple buttons See the description for button in this table e field Field on the form A form can contain multiple fields See the description for field in this table Integration Guide 4 TABLE 7 2 Element Page Elements Continued Description image link list navbar navspacer Provides an image for a page Advanced devices can add images in other places An image can contain the following elements name Name of the file that contains the image The style sheet provides the path and the suffix for the image For example if the image is in web images logo gif set name to logo Do not include this element if the path element is included path URL path to the file that contains the image for example http serverl com web images logo gif Do not include this element if the name element is included alt Alternate text for an image This element general
32. egories Chapter 7 Device Specific User Interface Framework 3 7 4 The pages for the device based Subscriber Portal are defined once using XML The XML files are then processed with each existing stvle sheet to generate the JSP pages for each version of the Subscriber Portal that is needed The following table describes the elements that can be used in each page TABLE7 2 Page Elements Element Description button divider field form Provides a button for a form and is used to submit data This element appears under a form element A button can contain the following elements label The string displayed on the button This element generally contains a lt jsp gt tag that contains a lt bean message gt or lt bean write gt tag name A string used to identify the button to the handler that processes the form Adds a horizontal line to a page Provides a field on a form in which a user can enter information and appears under a form element This element can have the attribute multiple Set this attribute to true to indicate that a field of type select allows multiple items to be selected A field can contain the following elements name Name of the field This name maps to the form bean type Type of field for example text password select or text area label Label that appears on the form This element generally contains a lt jsp gt tag that contains a lt bean message gt or lt b
33. elds Processes and Page Usage The following sections describe the general process flow of the primary functions of the Subscriber Portal These descriptions identify the pages shown to subscribers on their device and the files used to generate the pages The files are described in TABLE 7 1 Log In Process The following figure shows the process of logging in to the Subscriber Portal and the options available after the subscriber is logged in The description that follows the figure identifies the XML file used for each page Chapter 7 Device Specific User Interface Framework 7 9 7 10 CDS Log In Main Log In Menu Error Get 5 h i e earc l i Content Content Settings rase s gt D l I l M I l My I I l 3 I l y DI l 1 l i 0 Downloads 1 i Wish List 1 ee l optional optional i i i 4 ne aj ES a 4 FIGURE 7 1 Log In Process 1 The CDS Log In page generated from _login xml is the first page shown to the subscriber 2 If login is successful the main page of the Subscriber Portal generated from _main_menu xml is shown If the login fails an error is shown on the CDS Log In page If the subscriber s account is disabled or the login fails three times in a row a page in which the login is disabled generated from login disabled xml is shown 3 From the Main Menu page the following actions are available
34. ent Details page generated from detail xmi is shown From this page the subscriber can download the item purchase the item for a friend or tell a friend about the item See Section 7 1 3 9 Purchase Process on page 7 15 for information on the purchase process View My Wish List Process My Wish List is available on the Main Menu page only if the subscriber added content to the wish list when browsing content using the PC based Subscriber Portal When the subscriber clicks My Wish List the My Wish List page generated from _catalog_menu xml is shown This page shows the list of content that the subscriber has downloaded When the subscriber selects an item of content the Purchase Content page generated from _detail xml is shown See Section 7 1 3 9 Purchase Process on page 7 15 for information on the purchase process View the My Gifts List Process The My Gifts list is available on the Main Menu page only if the subscriber received a gift or purchased a gift for another subscriber When the subscriber clicks My Gifts the My Gifts page generated from mv gifts menu xmil is shown If the subscriber received a gift the My Gifts page has a link for Gifts Received When the subscriber clicks the Gifts Received link the Gifts Received page generated from _catalog_menu xm1 is shown This page shows the list of content that the subscriber received as gifts When the subscriber selects an item of content the details for
35. erver edit the push properties in the MsgServices properties and CommonMsg properties files in the CDS_HOME deployment deployment name conf directory See the Sun Java System Content Delivery Server Installation Guide for additional information To specify the push listener adapter that you want to use follow these steps Register the adapter with the Content Delivery Server To register the adapter create an XML file named pushlistenerfactory xml in the CDS_HOME deployment deployment name conf directory See Section 6 3 2 Sample pushlistenerfactory xml on page 6 5 for an example of this file Include the adapter class and any dependent classes in your class path If you did not do so when you installed the Content Delivery Server edit the push properties in the PushListener properties and CommonMsg properties file in the CDS_HOME deployment deployment name conf directory See the Sun Java System Content Delivery Server Installation Guide for details 6 4 Integration Guide 9 2005Q4 6 3 6 3 1 CODE EXAMPLE 6 1 Sample Registration File This section includes samples of the pushsenderfactory xml file and the pushlistenerfactory xml file Use these files to register the push adapters that you want to use Sample pushsenderfactory xml The pushsenderfactory xml file is used to register the push sender adapters that you choose to use As shown in the following code example the pushmsgsender
36. eway API 5 1 WAP push sender adapter 6 3 wapgateway config file 5 3 WML 1_1 xsl 7 8 WML 1_2 xsl 7 8 workflow creating 8 3 criteria 8 4 overview 8 1 X XHTML Alternate xsl 7 9 XHTML AU xsl 7 9 XHTML Basic xsl 7 8 XHTML Color xsl 7 8 XHTML IAppli xsl 7 9 XHTML Motorola xsl 7 9 XHTML NokiaSeries40 xsl 7 9 XHTML SE xsl 7 9 XHTML Symbian xsl 7 9 XHIML UPxsl 7 9 XML file pushlistenerfactory xml 6 4 pushsenderfactory xml 6 4 xml record xsi file 2 2 Index 3 Index 4 Integration Guide 2005Q4
37. factory xml file as described in Section 6 2 Using a Push Adapter on page 6 4 6 2 Integration Guide 4 6 1 1 2 6 1 1 3 6 1 1 4 6 1 2 WAP Push for Messages This adapter supports push delivery using WAP push Use the class com sun content server server msgserver push WAPPushMsgSender as your adapter Specify this adapter in the pushsenderfactory xml file as described in Section 6 2 Using a Push Adapter on page 6 4 If your WAP push proxy gateway PPG requires attributes other than what is currently included in the message template you must update the wap push template xsi file This file is in the CDS HOME deplovment deployment name con directory SMTP Push for Messages This adapter supports push delivery using SMTP Use the class com sun content server server msgserver push SMTPPushMsgSender as your adapter Specify this adapter in the pushsenderfactory xml file as described in Section 6 2 Using a Push Adapter on page 6 4 SMS Push for Binary Content If you want to push binary content to devices you must create your own adapter using the Messaging API Use the push category to determine whether binary content or a message is sent The constant PUSH_CONTENT_BINARY_CATEGORY defined in the PushConstants class identifies messages that contain binary content See the Sun Java System Content Delivery Server Customization Guide for information on the Messaging API and the PushConstants cla
38. generated JSP pages to the Subscriber Portal application directory on each application server where you deployed a Subscriber Portal a For Sun Java System Application Server CDS_HOME deployment deployment name sun domains server domain server name applications j2ee modules CDSSubscriberPortal 1 device For WebLogic Server CDS_HOME deployment deplovment name weblogic domains server domain applications subscriberportal devic 4 Create a handler that contains the business logic for the new page The handler must extend e com sun content server server webapps device BaseDeviceHandler See the output of the Javadoc utility in the directory that contains the documentation for the Content Deliverv Server for information on this class Place the compiled class in a Java Archive JAR file in one of the following locations For Sun Java System Application Server CDS_HOME deployment deployment name sun domains server domain server name applications j2ee modules CDSSubscriberPortal 1 WEB INF lib 7 20 Integration Guide 4 m For WebLogic Server CDS_HOME deployment deplovment name weblogic domains server domain applications subscriberportal WEB INF 1ib The following code example shows a sample handler that determines if the Terms and Conditions page should be shown CODE EXAMPLE 7 4 Sample Handler Copyright c 2004 Sun Microsystems Inc All rights
39. he language to be used Customize Categories When this option is selected the Manage Categories page generated from _manage_category xml is shown This page enables the subscriber to choose the categories to be shown and the order in which the categories are shown View Promotions Process The Promotions option is available on the Main Menu page only if campaigns are set up in the Vending Manager When the subscriber clicks Promotions the Promotions page generated from _catalog_menu xml is shown This page shows the list of promotions that are available When the subscriber selects a promotion the details for that promotion generated from _campaign xml are shown When the subscriber clicks an item of content included in the promotion the Purchase Content page generated from _detail xml is shown From this page the subscriber can download the item or purchase the item for a friend See Section 7 1 3 9 Purchase Process on page 7 15 for information on the purchase process View the Mv Downloads List Process The My Downloads list is available on the Main Menu page only if the subscriber previously purchased content When the subscriber clicks My Downloads the My Downloads page generated from catalog menu xml is shown This page shows the list of content that the subscriber has purchased Chapter 7 Device Specific User Interface Framework 7 13 7 1 3 7 7 1 3 8 When the subscriber selects an item of content the Cont
40. idDefaultHandler 2 2 preferences set 7 12 process log in 7 9 purchase 7 15 search for content 7 12 set preferences 7 12 view content 7 11 view Mv Downloads 7 13 view My Gifts 7 14 view Mv Wish List 7 14 view promotions 7 13 properties DRM Mobile 9 2 purchase 7 15 push adapter definition 6 1 listener 6 3 sender 6 2 pushlistenerfactory xml file 6 4 6 5 pushsenderfactory xml file 6 4 6 5 5 securitv config file 3 2 single sign on 4 1 SMPP SMS push listener 6 4 SMS push sender 6 2 SMS HTTP 6 2 SMS push binarv content 6 3 messages 6 2 SMS push sender adapter 6 2 SMTP push sender adapter 6 3 struts config xml file 7 22 style sheet 7 8 subscriber adapter defined 3 1 subscriber adapter LDAP 3 1 subscriber integration 3 1 Subscriber Portal device specific page elements 7 4 generating pages for a device 7 17 modifying pages 7 18 pages 7 2 process log in 7 9 purchase 7 15 search for content 7 12 set preferences 7 12 view content 7 11 view My Downloads 7 13 view My Gifts 7 14 view My Wish List 7 14 view promotions 7 13 style sheets for 7 8 user interface framework 7 1 T tuning LDAP 3 7 typographical conventions xii U user interface framework 7 1 User Profile API 3 1 Ww wait time for LDAP 3 3 WAP gateway adapter default 5 2 definition 5 1 Nokia Activ Server 2 0 1 5 2 Nokia Artus WAP gateway 5 2 Openwave WAP gateway 5 3 WAP Gat
41. iguration A WAP gateway serves as a translator between web protocols and wireless protocols You can configure the Content Delivery Server to work with the WAP gateway of your choice A WAP gateway adapter parses the HTTP header from a WAP gatewav to retrieve the MSISDN number device profile and other attributes needed by the Content Delivery Server The WAP gateway adapters provided with the Content Delivery Server are described in Section 5 1 WAP Gateway Adapters Provided on page 5 1 You can create your own WAP gateway adapter using the WAP Gateway API See the Sun Java System Content Delivery Server Customization Guide for information on this API 5 1 WAP Gatewav Adapters Provided The Content Deliverv Server provides a default WAP gatewav adapter that can be used with anv WAP gatewav that does not require the value returned for the unique ID or MSISDN to be parsed In addition adapters for the following WAP gatewavs are provided with the Content Deliverv Server Nokia Activ Server 2 0 1 Nokia Artus WAP Gateway Openwave WAP Gateway 5 1 5 1 1 9 1 2 Default WAP Gateway Adapter The default WAP gateway adapter can be used with any WAP gateway that can use the unique ID or MSISDN value in the format that it is received If the value must be parsed you must use an adapter created specifically for the WAP gateway that you are using To use the default adapter follow these steps Set the defau
42. ing svstem String that identifies the group to which the content belongs Text of the request from the subseriber for example the MO push request content Message included with the gift Number of times the recipient downloaded this gift including this time Number of subscription periods used by the recipient including this period Date that the gift was first downloaded bv the recipient Date bv which the gift must be claimed bv the recipient Date the gift was purchased by the giver Number of downloads included in the gift Number of subscription periods included in the gift Flag that indicates whether the content is alreadv on the device Flag that indicates whether the subscriber has prepaid for the content Subscriber s locale MSISDN for the subscriber device Message sent to the subscriber s device or email Locale of the intended recipient of the content Login ID of the intended recipient of the content Mobile ID of the intended recipient of the content Unique device ID of the intended recipient String that identifies the Vending Manager String that identifies the subscriber s session Integration Guide 4 TABLE2 1 Billing Event Parameters Continued Parameters Description source address subscription expiration subscription frequency subscription recurring subscription price timestamp unique device id usage count usage price user id username vend
43. ing a JMS client The JMS client uses the billing adapter to format the information for your billing system A billing adapter for prepaid or synchronous billing is called by the Content Delivery Server as the purchase is being processed The adapter can dynamically change the price of content if desired validate the purchase in real time or manage billing through an external system such as premium SMS You can create your own postpaid billing adapter using the Event Service APT if the adapter provided does not meet your needs You can create your own prepaid billing adapter using the Billing API See the Sun Java System Content Delivery Server Customization Guide for information on these APIs 2 1 Billing Adapter Provided For postpaid billing the Content Deliverv Server provides the Postpaid Service This service includes a JMS client that processes the billing events in the event queue and generates a file that contains the information that vour billing svstem can use to charge subscribers The file format can be XML comma separated values CSV or name value pairs See Section 2 2 Working with the Postpaid Service on page 2 2 No prepaid billing adapters are provided 2 1 2 2 Working with the Postpaid Service The Postpaid Service supports billing systems that charge subscribers after content has been purchased You can use the Postpaid Service instead of a customized billing adapter if your billing system suppor
44. ing res id Address of the external entitv from which the message was received for example the MSISDN of the SMSC Date that the subscription period ends How often the subscription price is charged Fag that indicates whether the subscriber should be automaticallv charged for the next period when the current subscription period ends Price of the subscription period Time at which the transaction occurred String that uniquely identifies the device used Number of uses allowed for the price specified for usage price Price charged for the number of uses specified for usage count String that identifies the user who initiated the transaction Login name for the subscriber String bv which the Vending Manager identifies the content Chapter 2 Billing Integration 2 5 2 6 Integration Guide 9 2005Q4 CHAPTER B Subscriber Integration The Sun Java System Content Delivery Server uses an Oracle database to manage subscriber profiles If you already have extensive subscriber data you do not need to duplicate this information The Content Delivery Server can be configured to work with your existing subscriber data A subscriber adapter maps external subscriber data to the data required by the Content Delivery Server when processing subscriber related functions The subscriber adapter provided with the Content Delivery Server is described in Section 3 1 Subscriber Adapter Provided on page 3 1 You can cre
45. ining what hardware and software is needed to efficiently run the Content Delivery Server Describes how to submit content to the Content Delivery Server Describes the Content Delivery Server APIs that can be used to create customized adapters for use in integrating Content Delivery Server with the existing infrastructure Describes error messages that are generated by the Content Delivery Server and suggests actions to take to resolve problems reported Provides information about installing and configuring the Content Delivery Server Describes how to migrate from the previous version of the Content Delivery Server to the current version Provides information on running and maintaining the Content Delivery Server 819 3209 10 819 3210 10 819 3211 10 819 3212 10 819 3213 10 819 3214 10 819 3215 10 819 3217 10 819 3218 10 Preface xiii Sun Welcomes Your Comments Sun is interested in improving its documentation and welcomes vour comments and suggestions To share your comments go to http 6068 sun com and click Send Comments In the online form provide the document title and part number xiv Integration Guide 4 CHAPTER 1 Introduction The Content Deliverv Server is a software solution that helps vou manage and deliver applications and static content over the air OTA to your subscribers Due to the flexibilitv of the architecture vou do not need to change the wav that
46. ion you must provide the application that the Content Delivery Server works with For this release Content Deliverv Server provides support for SafeNet DRM Mobile as the OMA DRM 1 0 implementation This chapter describes how to integrate the Content Deliverv Server with DRM Mobile For information on configuring DRM support in the Content Deliverv Server see the Sun Java System Content Delivery Server Installation Guide For information on applying DRM to content see the Sun Java System Content Delivery Server Administration Guide 9 1 Setting Up DRM Mobile DRM Mobile can be obtained from SafeNet See http www safenet inc com products sentinel DRM Mobile asp for information Install DRM Mobile on the server on which the Catalog Manager is deploved Use the instructions provided with DRM Mobile DRM Mobile consists of a protection component and a license component Install both components with the Catalog Manager Create an operator user in DRM Mobile for accessing the protection component and the license component If vou do not want to use the same user name for both components create a content provider user to access the protection component and a content distributor user to access the license component 9 1 Note the user names and passwords for the users that vou created as well as the URL needed to access the DRM Mobile components Xou need this information to configure the Content Deliverv Server to use DRM Mobile a
47. is enabled msisdn TMSISDN number for the subscriber used when sending messages to the subscriber s device Note This field is required and must be mapped The mapping is contained in the lt mapping gt lt mapping gt section of the XML file The mapping element has the following attributes m isDeletable Set to true to allow user records to be deleted by the Content Delivery Server Set to false to prevent user records from being deleted m isAddable Set to true to allow user records to be created by the Content Delivery Server Set to false to prevent user records from being created Each element in the mapping section can have one or more of the following attributes m isRequired Set to true to indicate that the mapped field must not be null or empty Set to false to indicate that the mapped field can be null or empty If this attribute is set to true and a null or empty value is returned from the LDAP directory an error message is generated m isModifiable Set to true to allow the field to be modified by Content Delivery Server Set to false to prevent the field from being modified isMultiple Set to true to indicate that more than one field in LDAP maps to the field in the Content Delivery Server If this attribute is true you must include a valuen element for each LDAP field where n is a sequential number from 0 to number of fields 1 For example if the uniqueDeviceld field maps to handset ID and mobileID
48. ish List Process 7 14 7 1 3 8 View the My Gifts List Process 4 7 1 3 9 Purchase Process 7 15 7 2 Generating Pages for a Specific Device 7 7 3 Modifying Pages for All Devices 8 74 Adding a Custom Page 7 19 Content Validation Workflows 8 1 8 1 Creating a Content Validation Adapter 8 1 8 2 Creating a Workflow 8 3 8 3 Defining Criteria for the Workflow 8 4 DRM Server Integration 9 1 9 1 Setting Up DRM Mobile 9 1 92 Configuring the Content Delivery Server to Use DRM Mobile 2 Index Index 1 Contents v vi Integration Guide 4 FIGURE 7 1 FIGURE 7 2 FIGURE 7 3 FIGURE 7 4 FIGURE 7 5 Figures Log In Process 7 10 View Content Process 1 Search for Content Process 7 12 Set Preferences Process 7 13 Purchase Process 5 vii viii Integration Guide 7 2005Q4 Tables TABLE 2 1 TABLE 3 1 TABLE 3 2 TABLE 3 3 TABLE 3 4 TABLE 7 1 TABLE 7 2 TABLE 8 1 TABLE 9 1 Billing Event Parameters 2 2 Configuration Properties 3 LDAP Properties 3 3 Subscriber Data 3 4 Data for Sample LDAP File 3 6 XML Files for Subscriber Portal Pages 7 2 Page Elements 4 Content Validation Adapters 2 Properties for DRM Mobile 9 2 Integration Guide 2005Q4 Preface The Sun Java System Content Delivery Server Integration Guide describes the adapters provided with the Content Deliverv Server These adapters enable vou to integrate the Content Deliverv Server with common svstems and protocols that vou are
49. lt unique http_header key property in the CDS_HOME deployment deployment name conf SubscriberPortal properties file to the key used to retrieve the unique ID or MSISDN for example default unique http_header key x up subno Make sure that the adapter is registered See Section 5 2 Using a WAP Gateway Adapter on page 5 3 for instructions Nokia Activ Server 2 0 1 The Nokia Activ Server WAP gateway adapter parses the HTTP headers from the Nokia Activ Server WAP gateway and passes the information to the Content Delivery Server To use this adapter register the following class com sun content server service gateway nokia NokiaActivServerWAPGateway 6 13 Nokia Artus WAP Gateway The Nokia Artus WAP gateway adapter parses the HTTP headers from the Nokia Artus WAP gateway and passes the information to the Content Delivery Server To use this adapter register the following class com sun content server service gateway nokia NokiaArtusWAPGateway 5 2 Integration Guide 9 2005Q4 5 1 4 Openwave WAP Gatewav The Openwave WAP Gatewav parses the HTTP headers from the Openwave WAP gatewav and passes the information to the Content Deliverv Server To use this adapter register the following class com sun content server service gatewav openwave OpenwavewAPGatewav 5 2 Using a WAP Gateway Adapter To register the WAP gateway adapter that you want to use add the class name to the wapgateway config file in the CDS_HOM
50. ly contains a lt jsp gt tag that contains a lt bean message gt or lt bean write gt tag Provides a link on the page and appears under either the navbar element or as a list element A link contains the following elements e name Text displayed on the page e url URL to which the link points accesskey Flag that indicates whether to include a shortcut key to access the item Set to true to include an access key Set to false or omit the element to not include an access key This attribute is ignored if a browser cannot handle access keys For example the following code segment shows a link to a page outside of the Subscriber Portal lt link gt lt name gt Yahoo lt name gt lt url gt lt jsp gt http wap yahoo com lt jsp gt lt url gt lt link gt Provides a list of items for a page and appears under the view element The list element contains one or more item elements An item element contain either a link element or a text element Provides a set of links that are displayed as a group such as ok and cancel or yes and no These links are automatically separated by a navspacer The navbar element appears under the view element and can have the attribute orientation Valid value are horizontal and vertical The default is vertical Note Some browsers might not have the capability to group the links Divides items in a navbar Chapter 7 Device Specific User Interface Framework 7 5 TABLE7 2 Pag
51. mission verifier workflows A workflow typically includes steps to validate the content Content that does not require special processing must be processed by the default workflow The workflows provided with Content Delivery Server are defined in the CDS_HOME deployment deployment name con SubmissionVerifierWorkflows xml file Workflows are provided for the following types of content m Java technology based applications Java applications m iAppli applications that use the Doja library Copyrighted externally hosted content m Other content Use of the workflows provided with the Content Delivery Server is described in the Sun Java System Content Delivery Server Installation Guide If these workflows do not meet your needs you can create your own This chapter presents the following topics Creating a Content Validation Adapter Creating a Workflow Defining Criteria for the Workflow 8 1 Creating a Content Validation Adapter A content validation adapter processes the content that is submitted to the Content Delivery Server according to the purpose of the adapter Any preprocessing that is required before the content is accepted can be handled by an adapter For example 8 1 8 2 adapters can be used to verifv that the content meets the guidelines established bv your enterprise add code for digital rights management DRM or obfuscate the code Each step in a workflow must include the name of the
52. msisdn gt lt mapping gt lt ldapusermanager gt 3 3 2 Tuning LDAP When using an LDAP directory as the subscriber database you might want to create an index on the attribute mapped to the unique device ID to improve performance See the documentation for the LDAP directory that you are using for instructions on creating an index Create the index on the attribute that is mapped to uniqueDeviceId in the mapping file that you created Creating an index is resource intensive and could affect system performance Choose a time to create the index that is least likely to impact users Chapter 3 Subscriber Integration 3 7 3 8 Integration Guide 9 2005Q4 CHAPTER 4 Single Sign on Support The Sun Java System Content Delivery Server supports single sign on Single sign on makes it possible for a subscriber who has signed on to an operator s service to access content provided by the Content Delivery Server without having to sign on again 4 1 Using the MSISDN Number Through the WAP Gateway Single sign on is achieved through the use of the MSISDN number This number is provided through the WAP gateway that you have configured the Content Delivery Server to use see Section WAP Gateway Configuration on page 5 1 The Content Delivery Server uses the MSISDN Mobile Station Integrated Services Digital Network number to authenticate users 4 1 4 2 Integration Guide 4 CHAPTER 5 WAP Gateway Conf
53. on deployment FileConte ntHost outputPath property in the DRM Mobile protectionConfig properties file See the DRM Mobile documentation for information on the proper format for this value Domain name used to generate unique IDs for the protected content for example using sun com as the domain generates IDs similar to cid 2001 SD sun com 9 2 Integration Guide 9 2005Q4 TABLE9 1 Properties for DRM Mobile Continued Propertv Description license url URL used to access the license component of DRM Mobile license username User name used to access the license component of DRM Mobile license password Password for the user name used to access the license component of DRM Mobile license rightsIssuerUrl URL used to access the license for content when separate delivery is used for example http www sun com cds cid cid The Content Delivery Server replaces the value inside the braces with the content ID for the content that the subscriber is accessing If you did not enable the OMA DRM 1 0 method when you deployed and configured the Content Delivery Server use the following command to enable this method cdsi db import conf db configuration file cs enableomadrm10 sqli db configuration file is the name of the database configuration file that contains the information for creating the Catalog Manager schema If db configuration file is not provided the value specified for the DEFAULT_DB variable in the init_env sh script
54. own as described for the Purchase option Buy for a Friend Subscribers can purchase content as a gift for another subscriber by clicking Buy for a Friend a The Buy for a Friend page generated from share content xml is shown b After the information for the recipient is provided the Confirm Purchase page generated from share content confirm xmil is shown c If the request completes successfullv a notification page generated from share content success xml is shown The message that the recipient of the gift receives includes a link to the gift When the recipient clicks the link and accesses the Subscriber Portal a notification about the gift generated from share content receive xmi is shown Tell a Friend Subscribers can notifv another subscriber of content in which they might be interested bv clicking Tell a Friend The Tell a Friend page generated from share content xm1 is shown If the request completes successfully a notification page generated from share content success xml is shown The message sent to the friend includes a link to the content When the recipient clicks the link and accesses the Subscriber Portal a notification about the content generated from share content receive xmi is shown Integration Guide 9 2005Q4 72 Generating Pages for a Specific Device Generate the device specific pages on a test system to avoid disrupting the production system When you are sure that the gener
55. properties must include the fully qualified name of the push adapter class and the protocol that the adapter supports The following sample registers an adapter for each type of push sender supported Sample pushsenderfactory xml File 6 3 2 lt pushmsgsenderset gt lt pushmsgsender0 class com sun content server server msgserver push TestSMSPushMsgSenderImp1 protocol lt pushmsgsender1 class com sun content server server msgserver push WAPPushMsgSender protocol lt pushmsgsender2 class com sun content server server msgserver push SMTPPushMsgSender protocol lt pushmsgsender3 class com sun content server server msgserver push MMSPushMsgSender protocol lt pushmsgsenderset gt sms gt wap gt smtp gt mms gt Sample pushlistenerfactory xml The pushlistenerfactory xml file is used to register the push listener adapter that you choose to use The pushmsglistener properties must include the fully qualified name of the push adapter class and the protocol that the adapter supports Chapter 6 Push Delivery 6 5 The following sample registers the adapter for CIMD2 CODE EXAMPLE 6 2 Sample pushlistenerfactory xml File lt pushmsglistenerset gt lt pushmsglistener0 class com sun content server server msgserver protocol cimd2 CIMD2PushMsgListener protocol sms gt lt pushmsglistenerset gt 6 6 Integration Guide 9 2005Q4 CHAPTER 7 Device Specific User Interface
56. r LDAP on page 3 2 De Working with LDAP This section provides additional information on setting up your system to work with the Content Delivery Server when your subscriber data is stored in an LDAP directory Section 3 3 1 Creating the Mapping File for LDAP on page 3 2 describes how to create a file that maps the fields in the LDAP directory to the fields in the Content Delivery Server Section 3 3 2 Tuning LDAP on page 3 7 describes how to set up LDAP to improve performance 3 3 1 Creating the Mapping File for LDAP To use subscriber data in an LDAP directory you must create a mapping file in XML that maps the data needed by the Content Delivery Server to the information in the LDAP directory The conf xm1 file in the CDS_HOME deployment deployment name conf directory contains a sample mapping Edit this file and save your version to a new file in the same directory for example cdsmapping xml 3 2 Integration Guide 4 3 3 1 1 Section 3 3 1 1 Subscriber Data for the Content Delivery Server on page 3 3 identifies the data that must be provided to the Content Delivery Server Section 3 3 1 2 Sample Mapping File on page 3 6 provides a sample file Subscriber Data for the Content Delivery Server The first few lines of the mapping file contain the connection information for the LDAP server The following tables describe the properties in the mapping file TABLE 3 1 describes the configuration prope
57. r end users whether direct or indirect are strictly prohibited Export or reexport to countries subject to U S embargo or to entities identified on U S export exclusion lists including but not limited to the denied persons and specially designated nationals lists is strictly prohibited DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID Copyright 2005 Sun Microsystems Inc 4150 Network Circle Santa Clara California 95054 Etats Unis Tous droits r serv s Sun Microsystems Inc d tient les droits de propri t intellectuels relatifs la technologie incorpor e dans le produit qui est d crit dans ce document En particulier et ce sans limitation ces droits de propri t intellectuelle peuvent inclure un ou plus des brevets am ricains list s l adresse http www sun com patents etun ou les brevets suppl mentaires ou les applications de brevet en attente aux Etats Unis et dans les autres pays Cette distribution peut comprendre des composants d velopp s par des tierces parties Sun Sun Microsystems le logo Sun JavaServer Pages JSP Javadoc et Java sont des marques de fabrique ou des marques d pos es de Sun Microsystems Inc aux Etats Unis et dans d autres pays
58. riberPortal 1 WEB INF m For WebLogic Server CDS_HOME deployment deplovment name weblogic domains server domain applications subscriberportal WEB INF a Remove the following section of code lt action path device provision type com sun content server server webapps device ProvisionUserHandler gt lt forward name device select _ locale path dv5 do gt lt forward name success path dv42 do gt lt action gt b Add the following code in place of the section that you removed lt action path device_provision type com sun content server server webapps device ProvisionUserHandler gt lt forward name device_select_locale path dv5 do gt lt forward name success path check_new_page do gt lt action gt lt action path check_new_page type com sun content server cdsexample CheckNewPageHandler gt lt forward name show page path device_show_new_page do gt lt forward name do not show page path device direct url do 2 lt action gt lt action path device show new page tvpe com sun content server server webapps device ReturnSuccessHandler lt forward name success path View pg new page jsp gt lt action gt 6 Restart the server 7 22 Integration Guide 4 CHAPTER 8 Content Validation Workflows Content submitted to the Sun Java System Content Delivery Server goes through a validation process that is managed by the sub
59. rties that must be set TABLE 3 1 Configuration Properties Property Description search_scope Scope of the search Specify one of the following values e 0 Searches the named object e 1 Searches only one level of the named object This is the default e 2 Searches the entire sub tree of the named object max search wait time Maximum time in milliseconds that LDAP executes a search request TABLE 3 2 describes the properties that define vour LDAP environment TABLE 3 2 LDAP Properties Propertv Description initial_context_factory Fullv qualified class name of the initial context factory provider url URL of the provider LDAP server Note If vou are using Sun Java Svstem Application Server the URL must not contain spaces prefix Prefix used username User distinguished name used to access LDAP password Password associated with the user name master username User name for the master server This propertv is optional master password Password associated with the master user name This propertv is optional object One or more objects from LDAP Chapter 3 Subscriber Integration 3 3 TABLE 3 3 identifies the subscriber data used bv the Content Deliverv Server Add an element with the field name in the XML file that vou create The required fields are noted TABLE 3 3 Content Deliverv Subscriber Data Server Field Description logini Login ID used by the subscriber to access th
60. ry Server with existing processes m The device specific user interface framework enables you to tailor the pages of the Subscriber Portal to suit the capabilities of the device on which it is viewed This framework helps to ensure the best possible experience for your subscribers 1 1 Content validation workflows enable you to customize the process for accepting content that is submitted to the Content Delivery Server You can create different workflows for specific types of content You can use content validation adapters provided with the Content Delivery Server or write your own adapters to perform such functions as verifying the content or adding code for digital rights management Integration with a digital rights management DRM server enables content to be protected from unauthorized distribution and use based on the Open Mobile Alliance OMA DRM 1 0 guidelines 1 2 Integration Guide 4 CHAPTER 2 Billing Integration Xou do not need to change vour billing implementation to use the Content Deliverv Server Xou can configure the Content Deliverv Server to work with vour current billing svstem through the use of billing adapters A billing adapter for postpaid or asvnchronous billing converts the information provided bv the Content Deliverv Server to the format needed bv vour billing svstem The Content Deliverv Server posts billing events to a Java Message Service JMS queue You can receive these billing events us
61. s described in the next section 9 2 Configuring the Content Delivery Server to Use DRM Mobile After you install DRM Mobile and set up the required users set the properties shown in the following table These properties are in the CDS_HOME deployment deployment name conf drmmobile properties file Set these properties in the Catalog Manager deployment and in each Vending Manager deployment Note This file contains unencrypted passwords Set the file permissions to restrict access to this file TABLE9 1 Properties for DRM Mobile Property Description protection url protection username protection password protection uploadDirectory protection deplovDirectorv protection domain URL used to access the protection component of DRM Mobile User name used to access the protection component of DRM Mobile Password for the user name used to access the protection component of DRM Mobile Directorv from which DRM Mobile accesses the unprotected content and uses for temporarv files created during the protection process These files are deleted when the protection process completes Note The directorv specified must be the same as the directorv specified for the java io tmpdir property in the DRM Mobile protectionConfig properties file Directory to which DRM Mobile writes the protected content Note The directory specified must be the same as the directory specified for the com dmdsecure mobile protecti
62. sS amp o SUN microsystems Sun Java System Content Delivery Server 5 0 Integration Guide 2005Q4 Sun Microsystems Inc www sun com Part No 819 3216 10 Submit comments about this document at http docs sun com app docs form comments Copyright 2005 Sun Microsystems Inc 4150 Network Circle Santa Clara California 95054 U S A All rights reserved Sun Microsvstems Inc has intellectual propertv rights relating to technologv embodied in the product that is described in this document In particular and without limitation these intellectual property rights may include one or more of the U S patents listed at http www sun com patents and one or more additional patents or pending patent applications in the U S and in other countries U S Government Rights Commercial software Government users are subject to the Sun Microsystems Inc standard license agreement and applicable provisions of the FAR and its supplements This distribution may include materials developed by third parties Sun Sun Microsystems the Sun logo JavaServer Pages JSP Javadoc and Java are trademarks or registered trademarks of Sun Microsystems Inc in the U S and other countries Products covered by and information contained in this service manual are controlled by U S Export Control laws and may be subject to the export or import laws in other countries Nuclear missile chemical biological weapons or nuclear maritime end uses o
63. ss If you write your own adapter specify this adapter in the pushsenderfactory xml file as described in Section 6 2 Using a Push Adapter on page 6 4 Push Listener Adapter The Content Delivery Server provides push listener adapters for an SMSC that supports CIMD2 or SMPP To use the CIMD2 adapter specify the class com sun content server server msgserver protocol cimd2 CIMD2Push MsgListener in the pushlistenerfactory xml file as described in Section 6 2 Using a Push Adapter on page 6 4 Chapter 6 Push Delivery 6 3 To use the SMPP adapter specifv the class com sun content server server msgserver protocol smpp SMPPPushMsg Listener in the pushlistenerfactorv xml file as described in Section 6 2 Using a Push Adapter on page 6 4 6 2 Using a Push Adapter Set up the Content Deliverv Server to support the push sender adapter and the push listener adapters that vou want to use To specifv the push sender adapters follow these steps Register the adapters with the Content Deliverv Server To register the adapters create an XML file named pushsenderfactory xml in the CDS_HOME deployment deployment name conf directory Only one SMS push adapter can be specified See Section 6 3 1 Sample pushsenderfactory xml on page 6 5 for an example of this file Include the adapter class and any dependent classes in your class path If you did not do so when you installed the Content Delivery S
64. t bean encodedmessage key device newPage continue gt gt lt jsp gt lt name gt lt url gt lt jsp gt Web getWeb getActionURL device direct url do null response lt jsp gt lt url gt lt link gt lt navbar gt lt view gt Chapter 7 Device Specific User Interface Framework 9 2 Add the strings used in the page definition to each language version of the SubscriberPortalLocaleResource properties file in the 5605 HOMI localization directorv zH The name of the properties that vou add corresponds to the values that vou specified for the kev parameters for example device newPage title Terms and Conditions device newPage instructions Here are the latest updates to the site s Terms and Condition device newPage continue Continue 3 Generate all the pages for the Subscriber Portal a Run the command bin cdsi genmarkup ss all This command processes all of the XML files in the CDS_HOME deployment deployment name markup_generation page defs directory against all of the style sheets in the CDS_HOME deployment deployment name markup_generation stylesheets directory and generates a new set of JSP pages for each style sheet Each set of pages is placed in the CDS_HOME deployment deployment name markup_generation jsps stylesheet directory where stylesheet is the name of the style sheet used to generate the pages b Move the directories that contain the
65. the developer who submitted the content Flag that indicates whether a confirmation is required after a successful download Number of times the content can be downloaded for the price paid Number of times the subscriber has downloaded this content including this time Flag that indicates whether the download period has expired Time period during which the content can be downloaded without additional charge to the subscriber Price of the content purchased Flag that indicates this is a purchase request Flag that indicates whether the subscriber is charged for each download Name of the event log Message issued with the event Chapter 2 Billing Integration 2 3 TABLE 2 1 Parameters Billing Event Parameters Continued Description event source tvpe id event tvpe event tvpe id external content id external group id external request text gift message gifted current downloads gifted current subscriptions gift download date gift expiration date gift purchase date gifted downloads gifted subscriptions is on device is prepav locale msisdn push msgtext recipient locale code recipient login id recipient mobile id recipient unique device id server id session id Number that identifies the source of the event Numeric representation of the event that occurred String that identifies the tvpe of event that occurred String that identifies the content to the bill
66. the gift generated from _gift_details xml are shown If the subscriber wants to accept a gift the Download Gift link is clicked and the Download page generated from _download xm1 is shown If the subscriber purchased a gift for another subscriber the My Gifts page has a link for Gifts Sent When the subscriber clicks the Gifts Sent link the Gifts Sent page generated from _catalog_menu xml is shown This page shows the list of content that the subscriber purchased as gifts When the subscriber selects an item of content the details for the gift generated from gift details xmi are shown Gifts of content charged on a subscription basis have an option to cancel the gift If the subscriber cancels a gift subscription a page confirming the request generated from _gift_cancel_confirm xml is shown If the request completes successfully a notification page generated from gift cancel success xml is shown 7 14 Integration Guide 4 7 1 3 9 Purchase Process The following figure shows the process of purchasing content either for download or as a gift The purchase process is initiated from the content details page or when an item is selected from the wish list l Trial I Purch y optional 1 MIS Confirm Purchase Download Content FIGURE 7 5 Purchase Process Purchase Content Have a Coupon Enter Coupon Code Confirm Purchase Download Content Buy for a Tell a Friend Friend
67. ts of pages created using JavaServer Pages technology JSPTM pages These JSP pages are generated from XML files that describe the pages to be produced and XSL style sheets that describe how the page elements are to be rendered A version of the Subscriber Portal that is one set of JSP pages is 7 1 7 1 1 generated for each style sheet Each set of pages is stored in a subdirectory with the same name as the name of the style sheet These subdirectories are in the following locations CDS_HOME deployment deployment name sun domains server domain server name applications j2ee modules CDSSubscriberPortal device if you are using Sun Java System Application Server CDS_HOME deployment deployment name weblogic domains server domain applications subscriber device if you are using WebLogic Server server domain is the value specified for the app server domain property in the configuration file server name is the value specified for the app server name propertv in the configuration file When the Catalog Manager administrator adds a device to the list of supported devices one of the capabilities specified for the device is the browser tvpe The browser tvpe specified for the device determines which version of the pages is used Page Definitions The files that contain the page definitions for the device based Subscriber Portal are identified in the following table These files are in the CDS_HOME deployment
68. ts postpaid billing and processes records in one of the following formats a XML a CSV Name value pairs To use the Postpaid Service set the following properties in the PostpaidService properties file This file is in the CDS_HOME deployment deployment name con directory m postpaid handler class Set this property to the fully qualified name of the class that you want to use Use one of the following values cCom sun content server postpaid impl PostpaidDefaultHandler Use this class to generate billing records in either XML or name value format a cCom sun content server postpaid impl PostpaidCSVHandler Use this class to generate billing records in CSV format m postpaid record class Set this propertv to com sun content server postpaid PostpaidBillingRecord postpaid template filename Set this property to the fully qualified name of the file that defines the records that vou want generated Use one of the following values deployment deployment name conf resources default_record xs1 Use this file with PostpaidDefaultHandler to generate name value records deployment deployment name conf resources xml_record xs1 Use this file with PostpaidDefaultHandler to generate XML records deployment deployment name conf resources csv_record xs1 Use this file with PostpaidCSVHandler to generate CSV records The following table shows the information provided for each billing event
69. ttings Integration Guide 2005Q4 Related Documentation The Sun Java Svstem Content Deliverv Server manuals are available as Portable Document Format PDF and Hypertext Markup Language HTML files These files Documentation subdirectorv of the directorv where the Content Delivery Server is installed as well as online at http docs sun com are available in the 1 The following table summarizes the books included in the Content Delivery Server documentation set Book Title Description Part Number Sun Java System Content Delivery Server Administration Guide Sun Java System Content Delivery Server Branding and Localization Guide Sun Java System Content Delivery Server Capacity Planning Guide Sun Java System Content Delivery Server Content Developer Guide Sun Java System Content Delivery Server Customization Guide Sun Java System Content Delivery Server Error Messages Sun Java System Content Delivery Server Installation Guide Sun Java System Content Delivery Server Migration Guide Sun Java System Content Delivery Server System Management Guide Describes how to manage content devices and access to the Content Delivery Server Describes how to customize the Subscriber Portal and Developer Portal components of the Content Delivery Server for the look and feel of your enterprise This guide also describes how to localize the Content Delivery Server interfaces Provides guidelines for determ
70. u use Chapter 6 describes the push adapters that are available for the Content Delivery Server to support the delivery method that you use Chapter 7 describes how to create a version of the Subscriber Portal for a specific device A customized version is needed only if the Subscriber Portal pages do not display correctly or when a device provides additional browser capabilities that you want to use Chapter 8 describes how to create a customized submission verifier workflow to validate content submitted to the Content Delivery Server and to add code for Digital Rights Management DRM Chapter 9 describes how to integrate the DRM server DRM Mobile with the Content Delivery Server A DRM server is needed only if you want to protect content using Open Mobile Alliance OMA DRM 1 0 guidelines xii Typographic Conventions Typeface Meaning Examples AaBbCc123 The names of commands files Edit your Login file and directories on screen Use 1s a to list all files computer output You have mail AaBbCc123 What you type when contrasted su with on screen computer output password AaBbCc123 Book titles new words or terms Read Chapter 6 in the User s Guide words to be emphasized Replace command line variables with real names or values These are called class options You must be superuser to do this To delete a file type rm filename a The settings on your browser might differ from these se
71. very Server to send messages and content to subscribers Push listener adapters are used by the Content Delivery Server to receive messages initiated by subscribers 6 1 6 1 1 Push Sender Adapters The Content Deliverv Server supports SMS WAP and SMTP push formats for messages Several SMS formats are supported Deliverv of binarv content using either MMS or SMS is also supported but vou must write vour own adapter for each deliverv method that vou want to use 6 1 1 1 SMS Push for Messages The following forms of SMS push are supported m Short Message Peer to Peer SMPP When you have your own SMSC use the following class as your adapter com sun content server server msgserver push SMSPushMsgSender SMS HTTP When you are using HTTP for your SMS services use the following class as your adapter com sun content server server msgserver push HTTPSMSPushMsgSender If the SMSC that you use requires parameters different than those supported by this adapter you must write your own adapter using the Messaging API See the Sun Java System Content Delivery Server Customization Guide for information on this API Computer Interface to Message Distribution CIMD2 When the SMSC that you use supports the CIMD2 protocol use the following class as your adapter com sun content server server msgserver push SMSCIMD2PushMsgSender For each protocol that you support specify the adapter that you want to use in the pushsender
72. xm1 is shown This page shows the details for the item selected and provides the following options Purchase Trial if a trial is available I Have a Coupon Buy for a Friend Tell a Friend Chapter 7 Device Specific User Interface Framework 7 11 See Section 7 1 3 9 Purchase Process on page 7 15 for a description of these options 7 1 3 3 Search for Content Process The following figure shows the process of searching content Search Content Enter Search Kevword Search Results FIGURE 7 3 Search for Content Process 1 When the subscriber clicks Search Content on the Main Menu the Search Content page generated from _search xml is shown This page prompts the subscriber for the search criteria 2 After the search completes the Search Results page generated from _catalog_menu xml is shown This page shows the list of content that matches the search criteria 7 1 3 4 Set Preferences Process The following figure shows the process of setting preferences 7 12 Integration Guide 4 7 1 3 5 7 1 3 6 Settings Set Manage Language Categories FIGURE 7 4 Set Preferences Process When the subscriber clicks Settings on the Main Menu the Settings page generated from _user_admin_menu xml is shown This page provides the following options m Set Language When this option is selected the Set Language page generated from _locale_selection xml is shown This page enables the subscriber to select t
73. xml Prompts the subscriber to confirm the request to cancel a gift subscription Confirms that the gift subscription is cancelled Shows the details for a gift that was sent to a subscriber Prompts subscribers to select their language preference Prompts the subscriber to log in Prevents the subscriber from logging in and is shown if the subscriber attempts to log in to an account that is disabled or if the wrong password is provided three times in a row Shows the main menu shown when the subscriber logs in Enables subscribers to select the categories that they want to see Shows the links for gifts a subscriber gave and gifts a subscriber received The associated link appears only if a subscriber gave or received at least one gift Prompts the subscriber to confirm the request to purchase content Prompts the subscriber for search criteria Enables the subscriber to share an item of content with another subscriber Prompts the subscriber to confirm the request to share content Notifies the subscriber that the recipient has received the content that the subscriber chose to share Confirms that the recipient of shared content received that content Notifies the subscriber that the requested content is sent in an SMS message Confirms that the subscriber no longer has a subscription for an item of content Provides the options for administering an account such as setting the language and managing cat

Sun Java System Content Delivery Server Integration Guide

Contents

Download Pdf Manuals

Related Search

Related Contents