Configuring JSR 286 portlets

This topic provides a brief description of some of the new tabs and fields in the JSR 286 Portlet Deployment Editor.

To configure a JSR 286 portlet, double click on the Portlet Deployment Descriptor (PDD) in the Project Navigator. The PDD editor opens. The JSR 286 PDD has additional tabs for JSR 286 specific properties, such as Events, Render Parameters, Filters, and URL listeners.

This section is a brief description of some of the new tabs and fields in the JSR 286 Portlet Deployment Descriptor Editor.

Render Parameters Tab

It enables you to declare all the public render parameters that are defined for the portlet application.

• Name: This should either be a string or a namespace-qualified name. Select either the default namespace or specify a custom namespace. The localized string that you entered as the Event name is appended to the selected namespace.

• Identifier: Specify an identifier. This is used to refer to this public render parameter inside the code.

• Description: Enter a descriptive text about the defined render parameter.

• Alias: Specify a namespace-qualified alias name.

Filters Tab

It enables you to define all the filters for the portlet application. One filter can apply to multiple portlets.

• Filter Name: Enter a string specifying a unique and logical filter name.

• Filter Class: Select a fully qualified filter class name.

• Language: Select the language in which the display name should appear.

• Display Name: Specify a short name. This will be displayed by the tool.

• Description: Enter a descriptive text about the filter.

• Lifecycle: Select the lifecycle for which the filter should be applied. The phases:

  • Action phase

  • Event phase

  • Render phase

  • Resource phase

  Note: You can select multiple phases.

• Initialization: You can add name value initialization pairs for the filter.

• Mapped portlets: Specify the set of portlets to which the filter applies.

Events Tab

It enables you to define all the events that are declared for the portlet application.

• Event Name: A string or namespace-qualified name. Specify either the default namespace or specify a custom namespace. The localized string that you enter as the Event name is appended to the selected namespace.

• Value Type: Select a fully qualified Java class name of the value to be transferred with the event.

• Description: Enter a descriptive text about the events that are declared for the portlet application.

• Language: Select the language in which the description should be displayed.

• Alias: Specify a namespace qualified name for events. This is to enable portals to perform automatic wiring between portlets.

Runtime options Tab

This enables you to add, edit, or remove all the container runtime options that define additional runtime behavior for the portlet application.

• Name: Specify a name of the Container runtime option.

• Value: Specify a runtime option value. You can add multiple runtime options values.

URL Listeners Tab

URL Listeners: This enables you to define URL Listeners for the portlet project in order to filter URLs.

• URL Listener Class: Specify the class name that implements the PortletURLGenerationListener.

• Description: Enter a descriptive text about the specified URL listeners.

• Language: Select the language in which the description should be displayed.

Modes Tab

The following are the new options available in the custom portlet mode tab:

• Language: Select a language in which the description should be displayed.

• Portal-managed checkbox: Select the checkbox to indicate if the custom portlet mode needs to be managed.

For a description of properties common to both specifications, refer to Configuring JSR 168 portlets

---