Configuration common to most portlets

Common elements

• portlet-entry
• meta-info
• classname
• parameter
• url
• security
• media-type

Registery Entry examples

Definition of a portlet.

Attribute Name	Description
name	Name of portlet. This name MUST be unique
type	Type of portlet-entry Allowable values abstract Portlet is one which cannot be created directly. It acts as a portlet template, useful for defining common properties for a group of related portlets. instance Portlet is the basic entry. It should provide all the necessary information to create the portlet, at least the classname. ref Portlet is based on an existing <portlet-entry> which can be of any type, including other ref entries. The engine will follow all refs until it finds either an abstract or instance entry, override all parameters found in the these definitions by those in the ref definition's, and then create the portlet using the combined definitions
hidden	Allowable values false true
application	Portlet will be displayed in a full screen, i.e. the only portlet displayed. Allowable values false true

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.

Element: title

Title of item (portlet, parameter, ...) Parent Element Default portlet-entry Value of portlet-entry's name attribute parameter Value of parameter's name attribute

Element: description

Description of item (portlet, parameter, ...). Their is no default description.

Element: icon

Path and file name of icon relative to <jetspeed_home>

Java class uses to generate content.

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 Allowable values boolean Only true or false are allowed as a value for this parameter
hidden	Allowable values false true

Parameter Name	Description
_display	Initial display state of portlet. This parameter can only be set in PSML. If not present, Default: normal Value Description closed Portlet is closed and not visible minimized Portlet is minimized. Only title is displayed normal Portal and content is displayed
_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 Value Description true Portlet Title Bar is displayed false Portlet Title Bar is NOT displayed
_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. Time Activity 1:00 Portlet created 1:00 User Joe displayed the portlet content 1:03 Portlet marked as expired, the portlet's refresh() is called, the portlet is no longer expired 1:05 User Sam displayed the portlet content 1:06 Portlet marked as expired, the portlet's refresh() is called, the portlet is no longer expired 1:09 Portlet marked as expired, the portlet's refresh() is called, the portlet is no longer expired 1:12 Portlet marked as expired. Since the portlet has been idle for 7 minutes, the portlet will be removed from cache. This parameter can be set in PSML or in the .xreg files. This parameter was added in version 1.3a3.

Since the configuration file is an XML file, some character must be represented using XML entities.

Character	XML Entity
&	&
<	&lt;
>	&gt;

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:

<url>http://jakata.apache.org/jetspeed</url>

Basic URL

<url>http://search.yahoo.com/bin/search?p=jetspeed</url>

1 Parameter passed

<url>http://search.yahoo.com/search?p=jetspeed&amp;n=100</url>

2 Parameter passed

Bad URLs:

<url>index.html</url>

No protocol, http:// or hostname

<url>http://search.yahoo.com/search?p=jetspeed&n=100</url>

Contains & instead of &amp;.

Used by customizer to limit access to this item (portlet, parameter,...)

Attribute Name	Description
role	Role required by user to select this item

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.

Abstract Portal Entry

	<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>

Reference Portal 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>

• Add descriptions and review.
• Add common parameters, i.e. bgcolor and display.screen.
• Complete examples
• How is the application attribute of <portlet-entry> used?
• How is the hidden attribute of <portlet-entry> used?
• How is the hidden attribute of <parameter> used?
• Verify definition/implementation of <portlet-entry>.