The registry element needs to be the root elements of any registry fragment. It can contains any of the currently defined entries.

The portlet-entry element is the main element encountered in the Registry. It describes a Portlet object that can be used within a portal page description.

There are 3 main types of portlet-entry definitions, controlled by the value of the type attribute in the entry:

abstract

These portlets cannot be used directly in a portlet page and simply provide a configuration template for creating ref portlet-entry.

The classname element is required in an abstract portlet

instance

These are the default portlet entries created within the registry and describe standard Java component complying to the Portlet API that can be added directly within a portal page.

The classname element is required in an instance portlet

ref

These entries are the more frequently encountered definitions in the registry. They define portlets that reference another existing portlet entry in the registry, yet override or complement the previous definitions with additionnal parameters.

The parent attribute is required in a ref portlet and must refer another existing abstract or instance portlet, but not another ref portlet.
The classname element should not occur within a ref prtlet definition.

In addition to the type attribute, portlet entries can also use standard attributes and elements that can be used in most other registry entries and are explained here

Parameter handling

Some parameters have special meanings when encountered in a portlet-entry defintion:

Also note that any parameter starting with a "_" will not be ignored by the default portlet customizer.

The first example presents a minimal abstract type portlet definition. Note that it's defined as hidden to prevent the entry from showing up when browsing for portlets

The second example provides a standard instance type portlet definition.

The portlet-control-entry element defines the available PortletControl available to decorate the different portlets.

The portlet-control-entry definition is nearly identical to those of instance type portlet-entry, expect that there's no category, url or caching related attributes.

A typical control defintion will use the default VelocityPortletControl and simply specify the associated template and working parameters.

The portlet-controller-entry element defines the available PortletController that are used to lay out a pane content.

The syntax and usage of this element is exactly the same as the portlet-control-entry

A typical controller defintion will use the default VelocityPortletController and simply specify the associated template and working parameters.

The skin-entry element defines the color scheme that can be used to decorate the portal pages. It contists of a simple named list of properties that can be associated to a portal or pane on a portal page.

The following properties are currently used by the default controls and controllers. It's possible to freely add new properties.

These properties are only styling hints that may be disregarded by some controls or controllers.

This example presents the default skin definition used by the default Jetspeed portal.

The media-type-entry element defines the media types supported the portal instance.

These media types are defined by a MIME content type, an optional character set and an optional set of user agent capabilities required to correctly access this media type.

The media types are referenced by the portlet-entry, portlet-control-entry and portlet-controller-entry to define when these entries can be used.

These elements needs to be ordered from most preferred to least preferred for the client detection to work correctly.

For more information, see the Client media detection document.

The client-entry element, introduced in the Jetspeed release 1.4b2, describes known user agents and their capabilities in handling the different content-types.

These elements needs to be ordered from most preferred to least preferred for the client detection to work correctly.

For more information, see the Client media detection document.

The security-entry element is used to describe standard sets of access rules that can be used to protect portal elements or actions. These security entry are referenced by the other types of registry entries by using the security-ref element.

See the Security system overview

Several attributes and inner elements can be found in all registry entry types with similar semantics. This section describes these attributes and elements.