Appendix C
JavaServer Pages Reference
This appendix describes the various JavaServer Pages™ (JSP™) used by Sun Java System Portal Server software.
This appendix contains these sections:
Before using this appendix, you should understand the order in which the Portal Server software looks for JSPs. Some of the JSPs that are used by a particular channel are actually located in the directory named for the provider instead of the channel. In other cases, the JSPs are located in the /etc/opt/SUNWps/desktop/default directory. Also, if the Desktop type, for example, is sampleportal, the lookup mechanism searches in the default directory if the file is not found in the particular DesktopType subdirectory.
See JSP and Template Files Lookup Scenario for more information.
Anonymous Desktop JSPs
Anonymous Desktop JSPs are located under the /etc/opt/SUNWps/desktop/anonymous/* directory. This section includes:
FrameTabContainer JSPs
Anonymous Desktop JSPs for the FrameTabContainer are located in the /etc/opt/SUNWps/desktop/anonymous/FrameTabContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
frametab.jsp
|
This JSP is the anonymous version of the frametab.jsp for the frame tab container with the links for customization deactivated.
|
|
header.jsp
|
This JSP is the anonymous version of the header.jsp for the frame tab container with the links for customization deactivated.
|
|
menubar.jsp
|
This JSP is the anonymous version of the menubar.jsp for frame tab container with the links for customization deactivated.
|
JSPDynamicSingleContainer JSPs
Anonymous Desktop JSPs for the JSPDynamicSingleContainer are located in the /etc/opt/SUNWps/desktop/anonymous/JSPDynamicSingleContainer directory.
JSPTabContainer JSPs
Anonymous Desktop JSPs for the JSPTabContainer are located in the /etc/opt/SUNWps/desktop/anonymous/JSPTabContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
header.jsp
|
This JSP is the anonymous version of the header.jsp for the tab container with the links for customization deactivated.
|
|
menubar.jsp
|
This JSP is the anonymous version of the menubar.jsp for the tab container with the links for customization deactivated.
|
JSPTableContainer JSPs
Anonymous Desktop JSPs for the JSPTableContainer are located in the /etc/opt/SUNWps/desktop/anonymous/JSPTableContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
header.jsp
|
This JSP is the anonymous version of the header.jsp for the table container with the links for customization deactivated.
|
|
menubar.jsp
|
This JSP is the 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 JSPs
Anonymous Desktop JSPs for the PredefinedFrontPageFramePanelContainerProvider are located in the /etc/opt/SUNWps/desktop/anonymous/PredefinedFrontPageFramePanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
header.jsp
|
This JSP is the anonymous version of the header.jsp for the table container with the links for customization deactivated.
|
|
menubar.jsp
|
This JSP is the 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 JSPs
Anonymous Desktop JSPs for the PredefinedFrontPageTabPanelContainerProvider are located in the /etc/opt/SUNWps/desktop/anonymous/PredefinedFrontPageTabPanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
header.jsp
|
This JSP is the anonymous version of the header.jsp for the tab container with the links for customization deactivated.
|
|
menubar.jsp
|
This JSP is the 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 JSPs
Anonymous Desktop JSPs for the PredefinedSamplesFramePanelContainerProvider are located in the /etc/opt/SUNWps/desktop/anonymous/PredefinedSamplesFramePanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
header.jsp
|
This JSP is the anonymous version of the header.jsp for the table container with the links for customization deactivated.
|
|
menubar.jsp
|
This JSP is the 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 JSPs
Anonymous Desktop JSPs for the PredefinedSamplesTabPanelContainerProvider are located in the /etc/opt/SUNWps/desktop/anonymous/PredefinedSamplesTabPanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
header.jsp
|
This JSP is the anonymous version of the header.jsp for the tab container with the links for customization deactivated.
|
|
menubar.jsp
|
This JSP is the 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.)
|
Desktop JSPs in the default Directory
This section provides a listing with description of the JSPs in the /etc/opt/SUNWps/desktop/default directory. It contains:
DiscussionLite JSPs
The DiscussionLite channel JSPs are located in /etc/opt/SUNWps/desktop/default/DiscussionLite directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
discussionLiteContent.j
sp
|
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.
|
Discussions JSP
The Discussions channel JSPs are located in the /etc/opt/SUNWps/desktop/default/Discussions directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
declare.jsp
|
Declares all portal properties.
|
|
discussionContent.jsp
|
Content page. This JSP routes the request to:
- fullDiscussion.jsp if display mode is set to full (or dmode=full)
- viewDiscussion.jsp if dmode=vl
- feedback.jsp if dmode-cmt
- ratingProcess.jsp if dmode=rtg
|
|
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 the header information above the feedback form.
|
|
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 SOIF and submits the SOIF to the search database. This JSP consists of scriptlets.
|
|
fullDiscussion.jsp
|
Request is handled by fullDiscussion.jsp when dmode is full and routes the request to fullDiscussionDisplay.jsp. Controls the list view of discussions.
|
|
fullDiscussionDisplay.j
sp
|
fullDiscussionDisplay.jsp displays the list of results requested by fullDiscussion.jsp.
|
|
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.j
sp
|
Displays the discussion subtree below the separator bar.
|
|
viewDiscussionHeader.js
p
|
Displays the detailed view of the discussion. Displayed above the separator bar.
|
|
viewDiscussionNavigatio
n.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’.
|
DiscussionsProvider JSPs
The DiscussionsProvider JSPs are located in /etc/opt/SUNWps/desktop/default/DiscussionsProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
declare.jsp
|
Declares all portal properties.
|
|
discussionContent.jsp
|
Content page. This JSP routes the request to full if 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 SOIF and submits the SOIF to the search database. This JSP consists of scriptlets.
|
|
fullDiscussion.jsp
|
Sets search parameters, executes search, and displays results.
|
|
fullDiscussionDisplay.j
sp
|
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.j
sp
|
Displays the discussion subtree below the separator bar.
|
|
viewDiscussionHeader.js
p
|
Displays the detailed view of the discussion. Displayed above the separator bar.
|
|
viewDiscussionNavigatio
n.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’.
|
DummyChannel JSPs
The DummyChannel JSPs are located in the /etc/opt/SUNWps/desktop/default/DummyChannel directory. These JSPs are used in the situation when there is no valid default channel name specified for the Desktop. For example, when a new organization is created, the default channel name will be set to DummyChannel by default. If the system administrator does not specify a valid default channel name, then the DummyChannel will be displayed with a warning message to remind user that the default channel name needs to be configured.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
dummy.jsp
|
Displays the warning message for the user.
|
|
header.jsp
|
The header for the Dummy Channel.
|
|
menubar.jsp
|
The menubar for the Dummy Channel.
|
IMProvider JSPs
The IMProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/IMProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The JSPContentContainer JSPs are located in the /etc/opt/SUNWps/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 following is a two column table: column one lists the file name; column two provides a brief description.
|
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 /etc/opt/SUNWps/desktop/default/JSPDynamicSingleContainer directory. This container is used by the search form in the header on the Desktop front page.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
dynamicSingle.jsp
|
Used by the DynamicSingleContainer to display the channel specified in the request parameter.
|
JSPEditContainer JSPs
JSPEditContainer JSPs are located in the /etc/opt/SUNWps/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 following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
JSPFrameCustomTableContainerProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/JSPFrameCustomTableContainerProvider directory.
JSPFrameCustomTableContainerProvider JSPs are used when the user creates a new page from Scratch in the sections page.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
JSPLayoutContainer JSPs are located in the /etc/opt/SUNWps/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 following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
JSPProvider JSPs
JSPProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/JSPProvider directory. This directory contains default set of JSPs that are used by the JSP channels.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
JSPSingleContainerProvider JSPs
JSPSingleContainerProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/JSPSingleContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
JSPTabContainerProvider JSPs
JSPTabContainerProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/JSPTabContainerProvider directory. These JSPs are used as the default set of JSPs for a new channel based on JSPTabContainerProvider.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
JSPTabCustomTableContainerProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/JSPTabCustomTableContainerProvider directory. JSPTabCustomTableContainerProvider JSPs are used when the user creates a new tab from scratch in the tabs page.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
JSPTableContainerProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/JSPTableContainerProvider directory. JSPTableContainerProvider JSPs are the default JSPs that are used by the JSPTableContainerProvider channels.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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
|
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
|
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.)
|
Miscellaneous JSPs
Miscellaneous JSPs are located in the /etc/opt/SUNWps/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 following is a two column table: column one lists the file name; column two provides a brief description.
|
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 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.j
sp
|
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.js
p
|
Displays the menubar that is used by the tab containers.
|
SampleSimpleWebService JSPs
SampleSimpleWebService JSPs are located in the /etc/opt/SUNWps/desktop/default/SampleSimpleWebService directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
SampleSimpleWebServiceConfigurable JSPs are located in the /etc/opt/SUNWps/desktop/default/SampleSimpleWebServiceConfigurable directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
Search JSPs
Search JSPs are located in the /etc/opt/SUNWps/desktop/default/Search directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
|
basicSearch.jsp
|
Displays the interface to perform a basic search.
|
|
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.
|
|
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.)
|
|
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, and so on, 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. browseSearch.jsp and searchOnly.jsp are included only if the user has specified a query; otherwise the category tree (no search) is displayed from browseOnly.jsp. The pageFooter.jsp 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.
|
SearchProvider JSPs
SearchProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/SearchProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.)
|
|
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. browseSearch.jsp and searchOnly.jsp are included only if the user has specified a query; otherwise the category tree (no search) is displayed from browseOnly.jsp. The pageFooter.jsp 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 JSPs
SimpleWebServiceConfigurableProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/SimpleWebServiceConfigurableProvider directory. These JSPs are the default JSPs that are used by the SimpleWebServiceConfigurableProvider channels.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
SimpleWebServiceProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/SimpleWebServiceProvider directory. These JSPs are default JSPs that are used by the SimpleWebServiceProvider channels.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
Subscriptions JSPs
The Subscriptions channel JSPs are located in the /etc/opt/SUNWps/desktop/default/Subscriptions directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 Identity Server subscriptions service attributes holding the subscription information.
|
SubscriptionsProvider JSPs
The SubscriptionsProvider JSPs are located in the /etc/opt/SUNWps/desktop/default/SubscriptionsProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 Identity Server subscriptions service attributes holding the subscription information.
|
TabJSPEditContainer JSPs
TabJSPEditContainer JSPs are located in the /etc/opt/SUNWps/desktop/default/TabJSPEditContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
JSPs in the sampleportal Directory
This section provides a listing with description of the JSPs in the /etc/opt/SUNWps/desktop/sampleportal/* directory. It contains
- FrameTabContainer JSPs
- JSPContentContainer JSPs
- JSPCreateChannelContainer JSPs
- JSPCustomThemeContainer JSPs
- JSPDynamicSingleContainer JSPs
- JSPEditContainer JSPs
- JSPFrameCustomTableContainerProvider JSPs
- JSPLayoutContainer JSPs
- JSPPopupContainer JSPs
- JSPPresetThemeContainer JSPs
- JSPSingleContainer JSPs
- JSPTabContainer JSPs
- JSPTabCustomTableContainerProvider JSPs
- JSPTableContainerProvider JSPs
- Miscellaneous JSPs
- PredefinedFrontPageFramePanelContainerProvider and PredefinedFrontPageTabPanelContainerProvider
- PredefinedSamplesFramePanelContainerProvider and PredefinedSamplesTabPanelContainerProvider
- SampleJSP JSPs
- SampleSimpleWebService JSPs
|
|
Note
|
All the JSPs in sampleportal directory inherit the new Themes.
|
|
FrameTabContainer JSPs
FrameTabContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/FrameTabContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The JSPContentContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPContentContainer directory. These JSPs are used for the content view when the Content link is selected in a JSP-based table container.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
contentedit.jsp
|
Displays the content Edit page.
|
JSPCreateChannelContainer JSPs
The JSPCreateChannelContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPCreateChannelContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
createchannel.jsp
|
These JSPs are used for the User Defined Channel page on the Desktop.
|
|
createchannelcontent.js
p
|
|
createchanneldoedit.jsp
|
|
createchanneledit.jsp
|
|
createchannelui.jsp
|
|
deletechannel.jsp
|
|
deletechannelui.jsp
|
JSPCustomThemeContainer JSPs
JSPCustomThemeContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPCustomThemeContainer directory. These JSPs are used when the Custom Theme link is selected in the Themes page.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The JSPDynamicSingleContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPDynamicSingleContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
dynamicSingle.jsp
|
Used by the DynamicSingleContainer to display the channel specified in the request parameter. This JSP uses the Desktop theme.
|
JSPEditContainer JSPs
The JSPEditContainer JSP is located in the /etc/opt/SUNWps/desktop/sampleportal/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 following is a two column table: column one lists the file name; column two provides a brief description.
|
edit.jsp
|
Displays the Edit view of a channel. Also provides a wrapper around the actual Edit view for a given channel.
|
JSPFrameCustomTableContainerProvider JSPs
The JSPFrameCustomTableContainerProvider JSP is located in the /etc/opt/SUNWps/desktop/sampleportal/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 following is a two column table: column one lists the file name; column two provides a brief description.
|
framecustomtable.jsp
|
Displays the content for the newly created page (table container) from the Sections page.
|
JSPLayoutContainer JSPs
The JSPLayoutContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPLayoutContainer directory. These JSPs are used to display the Layout view when the Layout link is selected in a JSP-based table container.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
layoutedit.jsp
|
Displays the Layout Edit page.
|
JSPPopupContainer JSPs
The JSPPopupContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPPopupContainer directory. These JSPs were used to detach a channel from a JSP-based Desktop. However, this container is no longer used by the sample portal. The detached windows in sample portal are now drawn by the popup.jsp, popupmenubar.jsp, and providerwrapper.jsp in JSPTableContainer. These JSPs are present for backward compatibility only.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The JSPPresetThemeContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPPresetThemeContainer directory. These JSPs are used when the Preset Themes link is selected in the Themes page.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The JSPSingleContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPSingleContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The JSPTabContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPTabContainer directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.
|
|
|
Note
|
The header.jsp and menubar.jsp have the new Themes look.
|
|
JSPTabCustomTableContainerProvider JSPs
The JSPTabCustomTableContainer JSPs is located in the /etc/opt/SUNWps/desktop/sampleportal/JSPTabCustomTableContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
tabcustomtable.jsp
|
Displays the table container’s content view.
|
JSPTableContainerProvider JSPs
The JSPTableContainer JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/JSPTableContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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.)
|
Miscellaneous JSPs
Miscellaneous JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal 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 following is a two column table: column one lists the file name; column two provides a brief description.
|
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.j
sp
|
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.js
p
|
Displays the menubar that is used by the tab containers.
|
|
tablePreferenceHeader.j
sp
|
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 /etc/opt/SUNWps/desktop/sampleportal/PredefinedFrontPageFramePanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 /etc/opt/SUNWps/desktop/sampleportal/PredefinedFrontPageTabPanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 /etc/opt/SUNWps/desktop/sampleportal/PredefinedSamplesFramePanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 /etc/opt/SUNWps/desktop/sampleportal/PredefinedSamplesTabPanelContainerProvider directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The SampleJSP JSPs are located in the /etc/opt/SUNWps/desktop/sampleportal/SampleJSP directory. These JSPs are used by the SampleJSP channel.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
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 JSPs
The SampleSimpleWebService JSP is located in the /etc/opt/SUNWps/desktop/sampleportal/SampleSimpleWebService directory.
The following is a two column table: column one lists the file name; column two provides a brief description.
|
webserviceContent.jsp
|
Displays the Content view of the simple web service channels.
|
Miscellaneous JSP Information
This section contains miscellaneous information on using JSPs when customizing the Desktop.
Performing Redirects
To perform redirects from the doedit.jsp page back to the edit.jsp page, use the following URL:
|
response.sendRedirect(p.getProviderContext().getDesktopURL(request).toStrin
g() + "?action=edit&provider=ipsdtJSPEditChannel" + "&targetprovider=" +
p.getName() + "&reedit=true");
|
|
To return back to the Edit page, use the following, which does not hardcode the editchannel name.
|
String editChannel = request.getParameter("editChannelName");
response.sendRedirect(p.getProviderContext().getDesktopURL(request).toStrin
g() + "?action=edit&provider=<%=editChannel%>&targetprovider=" + p.getName()
+ "&redit=true");
|
|
JSP vs. Theme Color
The colors of a theme can be changed in two places: in the JSP or template file that uses the theme tag, and in the display profile using the GlobalThemes attribute.
If you change the color value in the JSP or template file, the Desktop uses this value and not what is in the GlobalThemes attribute.
For example, if you manually change the following background color in a JSP file
BGCOLOR="<dttheme:getAttribute name="borderColor"/>"
to
BGCOLOR="#FFFFFF"
then the Desktop shows white for border color, and the theme color is not used. There is no way the theme or the Desktop can detect this.
Recompiling JSPs
Every time you make a modification to a JSP file, you need to recompile. You do this by running the touch command on the modified container’s top-level JSP file.
For example, type touch tab.jsp.
|
|
Note
|
A typical desktop will include content from several JSPs. However, if you make a modification to a non-toplevel JSP that has been included in a top level JSP, the included JSP will not be recomplied. The end result is your desktop changes will never be reflected.
If the top-level JSP is touched, the JSP engine recompiles all the relevant JSPs. If you cannot find the top level JSP, run the touch command on all JSPs in the directory, for example,
touch *.jsp
This modifies all JSPs, including the top-level JSP.
See JavaServer Page Caching Information for information on how to find the top-level (parent) JSP.
|
|
JavaServer Page Caching Information
When the system compiles JavaServer Pages™ (JSP™), the result is only one Java™ class per parent JSP. There is no compiled class for the static included JSPs. Thus, when you change an included JSP, you need to run the touch command on the parent JSP to recompile the parent JSP with the changed JSP. The Portal Server software JSP engine checks the last modification time on the compiled class and the JSP file to see if the JSP needs to be recompiled. In this way, the change takes effect immediately.
To find a JSP’s parent JSP, search in the JSP for the string <%@ include file="filename.jsp" %>. Some JSPs are dynamically included by using the <jsp:include page="header.jsp" flush="true"/> syntax instead of <%@ include file="header.jsp" %>. This syntax compiles header.jsp and generates a separate Java class.
The path to cached JSPs is constructed in such a way so that the compiled JSPs do not conflict with each other in multi-server instances, when multiple Desktop types contain the same JSPs and for multiple clientTypes and locales. So when JSPs are dynamically included, the touch command does not need to be run for the parent JSP.
Debugging JSPs
The JSP classes are created at:
/var/opt/SUNWps/https-psservername/portal/tmp/_jsps
You can find compilation and runtime errors in the Desktop debug log at:
/var/opt/SUNWam/debug/desktop.debug
Also, all JSPProvider based Desktop channels have a property called showExceptions. This property, by default, is set to false; setting it to true causes the JSP exception to show up as the content of the channel.
