Sun Java System Portal Server 7.1 Technical Reference

Chapter 36 Understanding the Developer Sample

This chapter describes the developer sample that you can choose to install on your system during the Sun Java System Portal Server installation. See the Installation Guide for more information on installing the developer sample. This chapter contains the following sections:

Overview

Conceptually, the Desktop is split into the three well-defined components as shown in Figure 37–1.

Base Desktop

This includes Provider Java classes (based on the Provider API), provider display profile definitions and resource bundles (also referred to as properties files), display profile definitions of channels referenced by base Desktop XML or base Desktop JSPs and templates, default templates and JSPs (installed in /var/opt/SUNWportal/portals/<portal_id>/desktop/default directory), and help files.

Developer Sample

This includes organization level display profile definitions (such as themes and channel display profile definitions), templates and JSPs for the example Desktops in the developer sample (installed in /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample directory), and user definition, Desktop display profile definitions, and templates and JSPs for the Authless user.

Other components

This includes the Provider Java classes for their component specific providers, provider display profile definitions for their component specific providers and provider resource bundles (properties files), display profile definition for channels referenced by component display profile XML or component templates and JSPs, default templates and JSPs, and help files.

The developer sample has a dependency on the base Desktop and other components and cannot be installed if the base Desktop and other components are not installed. The base Desktop and other components are installed as part of the Portal Server 7.1 software.

Figure 36–1 Desktop Components

When you install the Portal Server 7.1 software, you can choose to install the developer sample. The developer sample is an authentication-less (authless) desktop that consists of containers, channels, portlets, services, and templates which can be used to demonstrate what the Portal Server 7.1 software is capable of. It includes five example Desktops that show the possibilities of the Portal Server 7.1 software. In this way you can quickly get a feel for the kinds of containers that are possible to design.

Developer Sample Installation Directories

If you choose to install the developer sample, the installer locates the appropriate files in the following directories:

`PortalServer-base`/samples/desktop

This directory contains the following display profile documents:

dp-org.xml: Contains the display profile definitions for channels and containers.
dp-anon.xml: Contains the display profile definitions for channels and containers for the authlessanonymous and anonymous users in the default organization.

The /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample directory contains the JSP, template, and other support files for the Portal Server 7.1 software developer sample.

The /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample contains the JSP, template, and other support files for the Portal Server 7.1 software Desktop anonymous user.

Note –

Sample Desktops

The table below shows the three sample Desktops, which make up the developer sample.

Table 36–1 Sun Java System Portal Server Sample Desktop Containers


Container (Desktop) Type	Description
JSPTabContainer	Generates a JSP-based tab Desktop.Creates a Desktop that contains multiple containers selected using different tabs. Normally, each tab is constructed by using the corresponding PredefinedTabPanelContainer. This container is JSP-based. Its provider is JSPTabContainerProvider.
JSPTableContainer	Generates a JSP-based table Desktop. Creates a Desktop that arranges a maximum of five sub-containers into the channel arrangement. This container is JSP-based. Its provider is JSPTableContainerProvider.
FrameTabContainer	Generates a frame-based Desktop. Creates a Desktop using frames. The left-hand frame enables you to navigate, and the right-hand frame displays the channels. This container is JSP-based. Its provider is JSPTabContainerProvider.

The developer sample can also serve as a place to start when building your own site’s portal. You can customize the containers and use the building-block providers, such as XMLProvider and JSPProvider, to add customized content. The developer sample also includes content providers, such as BookmarkProvider, that cannot be extended but that can be used to provide content.

If the existing building-block and content providers do not meet your needs, you can either extend an existing building-block provider (content providers are not public and hence not extendible), or develop custom building-block providers. If either of these methods do not suit your needs, you can develop a custom provider.