Appendix B XML Reference

Appendix B
XML Reference

As an iPlanet™ Directory Server Access Management Edition application, the Sun™ ONE Portal Server registers its services into the Sun ONE Identity Server Service Management Services (SMS) framework. This occurs during the pre-installation of the Sun ONE Portal Server and post-installation for Sun ONE Identity Server..



Note	In general, any service-related data that is not server-specific is stored in the Sun ONE Identity Server directory. Server-specific data can be stored in properties files that are local to the specific server.

SMS provides a mechanism for services to define and manage their configuration data by using an Extensible Markup Language (XML) file that adheres to the SMS Document Type Definition (DTD). The definition of the configuration parameters through the XML file is called the schema for the service. Each Sun ONE Portal Server service (Desktop, Netmail, Rewriter, and Search) has its own XML and properties files for presenting and modifying service specific data.

Within the Sun ONE Identity Server framework, Sun ONE Portal Server defines services related to the following functional areas:

Desktop—The SunPortalDesktopService includes data associated with the Desktop component, including the display profile and other configuration parameters associated with the Desktop.

Search Engine—The SunPortalSearchService defines the data associated with the Search component, such as the search person and search instances. One or more instances of Search service instances can be defined.

NetMail—The SunPortalNetMailService includes data associated with the NetMail application primarily consisting of the user’s preferences.

Rewriter—The SunPortalRewriterService includes data associated with the Rewriter component, including the named rule sets that control the rewriting operation. The Rewriter API makes reference to the named rule sets that are stored in the directory.

In addtion, the Sun ONE Portal Server also uses other DTDs to define LDAP attribute values for the display profile and the Rewriter ruleset.

The Display Profile Document Type Definition (DTD) defines how the Display Profile is structured. The underlying data format for a display profile document is XML. It is intended to define the display configuration for the Desktop. It does that by defining provider, portlet, and channel objects, and their properties. See Chapter 5, "Administering the Display Profile"” for more information about the display profile.

The Rewriter ruleset DTD defines the structure of the ruleset. The Rewriter includes a default ruleset. Chapter 7, "Administering the Rewriter Service"” gives more details about the Rewriter and how it uses a ruleset.

This appendix provides a file listing for various XML files used to define the services of theSun ONE Portal Server. It contains the following sections:

Sun ONE Portal Server Desktop Service Definition

Sun ONE Portal Server NetMail Service Definition

Sun ONE Portal Server Rewriter Service Definition

Sun ONE Portal Server Search Service Definition

Display Profile DTD

Rewriter Ruleset DTD

Default Ruleset

Sun ONE Portal Server Desktop Service Definition

With the default installation, the Service Management Services Document Type Definition is found in the /opt/SUNWam/dtd/sms.dtd file. The portal server Desktop service definition is in the /opt/SUNWps/export/psDesktop.xml file.

Code Example B-1 Desktop Service Definition


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

<!--
Copyright 2001 Sun Microsystems, Inc. All rights reserved.
PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.

Sun ONE Portal Server (iPS) Desktop Service Definition
-->

<!DOCTYPE ServicesConfiguration
PUBLIC "=//Sun ONE//Service Management Services (SMS) 1.0 DTD//EN"
"jar://com/iplanet/sm/sms.dtd">

<ServicesConfiguration>
<Service name="SunPortalDesktopService" version="1.0">
<Schema
i18nFileName="psDesktop"
serviceHierarchy="/ps.configuration/SunPortalDesktopService"
propertiesViewBeanURL="/portal/dtadmin/DesktopAdminService"
i18nKey="sunPortalDesktopServiceDescription">
<Global>
<AttributeSchema name="serviceObjectClasses"
type="list"
syntax="string"
i18nKey="">
<DefaultValues>
<Value>sunPortalDesktopPerson</Value>
</DefaultValues>
</AttributeSchema>
<!--
desktop session reaping has been disabled per
bug #4720290. see this bug report for details.

when this bug is resolved, the entries must be added
back into psDesktop.ldif, as they have been removed
completely for lack of a commenting feature


<AttributeSchema name="sunPortalDesktopSessionReapInterval"
type="single"
syntax="string"
any="display"
i18nKey="g2">
<DefaultValues>
<Value>1800</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopSessionInactiveMaximum"
type="single"
syntax="string"
any="display"
i18nKey="g3">
<DefaultValues>
<Value>3600</Value>
</DefaultValues>
</AttributeSchema>
-->
<AttributeSchema name="sunPortalDesktopDpIsValidating"
type="single"
syntax="boolean"
any="display"
i18nKey="g5">
<DefaultValues>
<Value>true</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpNamespaceURI"
type="single"
syntax="string"
any="display"
i18nKey="g6">
<DefaultValues>
<Value>http://www.iplanet.com</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpDocument"
type="single"
syntax="xml"
any="display"
i18nKey="g7">
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpLastModified"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>-1</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopSessionReturnURLParamName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>goto</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DSAMEDPContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpUserContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DSAMEDPUserContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDebugContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DSAMEDebugContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopServiceContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DSAMEServiceContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopSessionAppContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DSAMESessionAppContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopSessionContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DSAMESessionContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopAuthlessSessionContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.CookieSessionContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDesktopContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.PSDesktopContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopContainerProviderContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.PSContainerProviderContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopProviderManagerContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.PSProviderContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopPropertiesContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DPPropertiesContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopTemplateContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.FileTemplateContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopClientContextClassName"
type="single"
syntax="string"
any="display">
<DefaultValues>
<Value>com.sun.portal.desktop.context.DSAMEClientContext</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopAuthorizedAuthlessUIDs"
type="list"
syntax="string"
any="display"
i18nKey="g8">
<DefaultValues>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDefaultAuthlessUID"
type="single"
syntax="string"
any="display"
i18nKey="g9">
<DefaultValues>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopChannelImportModules"
type="list"
syntax="string"
any="display">
<DefaultValues>
</DefaultValues>
</AttributeSchema>
</Global>

<Dynamic>
<AttributeSchema name="sunPortalDesktopDefaultChannelName"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="d1">
<DefaultValues>
<Value>JSPTabContainer</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopEditProviderContainerName"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="d2">
<DefaultValues>
<Value>JSPEditContainer</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopType"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="d3">
<DefaultValues>
<Value>default</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpDocument"
type="single"
syntax="xml"
cosQualifier="default"
any="display"
i18nKey="d4">
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpLastModified"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="">
<DefaultValues>
<Value>-1</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpCanView"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="d5">
<DefaultValues>
<Value>true</Value>
</DefaultValues>
</AttributeSchema>
</Dynamic>

<Policy>
<ActionSchema name="sunPortalDesktopExecutable"
type="single"
syntax="boolean"
any="display"
cosQualifier="default"
i18nKey="p1">
<DefaultValues>
<Value>true</Value>
</DefaultValues>
</ActionSchema>
</Policy>

<User>
<AttributeSchema name="sunPortalDesktopDefaultChannelName"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="d1">
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopEditProviderContainerName"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="d2">
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopType"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="d3">
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpDocumentUser"
type="single"
syntax="xml"
any="display"
i18nKey="u1">
</AttributeSchema>
<AttributeSchema name="sunPortalDesktopDpLastModifiedUser"
type="single"
syntax="string"
any="display"
i18nKey="">
<DefaultValues>
<Value>-1</Value>
</DefaultValues>
</AttributeSchema>
</User>

</Schema>
</Service>
</ServicesConfiguration>

Sun ONE Portal Server NetMail Service Definition

With the default installation, the Service Management Services Document Type Definition is found in the /opt/SUNWam/dtd/sms.dtd file. The portal server NetMail service definition is in the /opt/SUNWps/export/psNetMail.xml file

Code Example B-2 NetMail Service Definition

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

<!--
Copyright 2001 Sun Microsystems, Inc. All rights reserved.
PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.

Sun ONE Portal Server (iPS) NetMail Service Definition
-->

<!--
FIXME(P@): replace below DTD path with a token that can
be substituted by postinstall script
-->

<!DOCTYPE ServicesConfiguration
PUBLIC "=//Sun ONE//Service Management Services (SMS) 1.0 DTD//EN"
"file:/opt/SUNWam/dtd/sms.dtd">

<ServicesConfiguration>
<Service name="SunPortalNetMailService" version="1.0">
<Schema
i18nFileName="psNetMail"
serviceHierarchy="/ps.configuration/SunPortalNetMailService"
i18nKey="sunPortalNetmailServiceDescription">
<Global>
<AttributeSchema name="serviceObjectClasses"
type="list"
syntax="string"
i18nKey="">
<DefaultValues>
<Value>sunPortalNetmailPerson</Value>
</DefaultValues>
</AttributeSchema>
</Global>
<Dynamic>
<AttributeSchema name="sunPortalNetmailIMAPServerName"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a01">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailSMTPServerName"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a02">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailDefaultMailDomain"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a03">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailRootFolder"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a04">
<DefaultValues>
<Value>Mail</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailSentMessagesFolder"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a15">
<DefaultValues>
<Value>Mail/Sent</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReplyWithAuthor"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a20">
<DefaultValues>
<Value>false</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReplyWithDate"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a21">
<DefaultValues>
<Value>false</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReplyWithBody"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a22">
<DefaultValues>
<Value>true</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailIndentPrefix"
type="single"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a18">
<DefaultValues>
<Value>></Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAddSignature"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a19">
<DefaultValues>
<Value>false</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailInitialHeaders"
type="single"
syntax="numeric"
cosQualifier="default"
any="display"
i18nKey="a07">
<DefaultValues>
<Value>10</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailInactivityInterval"
type="single"
syntax="numeric"
cosQualifier="default"
any="display"
i18nKey="a09">
<DefaultValues>
<Value>5</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailMaxAttachLen"
type="single"
syntax="numeric"
cosQualifier="default"
any="display"
i18nKey="a10">
<DefaultValues>
<Value>0</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutoload"
type="single_choice"
syntax="numeric"
cosQualifier="default"
any="display"
i18nKey="a11">
<ChoiceValues>
<ChoiceValue i18nKey="autoload.All">0</ChoiceValue>
<ChoiceValue i18nKey="autoload.None">1</ChoiceValue>
<ChoiceValue i18nKey="autoload.New">2</ChoiceValue>
<ChoiceValue i18nKey="autoload.Unread">3</ChoiceValue>
<ChoiceValue i18nKey="autoload.New_and_Unread">4</ChoiceValue>
<ChoiceValue i18nKey="autoload.Found">5</ChoiceValue>
</ChoiceValues>
<DefaultValues>
<Value>0</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutosave"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a17">
<DefaultValues>
<Value>true</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutopurge"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a14">
<DefaultValues>
<Value>false</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutoFolderLoad"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a05">
<DefaultValues>
<Value>false</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailMultipleReadWindows"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a13">
<DefaultValues>
<Value>false</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailHeadersPerPage"
type="single"
syntax="numeric"
cosQualifier="default"
any="display"
i18nKey="a08">
<DefaultValues>
<Value>10</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailNewestFirst"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a12">
<DefaultValues>
<Value>true</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailNoPrefsList"
type="multiple_choice"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a23">
<ChoiceValues>
<ChoiceValue>IMAPServerName</ChoiceValue>
<ChoiceValue>IMAPUserName</ChoiceValue>
<ChoiceValue>IMAPPassword</ChoiceValue>
<ChoiceValue>SMTPMailServer</ChoiceValue>
<ChoiceValue>rootFolder</ChoiceValue>
<ChoiceValue>inactivityInterval</ChoiceValue>
<ChoiceValue>initialHeaders</ChoiceValue>
<ChoiceValue>multipleReadWindows</ChoiceValue>
<ChoiceValue>resetSize</ChoiceValue>
<ChoiceValue>autopurge</ChoiceValue>
<ChoiceValue>replyToAddress</ChoiceValue>
<ChoiceValue>indentPrefix</ChoiceValue>
<ChoiceValue>replyFields</ChoiceValue>
<ChoiceValue>saveSentMessages</ChoiceValue>
<ChoiceValue>sentMessagesFolder</ChoiceValue>
<ChoiceValue>signature</ChoiceValue>
<ChoiceValue>autosave</ChoiceValue>
<ChoiceValue>autoFolderLoad</ChoiceValue>
<ChoiceValue>autoload</ChoiceValue>
<ChoiceValue>maxAttachLen</ChoiceValue>
<ChoiceValue>textStyle</ChoiceValue>
<ChoiceValue>textSize</ChoiceValue>
<ChoiceValue>textColor</ChoiceValue>
<ChoiceValue>backgroundColor</ChoiceValue>
</ChoiceValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailLDAPServers"
type="list"
syntax="string"
cosQualifier="default"
any="display"
i18nKey="a06">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailLogMessages"
type="single"
syntax="boolean"
cosQualifier="default"
any="display"
i18nKey="a16">
<DefaultValues>
<Value>false</Value>
</DefaultValues>
</AttributeSchema>
</Dynamic>

<Policy>
<ActionSchema name="sunPortalNetmailExecutable"
type="single"
syntax="boolean"
any="display"
cosQualifier="default"
i18nKey="p1">
<DefaultValues>
<Value>true</Value>
</DefaultValues>
</ActionSchema>
</Policy>

<User>
<AttributeSchema name="sunPortalNetmailIMAPUserid"
type="single"
syntax="string"
any="display"
i18nKey="u1">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailIMAPPassword"
type="single"
syntax="encrypted_password"
any="display"
i18nKey="u2">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReplyToAddress"
type="single"
syntax="string"
any="display"
i18nKey="u3">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailSignature"
type="single"
syntax="paragraph"
any="display"
i18nKey="u4">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailFavoriteFolders"
type="list"
syntax="string"
any="display"
i18nKey="">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailPersonalAddressBook"
type="list"
syntax="string"
any="display"
i18nKey="">
</AttributeSchema>
<!-- attributes duplicated from the dynamic section -->
<AttributeSchema name="sunPortalNetmailIMAPServerName"
type="single"
syntax="string"
any="display"
i18nKey="a01">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailSMTPServerName"
type="single"
syntax="string"
any="display"
i18nKey="a02">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailDefaultMailDomain"
type="single"
syntax="string"
any="display"
i18nKey="a03">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailRootFolder"
type="single"
syntax="string"
any="display"
i18nKey="a04">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailSentMessagesFolder"
type="single"
syntax="string"
any="display"
i18nKey="a15">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReplyWithAuthor"
type="single"
syntax="boolean"
any="display"
i18nKey="a20">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReplyWithDate"
type="single"
syntax="boolean"
any="display"
i18nKey="a21">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReplyWithBody"
type="single"
syntax="boolean"
any="display"
i18nKey="a22">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailIndentPrefix"
type="single"
syntax="string"
any="display"
i18nKey="a18">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAddSignature"
type="single"
syntax="boolean"
any="display"
i18nKey="a19">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailInitialHeaders"
type="single"
syntax="numeric"
any="display"
i18nKey="a07">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailInactivityInterval"
type="single"
syntax="numeric"
any="display"
i18nKey="a09">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailMaxAttachLen"
type="single"
syntax="numeric"
any="display"
i18nKey="a10">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutoload"
type="single_choice"
syntax="numeric"
any="display"
i18nKey="a11">
<ChoiceValues>
<ChoiceValue i18nKey="autoload.All">0</ChoiceValue>
<ChoiceValue i18nKey="autoload.None">1</ChoiceValue>
<ChoiceValue i18nKey="autoload.New">2</ChoiceValue>
<ChoiceValue i18nKey="autoload.Unread">3</ChoiceValue>
<ChoiceValue i18nKey="autoload.New_and_Unread">4</ChoiceValue>
<ChoiceValue i18nKey="autoload.Found">5</ChoiceValue>
</ChoiceValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutosave"
type="single"
syntax="boolean"
any="display"
i18nKey="a17">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutopurge"
type="single"
syntax="boolean"
any="display"
i18nKey="a14">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailAutoFolderLoad"
type="single"
syntax="boolean"
any="display"
i18nKey="a05">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailMultipleReadWindows"
type="single"
syntax="boolean"
any="display"
i18nKey="a13">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailSortKey"
type="single_choice"
syntax="numeric"
any="display"
i18nKey="">
<ChoiceValues>
<ChoiceValue i18nKey="sort-key.IMAP_Number">0</ChoiceValue>
<ChoiceValue i18nKey="sort-key.Status">1</ChoiceValue>
<ChoiceValue i18nKey="sort-key.Cached">2</ChoiceValue>
<ChoiceValue i18nKey="sort-key.From">3</ChoiceValue>
<ChoiceValue i18nKey="sort-key.Size">4</ChoiceValue>
<ChoiceValue i18nKey="sort-key.Date">5</ChoiceValue>
<ChoiceValue i18nKey="sort-key.Subject">6</ChoiceValue>
</ChoiceValues>
<DefaultValues>
<Value>0</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailViewKey"
type="single_choice"
syntax="numeric"
any="display"
i18nKey="">
<ChoiceValues>
<ChoiceValue i18nKey="view-key.All">0</ChoiceValue>
<ChoiceValue i18nKey="view-key.New">1</ChoiceValue>
<ChoiceValue i18nKey="view-key.Non-deleted">2</ChoiceValue>
<ChoiceValue i18nKey="view-key.Cached">3</ChoiceValue>
<ChoiceValue i18nKey="view-key.Non-cached">4</ChoiceValue>
<ChoiceValue i18nKey="view-key.Found">5</ChoiceValue>
<ChoiceValue i18nKey="view-key.Unread">6</ChoiceValue>
</ChoiceValues>
<DefaultValues>
<Value>0</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailComposeWinBounds"
type="single"
syntax="string"
any="display"
i18nKey="">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailFolderWinBounds"
type="single"
syntax="string"
any="display"
i18nKey="">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailReadWinBounds"
type="single"
syntax="string"
any="display"
i18nKey="">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailGridHeight"
type="single"
syntax="numeric"
any="display"
i18nKey="">
<DefaultValues>
<Value>0</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailGridColWidths"
type="single"
syntax="string"
any="display"
i18nKey="">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailTextColor"
type="single_choice"
syntax="number"
any="display"
i18nKey="">
<ChoiceValues>
<ChoiceValue i18nKey="white">-1</ChoiceValue>
<ChoiceValue i18nKey="pink">-20561</ChoiceValue>
<ChoiceValue i18nKey="red">-65536</ChoiceValue>
<ChoiceValue i18nKey="orange">-14336</ChoiceValue>
<ChoiceValue i18nKey="yellow">-256</ChoiceValue>
<ChoiceValue i18nKey="green">-16711936</ChoiceValue>
<ChoiceValue i18nKey="cyan">-16711681</ChoiceValue>
<ChoiceValue i18nKey="blue">-16776961</ChoiceValue>
<ChoiceValue i18nKey="magenta">-65281</ChoiceValue>
<ChoiceValue i18nKey="lightGray">-4144960</ChoiceValue>
<ChoiceValue i18nKey="darkGray">-12566464</ChoiceValue>
<ChoiceValue i18nKey="black">-16777216</ChoiceValue>
</ChoiceValues>
<DefaultValues>
<Value>-16777216</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailBackgroundColor"
type="single_choice"
syntax="number"
any="display"
i18nKey="">
<ChoiceValues>
<ChoiceValue i18nKey="white">-1</ChoiceValue>
<ChoiceValue i18nKey="pink">-20561</ChoiceValue>
<ChoiceValue i18nKey="red">-65536</ChoiceValue>
<ChoiceValue i18nKey="orange">-14336</ChoiceValue>
<ChoiceValue i18nKey="yellow">-256</ChoiceValue>
<ChoiceValue i18nKey="green">-16711936</ChoiceValue>
<ChoiceValue i18nKey="cyan">-16711681</ChoiceValue>
<ChoiceValue i18nKey="blue">-16776961</ChoiceValue>
<ChoiceValue i18nKey="magenta">-65281</ChoiceValue>
<ChoiceValue i18nKey="lightGray">-4144960</ChoiceValue>
<ChoiceValue i18nKey="darkGray">-12566464</ChoiceValue>
<ChoiceValue i18nKey="black">-16777216</ChoiceValue>
</ChoiceValues>
<DefaultValues>
<Value>-1</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailTextSize"
type="single_choice"
syntax="numeric"
any="display"
i18nKey="">
<ChoiceValues>
<ChoiceValue>8</ChoiceValue>
<ChoiceValue>10</ChoiceValue>
<ChoiceValue>12</ChoiceValue>
<ChoiceValue>14</ChoiceValue>
<ChoiceValue>16</ChoiceValue>
<ChoiceValue>18</ChoiceValue>
<ChoiceValue>20</ChoiceValue>
<ChoiceValue>24</ChoiceValue>
<ChoiceValue>28</ChoiceValue>
</ChoiceValues>
<DefaultValues>
<Value>12</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailTextStyle"
type="single_choice"
syntax="numeric"
any="display"
i18nKey="">
<ChoiceValues>
<ChoiceValue i18nKey="plain">0</ChoiceValue>
<ChoiceValue i18nKey="bold">1</ChoiceValue>
<ChoiceValue i18nKey="italic">2</ChoiceValue>
<ChoiceValue i18nKey="bold_italic">3</ChoiceValue>
</ChoiceValues>
<DefaultValues>
<Value>0</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailHeadersPerPage"
type="single"
syntax="numeric"
any="display"
i18nKey="a08">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailNewestFirst"
type="single"
syntax="boolean"
any="display"
i18nKey="a12">
</AttributeSchema>
<AttributeSchema name="sunPortalNetmailLogMessages"
type="single"
syntax="boolean"
any="display"
i18nKey="a16">
</AttributeSchema>
</User>

</Schema>
</Service>
</ServicesConfiguration>

Sun ONE Portal Server Rewriter Service Definition

With the default installation, the Service Management Services Document Type Definition is found in the /opt/SUNWam/dtd/sms.dtd file. The portal server Rewriter service definition is in the /opt/SUNWps/export/psRewriter.xml file.

Code Example B-3 Rewriter Service Definition

<?xml version="1.0" encoding="UTF-8"?>

<!--
Copyright 2001 Sun Microsystems, Inc. All rights reserved.
PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.
-->

<!DOCTYPE ServicesConfiguration
PUBLIC "=//Sun ONE//Service Management Services (SMS) 1.0 DTD//EN"
"jar://com/iplanet/sm/sms.dtd">

<ServicesConfiguration>
<Service name="SunPortalRewriterService" version="1.0">

<Schema serviceHierarchy="/ps.configuration/SunPortalRewriterService"
propertiesViewBeanURL="/portal/rwadmin/SelectRule"
i18nFileName="psRewriter"
i18nKey="sunPortalRewriterServiceDescription">
<Global>
<SubSchema name="SunPortalRewriterGlobal">
<SubSchema name="SunPortalRewriterRuleSets" inheritance="multiple">
<AttributeSchema name="sunPortalRewriterRuleset" syntax="xml" />
</SubSchema>
</SubSchema>
</Global>
</Schema>

<Configuration>
<GlobalConfiguration>
<SubConfiguration name="SunPortalRewriterGlobal">
</SubConfiguration>
</GlobalConfiguration>
</Configuration>

</Service>
</ServicesConfiguration>

Sun ONE Portal Server Search Service Definition

Code Example B-4 Search Service Definition

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Copyright 2001 Sun Microsystems, Inc. All rights reserved.
PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.

Sun ONE Portal Server (iPS) Search Service Definition
-->

<!DOCTYPE ServicesConfiguration
PUBLIC "=//Sun ONE//Service Management Services (SMS) 1.0 DTD//EN"
"file:/opt/SUNWam/dtd/sms.dtd">

<ServicesConfiguration>
<Service name="SunPortalSearchService" version="1.0">
<Schema
serviceHierarchy="/ps.configuration/SunPortalSearchService"
propertiesViewBeanURL="/portal/searchadmin/"
i18nFileName="psSearch"
i18nKey="sunPortalSearchServiceDescription">
<Global>
<AttributeSchema name="serviceObjectClasses"
type="list"
syntax="string"
i18nKey="">
<DefaultValues>
<Value>sunPortalSearchPerson</Value>
</DefaultValues>
</AttributeSchema>
<AttributeSchema name="sunPortalSearchInstances"
type="list"
syntax="string"
i18nKey="cs_instances">
<DefaultValues>
</DefaultValues>
</AttributeSchema>
</Global>

</Schema>

</Service>
</ServicesConfiguration>

Display Profile DTD

In the default installation, the display profile DTD is in the /opt/SUNWps/dtd/psdp.dtd file.

Code Example B-5 Display Profile DTD


<!ELEMENT DisplayProfile
(
Properties,
Channels,
Providers
)
>
<!ATTLIST DisplayProfile
xmlns:DisplayProfile CDATA #FIXED 'http://www.iplanet.com'
name CDATA #FIXED "_root"
version CDATA #REQUIRED
merge (replace\|fuse) "fuse"
lock (true\|false) "false"
advanced (true\|false) "false"
priority CDATA #REQUIRED
>

<!ELEMENT Channels
(
(Container\|Channel)*
)
>
<!ATTLIST Channels
>

<!ELEMENT Providers
(
(Provider)*
)
>
<!ATTLIST Providers
>

<!ELEMENT Provider
(
Properties
)
>
<!ATTLIST Provider
name CDATA #REQUIRED
class CDATA #REQUIRED
merge (replace\|remove\|fuse) "fuse"
lock (true\|false) "false"
advanced (true\|false) "false"
>

<!ELEMENT Channel
(
Properties
)
>
<!ATTLIST Channel
name CDATA #REQUIRED
provider CDATA #REQUIRED
merge (replace\|remove\|fuse) "fuse"
lock (true\|false) "false"
advanced (true\|false) "false"
>

<!ELEMENT Container
(
Properties,
Available,
Selected,
Channels
)
>
<!ATTLIST Container
name CDATA #REQUIRED
provider CDATA #REQUIRED
merge (replace\|remove\|fuse) "fuse"
lock (true\|false) "false"
advanced (true\|false) "false"
>

<!ELEMENT Available
(Reference*)
>
<!ATTLIST Available
merge (replace\|fuse) "fuse"
lock (true\|false) "false"
advanced (true\|false) "false"
>

<!ELEMENT Selected
(Reference*)
>
<!ATTLIST Selected
merge (replace\|fuse) "fuse"
lock (true\|false) "false"
advanced (true\|false) "false"
>

<!ELEMENT Properties
(
Collection\|
Integer\|
String\|
Boolean\|
Locale
)*
>
<!ATTLIST Properties
name CDATA #FIXED "_properties"
merge (replace\|fuse) "fuse"
lock (true\|false) "false"
propagate (true\|false) "true"
advanced (true\|false) "false"
>

<!ELEMENT Locale
(
Collection\|
Integer\|
String\|
Boolean
)*
>
<!ATTLIST Locale
language CDATA #IMPLIED
country CDATA #IMPLIED
variant CDATA #IMPLIED
merge (replace\|remove\|fuse) "fuse"
lock (true\|false) "false"
propagate (true\|false) "true"
advanced (true\|false) "false"
>

<!ELEMENT Collection
(
Collection\|
Integer\|
String\|
Boolean
)*
>
<!ATTLIST Collection
name CDATA #REQUIRED
merge (replace\|remove\|fuse) "fuse"
lock (true\|false) "false"
propagate (true\|false) "true"
advanced (true\|false) "false"
>

<!ELEMENT Integer EMPTY>
<!ATTLIST Integer
name CDATA #IMPLIED
value CDATA #REQUIRED
merge (replace\|remove) "replace"
lock (true\|false) "false"
propagate (true\|false) "true"
advanced (true\|false) "false"
>

<!ELEMENT String (#PCDATA)>
<!ATTLIST String
name CDATA #IMPLIED
value CDATA #IMPLIED
merge (replace\|remove) "replace"
lock (true\|false) "false"
propagate (true\|false) "true"
advanced (true\|false) "false"
>

<!ELEMENT Reference EMPTY>
<!ATTLIST Reference
value CDATA #REQUIRED
merge (replace\|remove) "replace"
lock (true\|false) "false"
propagate (true\|false) "true"
advanced (true\|false) "false"
>

<!ELEMENT Boolean EMPTY>
<!ATTLIST Boolean
name CDATA #IMPLIED
value (true\|false) #REQUIRED
merge (replace\|remove) "replace"
lock (true\|false) "false"
propagate (true\|false) "true"
advanced (true\|false) "false"
>

<!ELEMENT ParEntry
(
Description?,
Provider?,
Channel?
)
>
<!ATTLIST ParEntry
xmlns:ParEntry CDATA #FIXED 'http://www.iplanet.com'
name CDATA #REQUIRED
version CDATA #REQUIRED
date CDATA #REQUIRED
author CDATA #REQUIRED
requiredClass CDATA #REQUIRED
>

<!ELEMENT Description (#PCDATA) >

Rewriter Ruleset DTD

In the default installation, the Rewriter Ruleset DTD is in the /opt/SUNWps/web-src/WEB-INF/lib/rewriter.jar jar file under resources/RuleSet.dtd.

Code Example B-6 Rewriter Ruleset DTD


<?xml version="1.0" encoding="UTF-8"?>

<!ENTITY % gtype 'GROUPED'>
<!ENTITY % stype 'SCATTERED'>
<!ENTITY % jURL 'URL'>
<!ENTITY % jEXPRESSION 'EXPRESSION'>
<!ENTITY % jDHTML 'DHTML'>
<!ENTITY % jDJS 'DJS'>
<!ENTITY % jSYSTEM 'SYSTEM'>
<!ENTITY % ruleSetElements '(HTMLRules \| JSRules \| XMLRules)? '>
<!ENTITY % htmlElements '(Form \| Applet \| Attribute \| JSToken)*'>
<!ENTITY % jsElements '(Variable \| Function)*'>
<!ENTITY % xmlElements '(Attribute \| TagText)*'>
<!ELEMENT RuleSet (%ruleSetElements;,%ruleSetElements;,%ruleSetElements;)>
<!ATTLIST RuleSet
type (%gtype; \| %stype;) "GROUPED"
id ID #REQUIRED
>

<!ELEMENT HTMLRules (%htmlElements;)>
<!ATTLIST HTMLRules
type (%gtype; \| %stype;) "GROUPED"
id CDATA "html_rules"
>
<!ELEMENT Form EMPTY>
<!ATTLIST Form
source CDATA #REQUIRED
name CDATA #REQUIRED
field CDATA #REQUIRED
valuePatterns CDATA ""
>
<!ELEMENT JSToken (#PCDATA)>
<!ELEMENT Applet EMPTY>
<!ATTLIST Applet
source CDATA #REQUIRED
code CDATA #REQUIRED
param CDATA "*"
valuePatterns CDATA ""
>
<!ELEMENT JSRules (%jsElements;)>
<!ATTLIST JSRules
type (%gtype; \| %stype;) "GROUPED"
id CDATA "js_rules"
>
<!ELEMENT Variable (#PCDATA)>
<!ATTLIST Variable
type (%jURL; \| %jEXPRESSION; \| %jDHTML; \| %jDJS; \| %jSYSTEM;) "URL"
>
<!ELEMENT Function EMPTY>
<!ATTLIST Function
type (%jURL; \| %jEXPRESSION; \| %jDHTML; \| %jDJS;) "URL"
name CDATA #REQUIRED
paramPatterns CDATA #REQUIRED
>
<!ELEMENT XMLRules (%xmlElements;)>
<!ATTLIST XMLRules
type (%gtype; \| %stype;) "GROUPED"
id CDATA "xml_rules"
>
<!ELEMENT TagText EMPTY>
<!ATTLIST TagText
tag CDATA #REQUIRED
attributePatterns CDATA ""
>
<!ELEMENT Attribute EMPTY>
<!ATTLIST Attribute
name CDATA #REQUIRED
tag CDATA "*"
valuePatterns CDATA ""
>

Default Ruleset

In the default installation, the default ruleset is in the /opt/SUNWps/web-src/WEB-INF/lib/rewriter.jar jar file under resources/DefaultRuleSet.xml. This file is also in the /opt/SUNWps/export directory.

Code Example B-7 Default Ruleset


<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE RuleSet SYSTEM "jar://rewriter.jar/resources/RuleSet.dtd">

<RuleSet id="default_ruleset">

<!-- Rules for Rewriting HTML Source -->
<HTMLRules>

<!-- Rules for Rewriting Form Input/Option Values List -->


<!-- Rules for Rewriting Applet/Object Parameter Values List -->


<!-- Rules for Rewriting HTML Attributes -->
<Attribute name="action" />
<Attribute name="background" />
<Attribute name="codebase" />
<Attribute name="code" />
<Attribute name="href" />
<Attribute name="src" />
<Attribute name="value" />
<Attribute name="imagePath" />
<Attribute name="lowsrc" />
<Attribute name="archive" valuePatterns="*;,,,,,,,,,,,**"/>
<Attribute name="style" />
<Attribute name="content" tag="meta" />

<!-- Rules for Rewriting HTML Attributes containing Java Script -->
<JSToken>onAbort</JSToken>
<JSToken>onBlur</JSToken>
<JSToken>onChange</JSToken>
<JSToken>onClick</JSToken>
<JSToken>onDblClick</JSToken>
<JSToken>onError</JSToken>
<JSToken>onFocus</JSToken>
<JSToken>onKeyDown</JSToken>
<JSToken>onKeyPress</JSToken>
<JSToken>onKeyUp</JSToken>
<JSToken>onLoad</JSToken>
<JSToken>onMouseDown</JSToken>
<JSToken>onMouseMove</JSToken>
<JSToken>onMouseOut</JSToken>
<JSToken>onMouseOver</JSToken>
<JSToken>onMouseUp</JSToken>
<JSToken>onReset</JSToken>
<JSToken>onSelect</JSToken>
<JSToken>onSubmit</JSToken>
<JSToken>onUnload</JSToken>
</HTMLRules>

<!-- Rules for Rewriting JavaScript Source -->
<JSRules>

<!-- Rules for Rewriting JavaScript variables in URLs -->
<Variable type="URL"> imgsrc </Variable>
<Variable type="URL"> location.href </Variable>
<Variable type="URL"> _fr.location </Variable>
<Variable type="URL"> mf.location </Variable>
<Variable type="URL"> parent.location </Variable>
<Variable type="URL"> self.location </Variable>
<Variable type="EXPRESSION"> location </Variable>
<Variable type="SYSTEM"> window.location.pathname </Variable>

<!-- Rules for Rewriting JavaScript Function Parameters -->
<Function type="URL" name="openURL" paramPatterns="y"/>
<Function type="URL" name="openAppURL" paramPatterns="y"/>
<Function type="URL" name="openNewWindow" paramPatterns="y"/>
<Function type="URL" name="parent.openNewWindow" paramPatterns="y"/>
<Function type="URL" name="window.open" paramPatterns="y"/>
<Function type="DHTML" name="document.write" paramPatterns="y"/>
<Function type="DHTML" name="document.writeln" paramPatterns="y"/>

</JSRules>

<!-- Rules for Rewriting XML Source -->
<XMLRules>

<!-- Rules for Rewriting Attributes -->
<Attribute name="xmlns"/>
<Attribute name="href" tag="a"/>

<!-- Rules for Rewriting TagText -->
<TagText tag="baseroot" />
<TagText tag="img" />
</XMLRules>

</RuleSet>

Previous Contents Index Next