Portlet Application Deployment Descriptor - Filters

Use to specify filter information in the portlet application deployment descriptor (portlet.xml).

A portlet filter is a reusable piece of code that can transform the content of portlet requests and portlet responses.

Element Description

Name

Select the portlet filter with which you want to work.
  • Add

    Click to create a new filter class in which to create portlet filters. This launches the Create Portlet Filter dialog.

  • Remove

    Click to delete the currently selected portlet filter.

Name

Edit the name of the portlet filter. The name must be unique within the application.

Display Name

Edit the display name of the portlet filter.

Class

Edit the name of the class for the portlet filter. The class must have a valid Java name. The filter class must implement one or more of the javax.portlet.filter classes: ActionFilter, EventFilter, RenderFilter, and ResourceFilter.

Description

Edit the description of the portlet filter.

Lifecycle Phases

Select which of the portlet filter's implemented lifecycle phases are applied to the portlet filter for the application.

Note: Checkboxes are available depending on which interfaces the filter class implements. For example, if the filter class does not implement the ActionFilter interface, the Action checkbox is not selectable.

  • Action

    Select to make the filter available during the action lifecycle phase of the portlet.

  • Event

    Select to make the filter available during the event lifecycle phase of the portlet.

  • Render

    Select to make the filter available during the render lifecycle phase of the portlet.

  • Resource

    Select to make the filter available during the resource lifecycle phase of the portlet.

Initialization Parameters

Use this panel to create and manage initialization parameters for the selected portlet filter. These parameters are passed to the init() method of the portlet filter's Java class.

Add

Click to create an initialization parameter for the portlet filter.

  • Name

    Enter a name for the initialization parameter. The name must be unique in the application. Use only letters, numbers, and the underscore character.

  • Value

    Enter the default value for the initialization parameter.

  • Description

    Enter a description for the initialization parameter.

Remove

Click to delete the currently selected initialization parameter.


Related Topics

"Introduction to Portlets" in Developing WebCenter Portal Assets and Custom Components with Oracle JDeveloper

"Building Standards-Based Java Portlets Using JSR 286" in Developing WebCenter Portal Assets and Custom Components with Oracle JDeveloper