Sun Java System Content Delivery Server Integration Guide Table Of ContentsPrevious ChapterNext ChapterBook Index


C H A P T E R  7
Device-Specific User Interface 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 by different devices have different capabilities, the Content Delivery 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 Delivery Server provides Subscriber Portal pages for devices that use browsers based on WML and XHTML. The pages provided are suitable for many 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 specifically for that device.

Section 7.1, Overview of the Framework describes the framework for device-specific user interfaces. Section 7.2, Generating Pages for a Specific Device describes how to generate Subscriber Portal pages tailored to the capabilities of a device. Section 7.3, Modifying Pages for All Devices describes how to modify a page and propagate the change to all device-specific versions of the page.

7.1 Overview of the Framework

The Subscriber Portal consists of pages created using JavaServer PagesTM 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 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:

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 property 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 type. The browser type specified for the device determines which version of the pages is used.

7.1.1 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/deployment-name/markup_generation/page-defs directory. The use of these files is described in Section 7.1.3, Processes and Page Usage.


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.

_gift_cancel_confirm.xml

Prompts the subscriber to confirm the request to cancel a gift subscription.

_gift_cancel_success.xml

Confirms that the gift subscription is cancelled.

_gift_details.xml

Shows the details for a gift that was sent to a subscriber.

_locale_selection.xml

Prompts subscribers to select their language preference.

_login.xml

Prompts the subscriber to log in.

_login_disabled.xml

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.

_main_menu.xml

Shows the main menu shown when the subscriber logs in.

_manage_category.xml

Enables subscribers to select the categories that they want to see.

_my_gifts_menu.xml

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.

_purchase_confirm.xml

Prompts the subscriber to confirm the request to purchase content.

_search.xml

Prompts the subscriber for search criteria.

_share_content.xml

Enables the subscriber to share an item of content with another subscriber.

_share_content_confirm.xml

Prompts the subscriber to confirm the request to share content.

_share_content_receive.xml

Notifies the subscriber that the recipient has received the content that the subscriber chose to share.

_share_content_success.xml

Confirms that the recipient of shared content received that content.

_sms_sent.xml

Notifies the subscriber that the requested content is sent in an SMS message.

_unsub_success.xml

Confirms that the subscriber no longer has a subscription for an item of content.

_user_admin_menu.xml

Provides the options for administering an account, such as setting the language and managing categories.


The pages for the device-based Subscriber Portal are defined once using XML. The XML files are then processed with each existing style 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.


TABLE 7-2 Page Elements

Element

Description

button

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 <jsp> tag that contains a <bean:message> or <bean:write> tag.
  • name - A string used to identify the button to the handler that processes the form.

divider

Adds a horizontal line to a page.

field

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 <jsp> tag that contains a <bean:message> or <bean:write> tag.
  • size - Size of the field.
  • maxlength - Maximum length of the data a user can enter.
  • 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.

form

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.
  • field - Field on the form. A form can contain multiple fields. See the description for field in this table.

image

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://server1.com/web/images/logo.gif. Do not include this element if the name element is included.
  • alt - Alternate text for an image. This element generally contains a <jsp> tag that contains a <bean:message> or <bean:write> tag.

link

Provides a link on the page and appears under either the navbar element or as a list element. A link contains the following elements:

  • name - Text displayed on the page.
  • 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.

<link>

<name>Yahoo</name>

<url><jsp>"http://wap.yahoo.com"</jsp></url>

</link>

list

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.

navbar

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.

navspacer

Divides items in a navbar.

option, optionlist

Describe the list of items included in a field of type select and appear under the field element. Use option when the list of items is known. Use optionlist when the list is dynamically generated. An option contains the following elements:

  • name - Name of the item.
  • value - Value assigned to the item.

text

Provides the text for the page and appears under either the view element or a list element. The text element generally contains a <jsp> tag that contains a <bean:message> or <bean:write> tag. This element can have the following attributes:

  • alignment - Valid values are left, right, and center.
  • type - Valid values are error and bold.

title

Provides the title used for the page and appears under the view element. The title element generally contains a <jsp> tag that contains a <bean:message> or <bean:write> tag.

view

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 following code example shows a page that contains a form.


CODE EXAMPLE 7-1 Sample Page with Form 
<?xml version="1.0"?>

<!-- Copyright (c) 2003 Sun Microsystems, Inc. All rights reserved -->

<!-- SUN PROPRIETARY/CONFIDENTIAL. -->

<!-- Use is subject to license terms. -->

<view>

  <title>

    <jsp><![CDATA[<bean:encodedmessage key="device.login.title"/>]]></jsp>

  </title>

  <jsp><![CDATA[<logic:messagesPresent>]]></jsp>

  <text type="error">

    <jsp><![CDATA[<html:encodederrors/>]]></jsp>

  </text>

  <jsp><![CDATA[</logic:messagesPresent>]]></jsp>

  <jsp><![CDATA[<logic:messagesNotPresent>]]></jsp>

  <jsp><![CDATA[</logic:messagesNotPresent>]]></jsp>

  <form>

    <action>

      <jsp>Web.getWeb().getActionURL(SubscriberConstants.ACTION_DEVICE_LOGIN, 

           null, response)</jsp>

    </action>

    <field>

      <name>username</name>

      <type>text</type>

      <size>10</size>

      <maxlength>40</maxlength>

      <label>

        <jsp><![CDATA[<bean:encodedmessage key="device.login.username"/>]]></jsp>

      </label>

    </field>

    <field>

      <name>password</name>

      <type>password</type>

      <size>10</size>

      <maxlength>40</maxlength>

      <label>

        <jsp><![CDATA[<bean:encodedmessage key="device.login.password"/>]]></jsp>

      </label>

    </field>

    <button>

      <name>

        <jsp><![CDATA[<%=SubscriberConstants.BUTTON_SUBMIT%>]]></jsp>

      </name>

      <label>

        <jsp><![CDATA[<bean:encodedmessage key="device.login.loginLink"/>]]></jsp>

      </label>

    </button>

  </form>

</view>

The following code example shows a page that contains links to other pages.


CODE EXAMPLE 7-2 Sample Page with Links 
<?xml version="1.0"?>

<!-- Copyright (c) 2003 Sun Microsystems, Inc. All rights reserved -->

<!-- SUN PROPRIETARY/CONFIDENTIAL. -->

<!-- Use is subject to license terms. -->

<view>

  <title>

    <jsp><![CDATA[<bean:encodedmessage key="device.menu.main.title"/>]]></jsp>

  </title>

  <list>

    <jsp><![CDATA[<logic:iterate id="element" 

         name="<%=SubscriberConstants.ATTR_MENU_LIST%>" 

         type="com.sun.content.server.server.webapps.common.ListItem" 

         indexId="index">]]></jsp>

    <item>

      <link>

        <name>

          <jsp><![CDATA[<bean:encodedwrite name="element" 

               property="name"/>]]></jsp>

        </name>

        <url>

          <jsp>element.getUrl()</jsp>

        </url>

        <accesskey>

          <jsp><![CDATA[<%=index.intValue()+1%>]]></jsp>

        </accesskey>

      </link>

    </item>

    <jsp><![CDATA[</logic:iterate>]]></jsp>

  </list>

</view>

7.1.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.

These style sheets are suitable for many 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. Only those elements that do not display well need to be included in the new style sheet. For example, if a device uses the XHTML-Alternate.xsl style sheet and only links and fields render poorly, create a style sheet that imports XHTML-ALternate.xsl and includes definitions for only links and fields.

7.1.3 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.

7.1.3.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.


FIGURE 7-1 Log In Process

Diagram of the process of logging in to the Subscriber Portal from a device. The process is described in the text.


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:

7.1.3.2 View Content Process

The following figure shows the process of viewing available content.


FIGURE 7-2 View Content Process

Diagram of the process of viewing content from a device. The process is described in the text.


1. When the subscriber clicks Get Content on the Main Menu, the Select Category page, generated from _catalog_menu.xml, 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.xml, is shown. This page shows the details for the item selected and provides the following options:

See Section 7.1.3.9, Purchase Process for a description of these options.

7.1.3.3 Search for Content Process

The following figure shows the process of searching content.


FIGURE 7-3 Search for Content Process

Diagram of the process of searching for content from a device. The process is described in the text.


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.


FIGURE 7-4 Set Preferences Process

Diagram of the process of setting preferences from a device. The process is described in the text.


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:

7.1.3.5 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 for information on the purchase process.

7.1.3.6 View the My 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.

When the subscriber selects an item of content, the Content Details page, generated from _detail.xml, 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 for information on the purchase process.

7.1.3.7 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 for information on the purchase process.

7.1.3.8 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 _my_gifts_menu.xml, 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.xml, 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 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.xml, 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.xml, 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.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.


FIGURE 7-5 Purchase Process

Diagram of the process of purchasing content from a device. The process is described in the text.


The Purchase Content page provides the following options:

The trial option is available only if the administrator set up a trial for the item.

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.xml, is shown.

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.xml, is shown.

c. If the request completes successfully, 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.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.xml, is shown.

7.2 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 generated 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:

1. 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 <xsl:import href="XHTML-Basic.xsl"/> in 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.

2. 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 .xsl 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.

3. Move the directory that contains the generated JSP pages to the Subscriber Portal application directory on each application server where you deployed a Subscriber Portal.

4. 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

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, 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 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.

7.4 Adding a Custom Page

The version of the Subscriber Portal that runs on 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/deployment/deployment-name/markup_generation/page-defs directory.

See Section 7.1.1, Page Definitions for information on the page elements that you 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 
<?xml version="1.0"?>

<!-- Copyright (c) 2003 Sun Microsystems, Inc. All rights reserved -->

<!-- SUN PROPRIETARY/CONFIDENTIAL. -->

<!-- Use is subject to license terms. -->

<view>

  <title>

    <jsp><![CDATA[<bean:encodedmessage key="device.newPage.title"/>]]></jsp>

  </title>

  <text>

    <jsp><![CDATA[<bean:encodedmessage 

         key="device. newPage.instructions"/>]]></jsp>

  </text>

  <navbar orientation="horizontal">

    <link>

      <name>

        <jsp><![CDATA[<bean:encodedmessage 

             key="device. newPage.continue"/>]]></jsp>

      </name>

      <url>

        <jsp>Web.getWeb().getActionURL("/device_direct_url.do", 

             null,response)</jsp>

      </url>

    </link>

  </navbar>

</view>

2. Add the strings used in the page definition to each language version of the SubscriberPortalLocaleResource.properties file in the $CDS_HOME/localization directory.

The name of the properties that you add corresponds to the values that you specified for the key 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 generated JSP pages to the Subscriber Portal application directory on each application server where you deployed a Subscriber Portal.

4. Create a handler that contains the business logic for the new page.

The handler must extend com.sun.content.server.server.webapps.device.BaseDeviceHandler. See the output of the Javadoctrademark utility in the directory that contains the documentation for the Content Delivery Server for information on this class.

Place the compiled class in a Java Archive (JAR) file in one of the following locations:

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 reserved.

*/

 

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

 */

public class CheckNewPageHandler extends BaseDeviceHandler

{

    public ActionForward doExecute(ActionMapping mapping, ActionForm form,

        HttpServletRequest request, HttpServletResponse response) 

        throws Exception

    {

        IApiContext apiContext = getApiContext(request);

 

        // ExternalService class needs to be implemented

       boolean showPage = ExternalService.showPage(apiContext.getMobileId());

 

        if (showPage)

            return mapping.findForward("show_page");

        else

            return mapping.findForward("do_not_show_page");        

    }

}

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:

a. Remove the following section of code: 


<action path="/device_provision"

  type="com.sun.content.server.server.webapps.device.ProvisionUserHandler">

  <forward name="device_select_locale" path="/dv5.do"/>

  <forward name="success" path="/dv42.do"/>

</action>

b. Add the following code in place of the section that you removed: 


<action path="/device_provision" 

  type="com.sun.content.server.server.webapps.device.ProvisionUserHandler">

  <forward name="device_select_locale" path="/dv5.do"/>

  <forward name="success" path="/check_new_page.do"/>

</action>

<action path="/check_new_page"

  type=" com.sun.content.server.cdsexample.CheckNewPageHandler">

  <forward name="show_page" path="/device_show_new_page.do"/>

  <forward name="do_not_show_page " path="/device_direct_url.do"/>

</action>

<action path="/device_show_new_page"

  type="com.sun.content.server.server.webapps.device.ReturnSuccessHandler">

  <forward name="success" path="/View?pg=_new_page.jsp"/>

</action>

6. Restart the server.

 



  Sun Java System Content Delivery Server Integration Guide 819-3216-10 Table Of ContentsPrevious ChapterNext ChapterBook Index


Copyright © 2005, Sun Microsystems, Inc. All Rights Reserved.