Chapter 3   Using Leaf Providers

A portal provider is a generic connector to the resource in a channel and is the programmatic entity responsible for generating channels on the Desktop. A single provider can be used to create multiple channel instances. The leaf providers are tools for building channels for the portal.

Out of the box, the software includes the following building block leaf providers:

• JSPProvider - Serves JavaServer Pages^TM (JSP^TM)
• URLScraperProvider - Serves data from a URL (HTTP or file path)
• XMLProvider - Enables XSL transformation of an XML document

These providers are public and you can extend the Java class to provide customized functionality based on these providers. This chapter also includes detailed instructions for:

• Extending the building block leaf providers    
• Deploying JSP Tags and Tag Libraries

Introduction

Figure 3-1 shows the relationship between the PAPI base class and the leaf providers discussed in this chapter. The JSPProvider and URLScraperProvider extend the ProfileProviderAdapter to include support for retrieving content from JavaServer Pages and URLs respectively. The XMLProvider extends the URLScraperProvider's functionality to scrape XML content from the named source and translate it into the markup language supported by the requesting client. The XMLProvider uses the URLScraperProvider's built-in functionality to fetch the XML contents from HTTP, HTTPs, and file URLs.

Figure 3-1   

The Building Block Providers

JSPProvider

A JSPProvider is a content provider that can use JavaServer Pages to create the content for a channel on the Desktop.

Invoking a JSP

The following is a description of the step-by-step process of the JSPProvider invoking a JSP.

1. The JSPProvider.getContent() method is called and the JSPProvider looks up the JSP to be executed. It calls a common private method to service the JSP.
2. The provider then creates request and response objects, copies information (such as cookies) from the Desktop request to those objects, initializes the session information, and checks to see if a servlet wrapper for the JSP already exists. If not, a servlet wrapper is created. The service method is then called on the wrapper.
3. The servlet wrapper service method loads the JSP. Before loading, it checks to see if the JSP class file is out of date with the class file. If the JSP class file is out of date with the class file, it invokes the compiler to compile the JSP into a class file and read the class file into memory and uses the class loader to define the new class.
4. Finally, the JSP servlet is instantiated and the init() method is called on the JSP.
5. Once the JSP is loaded, the JSP's service method is called by the servlet wrapper service method.
6. After the JSP's service method completes, the JSPProvider getContent() method extracts the response body from the processed JSP file and returns it as a StringBuffer.

Extending the JSPProvider

This sections contains some sample extensions to the JSPProvider.

Example 1

In the following example, the JSPProvider getContent() method is overridden to make a connection to the database to get the address book from the database and use a JSP to display the content of the address book for each user. To accomplish this:

1. Extend the JSPProvider and develop the AddressBookProvider class.

The AddressBookProvider class overrides the JSPProvider's getContent() method which reads the user's address book. The getContent() method gets the address book for the user who is logged in to the Sun^TM ONE Portal Server Desktop.




---

Code Example 3-1    AddressBookProvider.java File

package custom;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpServletRequest;

import com.sun.portal.providers.ProviderException;

import com.sun.portal.providers.jsp.JSPProvider;

public class AddressBookProvider extends JSPProvider {

public StringBuffer getContent (

HttpServletRequest req, HttpServletResponse res

) throws ProviderException {

AddressBook addrBook = new custom.AddressBook(getProviderContext().getUserID());

req.setAttribute("addressBook", addrBook);

return super.getContent(req, res);

}

}

2. Develop the AddressBook class.

The class AddressBook is responsible for making a connection to the database and get the user's address book from the database.

3. Compile both classes and put them in the provider class base directory.

The default directory for the class file is /etc/opt/SUNWps/desktop/classes. That is, build a JAR and copy the JAR into the provider class base directory. Or, just copy the class files into the provider class base directory.

4. Develop the display profile XML fragment for this provider and this provider's channel.

The display profile fragment for the AddressBookProvider's provider is saved in AddressBookProvider.xml file (see Code Example 3-2) and the display profile fragment for the AddressBookProvider's channel is saved in AddressBookChannel.xml file (see Code Example 3-3). In Code Example 3-3, note that the AddressBookProvider channel definition is embedded in an existing table container, JSPTableContainer.




---

Code Example 3-2    AddressBookProvider.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Provider name="AddressBookProvider" class="custom.AddressBookProvider">

<Properties>

<String name="title" value="Address Book Provider"/>

<String name="description" value="My Addressbook"/>

<String name="refreshTime" value="0" advanced="true"/>

<Boolean name="isEditable" value="false" advanced="true"/>

<String name="editType" value="edit_subset" advanced="true"/>

<String name="width" value="thin" advanced="true"/>

<String name="helpURL" value="desktop/usedesk.htm" advanced="true"/>

<String name="fontFace1" value="Sans-serif"/>

<String name="productName" value="Sun ONE Portal Server"/>

<String name="contentPage" value="addressBook.jsp"/>

</Properties>

</Provider>




---

Code Example 3-3    AddressBookChannel.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Container name="JSPTableContainer" provider="JSPTableContainerProvider">

<Properties>

<Collection name="Personal Channels">

<String name="AddressBook"/>

</Collection>

<Collection name="channelsColumn">

<String name="AddressBook" value="3"/>

</Collection>

</Properties>

<Available>

<Reference value="AddressBook"/>

</Available>

<Selected>

<Reference value="AddressBook"/>

</Selected>

<Channels>

<Channel name="AddressBook" provider="AddressBookProvider">

<Properties>

</Properties>

</Channel>

</Channels>

</Container>

5. Use the dpadmin command to upload the display profile fragments for this provider.

For the AddressBookProvider, use the dpadmin command to upload the AddressBookProvider.xml file and AddressBookChannel.xml file XML fragments in the display profile. That is, type:

dpadmin add -u dn_amadmin -w password -d distinguishedname AddressBookProvider.xml

dpadmin modify -m -p "JSPTableContainer" -u dn_amadmin -w password -d distinguishedname AddressBookChannel.xml

6. Develop the JSP file for the provider.

For the sample AddressBookProvider, the JSP in Code Example 3-4 can be used to display the content of the address book for each user. However, the details of displaying the address book is not shown in Code Example 3-4.




---

Code Example 3-4    addressBook.jsp File

<%-- addressBook.jsp --%>

<%@page import="custom.AddressBookProvider" %>

<%@page import="custom.AddressBook" %>

<%

AddressBookProvider addressBookProvider = (AddressBookProvider)pageContext.getAttribute("JSPProvider");

AddressBook addrBook = (AddressBook)pageContext.getAttribute("addressBook",PageContext.REQUEST_SCOPE) ;

%>

<%-- Display the address book --%>

7. Create a channel directory under the template root directory.

By default, the template root directory is /etc/opt/SUNWps/desktop/default. For this example, create an AddressBook directory under /etc/opt/SUNWps/desktop/default directory.

8. Copy all the JSP files over to the newly created directory (in Step 7). For example, type:

cp addressBook.jsp /etc/opt/SUNWps/desktop/default/AddressBook

9. Access the AddressBook channel inside the JSPTableContainer. To access, type the following URL in your browser:

http://hostname:port/portal/dt?provider=JSPTableContainer

Example 2

In the following example, the SimpleUserInfoProvider overrides the processEdit() method of the JSPProvider. It reads the common name that is input in the edit page JSP, and then it is read from the processEdit() method. The value is set to the backend store. To accomplish this:

1. Extend the JSPProvider and develop the SimpleUserInfoProvider class.

The SimpleUserInfoProvider class overrides the JSPProvider processEdit() method as shown in Code Example 3-5.




---

Code Example 3-5    SimpleUserInfoProvider.java File

package custom;

import java.net.URL;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpServletRequest;

import com.sun.portal.providers.ProviderException;

public class SimpleUserInfoProvider extends JSPProvider {

public URL processEdit(

HttpServletRequest req, HttpServletResponse res

) throws ProviderException {

//get the common name from the request and set it into the backend store

getProviderContext().setStringAttribute("cn",(String)req.getParameter( "cn"));

return null;

}

}

2. Compile the class and put it in the provider class base directory.

The default directory for the class file is /etc/opt/SUNWps/desktop/classes. That is, build the JAR and copy the JAR into the provider class base directory. Or, just copy the class as a file into the provider class base directory. To compile the SimpleUserInfoProvider.java file, type:

javac -d /etc/opt/SUNWps/desktop/classes -classpath BaseDir/SUNWps/sdk/desktop/desktopsdk.jar:BaseDir/SUNWam/lib/servlet.jar SimpleUserInfoProvider.java

3. Develop the display profile XML fragment for this provider and this provider's channel.

The display profile fragment for the SimpleUserInfoProvider's provider is saved in SimpleUIProvider.xml file (see Code Example 3-6) and the display profile fragment for the SimpleUserInfoProvider's channel is saved in SimpleUIPChannel.xml file (see Code Example 3-7). In Code Example 3-7, note that the SimpleUserInfoProvider channel definition is embedded inside JSPTableContainer thus making the channel only visible via the container.




---

Code Example 3-6    SimpleUIProvider.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Provider name="SimpleUserInfoProvider" class="custom.SimpleUserInfoProvider">

<Properties>

<String name="title" value="Simple User Information Provider"/>

<String name="description" value="My UserInformation"/>

<String name="refreshTime" value="0" advanced="true"/>

<Boolean name="isEditable" value="false" advanced="true"/>

<String name="editType" value="edit_subset" advanced="true"/>

<String name="width" value="thin" advanced="true"/>

<String name="helpURL" value="desktop/usedesk.htm" advanced="true"/>

<String name="fontFace1" value="Sans-serif"/>

<String name="productName" value="Sun ONE Portal Server"/>

<String name="contentPage" value="simpleUserInfoContent.jsp"/>

<String name="editPage" value="simpleUserInfoEdit.jsp"/>

</Properties>

</Provider>




---

Code Example 3-7    SimpleUIPChannel.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Container name="JSPTableContainer" provider="JSPTableContainerProvider">

<Properties>

<Collection name="Personal Channels">

<String name="SimpleUserInfo"/>

</Collection>

<Collection name="channelsColumn">

<String name="SimpleUserInfo" value="3"/>

</Collection>

</Properties>

<Available>

<Reference value="SimpleUserInfo"/>

</Available>

<Selected>

<Reference value="SimpleUserInfo"/>

</Selected>

<Channels>

<Channel name="SimpleUserInfo" provider="SimpleUserInfoProvider">

<Properties>

<String name="processPage" value="simpleUserInfoDoedit.jsp"/>

</Properties>

</Channel>

</Channels>

</Container>

4. Use the dpadmin command to upload the display profile fragments for this provider.

For the SimpleUserInfoProvider, use the dpadmin command to upload the SimpleUIProvider.xml file and SimpleUIPChannel.xml file XML fragments in the display profile. That is, type:

dpadmin add -u dn_amadmin -w password -d distinguishedname SimpleUIProvider.xml

dpadmin modify -m -p "JSPTableContainer" -u dn_amadmin -w password -d distinguishedname SimpleUIPChannel.xml

5. Create a channel directory under the template root directory.

By default, the template root directory is /etc/opt/SUNWps/desktop/default. For this example, create an SimpleUserInfo directory under /etc/opt/SUNWps/desktop/default directory.

6. Develop and copy all the JSP files over to the newly created directory (in Step 7).

For example, develop the simpleUserInfoContent.jsp and simpleUserInfoEdit.jsp files and copy them over to the newly created /etc/opt/SUNWps/desktop/default/SimpleUserInfo directory.

7. Access the SimpleUserInfo channel inside the JSPTableContainer. To access, type the following URL in your browser:

http://hostname:port/portal/dt?provider=JSPTableContainer

Deploying JSP Tags and Tag Libraries

To make custom JSP tags, refer to a document to write custom tag libraries (for example, see http://java.sun.com/products/jsp/tutorial/TagLibrariesTOC.html) and use this section to deploy the customized tag library into Sun ONE Portal Server software.

1. Copy the class files or JAR files that are required by the tag library under providerClassBaseDir where providerClassBaseDir is the directory defined in /etc/opt/SUNWps/desktop/desktopconfig.properties file.
2. Make the custom tag library.

For example, see the custom.tld shown in Code Example 0-1.




---

custom.tld Custom Tag Library

<?xml version="1.0" encoding="ISO-8859-1"?>

<!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.1//EN" "http://java.sun.com/j2ee/dtds/web-jsptaglibrary_1_1.dtd">

<taglib>

<tlibversion>0.1</tlibversion>

<jspversion>1.1</jspversion>

<shortname>customname</shortname>

<tag>

<name>MyCustomTag</name>

<tagclass>com.iplanet.portalserver.myTags.MyCustomTag</tagclass>

<bodycontent>empty</bodycontent>

</tag>

</taglib>

The shortname can be anything. The name must be the same as your custom tag name and the tagclass must point to the correct class.

3. Copy the tld file in templateBaseDir/default/tld where templateBaseDir is the directory defined in /etc/opt/SUNWps/desktop/desktopconfig.properties file.
4. Modify the JSP files to use the custom tags.

For example:




---

Code Example 3-8    Sample Tag Usage in JSPs

<%@ taglib uri="/tld/custom.tld" prefix="custom" %>

<HTML>

<HEAD>

<TITLE>My custom jsp</TITLE>

</HEAD>

<BODY>

Here is the result of MyCustomTag:

<custom:MyCustomTag/>

</BODY>

</HTML>

URLScraperProvider

The URLScraperProvider can retrieve and display content from a given URL.

Scraping Content from the URL

The following is a step-by-step description of how the URLScraperProvider retrieves and displays content from the specified URL:

1. Gets the timeout property for the provider.
2. Gets the url property for the provider.

This is the URL source for the content to be fetched.

3. Gets the urlScraperRulesetID to be used by rewriter as a string.
4. Determines if the cookieName can be forwarded.

To determine, it checks the value of cookiesToForwardAll attribute value in the display profile. If this value is false, it checks the cookiesToForwardList attribute value in the display profile.

5. Determines if cookies from the request should be forwarded.
6. Gets the content by:

• Retrieving content from the specified URL.

That is, it sends an HTTP request that contains information related to this request for content and gets an HTTP response that allows the provider to influence the overall response for the Desktop page (besides generating the content).

Or, by:

• Taking the fully qualified path name of the file and returning StringBuffer containing the data from the specified file or null if file does not exist or cannot be read.

Extending the URLScraperProvider

Consider extending the URLScraperProvider if, for example, the URL that the provider is going to scrape is based on some runtime values like clientType, or if you want your URLScraperProvider to get the required properties from somewhere other than display profile.

In the following example, the URLScraperProvider getURL() method is overridden to dynamically compute the URL to use. In the CustomURLScraperProvider, the URL is dynamically computed based on the clientType. To accomplish this:

1. Extend the URLScraperProvider and develop the CustomURLScraperProvider class file.

The CustomURLScraperProvider class file overrides the URLScraperProvider getURL() method as shown in Code Example 3-9.




---

Code Example 3-9    CustomURLScraperProvider.java File

package custom;

import com.sun.portal.providers.urlscraper.URLScraperProvider;

import com.sun.portal.providers.ProviderException;

import javax.servlet.http.HttpServletRequest;

public class CustomURLScraperProvider extends URLScraperProvider {

private String clientType = null;

public void init(

String n, HttpServletRequest req

) throws ProviderException {

// get the clientType

clientType = "genericHTML";

super.init(n, req);

}

protected String getURL() throws ProviderException {

if (clientType.equals("genericHTML")) {

return getStringProperty("url");

} else if (clientType.equals("wml")) {

return getStringProperty("wmlURL");

} else {

return getStringProperty("defaultURl");

}

}

}

2. Compile the class and put it in the provider class base directory.

The default directory for the class file is /etc/opt/SUNWps/desktop/classes. That is, build the JAR and copy the JAR into the provider class base directory. Or, just copy the class as a file into the provider class base directory. To compile the CustomURLScraperProvider.java file, type:

javac -d /etc/opt/SUNWps/desktop/classes -classpath BaseDir/SUNWps/sdk/desktop/desktopsdk.jar:BaseDir/SUNWam/lib/servlet.jar CustomURLScraperProvider.java

3. Develop the display profile XML fragment for this provider and this provider's channel.

The display profile fragment for the CustomURLScraperProvider's provider is saved in CustomURLSProvider.xml file (see Code Example 3-10) and the display profile fragment for the CustomURLScraperProvider's channel is saved in CustomURLSChannel.xml file (see Code Example 3-11).




---

Code Example 3-10    CustomURLSProvider.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Provider name="CustomURLScraperProvider" class="com.sun.portal.providers.example.CustomURLScraperProvider">

<Properties>

<String name="title" value="UrlScraper extension Channel"/>

<String name="description" value="This is an example of urlscraper extension"/>

<Boolean name="isEditable" value="false" advanced="true"/>

<String name="url" value="/desktop/ipinfo.html"/>

<String name="wmlURL" value="/desktop/ipinfo.wml"/>

<String name="chtmlURL" value="/desktop/ipinfo.chtml"/>

<String name="urlScraperRulesetID" value="default_ruleset"/>

<String name="width" value="thick"/>

<String name="refreshTime" value="0" advanced="true"/>

<String name="helpURL" value="desktop/urlscrpr.htm" advanced="true"/>

<String name="fontFace1" value="Sans-serif"/>

<String name="defaultURL" value="/desktop/ipinfo.html"/>

<String name="productName" value="Sun ONE Portal Server"/>

<Boolean name="cookiesToForwardAll" value="true"/>

<String name="inputEncoding" value="iso-8859-1"/>

<Collection name="cookiesToForwardList">

</Collection>

<Integer name="timeout" value="100"/>

</Properties>

</Provider>




---

Code Example 3-11    CustomURLSChannel.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Channel name="CustomURLSC" provider="CustomURLScraperProvider">

<Properties>

<String name="refreshTime" value="600" advanced="true"/>

<String name="url" value="file:///etc/opt/SUNWps/desktop/default/CustomURLSC/html/ipinfo.html"/>

<String name="wmlURL" value="file:///etc/opt/SUNWps/desktop/default/CustomURLSC/wml/ipinfo.wml"/>

<String name="chtmlURL" value="file:///etc/opt/SUNWps/desktop/default/CustomURLSC/chtml/ipinfo.chtml"/ >

<String name="title" value="URL Scraper Channel"/>

</Properties>

</Channel>

4. Use the dpadmin command to upload the display profile fragments for this provider.

For the CustomURLScraperProvider, use the dpadmin command to upload the CustomURLSProvider.xml and CustomURLSChannel.xml file XML fragments in the display profile. That is, type:

dpadmin add -u dn_amadmin -w password -d distinguishedname CustomURLSProvider.xml

dpadmin add -u dn_amadmin -w password -d distinguishedname CustomURLSChannel.xml

5. Include the new channel in one of the existing containers.

The CustomURLScraperProvider channel will be displayed in JSPTableContainer. To add the channel in the JSPTableContainer from the administration console, follow instructions in section "To Add a Channel or Container Channel" in Chapter 5 of the Sun ONE Portal Server 6.0 Administrator's Guide. To add the channel in the JSPTableContainer manually:

1. Add the CustomURLScraperProvider channel XML fragment (in the CustomURLSContainer.xml file) for the JSPTableContainerProvider.

The CustomURLScraperProvider container XML fragment is shown in Code Example 3-16.




---

Code Example 3-12    CustomURLSContainer.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Container name="JSPTableContainer" provider="JSPTableContainerProvider">

<Properties>

<Collection name="Personal Channels">

<String value="CustomURLSC"/>

</Collection>

<Collection name="channelsRow">

<String name="CustomURLSC" value="3"/>

</Collection>

</Properties>

<Available>

<Reference value="CustomURLSC"/>

</Available>

<Selected>

<Reference value="CustomURLSC"/>

</Selected>

<Channels>

</Channels>

</Container>

2. Use the dpadmin add sub command to add the channel to a container. If you do not specify a parent object with the -p option, the channel is added at the root level.

dpadmin modify -m -p "JSPTableContainer" -u dn_amadmin -w password -d distinguishedname CustonURLSContainer.xml

6. Access the CustomURLScraperProvider channel inside the JSPTableContainer. To access, type the following URL in your browser:

http://hostname:port/portal/dt?provider=JSPTableContainer

XMLProvider

The XML Provider can be used to convert and display an XML file according to the specified style sheet.

Retrieving XML Content

The XMLProvider first determines whether or not content is available for the requesting client. This is determined by checking on the availability of the XSL stylesheet for the requesting client via the File lookup API.

The path to the XML content can be specified as HTTP, HTTPs, or file URL. The path to the XML source is stored as a value of the property url. If the path is HTTP or HTTPs, the provider uses the super.getContent() method to fetch the XML content. If the path is a file URL, the provider reads the file into a StringBuffer.

The value for XSL file name to use for transformation is stored as value of the string property xslFileName. The value for the attribute can be either the absolute path (such as /export/home/xsl/abc.xsl) or just the file name. If just the filename has been specified, the provider will use the File Lookup API to locate the XSL file. If the absolute path is specified, it takes precedence and file lookup will not be performed to locate the XSL file.

If both the XML and the XSL files are present, the XMLProvider does the transformation using the XSLT engine. The generated contents are displayed in the channel. In order to transform the XML file, the provider uses JAXP 1.1.

The XMLProvider:

1. Takes the fully qualified path name of the XML file and returns the file, specified by the argument, as a StringBuffer.

It returns null if the file does not exists or cannot be read.

2. Gets the XSL file. If just an XSL filename has been specified, the getXSL method locates the XSL file using the File Lookup API.
3. Takes the XML and XSL files and does the transformation.
4. Gets the XML contents after converting the xml file according to the specified XSL stylesheet. In order to do this, it takes the HttpServletRequest and returns an HttpServletResponse with the XML file contents as a buffer.
5. Gets and displays the XML file contents in the channel using the getContent() method.

Extending the XMLProvider

In the following example, the XMLProvider getXML method is overridden to get the content out of a database. In the CustomXMLProvider, the XML content is retrieved from a database. To accomplish this:

1. Develop the CustomXMLProvider class file and override the getXML method in the CustomXMLProvider's class file.

The CustomXMLProvider class file (see Code Example 3-13) extends the XMLProvider and includes only the overriding getXML method.




---

Code Example 3-13    CustomXMLProvider.java File

package custom;

import com.sun.portal.providers.ProviderException;

import com.sun.portal.providers.context.ProviderContext;

import com.sun.portal.providers.xml.XMLProvider;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

public class CustomXMLProvider extends XMLProvider {

protected StringBuffer getXML(

HttpServletRequest req,HttpServletResponse res

) throws ProviderException {

String xmlURL = getURL();

StringBuffer xmlbuf = new StringBuffer();

// It must be http, https or file i.e http://<url>, https://<url>

// or file:////<path>

String proto = xmlURL.substring(0,xmlURL.indexOf(':'));

if((proto.equalsIgnoreCase("http")) || (proto.equalsIgnoreCase("https")) || (proto.equalsIgnoreCase("file"))) {

try {

xmlbuf = super.getXML(req, res);

} catch(ProviderException pr) {

getProviderContext().debugError("XMLProvider:getXML(): ",pr);

}

if (xmlbuf != null) {

return xmlbuf;

} else {

throw new ProviderException("XMLProvider.getXML(): Getting XML failed from source");

}

} else {

// Open database connection

// Read the XML contents into a stringbuffer (xmlbuf)

// Close the database connection

return xmlbuf;

}

}

}

2. Compile the class and put it in the provider class base directory.

That is, build the JAR and copy the JAR into the provider class base directory. Or, just copy the class as a file into the provider class base directory. The default directory for the class file is /etc/opt/SUNWps/desktop/classes. To compile the CustomXMLProvider.java file, type:

javac -d /etc/opt/SUNWps/desktop/classes -classpath BaseDir/SUNWps/sdk/desktop/desktopsdk.jar:BaseDir/SUNWam/lib/servlet.jar CustomXMLProvider.java

3. Develop the display profile XML fragment for this provider and this provider's channel.

The display profile fragment for the CustomXMLProvider's provider is saved in CustomXMLProvider.xml file (see Code Example 3-14) and the display profile fragment for the CustomXMLProvider's channel is saved in CustomXMLChannel.xml file (see Code Example 3-15).

  




---

Code Example 3-14    CustomXMLProvider.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Provider name="CustomXMLProvider" class="com.sun.portal.providers.xml.CustomXMLProvider">

<Properties>

<String name="title" value="*** XML Provider ***"/>

<String name="description" value="*** DESCRIPTION ***"/>

<String name="width" value="thick"/>

<String name="refreshTime" value="0" advanced="true"/>

<Boolean name="isEditable" value="false" advanced="true"/>

<String name="helpURL" value="desktop/xmlchann.htm" advanced="true"/>

<String name="fontFace1" value="Sans-serif"/>

<String name="productName" value="Sun ONE Portal Server"/>

<String name="url" value=""/>

<String name="xslFileName" value="html_stockquote.xsl"/>

<Integer name="timeout" value="100"/>

<String name="inputEncoding" value="iso-8859-1"/>

<String name="urlScraperRulesetID" value="default_ruleset"/>

<Boolean name="cookiesToForwardAll" value="true"/>

<Collection name="cookiesToForwardList">

</Collection>

</Properties>

</Provider>




---

Code Example 3-15    CustomXMLChannel.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Channel name="CustomXML" provider="CustomXMLProvider">

<Properties>

<String name="refreshTime" value="600" advanced="true"/>

<String name="title" value="XML Test Channel"/>

<String name="description" value="This is a test of the CustomXMLProvider"/>

<String name="url" value=""/>

<String name="xslFileName" value="html_stockquote.xsl"/>

</Properties>

</Channel>

4. Use the dpadmin command to upload the display profile fragments for this provider.

For the CustomXMLProvider, use the dpadmin command to upload the CustomXMLProvider.xml and CustomXMLChannel.xml file XML fragments in the display profile. That is, type:

dpadmin add -u dn_amadmin -w password -d distinguishedname CustomXMLProvider.xml

dpadmin add -u dn_amadmin -w password -d distinguishedname CustomXMLChannel.xml

5. Include the new channel in one of the existing containers.

The CustomXMLProvider channel will be displayed in JSPTableContainer. To add the channel in the JSPTableContainer from the administration console, follow instructions in section "To Add a Channel or Container Channel" in Chapter 5 of the Sun ONE Portal Server 6.0 Administrator's Guide. To add the channel in the JSPTableContainer manually:

1. Develop the CustomXMLProvider channel XML fragment (in the CustomXMLContainer.xml file) for the JSPTableContainer.

The CustomXMLProvider container fragment is shown in Code Example 3-16.




---

Code Example 3-16    CustomXMLContainer.xml File

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Container name="JSPTableContainer" provider="JSPTableContainerProvider">

<Properties>

<Collection name="Personal Channels">

<String value="CustomXML"/>

</Collection>

<Collection name="channelsRow">

<String name="CustomXML" value="3"/>

</Collection>

</Properties>

<Available>

<Reference value="CustomXML"/>

</Available>

<Selected>

<Reference value="CustomXML"/>

</Selected>

<Channels>

</Channels>

</Container>

2. Use the dpadmin add sub command to add the channel to a container. If you do not specify a parent object with the -p option, the channel is added at the root level.

dpadmin modify -m -u dn_amadmin -w password -d distinguishedname CustonXMLContainer.xml

6. Access the CustomXMLProvider channel inside the JSPTableContainer. To access, type the following URL in your browser:

http://hostname:port/portal/dt?provider=JSPTableContainer