Sun Java System Portal Server 7.1 Technical Reference

Part IV Desktop Java Server Pages

Chapter 26 Overview of Desktop JavaServer Pages

This chapter contains the following sections:

Introduction

To generate the rendered Desktop user interface (what the industry refers to as the “presentation”), the Sun Java System Portal Server 7.1 software makes use of either JSPs or template files. JSPs are preferred because they enable a much easier customization process without having to change the provider Java classes. JSPs also provide a way to enable a strict separation of business and presentation logic. Specifically, this means having the business logic in the provider classes and presentation logic in JSPs.

Installation Location

The default set of JSPs are installed in /var/opt/SUNWportal/portals/<portal_id>/desktop/default directory. The developer sample JSPs are installed in /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample and /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample directories. Files in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample directory are specific to the developer sample Anonymous Desktop.

The Desktop and JavaServer Pages

The JSPProvider class reads in the JSP, compiles it, and runs it to produce the channel content.

The JSPProvider class reads at most three JSPs, one for content, one for the Edit page, and one to process the form submission from the Edit page. All other JSPs used in a JSP-based channel are referenced from one of those JSPs, either by an include or a forward statement.

A simple JSP-based channel can have just one JSP. Multiple JSPs are useful when a single part of the Desktop has to be replicated in several places. For example, consider a channel that has several display modes based on links clicked in that channel. Further, assume that the channel has a banner that must be displayed in all modes but one. You could construct a JSP to reference a banner.jsp file that captures common formatting that is used in multiple branches of the logic. If you didn’t use this method, you would need to duplicate the content from the banner.jsp file, which is more difficult to maintain if that content needs to be changed.

File Lookup Scenario

The Portal Server software uses the lookup scenario outlined in this section to find the JSPs it needs. Use this order to decide the final location of your own JSPs.

Example 26–1 JSP Lookup Scenario

            
desktoptype_
            locale/
            channelname/
            clientPath

            desktoptype_
            locale/
            provider/
            clientPath

            desktoptype_
            locale/
            channelname

            desktoptype_
            locale/
            provider

            desktoptype_
            locale/
            clientPath

            desktoptype_
            locale

            desktoptype/
            channelname/
            clientPath

            desktoptype/
            provider/
            clientPath

            desktoptype/
            channelname

            desktoptype/
            provider

            desktoptype/
            clientPath

            desktoptype
default_
            locale/
            channelname/
            clientPath
default_
            locale/
            provider/
            clientPath
default_
            locale/channelname
default_
            locale/
            provider
default_
            locale/
            clientPath
default_
            locale
default/
            channelname/
            clientPath
default/
            provider/
            clientPath
default/
            channelname
default/
            provider
default/
            clientPath
default

            templateroot

If there is no clientPath specified, then the directory search order is as follows:

Example 26–2 JSP Lookup Scenario (no `clientPath`)

            
desktoptype_
            locale/
            channelname

            desktoptype_
            locale/
            provider

            desktoptype_
            locale

            desktoptype/
            channelname

            desktoptype/
            provider

            desktoptype
default_
            locale/
            channelname
default_
            locale/
            provider
default_
            locale
default/
            channelname
default/
            provider
default

            templateroot

The lookup scenario relies on the following parameters:

desktoptype: For example default (set in the administration console). Note that desktop type is now a comma separated string list and so the look up will be based on the desktop type(s) that are defined in the desktoptype attribute.
locale: Preferred locale is the user’s locale. For example, en_US (set by users through the administration console in the “User” setting)
clientPath: This is an optional file-path containing client-specific templates; for example, html (set through the administration console Client Detection service)
channelname: This is the name of the channel; for example, newSingleContainer (set in the display profile)
provider: This is the provider name; for example, JSPSingleContainerProvider (set in the display profile)
templateroot: This is defined in the desktopconfig.properties file. The root of the search directory (default value of /var/opt/SUNWportal/portals/<portal_id>/config/) can be changed by modifying the templateBaseDir property in the desktopconfig.properties file.

Chapter 27 JSPs in the default Directory

This chapter lists all the JSPs available in the JSP sub directories under the default directory installed in the Sun Java System Portal Server 7.1. The following sections are the names of the sub directories under the default directory. These sections list the JSPs available in each subdirectory and their description.

AddressBookJSPProvider

The AddressBookJSPProvider JSPs are located in html subdirectory under the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/html/AddressBookJSPProvider directory.

The JSPs available in the AddressBookJSPProvider subdirectory and their functionality are:

content.jsp: Displays address book entries.
contentJSFunctions.jsp: JavaScript functions used by channel (included by content.jsp).
contentNavigation.jsp: Displays navigation links in channel (included by content.jsp).
contentNavigationMenu.jsp: Displays navigation pull-down menu in channel (included in content.jsp).
contentStateAttrs.jsp: Controls state of channel (included by content.jsp).
edit.jsp: Allows editing of channel preferences.
error.jsp: Displays error message in channel.
process.jsp: Persists changes to channel preferences.

CalendarJSPProvider

The CalendarJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/CalendarJSPProvider directory.

The JSPs available in the CalendarJSPProvider subdirectory and their functionality are:

calheader.jsp: Displays header information for the calendar.
content.jsp: Retrieves calendar session.
edit.jsp: Allows user to edit preferences
error.jsp: Error message used when calendar connection fails.
fetch.jsp: Gets user preferences and retrieves calendar information based on those preferences.
process.jsp: Modifies user preferences from the edit page.
summary.jsp: Summary number events and tasks. Allows creation of new tasks if server supports the operation.
table.jsp: Shows calendar information for a month.
today.jsp: Shows calendar information for the selected day in day and day or week view.

CommunityDiscussionProvider

The CommunityDiscussionProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/CommunityDiscussionProvider directory.

The JSPs available in the CommunityDiscussionProvider subdirectory and their functionality are:

declare.jsp: Displays the declare section.
discussionContent.jsp: Displays the discussion content.
discussionDoEdit.jsp: Displays the discussion do edit.
discussionEdit.jsp: Displays the discussion edit.
error.jsp: Error message used when community discussion connection fails.
feedback.jsp: Displays the feedback section.
feedbackDisplay.jsp: Displays the feedback display.
feedbackForm.jsp: Displays the feedback form.
feedbackProcess.jsp: Displays the feedback process.
fullDiscussion.jsp: Displays the full discussion section.
fullDiscussionDisplay.jsp: Displays the full discussion display.
pageFooter.jsp: Displays the page footer.
portal.jsp: Displays the portal.
query.jsp: Displays the query.
rating.jsp: Displays the rating.
ratingProcess.jsp: Displays the rating process.
searchUI.jsp: Displays the search UI.
viewDiscussion.jsp: Displays the view discussion.
viewDiscussionBar.jsp: Displays the view discussion bar.
viewDiscussionDisplay.jsp: Display the view discussion display.
viewDiscussionHeader.jsp: Displays the view discussion header.
viewDiscussionNavigation.jsp: Displays the view discussion navigation.

CommunitySearchProvider

The CommunitySearchProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/CommunitySearchProvider directory.

The JSPs available in the CommunitySearchProvider subdirectory and their functionality are:

advQuery.jsp: Displays the advance query.
advancedSearch.jsp: Displays the advanced search.
basicSearch.jsp: Displays the basic search.
browseHeader.jsp: Displays the browse header.
browseOnly.jsp: Displays the browse only section.
browseResults.jsp: Displays browse results.
browseSearch.jsp: Displays browse search.
browseSearchResults.jsp: Displays browse search results.
catMenu.jsp: Displays cat menu.
dbMenu.jsp: Displays database menu.
descMenu.jsp: Displays description menu.
error.jsp: Error message used when community search connection fails.
pageFooter.jsp: Displays page footer.
processRating.jsp: Displays process rating.
psSearch.jsp: Displays ps search.
rating.jsp: Displays rating section.
results.jsp: Displays results.
score.jsp: Displays score section,
searchContent.jsp: Displays search content.
searchDoEdit.jsp: Displays search do edit.
searchEdit.jsp: Displays search edit.
searchMenu.jsp: Displays search menu.
searchOnly.jsp: Displays search only.

CommunitySubscriptionsProvider

The CommunitySubscriptionsProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/CommunitySubscriptionsProvider directory.

The JSPs available in the CommunitySubscriptionsProvider subdirectory and their functionality are:

profilerContent.jsp: Displays profiler content.
subscontent.jsp: Displays subscription content.
subsdoedit.jsp: Displays subscription do edit.
subsedit.jsp: Displays subscription edit.

DefaultChannel

The DefaultChannel JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/DefaultChannel directory.

The JSPs available in the DefaultChannel subdirectory and their functionality are:

content.jsp: Retrieves default channel session.
menubar.jsp: The menubar for the Default Channel.

DiscussionLite

The DiscussionLite channel JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/DiscussionLite directory.

The JSPs available in the DiscussionLite subdirectory and their functionality are:

discussionLiteContent.jsp: Content JSP. This JSP gets portal display profile properties and invokes search using query.jsp and most of the user interface is in display.jsp.
display.jsp: Displays results mostly in HTML.
error.jsp: Error page.
query.jsp: Sets search parameters and executes search.

DiscussionProvider

The DiscussionProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/DiscussionProvider directory.

The JSPs available in the DiscussionProvider subdirectory and their functionality are:

declare.jsp: Declares all portal properties.
discussionContent.jsp: Content page. This JSP routes the request to full if display mode is set to full (or dmode=full), or if vl is set to viewDiscussion.jsp, or cmt is set to feedback.jsp, or if rtg is set to ratingProcess.jsp.
discussionDoEdit.jsp: Process edit page.
discussionEdit.jsp: Edit page.
error.jsp: Error page.
feedback.jsp: Request is handled by feedback.jsp when the dmode (discussions mode) value is equal to cmt. Routes the request to feedbackForm.jsp.
feedbackDisplay.jsp: Displays feedback.
feedbackForm.jsp: Displays the ”post reply’ and ”start a new discussion’ form.
feedbackProcess.jsp: Comment submission is handled by this JSP. The JSP retrieves all the input parameters, builds the search result and submits the search result to the search database. This JSP consists of scriptlets.
fullDiscussion.jsp: Sets search parameters, executes search, and displays results.
fullDiscussionDisplay.jsp: Displays main discussions with description inline based on showDesc property.
pageFooter.jsp: Displays pagination on list discussions page.
portal.jsp: General portal Desktop page. Retrieves all portal provider properties.
query.jsp: Executes search. Used by all pages to execute a search.
rating.jsp: Displays the selection menu for ratings. Included in viewDiscusisonDisplay.jsp and viewDiscussionHeader.jsp.
ratingProcess.jsp: Request is handled by ratingProcess.jsp when dmode=rtg. Handles rating submission. Consists mostly of scriptlets.
searchUI.jsp: Displays the search box on the list discussions page.
viewDiscussion.jsp: Request is handled by viewDiscussion.jsp when dmode=vl. Controls the View A Discussion subtree page.
viewDiscussionBar.jsp: Displays the separator bar with the filter, threshold, view menus and the search discussion text field.
viewDiscussionDisplay.jsp: Displays the discussion subtree below the separator bar.
viewDiscussionHeader.jsp: Displays the detailed view of the discussion. Displayed above the separator bar.
viewDiscussionNavigation.jsp: Displays the Navigation links shown above and below the discussion header. Navigation links consist of links for ”All Discussions’, ”To parent’, ”To Discussion, ”Reference’, ”Post Reply’.

IFrameProvider

The IFrameProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/IFrameProvider directory.

The JSPs available in the IFrameProvider subdirectory and their functionality are:

iframe.jsp: Displays the iframe.

IMProvider

The IMProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/IMProvider directory.

The JSPs available in the IMProvider subdirectory and their functionality are:

IMArchiveDisplay.jsp: Controls searching through archived instant messaging content.
IMContent.jsp: Controls the content in the channel.
IMEdit.jsp: Controls the content for the edit page of the channel.
invite.jsp: Controls the content in the popup window that is displayed when a user is invited to a conference is an instant messaging client that is already running.
jnlpLaunch.jsp: Controls the messages that are in the Java Web Start window that is used to start the instant messaging client.
pluginLaunch.jsp: Controls the content of the popup window that is used to run the IM client.

JSPContentContainer

The JSPContentContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPContentContainer directory. These JSPs are used for the content view when the Content link is selected in a JSP-based table container.

The JSPs available in the JSPContentContainer subdirectory and their functionality are:

contentdoedit.jsp: Processes the result from the Content Edit page.
contentedit.jsp: Displays the content Edit page.

JSPDynamicSingleContainer

The JSPDynamicSingleContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPDynamicSingleContainer directory. This container is used by the search form in the header on the Desktop front page.

The JSPs available in the JSPDynamicSingleContainer subdirectory and their functionality are:

dynamicSingle.jsp: Used by the DynamicSingleContainer to display the channel specified in the request parameter.

JSPEditContainer

JSPEditContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPEditContainer directory. These JSPs are used when the Edit icon is selected in a channel title bar inside a JSP- based container. Channels that have the editType defined as EDIT_SUBSET use these JSPs.

The JSPs available in the JSPEditContainer subdirectory and their functionality are:

doedit.jsp: Processes the result from the Edit page.
edit.jsp: Displays the Edit view of a channel. Also provides a wrapper around the actual Edit view for a given channel.

JSPFrameCustomTableContainerProvider

JSPFrameCustomTableContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPFrameCustomTableContainerProvider directory.

JSPFrameCustomTableContainerProvider JSPs are used when the user creates a new page from Scratch in the sections page.

The JSPs available in the JSPFrameCustomTableContainerProvider subdirectory and their functionality are:

framecustomtable.jsp: Displays the content for the newly created page (table container) from the Sections page.
launchPopup.jsp: This JSP is used to determine the channels that are in detached mode and invoke the detached windows for these channels.
leafWrapper.jsp: Displays the channel title bar and border.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)

JSPLayoutContainer

JSPLayoutContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPLayoutContainer directory. These JSPs are used to display the Layout view when the Layout link is selected in a JSP-based table container.

The JSPs available in the JSPLayoutContainer subdirectory and their functionality are:

layout1.jsp: Displays the thin-wide layout view.
layout2.jsp: Displays the wide-thin layout view.
layout3.jsp: Displays the thin-wide-thin layout view.
layoutdoedit.jsp: Processes the result from the Layout Edit page.
layoutedit.jsp: Displays the Layout Edit page.
selectLayout.jsp: Displays the three layout images and the select radio buttons.

JSPMenuContainerProvider

This container is responsible for displaying menu or tab items. The JSPMenuContainerProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPMenuContainerProvider directory.

The JSPs available in the JSPMenuContainerProvider subdirectory and their functionality are:

channels.jsp: Displays the channels.
header.jsp: Displays the header.
menu.jsp: Displays the vertical menu.
menubar.jsp: The menubar for the Default Channel.
menuedit.jsp: This is the entry point into this container in edit mode.
menulist.jsp: The menubar for the Default Channel.
menumain.jsp: This is the entry point into this container in content mode.
menuoption.jsp: The menubar for the Default Channel.
selectedchannels.jsp: The menubar for the Default Channel.

JSPNativeContainer

The JSPNativeContainer JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPNativeContainer/aml/chtml directory.

The JSPs available in the chtml subdirectory under JSPNativeContainer and their functionality are:

channelMenuSection.jsp: Displays the channel menu section.
channelsContent.jsp: The menubar for the Default Channel.
header.jsp: Displays the header.
nonInlineChannelMenuSection.jsp: The menubar for the Default Channel.
wireless.jsp: Displays the wireless section.

JSPProvider

JSP Provider is used to create a channel using jsp file. JSPProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPProvider directory. This directory contains default set of JSPs that are used by the JSP channels.

The JSPs available in the JSPProvider subdirectory and their functionality are:

samplecontent.jsp: Displays the contents of the JSP channels.
sampledoedit.jsp: Invoked when the user completes processing the Edit page of the JSP channels.
sampleedit.jsp: Invoked when the user clicks the Edit button of the JSP channels.

JSPRenderingContainerProvider

The JSPRenderingContainerProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPRenderingContainerProvider/aml directory.

The JSPs available in the aml subdirectory under JSPRenderingContainerProvider and their functionality are:

channelMenuSection.jsp: Displays the channel menu section.
channelsCards.jsp: The menubar for the Default Channel.
desktop.jsp: Displays the desktop.
dtSetup.jsp: The menubar for the Default Channel.
minimizedChannelMenuSection.jsp: Displays the minimized channel menu section.
optionsCard.jsp: Displays the options card.

JSPRenderingContentChannel

The JSPRenderingContentChannel JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPRenderingContentChannel/aml directory.

The JSPs available in the aml subdirectory under JSPRenderingContentChannel and their functionality are:

contentSetup.jsp: Displays the content setup.
contentdoedit.jsp: The menubar for the Default Channel.
contentedit.jsp: Displays the content edit.

JSPRenderingEditContainer

The JSPRenderingEditContainer JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPRenderingEditContainer/aml directory.

The JSPs available in the aml subdirectory under JSPRenderingEditContainer and their functionality are:

doedit.jsp: Displays the do edit.
edit.jsp: Allows user to edit preferences.

JSPRenderingErrorChannel

The JSPRenderingErrorChannel JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPRenderingErrorChannel/aml directory.

The JSPs available in the aml subdirectory under JSPRenderingErrorChannel and their functionality are:

errorPage.jsp: Displays the error page.

JSPRenderingLayoutChannel

The JSPRenderingLayoutChannel JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPRenderingLayoutChannel/aml directory.

The JSPs available in the aml subdirectory under JSPRenderingLayoutChannel and their functionality are:

layoutSetup.jsp: Displays the layout setup.
layoutdoedit.jsp: Displays the layout do edit.
layoutedit.jsp: Displays the layout edit.

JSPRenderingProvider

The JSPRenderingProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPRenderingProvider/aml directory.

The JSPs available in the aml subdirectory under JSPRenderingProvider and their functionality are:

samplecontent.jsp: Displays the sample content.

JSPSingleContainerProvider

JSPSingleContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPSingleContainerProvider directory.

The JSPs available in the JSPSingleContainerProvider subdirectory and their functionality are:

header.jsp: Displays the product banner that is used by the Single Container page.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
single.jsp: Displays the content for JSPSingleContainerProvider.

JSPSingleRenderingContainerProvider

The JSPSingleRenderingContainerProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPSingleRenderingContainerProvider/aml directory.

The JSPs available in the aml subdirectory under JSPSingleRenderingContainerProvider and their functionality are:

header.jsp: Displays the header.
single.jsp: Displays the single section.

JSPTabContainerProvider

JSPTabContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPTabContainerProvider directory. These JSPs are used as the default set of JSPs for a new channel based on JSPTabContainerProvider.

The JSPs available in the JSPTabContainerProvider subdirectory and their functionality are:

availableTabs.jsp: Displays the tabs and the URLs associated with each tab for activating them on the front page.
header.jsp: Displays the header bar for the Tab Container page. (Dynamically included.)
makeNewTab.jsp: Provides the content for the Make New Tab page of the tab container.
makeTopic.jsp: Provides the content for each of the tab topics in the Make New Tab page.
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links. (Dynamically included.)
remove.jsp: Displays the remove, rename, and start links for each of the selected pages of the JSP tab container in the Current Tab Settings page.
removeRenameTab.jsp: Displays the remove and rename part of the Edit page for the tab container.
selectedTab.jsp: Displays the tab image for the current selected tab in the tab container.
tab.jsp: Is the main JSP for the tab container. It draws the content page for the tab container. (Dynamically includes header.jsp and menubar.jsp.)
tabedit.jsp: Displays the Edit page for the tab container where new pages can be added, removed, or renamed.
tabs.jsp: Displays the available tabs and the links for them to be activated on the Desktop.

JSPTabCustomTableContainerProvider

JSPTabCustomTableContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPTabCustomTableContainerProvider directory. JSPTabCustomTableContainerProvider JSPs are used when the user creates a new tab from scratch in the tabs page.

The JSPs available in the JSPTabCustomTableContainerProvider subdirectory and their functionality are:

launchPopup.jsp: Displays the windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the provider command bar for each channel inside the table container.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
tabcustomtable.jsp: Displays the table container’s content view.
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)

JSPTableContainerProvider

Files under this directory are used to layout the portal page. This container can display channels at FULL TOP, LEFT, CENTER, RIGHT, and FULL BOTTOM locations. JSPTableContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/JSPTableContainerProvider directory. JSPTableContainerProvider JSPs are the default JSPs that are used by the JSPTableContainerProvider channels.

The JSPs available in the JSPTableContainerProvider subdirectory and their functionality are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWraper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: This JSP is included by leafWrapper.jsp. This JSP is responsible to display the maximize, minimize, detach, and delete buttons. Displays the provider command bar for each channel inside the table container.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: This is the entry point into this container for content mode. Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Displays the LEFT, CENTER, and RIGHT channels of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Displays the FULL TOP and FULL BOTTOM channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

JSPs Within the default Directory

The JSPs listed below are located within the /var/opt/SUNWportal/portals/<portal_id>/desktop/default directory. These JSPs are used by more than one channel, and are also used as a default if the named JSP is not found in the provider or channel subdirectory.

The JSPs available within the /default directory and their functionality are:

defaultHeader.jsp: Displays the default product banner that includes the user reference links.
defaultMenubar.jsp: Displays the default menubar that includes the user reference links.
launchPopup.jsp: Displays the detached windows that are detached from the table containers. (Dynamically included.)
PortletBanner.jsp: This JSP is used to draw the banner on the edit page of a JSR (Java Specification Request) 168 portlet when the edit button is clicked on the portlet.
PortletEdit.jsp: This JSP is used to draw the edit page of a JSR 168 portlet when the edit button is clicked on the portlet.
PortletHelp.jsp: This JSP is used as a wrapper for the portlet’s help content on the help page of a JSR 168 portlet when the help button is clicked on the portlet.
PortletMenubar.jsp: This JSP is used to draw the menubar on the edit page of a JSR 168 portlet when the edit button is clicked on the portlet.
providerCommands.jsp: Displays the minimize, maximize, help, edit, detach, remove links in the channel title bar.
searchbox.jsp: Displays the search box that are used in the desktop header area.
singlePreferenceHeader.jsp: Displays the product banner that is used by the single containers.
singlePreferenceMenubar.jsp: Displays the menubar that is used by the single containers.
tablePreferenceHeader.jsp: Displays the product banner that is used by the table containers.
tablePreferenceMenubar.jsp: Displays the menubar that is used by the table containers.
tabPreferenceHeader.jsp: Displays the product banner that is used by the tab containers.
tabPreferenceMenubar.jsp: Displays the menubar that is used by the tab containers.

LotusNotesAddressBookJSPProvider

The LotusNotesAddressBookJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/LotusNotesAddressBookJSPProvider/html directory.

The JSPs available in the html subdirectory under LotusNotesAddressBookJSPProvider and their functionality are:

content.jsp: Displays address book entries.
contentJSFunctions.jsp: JavaScript functions used by channel (included by content.jsp).
contentNavigation.jsp: Displays navigation links in channel (included by content.jsp).
contentNavigationMenu.jsp: Displays navigation pull-down menu in channel (included in content.jsp).
contentStateAttrs.jsp: Controls state of channel (included by content.jsp).
edit.jsp: Allows editing of channel preferences.
error.jsp: Displays error message in channel.
process.jsp: Persists changes to channel preferences.

LotusNotesCalendarJSPProvider

The LotusNotesCalendarJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/LotusNotesCalendarJSPProvider directory.

The JSPs available in the LotusNotesCalendarJSPProvider subdirectory are similar to the JSPs available in the CalendarJSPProvider. For more information on these JSPs, see CalendarJSPProvider.

LotusNotesMailJSPProvider

The LotusNotesMailJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/LotusNotesMailJSPProvider/html directory.

The JSPs available in the html subdirectory under LotusNotesCalendarJSPProvider and their functionality are:

content.jsp: Retrieves lotus notes mail session.
edit.jsp: Allows user to edit preferences of the lotus notes mail.
error.jsp: Error message used when lotus notes mail connection fails.
process.jsp: Modifies user preferences from the edit page

MAAddressBookJSPProvider

The MAAddressBookJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/MAAddressBookJSPProvider/html directory.

The JSPs available in the html subdirectory under MAAddressBookJSPProvider and their functionality are:

edit.jsp: Allows editing of mobile address book application preferences. Used for Mobile Access application.
process.jsp: Persists changes to application preferences. Used for Mobile Access application.

MAMailJSPProvider

The MAMailJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/MAMailJSPProvider/html directory.

The JSPs available in the html subdirectory under MAMailJSPProvider and their functionality are:

edit-device.jsp: Used for mobile access. Allows editing of device properties.
edit-devices.jsp: Used for mobile access. Displays a list of devices that can be edited.
edit-main-other.jsp: Used for mobile access. Allows editing properties for the mobile mail application.
edit-main-pop.jsp: Used for mobile access. Allows editing of properties of POP collection feature of the mobile mail application.
edit-main-views.jsp: Used for mobile access. Allows editing of views feature of the mobile mail application.
edit-pop.jsp: Used for mobile access. Allows editing of properties of POP collection feature of the mobile mail application.
edit-rule.jsp: Used for mobile access. Allows editing of rules feature of the mobile mail application.
edit-rules.jsp: Used for mobile access. Allows editing of rules feature of the mobile mail application.
edit-view.jsp: Used for mobile access. Allows editing of views feature of the mobile mail application.
edit-views.jsp: Used for mobile access. Displays list of views configured for the mobile mail application.
edit.jsp: Used for mobile access. Allows editing of mobile mail application preferences.
error.jsp: Used for mobile access. Displays error message when channel connection fails.
process-device.jsp: Used for mobile access. Persists changes to the user preferences.
process-main.jsp: Used for mobile access. Persists changes to the user preferences.
process-pop-add.jsp: Used for mobile access. Persists changes to the user preferences.
process-pop-common.jsp: Used for mobile access. Persists changes to the user preferences.
process-pop-delete.jsp: Used for mobile access. Persists changes to the user preferences.
process-pop-edit.jsp: Used for mobile access. Persists changes to the user preferences.
process-rule-add.jsp: Used for mobile access. Persists changes to the user preferences.
process-rule-common.jsp: Used for mobile access. Persists changes to the user preferences.
process-rule-delete.jsp: Used for mobile access. Persists changes to the user preferences.
process-rule-edit.jsp: Used for mobile access. Persists changes to the user preferences.
process-view-add.jsp: Used for mobile access. Persists changes to the user preferences.
process-view-common.jsp: Used for mobile access. Persists changes to the user preferences.
process-view-delete.jsp: Used for mobile access. Persists changes to the user preferences.
process-view-edit.jsp: Used for mobile access. Persists changes to the user preferences.
process.jsp: Used for mobile access. Persists changes to the user preferences.

MSExchangeAddressBookJSPProvider

The MSExchangeAddressBookJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/MSExchangeAddressBookJSPProvider/html directory.

The JSPs available in the html subdirectory under MSExchangeAddressBookJSPProvider and their functionality are:

content.jsp: Displays MSExchange address book entries.
contentJSFunctions.jsp: JavaScript functions used by channel (included by content.jsp).
contentNavigation.jsp: Displays navigation links in channel (included by content.jsp).
contentNavigationMenu.jsp: Displays navigation pull-down menu in channel (included in content.jsp).
contentStateAttrs.jsp: Controls state of channel (included by content.jsp).
edit.jsp: Allows editing of channel preferences.
error.jsp: Displays error message in channel.
process.jsp: Persists changes to channel preferences.

MSExchangeCalendarJSPProvider

The MSExchangeCalendarJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/MSExchangeCalendarJSPProvider directory.

The JSPs available in the MSExchangeAddressBookJSPProvider subdirectory are similar to the JSPs available in the CalendarJSPProvider. For more information on these JSPs, see CalendarJSPProvider.

MSExchangeMailJSPProvider

The MSExchangeMailJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/MSExchangeMailJSPProvider/html directory.

The JSPs available in the html subdirectory under MSExchangeMailJSPProvider and their functionality are:

content.jsp: Displays a list of email headers.
edit.jsp: Allows editing of channel preferences.
error.jsp: Displays error message when channel connection fails.
process.jsp: Persists changes to the user preferences.

MailJSPProvider

The MailJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/MailJSPProvider/html directory.

The JSPs available in the html subdirectory under MailJSPProvider and their functionality are:

content.jsp: Displays a list of email headers.
edit.jsp: Allows editing of channel preferences.
error.jsp: Displays error message when channel connection fails.
process.jsp: Persists changes to the user preferences.

RenderingWrappingProvider

The RenderingWrappingProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/RenderingWrappingProvider/aml directory.

The JSPs available in the aml subdirectory under RenderingWrappingProvider and their functionality are:

contentWrapper.jsp: Displays the content wrapper.

SampleSimpleWebService

SampleSimpleWebService JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/SampleSimpleWebService directory.

The JSPs available in the SampleSimpleWebService subdirectory and their functionality are:

CurrencyExchangeService.wsdl: Displays the WSDL file for the current exchange web service.
webserviceContent.jsp: Displays the Content view of the simple web service channels.
webserviceInputEdit.jsp: Displays the Edit view of the simple web service channels.

SampleSimpleWebServiceConfigurable

SampleSimpleWebServiceConfigurable JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/SampleSimpleWebServiceConfigurable directory.

The JSPs available in the SampleSimpleWebServiceConfigurable subdirectory and their functionality are:

CurrencyExchangeService.wsdl: Displays the WSDL file for the current exchange web service.
webserviceContent.jsp: Displays the Content view of the simple web service configurable channels.
webserviceWsdlEdit.jsp: Displays the Edit view of the simple web service configurable channels.

SearchProvider

The SearchProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/SearchProvider directory.

The JSPs available in the SearchProvider subdirectory and their functionality are:

advQuery.jsp

Converts the advanced query to the list format. This JSP consists mostly of Java code, which is exposed so that the advanced search query list can be customized according to the schema changes.

advancedSearch.jsp

Displays the interface to perform an advanced search, including the description menu. This JSP uses the SearchRequestBean to store request parameters and display the form values. The bean reduces Java scriptlets in the JSP.

You use this JSP to make changes to the advanced search interface, removal for search fields, and addition of fields.

browseHeader.jsp

Contains the browse-related code that shows up in the browse interface. Includes the category tree Home link and the Search in all categories, and Search within a category radio buttons.

basicSearch.jsp

Displays the interface to perform a basic search.

browseOnly.jsp

Sets and executes the parameters for category browsing using the search tag library. This JSP sets all the parameters required to browse and executes the search and includes the browseResults.jsp page.

browseResults.jsp

Displays category tree in the browse section. (It consists of many Java scriptlets, so modifying this JSP requires good Java proficiency.)

browseSearch.jsp

Sets and executes the parameters for searching and browsing within categories using the Search tag library. The JSP sets the RDMType to rd-request and query language to search, and sets other search parameters. It includes the browseSearchResults.jsp page to display the category matches.

browseSearchResults.jsp

Displays the number of category matches found and the links to matching categories. (It consists of many Java scriptlets, so modifying this JSP requires good Java proficiency.)

catMenu.jsp

Displays category list.

dbMenu.jsp

Displays database list.

descMenu.jsp

Contains the description menu, that is, the Full, Brief, and Title menus. This menu is included in the basic, advanced, and browse interfaces.

error.jsp

Displays error messages.

pageFooter.jsp

Displays the list of pages, Next, and Previous links.

psSearch.jsp

Is the portal server related JSP file. The user profile property values are retrieved from the portal server. The customer can substitute this file if the values can be retrieved from other data stores.

results.jsp

Specifies the number of matches found and displays document results, score, title, description for each document. (Consists of some Java scriptlets.)

score.jsp

Computes the scale that displays the document match relevance.

searchContent.jsp

Displays the Content view of the Search channel, and delegates the request to other search JSPs, based on the request type. The basic search, advanced search, or browse interfaces are displayed based on the requested mode. The search results are displayed based on the request type.

This JSP includes the advancedSearch.jsp or basicSearch.jsp based on user selection. The browseSearch.jsp and searchOnly.jsp files are included only if the user has specified a query; otherwise the category tree (no search) is displayed from browseOnly.jsp. The pageFooter.jsp file is included to display the pagination bar in the Search channel.

searchDoEdit.jsp

Invoked when the user completes processing the Edit page of the Search channel.

searchEdit.jsp

Invoked when the user clicks the Edit button of the Search channel.

searchMenu.jsp

Contains the HTML ribbon for Basic, Advanced, and Browse links.

searchOnly.jsp

Sets and executes the parameters for search using search the tag library. The advQuery.jsp is included if its an advanced search. This JSP includes the results.jsp to display the document matches.

SimpleWebServiceConfigurableProvider

SimpleWebServiceConfigurableProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/SimpleWebServiceConfigurableProvider directory. These JSPs are the default JSPs that are used by the SimpleWebServiceConfigurableProvider channels.

The JSPs available in the SimpleWebServiceConfigurableProvider subdirectory and their functionality are:

webserviceContent.jsp: Displays the Content view of the simple web service configurable channels.
webserviceWsdlEdit.jsp: Displays the Edit view of the simple web service configurable channels.

SimpleWebServiceProvider

SimpleWebServiceProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/SimpleWebServiceProvider directory. These JSPs are default JSPs that are used by the SimpleWebServiceProvider channels.

The JSPs available in the SimpleWebServiceProvider subdirectory and their functionality are:

webserviceContent.jsp: Displays the Content view of the simple web service configurable channels.
webserviceInputEdit.jsp: Displays the Edit view of the simple web service channels.

SubscriptionsProvider

The SubscriptionsProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/SubscriptionsProvider directory.

The JSPs available in the SubscriptionsProvider subdirectory and their functionality are:

profilerContent.jsp

Displays the profiler content.

subscontent.jsp

Displays the list of subscriptions per type of subscriptions (such as category subscriptions, discussions subscriptions, saved search subscriptions). For each, the list of user’s subscriptions labels and associated document hit link is displayed. The hit link, points the end user to display a detailed view of the information matching their subscription.

subsdoedit.jsp

Used to manage (such as delete/update) existing subscriptions, or adding new subscriptions when the user clicks on “subscribe to” links from the search or discussion channel.

This JSP segments the subscriptions in to three types: category subscriptions, discussions subscriptions, saved search subscriptions.

subsedit.jsp

This JSP is triggered to handle the subscriptions changes made by the end user in the page presented by subsedit.jsp. The role of this JSP, is to update the Sun Java System Access Manager subscriptions service attributes holding the subscription information.

TabJSPEditContainer

TabJSPEditContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/TabJSPEditContainer directory.

The JSPs available in the TabJSPEditContainer subdirectory and their functionality are:

contentLayoutBar.jsp: Displays the Edit page for channels in JSPTabContainer.
doedit.jsp: Is the process page for TabJSPEditContainer.
tabedit.jsp: Displays the Content and Layout links and the current selected tab on the Edit page.

UWCAddressBookJSPProvider

The UWCAddressBookJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/UWCAddressBookJSPProvider/html directory.

The JSPs available in the html subdirectory under UWCAddressBookJSPProvider and their functionality are:

content.jsp: Displays UWC address book entries.
contentJSFunctions.jsp: JavaScript functions used by channel (included by content.jsp).
contentNavigation.jsp: Displays navigation links in channel (included by content.jsp).
contentNavigationMenu.jsp: Displays navigation pull-down menu in channel (included in content.jsp).
contentStateAttrs.jsp: Controls state of channel (included by content.jsp).
edit.jsp: Allows editing of channel preferences.
error.jsp: Displays error message in channel.
process.jsp: Persists changes to channel preferences.

UWCCalendarJSPProvider

The UWCCalendarJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/UWCCalendarJSPProvider directory.

The JSPs available in the UWCCalendarJSPProvider subdirectory are similar to the JSPs available in the CalendarJSPProvider. For more information on these JSPs, see CalendarJSPProvider.

UWCMailJSPProvider

The UWCMailJSPProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/UWCMailJSPProvider/html directory.

The JSPs available in the html subdirectory under UWCMailJSPProvider and their functionality are:

content.jsp: Displays a list of email headers.
edit.jsp: Allows editing of channel preferences.
error.jsp: Displays error message when channel connection fails.
process.jsp: Persists changes to the user preferences.

WirelessJSPClientConfigContainer

The WirelessJSPClientConfigContainer JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPClientConfigContainer/html directory.

The JSPs available in the html subdirectory under WirelessJSPClientConfigContainer and their functionality are:

clientconfig.jsp: Displays the client configuration.
clientconfigSetup.jsp: Displays the client configuration setup.
clientconfigprocess.jsp: Displays the client configuration process.

WirelessJSPContentChannel

The WirelessJSPContentChannel JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPContentChannel directory. Under this directory, you can find the contentSetup.jsp.

contentSetup.jsp: Displays the content setup.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPContentChannel/aml/chtml directory and their functionality are:

contentdoedit.jsp: Displays the content do edit.
contentedit.jsp: Displays the content edit.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPContentChannel/html directory and their functionality are:

contentSetup.jsp: Displays the content setup.
contentdoedit.jsp: Displays the content do edit.
contentedit.jsp: Displays the content edit.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPContentChannel/wml directory and their functionality are:

adjustChannelList.jsp: Displays the adjust channel list.
contentdoedit.jsp: Displays the content do edit.
contentedit.jsp: Displays the content edit.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPContentChannel/vxml directory and their functionality are:

adjustChannelList.jsp: Displays the adjust channel list.
contentdoedit.jsp: Displays the content do edit.
contentedit.jsp: Displays the content edit.
voiceSetup.jsp: Displays the voice setup.

WirelessJSPDesktopProvider

The WirelessJSPDesktopProvider JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPDesktopProvider directory. Under this directory, you can find the dtSetup.jsp.

dtSetup.jsp: Displays the dtsetup.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPDesktopProvider/aml/chtml directory and their functionality are:

channelMenuSection.jsp: Displays the channel menu section.
channelsContent.jsp: Displays the channels content.
nonInlineChannelMenuSection.jsp: Displays the non inline channel menu section.
wireless.jsp: Displays the wireless section.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPDesktopProvider/vxml directory and their functionality are:

desktop.jsp: Displays the desktop.
voiceSetup.jsp: Displays the voice setup.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPContentChannel/wml directory and their functionality are:

channelMenuSection.jsp: Displays the channel menu section.
channelsCards.jsp: Displays the channel cards.
minimizedChannelMenuSection.jsp: Displays the minimized channel menu section.
optionsCard.jsp: Displays the options card.
wireless.jsp: Displays the wireless section.

WirelessJSPLayoutChannel

The WirelessJSPLayoutChannel JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPLayoutChannel directory. Under this directory, you can find the following JSPs.

layoutSetup.jsp: Displays the layout setup.
layoutdoedit.jsp: Displays the layout do edit.

The JSP available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPLayoutChannel/aml/chtml directory and its functionality is:

layoutedit.jsp: Displays the layout edit.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPLayoutChannel/html directory and their functionality are:

layoutSetup.jsp: Displays the layout setup.
layoutdoedit.jsp: Displays the layout do edit.
layoutedit.jsp: Displays the layout edit.

The JSPs available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/default/WirelessJSPLayoutChannel/wml directory and their functionality are:

layoutdoedit.jsp: Displays the layout do edit.
layoutedit.jsp: Displays the layout edit.

vxml

The vxml JSPs are located in /var/opt/SUNWportal/portals/<portal_id>/desktop/default/vxml directory. Under this directory, you can find the following JSP.

docTypeDeclaration.jsp: Displays the do type declaration.

Chapter 28 JSPs in the community_sample Directory

This chapter contains the following sections:

AccountPreferencesContainer

The AccountPreferencesContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/AccountPreferencesContainer directory.

The list of JSPs in AccountPreferencesContainer directory and their description are:

AccountPreferencesContainer/content.jsp: The Account Preferences link in the Masthead calls the AccountPreferencesContainer. The content.jsp in this container provides initial content by including the content.jsp in sub directories such as timezone, password, and contactinfo for changing the respective account preferences.
AccountPreferencesContainer/process.jsp: This JSP processes account preferences by forwarding request to process.jsp in sub directories for timezone, password, and contactinfo.
AccountPreferencesContainer/timezone/error.jspAccountPreferencesContainer/timezone/content.jspAccountPreferencesContainer/timezone/process.jspAccountPreferencesContainer/timezone/complete.jspAccountPreferencesContainer/timezone/contentFormValidation.jsp: These JSPs handle time zone preferences display (content.jsp), processing changes (process.jsp), handling process errors (error.jsp), the process completion messages (complete.jsp), and the client side form validation process (clientFormValidation.jsp).
AccountPreferencesContainer/password/contentFormValidation.jspAccountPreferencesContainer/password/complete.jspAccountPreferencesContainer/password/content.jspAccountPreferencesContainer/password/process.jspAccountPreferencesContainer/password/error.jsp: These JSPs handle password preferences display (content.jsp), processing changes (process.jsp), handling process errors (error.jsp), the process completion messages (complete.jsp), and the client side form validation process (clientFormValidation.jsp).
AccountPreferencesContainer/contactinfo/process.jspAccountPreferencesContainer/contactinfo/complete.jspAccountPreferencesContainer/contactinfo/contentFormValidation.jspAccountPreferencesContainer/contactinfo/error.jspAccountPreferencesContainer/contactinfo/content.jsp: These JSPs handle contactinfo preferences display (content.jsp), processing changes (process.jsp), handling process errors (error.jsp), the process completion messages (complete.jsp), and the client side form validation process (clientFormValidation.jsp).

SearchProvider

The Search Provider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/SearchProvider directory.

The list of JSPs in SearchProvider directory and their description are:

SearchProvider/results.jspSearchProvider/pageFooter.jspSearchProvider/browseSearch.jspSearchProvider/browseHeader.jspSearchProvider/searchDoEdit.jspSearchProvider/descMenu.jspSearchProvider/browseSearchResults.jspSearchProvider/searchEdit.jspSearchProvider/basicSearch.jspSearchProvider/browseOnly.jspSearchProvider/searchMenu.jspSearchProvider/psSearch.jspSearchProvider/processRating.jspSearchProvider/searchOnly.jspSearchProvider/searchContent.jspSearchProvider/catMenu.jspSearchProvider/browseResults.jspSearchProvider/dbMenu.jspSearchProvider/rating.jspSearchProvider/score.jspSearchProvider/error.jspSearchProvider/advancedSearch.jspSearchProvider/advQuery.jsp: These JSPs handle search provider functionality in the community sample.

DiscussionProvider

The Discussion Provider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/DiscussionProvider directory.

The list of JSPs in DiscussionProvider directory and their description are:

DiscussionProvider/viewDiscussionNavigation.jspDiscussionProvider/discussiondoEdit.jspDiscussionProvider/viewDiscussionDisplay.jspDiscussionProvider/rating.jspDiscussionProvider/error.jspDiscussionProvider/viewDiscussionBar.jspDiscussionProvider/fullDiscussion.jspDiscussionProvider/viewDiscussion.jspDiscussionProvider/pageFooter.jspDiscussionProvider/viewDiscussionHeader.jspDiscussionProvider/declare.jspDiscussionProvider/fullDiscussionDisplay.jspDiscussionProvider/ratingProcess.jspDiscussionProvider/feedbackProcess.jspDiscussionProvider/searchUI.jspDiscussionProvider/feedback.jspSearchProvider/feedbackForm.jspSearchProvider/discussionEdit.jspDiscussionProvider/query.jspDiscussionProvider/portal.jspDiscussionProvider/feedbackDisplay.jspDiscussionProvider/discussionContent.jsp: These JSPs handle discussion provider functionality in the community sample.

PagePreferencesContainer

The JSPs in the PagePreferencesContainer are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/PagePreferencesContainer directory.

The list of JSPs in PagePreferencesContainer directory and their description are:

PagePreferencesContainer/process.jsp: This JSP controls the PagePreferencesContainer process. This JSP processes functionality by forwarding request to sub directories such as content and layout process jsps.
PagePreferencesContainer/content.jsp: This JSP controls the PagePreferencesContainer content display by including content from sub directories such as content and layout content jsps.
PagePreferencesContainer/content/process.jspPagePreferencesContainer/content/complete.jspPagePreferencesContainer/content/contentFormValidation.jspPagePreferencesContainer/content/error.jspPagePreferencesContainer/content/content.jsp: These jsps handle content display (content.jsp), processing changes (process.jsp), handling process errors (error.jsp), the process completion messages (complete.jsp), and the client side form validation process (clientFormValidation.jsp).
PagePreferencesContainer/layout/content.jspPagePreferencesContainer/layout/complete.jspPagePreferencesContainer/layout/contentFormValidation.jspPagePreferencesContainer/layout/process.jspPagePreferencesContainer/layout/tableContent.jspPagePreferencesContainer/layout/layout3.jspPagePreferencesContainer/layout/layout2.jspPagePreferencesContainer/layout/error.jspPagePreferencesContainer/layout/menuContent.jspPagePreferencesContainer/layout/layout1.jsp: These JSPs handle layout display (content.jsp), processing changes (process.jsp), handling process errors (error.jsp), the process completion messages (complete.jsp), and the client side form validation process (clientFormValidation.jsp). These JSPs also include display of channels in supported containers (menuContent.jsp) and (tableContent.jsp) with supported layouts for tableContent including layout1.jsp, layout2.jsp, and layout3.jsp.

JSPTableContainerProvider

The JSPTableContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/JSPTableContainerProvider directory.

The list of JSPs in JSPTableContainerProvider directory and their description are:

JSPTableContainerProviderProvider/popupChannelMenubar.jsp: This is the JSP for menu in channel titlebar area when the channel is detached.
JSPTableContainerProviderProvider/ChannelMenubar.jsp: This is the JSP for menu in channel titlebar area.
JSPTableContainerProviderProvider/Channel.jsp: This is the JSP for a channel.
JSPTableContainerProviderProvider/column.jsp: This is the JSP for a table container column of channels.
JSPTableContainerProviderProvider/popupChannel.jsp: This is the JSP processes the channel content if a channel is detached.
JSPTableContainerProviderProvider/table.jsp: This is the controlling JSP for a table container in the community sample.
JSPTableContainerProviderProvider/tableFullWindow.jsp: This is the JSP for when one of the channels in the container is maximized.
JSPTableContainerProviderProvider/launchPopup.jsp: This JSP includes JavaScript, which allows for a channel to be detached.

JSPEditContainer

Developer Sample Anonymous Desktop JSPs for the JSPEditContainer are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/JSPEditContainer directory.

The list of JSPs in JSPEditContainer directory and their description are:

JSPEditContainer/edit.jsp: This JSP is the wrapper for channel edit functionality.
JSPEditContainer/doedit.jsp: This JSP handles processing of edited channel preferences by forwarding request to a channel.

JSPMenuContainerProvider

Developer Sample Anonymous Desktop JSPs for the JSPMenuContainerProvider are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/JSPMenuContainerProvider directory.

The list of JSPs in JSPMenuContainerProvider directory and their description are:

JSPMenuContainerProvider/menumain.jsp: This is the controlling JSP for menu container with left side navigation and right side selected provider or Portlet content.
JSPMenuContainerProvider/menu.jsp: This JSP is the left side navigation for menu container.

JSPs Within the community_sample Directory

The JSPs available within the Community Sample Directory are:

singlePreferenceHeader.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/singlePreferenceHeader.jsp. This JSP is the masthead included with the JSPDynamicSingleContainer/dynamicSingle.jsp.
singlePreferenceMenubar.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/singlePreferenceMenubar.jsp. This JSP is the menubar included with the JSPDynamicSingleContainer/dynamicSingle.jsp.
PortletEdit.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/PortletEdit.jsp. This JSP is the wrapper for Portlet edit functionality.
datetime.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/datetime.jsp. This JSP is included in the masthead for current date/time.
breadcrumb.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/breadcrumb.jsp. This JSP is included in the Masthead for breadcrumb functionality.
header.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/header.jsp. This JSP is the Masthead for all Community Sample Containers.
JSPDynamicSingleContainer/dynamicSingle.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/JAPDynamicSingleContainer/dynamicSingle.jsp. This JSP is the clone of CommunityParentContainer/single.jsp for search and discussion providers.
Login/content.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/Login/content.jsp. This JSP is the channel content for login form.
CommunityParentContainer/single.jsp: This JSP is available in the /var/opt/SUNWportal/portals/<portal_id>/desktop/community_sample/CommunityParentContainer/single.jsp. This is the controlling JSP for community sample. This JSP includes masthead (header.jsp), content for selected community, and static footer (footer.html).

Chapter 29 JSPs in the enterprise_sample Directory

This chapter lists the subdirectories and the JSPs under the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/ directory.

ASCTabContainer

The ASCTabContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/ASCTabContainerProvider directory.

The ASCTabContainer is the Portal Desktop Parent Container for the Enterprise Sample. The ASCTabContainer JSPs are used to construct the Portal Desktop page.

The list of JSPs in the ASCTabContainer directory and their description are:

anonymous.jsp: This JSP displays the login form for the anonymous user.
body.jsp: This JSP displays the corporate logo and determines whether or not to display the anonymous user logged in the page. This JSP dynamically includes the anonymous.jsp and loggedIn.js.
loggedIn.jsp: This JSP displays the user information for the authenticated user and the logout link.
primaryContainer.jsp: This JSP displays the primary container or top level tabs.
secondaryContainer.jsp: This JSP displays the secondary containers or nested tabs for the current selected primary container.
tab.jsp: This JSP displays the tabs. This JSP dynamically includes the primaryContainer.jsp and the secondaryContainer.jsp.
user.jsp: This JSP determines whether the user is an anonymous user or not.

AccountPreferencesContainer

The AccountPreferencesContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/AccountPreferencesContainer directory.

The AccountPreferencesContainer JSPs are used to maintain the users account preference settings for contact information, password, and timezone.

The list of JSPs in the AccountPreferencesContainer directory and their description are:

content.jsp: This JSP displays the appropriate page for contact information, password, or timezone settings.
process.jsp: This JSP processes the request for contact information, password, or timezone settings.
title.jsp: This JSP displays the title for Account Settings page.

The AccountPreferencesContainer contact information JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/AccountPreferencesContainer/contactinfo directory.

The AccountPreferencesContainer password JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/AccountPreferencesContainer/password directory.

The AccountPreferencesContainer timezone JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/AccountPreferencesContainer/timezone directory.

FullPageContainer

The FullPageContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/FullPageContainer directory.

The FullPageContainer is used to display the channel content in a full page view.

The JSP available in the FullPageContainer directory and its description is:

content.jsp: This JSP displays the channel content in a full page view.

JSPEditContainer

The JSPEditContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/JSPEditContainer directory.

The JSPs in the EditContainer are used when the Edit icon is selected in a channel title bar inside a JSP based container. The channels that have the editType defined as EDIT_SUBSET to use these JSPs. The difference between the EditContainer JSP and the default directory JSP is that the EditContainer JSP includes the Enterprise Sample style.

The list of JSPs in the JSPEditContainer directory and their description are:

edit.jsp: This JSP displays the Edit view of a channel and provides a wrapper around the actual Edit view for a given channel.
doedit.jsp: This JSP processes the edit request.

JSPTableContainerProvider

The JSPTableContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/JSPTableContainerProvider directory.

The list of JSPs in the JSPTableContainerProvider directory and their description are:

channel.jsp: This JSP wraps the channel to display the channel menubar and content view. This JSP dynamically includes the channelMenubar.jsp.
channelMenubar.jsp: This JSP displays the menubar in the channel.
column.jsp: This JSP is responsible for each column in the table layout and to retrieve the channel content.
launchPopup.jsp: This JSP detaches the channel into a separate window.
popupChannel.jsp: This JSP displays the content view of the detached channel.
popupChannelMenubar.jsp: This JSP displays the menubar of the detached channel.
table.jsp: This JSP is responsible for the table layout and displays the content view of the table container. This JSP dynamically includes the column.jsp.
tableFullWindow.jsp: This JSP displays the content view of the table container for single maximized channel.

OnlineHelpContainer

The OnlineHelpContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/OnlineHelpContainer directory.

The list of JSPs in the OnlineHelpContainer directory and their description are:

content.jsp: This JSP displays the online help.
title.jsp: This JSP displays the title for online help page.

PagePreferencesContainer

The PagePreferencesContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/PagePreferencesContainer directory.

The PagePreferencesContainer JSPs are used to maintain the users page preference settings for the currently selected tab. These JSPs allow the user to change the page channel content and channel layout.

The list of JSPs in the PagePreferencesContainer directory and their description are:

content.jsp: This JSP displays the appropriate page for contact information, password, or timezone settings.
process.jsp: This JSP processes the request for the content or layout page.
title.jsp: This JSP displays the title for the Page Preferences page.

The PagePreferencesContainer content JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/PagePreferencesContainer/content directory.

The PagePreferencesContainer layout JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample/PagePreferencesContainer/layout directory.

JSPs Within the enterprise_sample Directory

The JSPs available within the enterprise_sample directory are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/enterprise_sample directory.

The list of JSPs within the enterprise_sample directory and their description are:

body.jsp: This JSP displays the corporate logo and determines whether to display the anonymous user in the logged in page. This JSP dynamically includes the anonymous.jsp or the loggedIn.jsp.
channelFullPageContent.jsp: This JSP displays channel content for a full page view.
header.jsp: This JSP displays the header information. This JSP dynamically includes the user.jsp, meta.jsp, title.jsp, script.jsp, and body.jsp.
loggedIn.jsp: This JSP displays the user information for the authenticated user and the logout link.
logout.jsp: This JSP displays the logout link.
meta.jsp: This JSP displays the HTML Meta information.
script.jsp: This JSP displays the JavaScript functions.
title.jsp: This JSP displays the page title.
user.jsp: This JSP determines whether the user is an anonymous user or not.

Chapter 30 JSPs in the developer_sample Directory

This chapter lists the sub directories and the JSPs available under the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/ directory.

FrameTabContainer

The FrameTabContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/FrameTabContainer directory.

The list of JSPs in the FrameTabContainer directory and their description are:

banner.jsp: Contains the required JavaScript and the body tag for the right frame of the frame tab container.
frameset.jsp: Contains the HTML source for frames of the frameset container.
frametab.jsp: Is the main JSP for the frame tab container and throws out the requested content for each frame based on the request parameters from the frameset JSP.
frametabedit.jsp: Displays the Edit page for the frame tab container where new pages can be added, removed, or renamed.
frametabmenu.jsp: Displays the left frame for the frame tab container that has the list of available pages and links to them.
header.jsp: Displays the product banner that is used by the frame tab container.
makeNewTab.jsp: Provides the content for the Make New Page part of the Sections page in the frame tab container.
makeTopic.jsp: Provides the content for each of the page topics in the Make New Page.
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links.
remove.jsp: Displays the remove, rename, and start links for each of the selected pages of the frame tab container in the Current Tab Settings page.
removeRenameTab.jsp: Displays the Start Page, Tab, and Actions part of the Current Tab Settings page for the frame tab container.
selectedTab.jsp: Displays the content for the right frame of the frame tab container.

JSPContentContainer

The JSPContentContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPContentContainer directory. These JSPs are used for the content view when the Content link is selected in a JSP-based table container.

The JSP available in the JSPContentContainer directory and its description is:

contentedit.jsp: Displays the content Edit page.

JSPCreateChannelContainer

The JSPCreateChannelContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPCreateChannelContainer directory.

The list of JSPs in the JSPCreateChannelContainer directory and their description are:

createchannel.jsp: These JSPs are used for the User Defined Channel page on the Desktop.
createchannelcontent.jsp: To create content in the User Defined Channel page.
createchanneldoedit.jsp: To edit content in the User Defined Channel page.
createchanneledit.jsp: To edit content in the User Defined Channel page.
createchannelui.jsp: To create user interface content in the User Defined Channel page.
deletechannel.jsp: To delete a User Defined Channel page.
deletechannelui.jsp: To delete a user interface in the User Defined Channel page.

JSPCustomThemeContainer

The JSPCustomThemeContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPCustomThemeContainer directory. These JSPs are used when the Custom Theme link is selected in the Themes page.

The list of JSPs in the JSPCustomThemeContainer directory and their description are:

customthemedoedit.jsp: Processes the result from the Custom Theme page.
customthemeedit.jsp: Displays the Custom Theme Edit page.
themepreview.jsp: Displays the preview view of the Custom Theme page.

JSPDynamicSingleContainer

The JSPDynamicSingleContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/Developer_sample/JSPDynamicSingleContainer directory.

The JSP available in the JSPDynamicSingleContainer directory and its description is:

dynamicSingle.jsp: Used by the DynamicSingleContainer to display the channel specified in the request parameter. This JSP uses the Desktop theme.

JSPEditContainer

The JSPEditContainer JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPEditContainer directory. These JSPs are used when the Edit icon is selected in a channel title bar inside a JSP- based container. Channels that have the editType defined as EDIT_SUBSET use these JSPs. The difference between this JSP and the one from default directory is that this includes the Desktop theme style.

The JSP available in the JSPEditContainer directory and its description is:

edit.jsp: Displays the Edit view of a channel. Also provides a wrapper around the actual Edit view for a given channel.

JSPFrameCustomTableContainerProvider

The JSPFrameCustomTableContainerProvider JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPFrameCustomTableContainerProvider directory.

JSPFrameCustomTableContainerProvider JSPs are mainly used by the user created pages in the frame tab container. When the user creates a new page from the Sections page in the frame tab container, a new table container is created dynamically. The following JSPs are used by the user created table containers. The difference between this JSP and the one from default directory is that this includes the Desktop theme style.

The JSP available in the JSPFrameCustomTableContainerProvider directory and its description is:

framecustomtable.jsp: Displays the content for the newly created page (table container) from the Sections page.

JSPLayoutContainer

The JSPLayoutContainer JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPLayoutContainer directory. These JSPs are used to display the Layout view when the Layout link is selected in a JSP-based table container.

The JSPs in the JSPLayoutContainer directory and its description is:

layoutedit.jsp: Displays the Layout Edit page.

JSPPopupContainer

The JSPPopupContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPPopupContainer directory. These JSPs were used to detach a channel from a JSP-based Desktop. However, this container is no longer used by the developer sample. The detached windows in developer sample are now drawn by the popup.jsp, popupmenubar.jsp, and providerwrapper.jsp in JSPTableContainer. These JSPs are present for backward compatibility only.

The list of JSPs in the JSPPopupContainer directory and their description are:

popup.jsp: Displays the contents of the channel inside the detached window.
popupMenubar.jsp: Displays the Update, Close, and Logout links inside the popup window.
providerWrapper.jsp: Combines the above JSPs.

JSPPresetThemeContainer

The JSPPresetThemeContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPPresetThemeContainer directory. These JSPs are used when the Preset Themes link is selected in the Themes page.

The list of JSPs in the JSPPresetThemeContainer directory and their description are:

themedoedit.jsp: Processes the result from the Preset Theme page.
themeedit.jsp: Displays the Preset Theme Edit page.
themepreview.jsp: This file exists for backward compatibility and shows that the theme changes apply to a channel only.

JSPSingleContainer

The JSPSingleContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPSingleContainer directory.

The list of JSPs in the JSPSingleContainer directory and their description are:

header.jsp: Displays the product banner that is used by the Single Container page.
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links.
single.jsp: Displays the content for JSPSingleContainerProvider.

JSPTabContainer

The JSPTabContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPTabContainer directory.

The list of JSPs in the JSPTabContainer directory and their description are:

header.jsp: Displays the product banner that is used by the Tab Container page. (Dynamically included.)
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links. (Dynamically included.)
selectedTab.jsp: Displays the tab image for the current selected tab in the tab container.
tab.jsp: Is the main JSP for the tab container. It draws the content page for the tab container. (Dynamically includes header.jsp and menubar.jsp.)
tabedit.jsp: Displays the Edit page for the tab container where new pages can be added, removed, or renamed.
tabs.jsp: Generates the available tabs and the links for them to be activated on the Desktop.

JSPTabCustomTableContainerProvider

The JSPTabCustomTableContainer JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPTabCustomTableContainerProvider directory.

The JSP available in the JSPTabCustomTableContainerProvider directory and their description are:

tabcustomtable.jsp: Displays the table container’s content view.

JSPTableContainerProvider

The JSPTableContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPTableContainerProvider directory.

The list of JSPs in the JSPTableContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
leafWraper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

JSPs Within the developer_sample Directory

These JSPs are located within the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample directory. These JSPs are used by more than one channel, and are also used as a default if the named JSP is not found in the provider or channel subdirectory.

The JSPs that are available within the developer_sample directory and their description are:

PortletBanner.jsp: This JSP is used to draw the banner on the edit page of a JSR 168 portlet when the edit button is clicked on the portlet.
PortletMenubar.jsp: This JSP is used to draw the menubar on the edit page of a JSR 168 portlet when the edit button is clicked on the portlet.
defaultHeader.jsp: Displays the default product banner that includes the user reference links.
defaultMenubar.jsp: Displays the default menubar that includes the user reference links.
framePreferenceHeader.jsp: Displays the product banner that is used by the frame tab containers.
framePreferenceMenubar.jsp: Displays the menubar that is used by the frame tab containers.
searchbox.jsp: Displays the search box that are used in the desktop header area.
singlePreferenceHeader.jsp: Displays the product banner that is used by the single containers.
singlePreferenceMenubar.jsp: Displays the menubar that is used by the single containers.
tabPreferenceHeader.jsp: Displays the product banner that is used by the tab containers.
tabPreferenceMenubar.jsp: Displays the menubar that is used by the tab containers.
tablePreferenceHeader.jsp: Displays the product banner that is used by the table containers.
tablePreferenceMenubar.jsp: Displays the menubar that is used by the table containers.

PredefinedFrontPageFramePanelContainerProvider

The PredefinedFrontPageFramePanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedFrontPageFramePanelContainerProvider directory.

The list of JSPs in the PredefinedFrontPageFramePanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedFrontPageTabPanelContainerProvider

The PredefinedFrontPageTabPanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedFrontPageTabPanelContainerProvider directory.

The list of JSPs in the PredefinedFrontPageTabPanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedSamplesFramePanelContainerProvider

The PredefinedSamplesFramePanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedSamplesFramePanelContainerProvider directory.

The list of JSPs in the PredefinedSamplesFramePanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedSamplesTabPanelContainerProvider

The PredefinedSamplesTabPanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedSamplesTabPanelContainerProvider directory.

The list of JSPs in the PredefinedSamplesTabPanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

SampleJSP

The SampleJSP JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/SampleJSP directory. These JSPs are used by the SampleJSP channel.

The JSP available in the SampleJSP directory and its description is:

samplecontent.jsp: Displays the contents of the Sample JSP channel. This JSP uses of the Desktop theme, and is used as an example of the channelHighlightColor attribute.

SampleSimpleWebService

The SampleSimpleWebService JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/SampleSimpleWebService directory.

The JSP available in the SampleSimpleWebService directory and its description is:

webserviceContent.jsp: Displays the Content view of the simple web service channels.

Chapter 31 JSPs in the developer_anonymous_sample Directory

This chapter contains the following sections:

FrameTabContainer

The JSPs for FrameTabContainer are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/desktop_anonymous_sample/FrameTabContainer directory.

The list of JSPs in the FrameTabContainer and their description are:

frametab.jsp: This JSP is the developer sample anonymous version of the frametab.jsp for the frame tab container with the links for customization deactivated.
header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the frame tab container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for frame tab container with the links for customization deactivated.

JSPDynamicSingleContainer

The JSPDynamicSingleContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample/JSPDynamicSingleContainer directory.

The list of JSPs in the JSPDynamicSingleContainer and their description are:

header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the JSP dynamic single container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for the JSP dynamic single container with the links for customization deactivated.

JSPTabContainer

The JSPTabContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample/JSPTabContainer directory.

The list of JSPs in the JSPTabContainer and their description are:

header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the tab container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for the tab container with the links for customization deactivated.

JSPTableContainerProvider

The JSPTableContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample/JSPTableContainerProvider directory.

The list of JSPs in the JSPTableContainerProvider and their description are:

header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the table container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for the table container with the links for customization deactivated.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedFrontPageFramePanelContainerProvider

The PredefinedFrontPageFramePanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample/PredefinedFrontPageFramePanelContainerProvider directory.

The list of JSPs in the PredefinedFrontPageFramePanelContainerProvider and their description are:

header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the table container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for the table container with the links for customization deactivated.
searchbox.jsp: Displays the search box that are used in the Desktop header area.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedFrontPageTabPanelContainerProvider

The PredefinedFrontPageTabPanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample/PredefinedFrontPageTabPanelContainerProvider directory.

The list of JSPs in the PredefinedFrontPageTabPanelContainerProvider and their description are:

header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the tab container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for the tab container with the links for customization deactivated.
searchbox.jsp: Displays the search box that are used in the Desktop header area.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedSamplesFramePanelContainerProvider

The PredefinedSamplesFramePanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample/PredefinedSamplesFramePanelContainerProvider directory.

The list of JSPs in the PredefinedSamplesFramePanelContainerProvider and their description are:

header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the table container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for the table container with the links for customization deactivated.
searchbox.jsp: Displays the search box that are used in the Desktop header area.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedSamplesTabPanelContainerProvider

The PredefinedSamplesTabPanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_anonymous_sample/PredefinedSamplesTabPanelContainerProvider directory.

The list of JSPs in the PredefinedSamplesTabPanelContainerProvider and their description are:

header.jsp: This JSP is the developer sample anonymous version of the header.jsp for the tab container with the links for customization deactivated.
menubar.jsp: This JSP is the developer sample anonymous version of the menubar.jsp for the tab container with the links for customization deactivated.
searchbox.jsp: Displays the search box that are used in the Desktop header area.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

Chapter 32 JSPs in the welcome_sample Directory

This chapter lists the subdirectory and the JSPs under the welcome_sample directory.

RedirectChannel

RedirectChannel

RedirectChannel is the subdirectory under the /var/opt/SUNWportal/portals/<portal_id>/desktop/welcome_sample/ directory. There are three other subdirectories such as aml, chtml, and wml under RedirectChannel. All these subdirectories contain the content.jsp.

The JSP available in the welcome_sample directory and its description is:

content.jsp: This JSP redirects the user to the Portal welcome page.

Part IV Desktop Java Server Pages

Chapter 26 Overview of Desktop JavaServer Pages

Introduction

Installation Location

The Desktop and JavaServer Pages

File Lookup Scenario

Example 26–1 JSP Lookup Scenario

Example 26–2 JSP Lookup Scenario (no clientPath)

Chapter 27 JSPs in the default Directory

AddressBookJSPProvider

CalendarJSPProvider

CommunityDiscussionProvider

CommunitySearchProvider

CommunitySubscriptionsProvider

DefaultChannel

DiscussionLite

DiscussionProvider

IFrameProvider

IMProvider

JSPContentContainer

JSPDynamicSingleContainer

JSPEditContainer

JSPFrameCustomTableContainerProvider

JSPLayoutContainer

JSPMenuContainerProvider

JSPNativeContainer

JSPProvider

JSPRenderingContainerProvider

JSPRenderingContentChannel

JSPRenderingEditContainer

JSPRenderingErrorChannel

JSPRenderingLayoutChannel

JSPRenderingProvider

JSPSingleContainerProvider

JSPSingleRenderingContainerProvider

JSPTabContainerProvider

JSPTabCustomTableContainerProvider

JSPTableContainerProvider

JSPs Within the default Directory

LotusNotesAddressBookJSPProvider

LotusNotesCalendarJSPProvider

LotusNotesMailJSPProvider

MAAddressBookJSPProvider

MAMailJSPProvider

MSExchangeAddressBookJSPProvider

MSExchangeCalendarJSPProvider

MSExchangeMailJSPProvider

MailJSPProvider

RenderingWrappingProvider

SampleSimpleWebService

SampleSimpleWebServiceConfigurable

SearchProvider

SimpleWebServiceConfigurableProvider

SimpleWebServiceProvider

SubscriptionsProvider

TabJSPEditContainer

UWCAddressBookJSPProvider

UWCCalendarJSPProvider

UWCMailJSPProvider

WirelessJSPClientConfigContainer

WirelessJSPContentChannel

WirelessJSPDesktopProvider

WirelessJSPLayoutChannel

vxml

Chapter 28 JSPs in the community_sample Directory

AccountPreferencesContainer

SearchProvider

DiscussionProvider

PagePreferencesContainer

JSPTableContainerProvider

JSPEditContainer

JSPMenuContainerProvider

JSPs Within the community_sample Directory

Chapter 29 JSPs in the enterprise_sample Directory

ASCTabContainer

AccountPreferencesContainer

FullPageContainer

JSPEditContainer

JSPTableContainerProvider

OnlineHelpContainer

Example 26–2 JSP Lookup Scenario (no `clientPath`)