Portlet Application Deployment Descriptor - Portlets - Advanced

Use to specify create portlet preferences, container runtime options, and the portlet caching mechanism.

Element Description

Name

Select the portlet with which you want to work.

Add

Click to create a new portlet in the application. This launches the Create JSR 286 Java Portlet wizard.

Remove

Click to delete the currently selected portlet.

Name

Edit the name of the portlet.

Class

Edit the name of the class for the portlet or click the Browse Classes icon to select an existing portlet class. The class must have a valid Java name.

Advanced Tab

Use this tab to create and manage portlet preferences and container runtime options, and to establish cache settings for the portlet.

Element Description

Preference Validator

(Optional) Enter or browse for the class that implements the PreferencesValidator interface.

Preferences

Use this panel to create and manage portlet preferences. Portlet preferences provide the primary means of associating application data with portlets. This feature is key to personalizing portlets based on their usage.

Element Description

Add

Click to create a portlet preference for the portlet.
  • Name

    Enter a name for the portlet preference. The name must be unique within the portlet.

  • Value

    Enter the default value for the portlet preference.

  • Read-only

    Select to indicate that the portlet preference cannot be updated programmatically.

Remove

Click to delete the currently selected portlet preference.

Container Runtime Options

Use this panel to set portlet-level container runtime options. You can use these options to override application-level options.

Element Description

Add

Click to display a list of supported container runtime options and select the option that you want to define. Select <Customize> to define your own container runtime option. For a list of standard and extended container runtime options supported by WebCenter Portal, see "Supported Container Runtime Options."
  • Name

    Specify the name of the container runtime option. The name must be unique within the application.

  • Value

    Enter a value for the container runtime option.

Remove

Click to remove the currently selected container runtime option.

Cache Management

Use this panel to specify whether the portlet content should be cached by default for faster rendering on second and subsequent requests.

Selecting the caching option indicates that portlet caching is managed by the portlet container. The portlet itself may choose to cache content for any given response. The settings on this page apply only when the portlet itself does not specify a caching option.

Element Description

Cache Portlet

Select to set up default caching for the selected portlet. Then set default expiry conditions. Selecting this option indicates that portlet caching is managed by the portlet container.Clear to forgo the caching option and render the portlet content afresh at every request.

Cache Scope

Select the scope of the cached content.

  • Public

    Select to share cached content across different users.

  • Private

    Select if you do not want to share cached content across users.

Expiration Options

Set the conditions under which the cached portlet content expires.

  • Cache Content Never Expires

    Select to specify that the cached content should never expire. This is a reasonable choice for portlets that contain static content that is unlikely to change. This sets <expiration-cache> to -1 in the portlet.xml file.

  • Cache Content Expires After [ ] seconds

    Select to specify that the cached portlet content should expire, and then enter the expiration period in seconds. The expiration period is the length of time the portlet content is held in cache before it is discarded. Once portlet content expires, the portlet is rendered afresh on the next request, the newly rendered portlet content is stored in cache, and the expiration countdown restarts. If the value is set to 0, the content is always treated as expired and is rendered afresh at every request.


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