Definition of a portlet.
| Attribute Name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| name | Name of portlet. This name MUST be unique | ||||||||
| type |
Type of portlet-entry
| ||||||||
| hidden |
| ||||||||
| application |
Portlet will be displayed in a full screen, i.e. the only portlet displayed.
|
Typically optional information that describe the item (portlet, parameter, ...). Meta-info is used by the Jetspeed customizer. The information is also available to some portlet types.
Title of item (portlet, parameter, ...)
| Parent Element | Default |
|---|---|
| portlet-entry | Value of portlet-entry's name attribute |
| parameter | Value of parameter's name attribute |
The hidden attribute controls whether the customizer will display the parameter.
This element is optional.
| Attribute Name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| name | Name of portlet, parameter,... | ||||||||
| value | Default/initial value | ||||||||
| type |
Data type of value. When this attribute is not present any character string is accepted
| ||||||||
| hidden |
|
| Parameter Name | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| _display |
Initial display state of portlet.
This parameter can only be set in PSML. If not present, Default: normal
| ||||||||||||||||
| _showtitlebar |
Should the Portlet's title bar be displayed. The title bar
includes the Portlet title and the action buttons
(Minimize, Maximize, Customize, and Close). When the title bar is
disabled, i.e. value = false, the user will only be able to add or
remove, if permissions allow, the portlet the customizer.
This parameter can be set in PSML or in the .xreg files. This parameter was added in version 1.3a3. If not present, Default: true
| ||||||||||||||||
| _TimeToLive |
How long, in milliseconds, should the portlet remain idle
in cache. This parameter is used to override the default value.
Example: _TimeToLive = 300000 which is 5 minutes (5 * 60 * 1000) and the portlet cached expires every 3 minutes.
This parameter can be set in PSML or in the .xreg files. This parameter was added in version 1.3a3. | ||||||||||||||||
| _control |
Overrides default portlet control with control specified.
This parameter can be set in PSML or in the .xreg files. If not present, default portlet control, as specified by This parameter was added in version 1.4b2. |
Since the configuration file is an XML file, some character must be represented using XML entities.
| Character | XML Entity |
|---|---|
| & | & |
| < | < |
| > | > |
| Allowable Protocols | Description |
|---|---|
| http:// | Standard HTTP protocol is used to retrieve file or data |
| | File is local and path is relative to <jetspeed_home> |
Good URLs:
Bad URLs:
Remote URL caching:
Portlet types extending the FileWatchPortlet (for example, NewRSSPortlet), read their remote URLs using the JetspeedCache. JetspeedCache uses DiskCacheDaemon to manage refreshing of these URLs upon their change or expiration. See the DiskCache for further details.
Used by customizer to limit access to this item (portlet, parameter,...)
| Attribute Name | Description |
|---|---|
| parent | Reference to an existing security constraint |
See the Security for further details.
Media types that can display and configure portal.
Media types are define in <jetspeed_home>/WEB-INF/conf/media.xreg
| Attribute Name | Description |
|---|---|
| ref | Media type. |
<portlet-entry name="RSS" hidden="false" type="abstract" application="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<classname>org.apache.jetspeed.portal.portlets.NewRSSPortlet</classname>
<parameter name="stylesheet" value="/WEB-INF/xsl/rss.xsl" hidden="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<security role="admin"/>
</parameter>
<media-type ref="html"/>
<media-type ref="wml"/>
</portlet-entry>
<portlet-entry name="RSS" hidden="false" type="ref" application="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<parameter name="" value="" hidden="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<security role=""/>
</parameter>
</portlet-entry>
<portlet-entry name="StockQuotePortlet" hidden="false" type="instance" application="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<parameter name="sort" value="Symbol" type="style"
hidden="false">
<meta-info>
<title>Sort</title>
<description>Column to sort by</description>
</meta-info>
</parameter>
<parameter name="sort.style" value="ListBox" hidden="true"/>
<parameter name="sort.style.items" value="Symbol,Volume,PChange" hidden="true"/>
<parameter name="columns"
value="Symbol,Quote,Date,Time,Change,PChange,Open,High,Low,Volume"
type="style" hidden="false">
<meta-info>
<title>Columns</title>
<description>Columns to display</description>
</meta-info>
</parameter>
<parameter name="columns.style.items"
value="Symbol,Quote,Date,Time,Change,PChange,Open,High,Low,Volume"
hidden="true"/>
<parameter name="columns.style.layout" value="$eastwest"
hidden="true"/>
<parameter name="columns.style" value="CheckBoxGroup"
hidden="true"/>
<parameter name="symbols"
value="MSFT,EMC,SUNW,ORCL,IBM"
type="style" hidden="false">
<meta-info>
<title>Symbols</title>
<description>List of comma-separated stock symbols</description>
</meta-info>
</parameter>
<parameter name="symbols.style" value="TextArea" hidden="true"/>
</portlet-entry>