Sun Logo


Sun Java System Content Delivery Server Customization Guide

Sun Javatrademark System

2005Q4

819-3213-10



Contents

Figures

Tables

Code Samples

Preface

1. Introduction

1.1 Event Service API

1.2 Billing API

1.3 Content Management API

1.4 Content Validation API

1.5 User Profile API

1.6 WAP Gateway API

1.7 Messaging API

1.8 Confirm Service API

1.9 Subscriber API

1.10 API by Feature

2. Event Service API

2.1 SQL*Net Client Application

2.1.1 Event Tables

2.1.1.1 CDS_EVENT Table

2.1.1.2 CDS_EVENT_TYPE Table

2.1.1.3 CDS_EVENT_GROUP Table

2.1.1.4 EVENT_SOURCE_TYPE_ID Table

2.1.2 Reporting Tools

2.2 JMS Client Application

2.3 Events and Event Data

2.4 Using the Event Service API

2.4.1 Developing an SQL*Net Client Application

2.4.2 Developing a JMS Client Application

2.5 Sample Implementation of MessageListener

3. Billing API

3.1 General Process Flow

3.1.1 Content Listing

3.1.2 Transaction Initiation

3.1.3 Subscriber Purchase

3.1.4 Download Confirmation

3.1.5 Subscription Verification

3.1.6 Error Handling

3.2 BillingManager Interface

3.2.1 authorize()

3.2.2 checkSubscription()

3.2.3 confirm()

3.2.4 getBillingInfo()

3.2.5 getBillingInfos()

3.2.6 getLog()

3.2.7 refund()

3.2.8 reverse()

3.2.9 subscribe()

3.2.10 unsubscribe()

3.3 Using the Billing API

3.4 Sample Billing Adapter

4. Content Management API

4.1 General Process Flow

4.1.1 Obtaining a List of Content

4.1.2 Obtaining Content Details

4.1.3 Downloading Content

4.2 ContentManager Interface

4.2.1 getContentInfo()

4.2.2 getContentInfos()

4.2.3 getContentDescriptor()

4.2.4 getContentBinary()

4.3 Using the Content Management API

4.4 Sample Content Management Adapter

5. Content Validation API

5.1 General Process Flow

5.2 ValidationAdapter Class

5.2.1 execute()

5.2.2 returns()

5.3 ValidationContent Class

5.4 Using the Content Validation API

5.5 Sample Content Validation Adapter

6. User Profile API

6.1 UserManager Class

6.1.1 doAccountExists()

6.1.2 doAddUser()

6.1.3 doDisableUser()

6.1.4 doEnableUser()

6.1.5 doFormatMobileId()

6.1.6 doFormatLoginId()

6.1.7 doGetAllLikeInOrder()

6.1.8 doGetAllUsers()

6.1.9 doGetAllUsersContainingFirstName()

6.1.10 doGetAllUsersContainingId()

6.1.11 doGetAllUsersContainingLastName()

6.1.12 doGetAllUsersContainingName()

6.1.13 doGetAnonymousUser()

6.1.14 doGetFieldName()

6.1.15 doGetUser()

6.1.16 doGetUserByMobileId()

6.1.17 doGetUserByUniqueDeviceId()

6.1.18 doGetUserInstance()

6.1.19 doIsActive()

6.1.20 doIsAuthenticated()

6.1.21 doRemoveUser()

6.1.22 doUpdateUser()

6.2 User Interface

6.2.1 getActivateDate()

6.2.2 getAttribute()

6.2.3 getAttribute()

6.2.4 getAttributes()

6.2.5 getCity()

6.2.6 getCountry()

6.2.7 getCreateDate()

6.2.8 getDeActivateDate()

6.2.9 getEmail()

6.2.10 getFirstName()

6.2.11 getGender()

6.2.12 getLastLogin()

6.2.13 getLastName()

6.2.14 getLoginId()

6.2.15 getMiddleName()

6.2.16 getMobileId()

6.2.17 getPassword()

6.2.18 getPhone()

6.2.19 getPostalCode()

6.2.20 getSalutation()

6.2.21 getState()

6.2.22 getStreet1()

6.2.23 getStreet2()

6.2.24 getUniqueDeviceId()

6.2.25 hasLoggedIn()

6.2.26 isConfirmed()

6.2.27 isEnabled()

6.2.28 isPrepay()

6.2.29 setActivateDate()

6.2.30 setAttribute()

6.2.31 setAttributes()

6.2.32 setCity()

6.2.33 setCountry()

6.2.34 setCreateDate()

6.2.35 setDeActivateDate()

6.2.36 setEmail()

6.2.37 setFirstName()

6.2.38 setGender()

6.2.39 setHasLoggedIn()

6.2.40 setIsEnabled()

6.2.41 setIsPrepay()

6.2.42 setLastName()

6.2.43 setLoginId()

6.2.44 setMiddleName()

6.2.45 setMobileId()

6.2.46 setPassword()

6.2.47 setPhone()

6.2.48 setPostalCode()

6.2.49 setSalutation()

6.2.50 setState()

6.2.51 setStreet1()

6.2.52 setStreet2()

6.2.53 setUniqueDeviceId()

6.2.54 updateLastLogin()

6.3 UserDeviceManager Interface

6.3.1 getUniqueDeviceID()

6.4 Using the User Profile API

6.5 Sample Implementation of the User Manager API

6.5.1 Support Files

6.5.2 SampleUserImpl.java

6.5.3 SampleUserManagerImpl.java

7. WAP Gateway API

7.1 WAPGatewayAdapter Class

7.1.1 doHandle()

7.1.2 getMSISDN()

7.1.3 getUniqueId()

7.2 Using the WAP Gateway API

7.3 Sample WAP Gateway Adapter

8. Messaging API

8.1 PushMsgSender Interface

8.1.1 pushMessage()

8.2 PushMsgListener Interface

8.2.1 connect()

8.2.2 initialize()

8.2.3 listen()

8.2.4 sendKeepAliveMsg()

8.3 PushMessage Class

8.3.1 addUserAgent()

8.3.2 getAllUserAgents()

8.3.3 getAttribute()

8.3.4 getContentBinary()

8.3.5 getContentType()

8.3.6 getDestinationAddress()

8.3.7 getJMSMessageId()

8.3.8 getKeyword()

8.3.9 getMessageId()

8.3.10 getMessageText()

8.3.11 getMimeType()

8.3.12 getPushCategory()

8.3.13 getPushDomain()

8.3.14 getPushType()

8.3.15 getShortCode()

8.3.16 getSubscriberId()

8.3.17 getUniqueDeviceId()

8.3.18 getVendingContentId()

8.3.19 setAllUserAgents()

8.3.20 setAttribute()

8.3.21 setContentBinary()

8.3.22 setContentType()

8.3.23 setDestinationAddress()

8.3.24 setJMSMessageId()

8.3.25 setKeyword()

8.3.26 setMessageId()

8.3.27 setMessageText()

8.3.28 setMimeType()

8.3.29 setPushCategory()

8.3.30 setPushDomain()

8.3.31 setShortCode()

8.3.32 setSubscriberId()

8.3.33 setUniqueDeviceId()

8.3.34 setVendingContentId()

8.3.35 toString()

8.4 SMSMessage Class

8.5 WapPushMessage Class

8.6 SMTPMessage Class

8.7 ContentSlide Class

8.7.1 getContentData()

8.7.2 getContentId()

8.7.3 getContentMimeType()

8.7.4 setContentData()

8.7.5 setContentId()

8.7.6 setContentMimeType()

8.8 MMSSlide Class

8.8.1 getAudioContent()

8.8.2 getImageContent()

8.8.3 getTextContent()

8.8.4 getVideoContent()

8.8.5 setAudioContent()

8.8.6 setImageContent()

8.8.7 setTextContent()

8.8.8 setVideoContent()

8.9 MMSPushMessage Class

8.9.1 addMMSSlide()

8.9.2 addRecipient()

8.9.3 getAllMMSSlides()

8.9.4 getAllRecipients()

8.9.5 getDeliveryReportRequired()

8.9.6 getFromAddress()

8.9.7 getMessageClass()

8.9.8 getMessagePriority()

8.9.9 getReadReportRequired()

8.9.10 getSenderVisibility()

8.9.11 getSMILPresentation()

8.9.12 setDeliveryReportRequired()

8.9.13 setFromAddress()

8.9.14 setMessageClass()

8.9.15 setMessagePriority()

8.9.16 setReadReportRequired()

8.9.17 setSenderVisibility()

8.9.18 setSMILPresentation()

8.10 MMSSender Interface

8.10.1 sendMMS()

8.11 PushResponse Class

8.11.1 getMessageId()

8.11.2 getResponseDescription()

8.11.3 getResponseStatus()

8.12 PushConstants Class

8.13 Using the Messaging API

9. Confirm Service API

9.1 General Process Flow

9.2 ConfirmServiceAdapter Class

9.2.1 connect()

9.2.2 listen()

9.2.3 messageReceived()

9.3 Using the Confirm Service API

10. Subscriber API

10.1 General Process Flow

10.2 Using the Subscriber API

10.2.1 Managing Transactions

10.2.2 Example of Creating an IApiContext Object

10.2.3 Example of Creating a Service

10.3 XML-RPC Implementation

10.3.1 Accessing the Content Delivery Server

10.3.2 Using XML-RPC Handlers for the Subscriber API

10.3.2.1 Guidelines for Calls to XML-RPC Methods

10.3.2.2 AuthenticationHandler

10.3.2.3 CategoryHandler

10.3.2.4 ContentHandler

10.3.2.5 DownloadHandler

10.3.2.6 GiftingHandler

10.3.2.7 MessageHandler

10.3.2.8 SystemHandler

10.3.2.9 UserHandler

10.3.2.10 Parameters for the Methods

10.3.3 Examples of Using Handlers

10.3.3.1 Example of Creating an ApiContext Object

10.3.3.2 Example of Creating a Handler and Purchasing Content

Index